Ryo Iizuka / libMiMic

This is Webservice SDK for mbed. LPCXpresso1769/LPC1768/FRDM-K64F/LPC4088

Dependents:   MbedFileServer_1768MiniDK2 RedWireBridge IssueDebug_gcc MiMicRemoteMCU-for-Mbed ... more

libMiMic(MiMic library for mbed)は、WebService機能を提供するSDKです。 mbedでWebAPIに対応したネットワークデバイスを簡単に作ることが出来ます。

libMiMicはMiMic projectで開発しています。MiMic projectについてはこちらをご覧ください。 http://nyatla.jp/mimic/wp/

構成

libMiMicはmbedRTOS上で動作し、ユーザアプリケーションにAPIを提供します。コアAPIはC言語で記述されていますが、使用頻度の高いものについてはmbed向けのC++APIが準備されています。

/media/uploads/nyatla/libmimic-sdk.png

※libMiMicはmbedの標準イーサネットドライバをしようしていません。

標準イーサネットドライバと同時に使用することはできません。

  • MiMicIP - IPv4スタックです。レテンシとメモリ消費量を抑えたuipベースのライブラリです。
  • ARP/ICMP/UDP/TCP - 基礎的なソケットAPIを提供します。APIは独自です。
  • HTTP/1.1 Server - HTTP/1.1に対応したサーバです。マルチセッション・Chunked・持続性接続に対応しています。
  • HTTP Modules - HTTP/1.1の機能モジュールです。以下のモジュールがあります。
    • ROM file provider - ROMに格納したファイルイメージを公開します。
    • File system provider - mbedファイルシステムを公開します。
    • Onchip configuration - プログラムフラッシュを利用して設定を保存します。
    • MiMicVM processor - RPCリクエスト(MiMicVM)を処理します。
    • FileUpload - ファイルアップロードを受け取ります。
    • URL decoder - HTTPリクエストを解析します。
    • UPnP handler -UPnPメッセージを処理します。
    • WebSocket - Websocketサーバです。
  • mDNS - マルチキャストDNSサービスです。
  • UPnP - UPnP/1.0の機能を提供します。UPnP handlerと協調して動作します。(現在はデバイス探索(SSDP)・デスクリプション(Description)のみ実装してあります。)
  • DHCP/APIPA - ゼロコンフィギュレーション用のモジュールです。
  • HTTP/1.1 Client
  • mbed C++ class library - mbed向けのC++CPIです。C言語のものより簡単です。

対応機種

  • mbed(mbed LPC1768)
  • LPCXpresso1769

プログラム

Import programMiMicRemoteMCU-for-Mbed

MiMic RemoteMCU for mbed. This program provides MCU control API over REST API. It can control MCU from Javascript,PHP or any HTTP rest client directly. And, The application has self development environment.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

チュートリアル

English

libMiMic(MiMic library for mbed) is SDK which provides Webservice functions. It can be created networking device easily using mbed.

See more MiMic information, See MiMic project website. http://nyatla.jp/mimic/wp/

Structure

libMiMic run on mbed RTOS and provides networking API to user application. This library has C++ class API for the mbed, and low-level C language API.

/media/uploads/nyatla/libmimic-sdk.png

For WebService general, it can be written in a simple C + + API.

libMiMic does not have the standard Ethernet driver of mbed.　It is not possible that will be used with the standard Ethernet driver.

  • MiMicIP - IPv4 protocol stack. This is based uip which is reduced memory and latency.
  • ARP / ICMP / UDP / TCP - Those are provide basic IP protocols.
  • HTTP/1.1 Server - The Http server compatible HTTP/1.1. It supports multi-session, chunked transport, persistent connection.
  • HTTP Modules - There are addon-module for HTTP server. The following modules.
    • ROM file module - Publish the file images in ROM.
    • File system module - Publish thefiles in mbed file system.
    • Onchip configuration module - To save the network settings to the program flash via REST.
    • MiMicVM module - To handle the (MiMicVM) RPC request.
    • FileUpload module - Accept a file via HTTP POST.
    • URL dedoce module - A versatility URL decoder.
    • UPnP handle module - To handle UPnP messages.
    • UPnP - This provides UPnP/1.0 device functions. It works together with UPnP handler.
    • Websocket - websocket (version13) server
  • mDNS Service - DNS-SD protocol server.
  • UPnP - This provides UPnP/1.0 device functions which works with UPnP handler. (You have been implemented (SSDP) ? description only (Description) device search now.) It is a module zero configuration for - DHCP / APIPA. mbed C + + class library - C of mbed for + + is the CPI. It is simple than that of the C language.
  • DHCP/APIPA - It support zero-cpnfigulation.
  • mbed C++ class library. Almost APIs for Web applications are available.
  • HTTP/1.1 Client

Supported target

  • mbed(mbed LPC1768)
  • LPCXpresso1769

Application

Import programMiMicRemoteMCU-for-Mbed

MiMic RemoteMCU for mbed. This program provides MCU control API over REST API. It can control MCU from Javascript,PHP or any HTTP rest client directly. And, The application has self development environment.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

Tutorial

mbed/mod/ModJsonRpc.h@114:f6aef16d4e60, 2016-06-04 (annotated)

Committer:
nyatla
Date:
Sat Jun 04 06:51:04 2016 +0000
Revision:
114:f6aef16d4e60
Parent:
85:416f8bbbdf54 
include????????; ???????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 72:c118a7aa37a3 1 #include "NyLPC_net.h"
nyatla 72:c118a7aa37a3 2 #include "ModBaseClass.h"
nyatla 72:c118a7aa37a3 3 #include "HttpdConnection.h"
nyatla 72:c118a7aa37a3 4 #include "Httpd.h"
nyatla 72:c118a7aa37a3 5 #include "Net.h"
nyatla 85:416f8bbbdf54 6
nyatla 72:c118a7aa37a3 7
nyatla 72:c118a7aa37a3 8 namespace MiMic
nyatla 72:c118a7aa37a3 9 {
nyatla 72:c118a7aa37a3 10 class HttpdConnection;
nyatla 72:c118a7aa37a3 11
nyatla 72:c118a7aa37a3 12 /**
nyatla 72:c118a7aa37a3 13 * This class is Websocket module.
nyatla 72:c118a7aa37a3 14 * The class provides 3 services.
nyatla 72:c118a7aa37a3 15 * <ul>
nyatla 72:c118a7aa37a3 16 * <li>d.xml - a device description.</li>
nyatla 72:c118a7aa37a3 17 * <li>control/xx - soap handler</li>
nyatla 72:c118a7aa37a3 18 * <li>event/xx -event handler.</li>
nyatla 72:c118a7aa37a3 19 * </ul>
nyatla 72:c118a7aa37a3 20 */
nyatla 72:c118a7aa37a3 21 class ModJsonRpc:ModBaseClass
nyatla 72:c118a7aa37a3 22 {
nyatla 76:b375b3d750d8 23 public:
nyatla 85:416f8bbbdf54 24 typedef struct TcJsonRpcEx{
nyatla 85:416f8bbbdf54 25 NyLPC_TcModJsonRpc_t super;
nyatla 85:416f8bbbdf54 26 ModJsonRpc* cppmod_ptr;
nyatla 85:416f8bbbdf54 27 }TcJsonRpcEx_t;
nyatla 85:416f8bbbdf54 28 public:
nyatla 76:b375b3d750d8 29 class BasicRpcObject
nyatla 76:b375b3d750d8 30 {
nyatla 76:b375b3d750d8 31 public:
nyatla 76:b375b3d750d8 32 void* obj;
nyatla 76:b375b3d750d8 33 BasicRpcObject(void* i_ptr) : obj(i_ptr){};
nyatla 76:b375b3d750d8 34 virtual ~BasicRpcObject(){}
nyatla 76:b375b3d750d8 35 };
nyatla 76:b375b3d750d8 36 template< class T > class RpcObject : public BasicRpcObject{
nyatla 76:b375b3d750d8 37 public:
nyatla 76:b375b3d750d8 38 RpcObject(T* i_ptr) : BasicRpcObject(i_ptr){};
nyatla 76:b375b3d750d8 39 virtual ~RpcObject(){delete (static_cast<T*>(this->obj));}
nyatla 76:b375b3d750d8 40 };
nyatla 76:b375b3d750d8 41 template< class T > class RpcArray : public BasicRpcObject{
nyatla 76:b375b3d750d8 42 public:
nyatla 76:b375b3d750d8 43 RpcArray(T* i_ptr) : BasicRpcObject(i_ptr){};
nyatla 76:b375b3d750d8 44 virtual ~RpcArray(){delete[] (static_cast<T*>(this->obj));}
nyatla 76:b375b3d750d8 45 };
nyatla 72:c118a7aa37a3 46 private:
nyatla 72:c118a7aa37a3 47 public:
nyatla 72:c118a7aa37a3 48 const static int PARSE_ERROR=NyLPC_TJsonRpcErrorCode_PARSE_ERROR;
nyatla 72:c118a7aa37a3 49 const static int INVALID_REQUEST=NyLPC_TJsonRpcErrorCode_INVALID_REQUEST;
nyatla 72:c118a7aa37a3 50 const static int METHOD_NOT_FOUND=NyLPC_TJsonRpcErrorCode_METHOD_NOT_FOUND;
nyatla 72:c118a7aa37a3 51 const static int INVALID_PARAMS=NyLPC_TJsonRpcErrorCode_INVALID_PARAMS;
nyatla 72:c118a7aa37a3 52 const static int INTERNAL_ERROR=NyLPC_TJsonRpcErrorCode_INTERNAL_ERROR;
nyatla 72:c118a7aa37a3 53 const static int SERVER_ERROR_BASE=NyLPC_TJsonRpcErrorCode_SERVER_ERROR_BASE;
nyatla 72:c118a7aa37a3 54 private:
nyatla 76:b375b3d750d8 55 BasicRpcObject** _objects;
nyatla 72:c118a7aa37a3 56 const struct NyLPC_TJsonRpcClassDef** _rpc_table;
nyatla 72:c118a7aa37a3 57 protected:
nyatla 85:416f8bbbdf54 58 TcJsonRpcEx_t* _mod;
nyatla 72:c118a7aa37a3 59 public:
nyatla 72:c118a7aa37a3 60 ModJsonRpc();
nyatla 72:c118a7aa37a3 61 /**
nyatla 72:c118a7aa37a3 62 * @param i_rpc_table
nyatla 72:c118a7aa37a3 63 * An address of Json RPC functions table.
nyatla 72:c118a7aa37a3 64 */
nyatla 72:c118a7aa37a3 65 ModJsonRpc(const char* i_path,const struct NyLPC_TJsonRpcClassDef** i_rpc_table);
nyatla 72:c118a7aa37a3 66 virtual ~ModJsonRpc();
nyatla 81:e5e4f2264d24 67 bool isStarted();
nyatla 72:c118a7aa37a3 68 void setParam(const char* i_path,const struct NyLPC_TJsonRpcClassDef** i_rpc_table);
nyatla 72:c118a7aa37a3 69 /**
nyatla 72:c118a7aa37a3 70 * This function prepares Json rpc loop with websocket negotiation.
nyatla 72:c118a7aa37a3 71 * @return
nyatla 72:c118a7aa37a3 72 * true if successful;otherwishe false.
nyatla 72:c118a7aa37a3 73 */
nyatla 72:c118a7aa37a3 74 bool execute(HttpdConnection& i_connection);
nyatla 75:2a18df0ef111 75 void dispatchRpc();
nyatla 72:c118a7aa37a3 76
nyatla 72:c118a7aa37a3 77 public:
nyatla 72:c118a7aa37a3 78 //for development
nyatla 76:b375b3d750d8 79 int addObject(BasicRpcObject* i_object);
nyatla 85:416f8bbbdf54 80 bool removeObject(int i_id);
nyatla 85:416f8bbbdf54 81
nyatla 85:416f8bbbdf54 82 void* getObject(int i_oid);
nyatla 85:416f8bbbdf54 83 bool putResult(unsigned int i_id);
nyatla 72:c118a7aa37a3 84 bool putResult(unsigned int i_id,const char* i_params_fmt,...);
nyatla 72:c118a7aa37a3 85 bool putError(unsigned int i_id,int i_code);
nyatla 72:c118a7aa37a3 86 };
nyatla 76:b375b3d750d8 87 }