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.cpp@72:c118a7aa37a3, 2014-06-13 (annotated)

Committer:
nyatla
Date:
Fri Jun 13 11:06:33 2014 +0000
Revision:
72:c118a7aa37a3
Child:
73:8c7dd6fd462e
mbedAPI???????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 72:c118a7aa37a3 1 #include "ModJsonRpc.h"
nyatla 72:c118a7aa37a3 2 #include "../net/httpd/mod/NyLPC_cModWebSocket_protected.h"
nyatla 72:c118a7aa37a3 3 #include "HttpdConnection.h"
nyatla 72:c118a7aa37a3 4
nyatla 72:c118a7aa37a3 5 namespace MiMic
nyatla 72:c118a7aa37a3 6 {
nyatla 72:c118a7aa37a3 7 #define NUM_OF_OBJECTS 32
nyatla 72:c118a7aa37a3 8
nyatla 72:c118a7aa37a3 9 ModJsonRpc::ModJsonRpc(const char* i_path,const struct NyLPC_TJsonRpcClassDef** i_rpc_table):ModBaseClass(i_path)
nyatla 72:c118a7aa37a3 10 {
nyatla 72:c118a7aa37a3 11 this->_mod=NULL;
nyatla 72:c118a7aa37a3 12 this->_rpc_table=i_rpc_table;
nyatla 72:c118a7aa37a3 13 }
nyatla 72:c118a7aa37a3 14 ModJsonRpc::ModJsonRpc()
nyatla 72:c118a7aa37a3 15 {
nyatla 72:c118a7aa37a3 16 this->_mod=NULL;
nyatla 72:c118a7aa37a3 17 }
nyatla 72:c118a7aa37a3 18 ModJsonRpc::~ModJsonRpc()
nyatla 72:c118a7aa37a3 19 {
nyatla 72:c118a7aa37a3 20 if(this->_mod!=NULL){
nyatla 72:c118a7aa37a3 21 NyLPC_cModJsonRpc_finalize(this->_mod);
nyatla 72:c118a7aa37a3 22 this->_mod=NULL;
nyatla 72:c118a7aa37a3 23 }
nyatla 72:c118a7aa37a3 24 }
nyatla 72:c118a7aa37a3 25 void ModJsonRpc::setParam(const char* i_path,const struct NyLPC_TJsonRpcClassDef** i_rpc_table)
nyatla 72:c118a7aa37a3 26 {
nyatla 72:c118a7aa37a3 27 ModBaseClass::setParam(i_path);
nyatla 72:c118a7aa37a3 28 this->_rpc_table=i_rpc_table;
nyatla 72:c118a7aa37a3 29 }
nyatla 72:c118a7aa37a3 30 bool ModJsonRpc::execute(HttpdConnection& i_connection)
nyatla 72:c118a7aa37a3 31 {
nyatla 72:c118a7aa37a3 32 if(this->_mod!=NULL){
nyatla 72:c118a7aa37a3 33 return false;
nyatla 72:c118a7aa37a3 34 }
nyatla 72:c118a7aa37a3 35 this->_mod=(NyLPC_TcModJsonRpc_t*)malloc(sizeof(NyLPC_TcModJsonRpc_t));
nyatla 72:c118a7aa37a3 36 if(this->_mod==NULL){
nyatla 72:c118a7aa37a3 37 return false;
nyatla 72:c118a7aa37a3 38 }
nyatla 72:c118a7aa37a3 39 bool ret=false;
nyatla 72:c118a7aa37a3 40 //initialize table
nyatla 72:c118a7aa37a3 41 this->_objects=new void*[NUM_OF_OBJECTS];
nyatla 72:c118a7aa37a3 42 memset(this->_objects,sizeof(void*)*NUM_OF_OBJECTS,0);
nyatla 72:c118a7aa37a3 43
nyatla 72:c118a7aa37a3 44 //initialize websocket
nyatla 72:c118a7aa37a3 45 NyLPC_cModJsonRpc_initialize(this->_mod,this->_path,this->_rpc_table);
nyatla 72:c118a7aa37a3 46 if(NyLPC_cModJsonRpc_canHandle(this->_mod,i_connection._ref_inst)){
nyatla 72:c118a7aa37a3 47 ret=NyLPC_cModJsonRpc_execute(this->_mod,i_connection._ref_inst)?true:false;
nyatla 72:c118a7aa37a3 48 }
nyatla 72:c118a7aa37a3 49 NyLPC_cModJsonRpc_finalize(this->_mod);
nyatla 72:c118a7aa37a3 50 free(this->_mod);
nyatla 72:c118a7aa37a3 51 this->_mod=NULL;
nyatla 72:c118a7aa37a3 52
nyatla 72:c118a7aa37a3 53 for(int i=0;i<NUM_OF_OBJECTS;i++){
nyatla 72:c118a7aa37a3 54 if(this->_objects[i]!=NULL){
nyatla 72:c118a7aa37a3 55 delete this->_objects[i];
nyatla 72:c118a7aa37a3 56 }
nyatla 72:c118a7aa37a3 57 }
nyatla 72:c118a7aa37a3 58 return ret;
nyatla 72:c118a7aa37a3 59 }
nyatla 72:c118a7aa37a3 60
nyatla 72:c118a7aa37a3 61 void ModJsonRpc::dispatchRpcCall()
nyatla 72:c118a7aa37a3 62 {
nyatla 72:c118a7aa37a3 63 const union NyLPC_TJsonRpcParserResult* rpc_result;
nyatla 72:c118a7aa37a3 64 for(;;){
nyatla 72:c118a7aa37a3 65 if(!NyLPC_cModJsonRpc_processRpcMessage(this->_mod)){
nyatla 72:c118a7aa37a3 66 break;
nyatla 72:c118a7aa37a3 67 }
nyatla 72:c118a7aa37a3 68 //メッセージ取得を試行
nyatla 72:c118a7aa37a3 69 rpc_result=NyLPC_cModJsonRpc_getMessage(this->_mod);
nyatla 72:c118a7aa37a3 70 if(rpc_result==NULL){
nyatla 72:c118a7aa37a3 71 //nothing
nyatla 72:c118a7aa37a3 72 continue;
nyatla 72:c118a7aa37a3 73 }
nyatla 72:c118a7aa37a3 74 if(NyLPC_TJsonRpcParserResult_hasMethodHandler(rpc_result)){
nyatla 72:c118a7aa37a3 75 if(NyLPC_TJsonRpcParserResult_callMethodHandler(rpc_result,this)){
nyatla 72:c118a7aa37a3 76 continue;
nyatla 72:c118a7aa37a3 77 }else{
nyatla 72:c118a7aa37a3 78 //function failed.
nyatla 72:c118a7aa37a3 79 break;
nyatla 72:c118a7aa37a3 80 }
nyatla 72:c118a7aa37a3 81 }else{
nyatla 72:c118a7aa37a3 82 //no handler
nyatla 72:c118a7aa37a3 83 break;
nyatla 72:c118a7aa37a3 84 }
nyatla 72:c118a7aa37a3 85 }
nyatla 72:c118a7aa37a3 86 NyLPC_cModJsonRpc_close(this->_mod,1000);
nyatla 72:c118a7aa37a3 87 return;
nyatla 72:c118a7aa37a3 88 }
nyatla 72:c118a7aa37a3 89 bool ModJsonRpc::putResult(unsigned int i_id,const char* i_params_fmt,...)
nyatla 72:c118a7aa37a3 90 {
nyatla 72:c118a7aa37a3 91 bool ret;
nyatla 72:c118a7aa37a3 92 va_list a;
nyatla 72:c118a7aa37a3 93 va_start(a,i_params_fmt);
nyatla 72:c118a7aa37a3 94 ret=NyLPC_cModJsonRpc_putResultV(this->_mod,i_id,i_params_fmt,a)?true:false;
nyatla 72:c118a7aa37a3 95 va_end(a);
nyatla 72:c118a7aa37a3 96 return ret;
nyatla 72:c118a7aa37a3 97 }
nyatla 72:c118a7aa37a3 98 bool ModJsonRpc::putError(unsigned int i_id,int i_code)
nyatla 72:c118a7aa37a3 99 {
nyatla 72:c118a7aa37a3 100 return NyLPC_cModJsonRpc_putError(this->_mod,i_id,i_code)?true:false;
nyatla 72:c118a7aa37a3 101 }
nyatla 72:c118a7aa37a3 102
nyatla 72:c118a7aa37a3 103 int ModJsonRpc::addObject(void* i_object)
nyatla 72:c118a7aa37a3 104 {
nyatla 72:c118a7aa37a3 105 for(int i=0;i<NUM_OF_OBJECTS;i++){
nyatla 72:c118a7aa37a3 106 if(this->_objects[i]==NULL){
nyatla 72:c118a7aa37a3 107 this->_objects[i]=i_object;
nyatla 72:c118a7aa37a3 108 return i;
nyatla 72:c118a7aa37a3 109 }
nyatla 72:c118a7aa37a3 110 }
nyatla 72:c118a7aa37a3 111 return -1;
nyatla 72:c118a7aa37a3 112 }
nyatla 72:c118a7aa37a3 113 void* ModJsonRpc::getObject(int i_oid)
nyatla 72:c118a7aa37a3 114 {
nyatla 72:c118a7aa37a3 115 return this->_objects[i_oid];
nyatla 72:c118a7aa37a3 116 }
nyatla 72:c118a7aa37a3 117
nyatla 72:c118a7aa37a3 118 }