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

core/net/httpd/mod/NyLPC_cModJsonRpc.c@72:c118a7aa37a3, 2014-06-13 (annotated)

Committer:
nyatla
Date:
Fri Jun 13 11:06:33 2014 +0000
Revision:
72:c118a7aa37a3
Parent:
71:855020258513
Child:
109:18f12ac01097
mbedAPI???????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 71:855020258513 1 #include "NyLPC_cModJsonRpc.h"
nyatla 71:855020258513 2
nyatla 71:855020258513 3
nyatla 71:855020258513 4
nyatla 71:855020258513 5
nyatla 71:855020258513 6 void NyLPC_cModJsonRpc_initialize(NyLPC_TcModJsonRpc_t* i_inst,const NyLPC_TChar* i_ref_root_path,const struct NyLPC_TJsonRpcClassDef** i_class_tbl)
nyatla 71:855020258513 7 {
nyatla 71:855020258513 8 NyLPC_cModWebSocket_initialize(&i_inst->super,i_ref_root_path);
nyatla 71:855020258513 9 NyLPC_cJsonRpcParser_initialize(&i_inst->_rpc_parser,i_class_tbl);
nyatla 71:855020258513 10 }
nyatla 71:855020258513 11 void NyLPC_cModJsonRpc_finalize(NyLPC_TcModJsonRpc_t* i_inst)
nyatla 71:855020258513 12 {
nyatla 71:855020258513 13 NyLPC_cJsonRpcParser_finalize(&i_inst->_rpc_parser);
nyatla 71:855020258513 14 NyLPC_cModWebSocket_finalize(&i_inst->super);
nyatla 71:855020258513 15 }
nyatla 71:855020258513 16 #define NyLPC_cModJsonRpc_canHandle(i,c) NyLPC_cModWebSocket_canHandle(&((i)->super),(c))
nyatla 71:855020258513 17
nyatla 71:855020258513 18 #define NyLPC_cModJsonRpc_close(i,t) NyLPC_cModWebSocket_close(&((i)->super),(t))
nyatla 71:855020258513 19
nyatla 71:855020258513 20
nyatla 71:855020258513 21 NyLPC_TBool NyLPC_cModJsonRpc_execute(NyLPC_TcModJsonRpc_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection)
nyatla 71:855020258513 22 {
nyatla 71:855020258513 23 //executeで強制初期化
nyatla 71:855020258513 24 NyLPC_cJsonRpcParser_initParser(&i_inst->_rpc_parser,&i_inst->_result);
nyatla 71:855020258513 25 return NyLPC_cModWebSocket_execute(&((i_inst)->super),i_connection);
nyatla 71:855020258513 26 }
nyatla 71:855020258513 27
nyatla 71:855020258513 28 static NyLPC_TInt32 readHandler(void* i_param,NyLPC_TChar i_c)
nyatla 71:855020258513 29 {
nyatla 71:855020258513 30 NyLPC_TcModJsonRpc_t* inst=(NyLPC_TcModJsonRpc_t*)i_param;
nyatla 71:855020258513 31 NyLPC_cJsonRpcParser_putChar(&inst->_rpc_parser,i_c);
nyatla 71:855020258513 32 switch(NyLPC_cJsonRpcParser_getStatus(&(inst->_rpc_parser))){
nyatla 71:855020258513 33 case NyLPC_TcJsonRpcParser_ST_END:
nyatla 71:855020258513 34 return 0;//終端到達。中断
nyatla 71:855020258513 35 case NyLPC_TcJsonRpcParser_ST_ERROR:
nyatla 71:855020258513 36 return -1;//エラー
nyatla 71:855020258513 37 default:
nyatla 71:855020258513 38 return 1;//次の文字をリクエスト
nyatla 71:855020258513 39 }
nyatla 71:855020258513 40 }
nyatla 71:855020258513 41
nyatla 71:855020258513 42
nyatla 71:855020258513 43 NyLPC_TBool NyLPC_cModJsonRpc_processRpcMessage(NyLPC_TcModJsonRpc_t* i_inst)
nyatla 71:855020258513 44 {
nyatla 71:855020258513 45 //終了した場合のみパーサステータスを初期化。
nyatla 71:855020258513 46 switch(NyLPC_cJsonRpcParser_getStatus(&i_inst->_rpc_parser)){
nyatla 71:855020258513 47 case NyLPC_TcJsonRpcParser_ST_END:
nyatla 71:855020258513 48 NyLPC_cJsonRpcParser_initParser(&i_inst->_rpc_parser,&i_inst->_result);
nyatla 71:855020258513 49 break;
nyatla 71:855020258513 50 case NyLPC_TcJsonRpcParser_ST_ERROR:
nyatla 71:855020258513 51 //パーサがエラーを検出してたら何もしない。
nyatla 71:855020258513 52 return NyLPC_TBool_FALSE;
nyatla 71:855020258513 53 }
nyatla 71:855020258513 54 //コールバックハンドラで受信
nyatla 71:855020258513 55 if(NyLPC_cModWebSocket_readCB(&(i_inst->super),readHandler,i_inst)<0){
nyatla 71:855020258513 56 return NyLPC_TBool_FALSE;
nyatla 71:855020258513 57 }
nyatla 71:855020258513 58 return NyLPC_TBool_TRUE;
nyatla 71:855020258513 59 }
nyatla 71:855020258513 60
nyatla 71:855020258513 61 const union NyLPC_TJsonRpcParserResult* NyLPC_cModJsonRpc_getMessage(NyLPC_TcModJsonRpc_t* i_inst)
nyatla 71:855020258513 62 {
nyatla 71:855020258513 63 return (NyLPC_cJsonRpcParser_getStatus(&i_inst->_rpc_parser)!=NyLPC_TcJsonRpcParser_ST_END)?NULL:(&i_inst->_result);
nyatla 71:855020258513 64 }
nyatla 71:855020258513 65
nyatla 71:855020258513 66 NyLPC_TBool NyLPC_cModJsonRpc_putRawMessageV(NyLPC_TcModJsonRpc_t* i_inst,const NyLPC_TChar* i_fmt,va_list i_args)
nyatla 71:855020258513 67 {
nyatla 71:855020258513 68 return NyLPC_cModWebSocket_writeFormatV(&i_inst->super,i_fmt,i_args);
nyatla 71:855020258513 69 }
nyatla 71:855020258513 70 NyLPC_TBool NyLPC_cModJsonRpc_putRawMessage(NyLPC_TcModJsonRpc_t* i_inst,const NyLPC_TChar* i_fmt,...)
nyatla 71:855020258513 71 {
nyatla 71:855020258513 72 NyLPC_TBool r;
nyatla 71:855020258513 73 va_list a;
nyatla 71:855020258513 74 va_start(a,i_fmt);
nyatla 71:855020258513 75 r=NyLPC_cModWebSocket_writeFormatV(&i_inst->super,i_fmt,a);
nyatla 71:855020258513 76 va_end(a);
nyatla 71:855020258513 77 return r;
nyatla 71:855020258513 78 }
nyatla 71:855020258513 79
nyatla 71:855020258513 80
nyatla 71:855020258513 81
nyatla 71:855020258513 82 /**
nyatla 71:855020258513 83 * @param i_params_fmt
nyatla 71:855020258513 84 * パラメータ部のフォーマット文字列です。NyLPC_cFormatWriterと同等の構文を使用できます。
nyatla 71:855020258513 85 * ここで指定した書式文字列は、"そのまま"パラメータ部に表示されます。文字列を返す場合は、次のように\"でエスケープしてください。
nyatla 71:855020258513 86 * '0,1,2,-1,\"result\",3'
nyatla 71:855020258513 87 */
nyatla 72:c118a7aa37a3 88 NyLPC_TBool NyLPC_cModJsonRpc_putResult(NyLPC_TcModJsonRpc_t* i_inst,NyLPC_TUInt32 i_id,const NyLPC_TChar* i_params_fmt,...)
nyatla 72:c118a7aa37a3 89 {
nyatla 72:c118a7aa37a3 90 NyLPC_TBool r;
nyatla 72:c118a7aa37a3 91 va_list a;
nyatla 72:c118a7aa37a3 92 //書き込み文字数の事前計算
nyatla 72:c118a7aa37a3 93 va_start(a,i_params_fmt);
nyatla 72:c118a7aa37a3 94 r=NyLPC_cModJsonRpc_putResultV(i_inst,i_id,i_params_fmt,a);
nyatla 72:c118a7aa37a3 95 va_end(a);
nyatla 72:c118a7aa37a3 96 return r;
nyatla 72:c118a7aa37a3 97 }
nyatla 72:c118a7aa37a3 98
nyatla 72:c118a7aa37a3 99 /**
nyatla 72:c118a7aa37a3 100 * @param i_params_fmt
nyatla 72:c118a7aa37a3 101 * パラメータ部のフォーマット文字列です。NyLPC_cFormatWriterと同等の構文を使用できます。
nyatla 72:c118a7aa37a3 102 * ここで指定した書式文字列は、"そのまま"パラメータ部に表示されます。文字列を返す場合は、次のように\"でエスケープしてください。
nyatla 72:c118a7aa37a3 103 * '0,1,2,-1,\"result\",3'
nyatla 72:c118a7aa37a3 104 */
nyatla 72:c118a7aa37a3 105 NyLPC_TBool NyLPC_cModJsonRpc_putResultV(NyLPC_TcModJsonRpc_t* i_inst,NyLPC_TUInt32 i_id,const NyLPC_TChar* i_params_fmt,va_list i_a)
nyatla 71:855020258513 106 {
nyatla 71:855020258513 107 NyLPC_TBool r;
nyatla 71:855020258513 108 va_list a;
nyatla 71:855020258513 109 NyLPC_TInt16 l;
nyatla 71:855020258513 110
nyatla 71:855020258513 111 //書き込み文字数の事前計算
nyatla 72:c118a7aa37a3 112 NyLPC_va_copy(a,i_a);
nyatla 72:c118a7aa37a3 113 l=NyLPC_cModWebSocket_testFormat(&i_inst->super,"{\"jsonrpc\":\"2.0\",\"result\":[");
nyatla 71:855020258513 114 l+=NyLPC_cModWebSocket_testFormatV(&i_inst->super,i_params_fmt,a);
nyatla 71:855020258513 115 l+=NyLPC_cModWebSocket_testFormat(&i_inst->super,"],\"id\":%d}",i_id);
nyatla 71:855020258513 116 va_end(a);
nyatla 71:855020258513 117
nyatla 71:855020258513 118 //バルク書き込み
nyatla 71:855020258513 119 NyLPC_cModWebSocket_startBulkWrite(&i_inst->super,l);
nyatla 72:c118a7aa37a3 120 r=NyLPC_cModWebSocket_writeBulkFormat(&i_inst->super,"{\"jsonrpc\":\"2.0\",\"result\":[");
nyatla 72:c118a7aa37a3 121 r=r&&NyLPC_cModWebSocket_writeBulkFormatV(&i_inst->super,i_params_fmt,i_a);
nyatla 71:855020258513 122 r=r&&NyLPC_cModWebSocket_writeBulkFormat(&i_inst->super,"],\"id\":%d}",i_id);
nyatla 71:855020258513 123 r=r&&NyLPC_cModWebSocket_endBulkWrite(&i_inst->super);
nyatla 71:855020258513 124 return r;
nyatla 71:855020258513 125 }
nyatla 71:855020258513 126
nyatla 72:c118a7aa37a3 127 struct CodeMsgTbl{
nyatla 72:c118a7aa37a3 128 const char* n;
nyatla 72:c118a7aa37a3 129 NyLPC_TInt32 id;
nyatla 72:c118a7aa37a3 130 };
nyatla 71:855020258513 131
nyatla 72:c118a7aa37a3 132 const static struct CodeMsgTbl _table[]=
nyatla 72:c118a7aa37a3 133 {
nyatla 72:c118a7aa37a3 134 {"Parse error",NyLPC_TJsonRpcErrorCode_PARSE_ERROR},
nyatla 72:c118a7aa37a3 135 {"Invalid Request",NyLPC_TJsonRpcErrorCode_INVALID_REQUEST},
nyatla 72:c118a7aa37a3 136 {"Method not found",NyLPC_TJsonRpcErrorCode_METHOD_NOT_FOUND},
nyatla 72:c118a7aa37a3 137 {"Invalid params",NyLPC_TJsonRpcErrorCode_INVALID_PARAMS},
nyatla 72:c118a7aa37a3 138 {"Internal error",NyLPC_TJsonRpcErrorCode_INTERNAL_ERROR},
nyatla 72:c118a7aa37a3 139 {"Server error",NyLPC_TJsonRpcErrorCode_SERVER_ERROR_BASE}
nyatla 72:c118a7aa37a3 140 };
nyatla 72:c118a7aa37a3 141 static const NyLPC_TChar* code2msg(NyLPC_TInt32 i_id)
nyatla 72:c118a7aa37a3 142 {
nyatla 72:c118a7aa37a3 143 int i;
nyatla 72:c118a7aa37a3 144 for(i=0;i<6;i++){
nyatla 72:c118a7aa37a3 145 if(i_id==_table[i].id){
nyatla 72:c118a7aa37a3 146 return _table[i].n;
nyatla 72:c118a7aa37a3 147 }
nyatla 72:c118a7aa37a3 148 }
nyatla 72:c118a7aa37a3 149 return _table[6].n;
nyatla 72:c118a7aa37a3 150 }
nyatla 72:c118a7aa37a3 151
nyatla 72:c118a7aa37a3 152 NyLPC_TBool NyLPC_cModJsonRpc_putError(NyLPC_TcModJsonRpc_t* i_inst,NyLPC_TUInt32 i_id,NyLPC_TInt32 i_code)
nyatla 72:c118a7aa37a3 153 {
nyatla 72:c118a7aa37a3 154 return NyLPC_cModWebSocket_writeFormat(&i_inst->super,"{\"jsonrpc\":\"2.0\",\"error\":{\"code\": %d, \"message\": \"%s\"},\"id\":%d}",i_code,code2msg(i_code),i_id);
nyatla 72:c118a7aa37a3 155 }