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/jsonrpc/RpcSerial.cpp@114:f6aef16d4e60, 2016-06-04 (annotated)

Committer:
nyatla
Date:
Sat Jun 04 06:51:04 2016 +0000
Revision:
114:f6aef16d4e60
Parent:
89:8b0a010f33a2 
include????????; ???????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 85:416f8bbbdf54 1 #include "RpcHandlerBase.h"
nyatla 85:416f8bbbdf54 2 namespace MiMic
nyatla 85:416f8bbbdf54 3 {
nyatla 85:416f8bbbdf54 4 class SerialHandler :RpcHandlerBase
nyatla 85:416f8bbbdf54 5 {
nyatla 85:416f8bbbdf54 6 public:
nyatla 85:416f8bbbdf54 7 static NyLPC_TBool new1(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 8 {
nyatla 85:416f8bbbdf54 9 //uu
nyatla 85:416f8bbbdf54 10 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 11 PinName pins[2];
nyatla 85:416f8bbbdf54 12 if(getParamsAsPin(mod,i_rpc,pins,2)){
nyatla 85:416f8bbbdf54 13 addNewObjectBatch(mod,i_rpc->method.id,new ModJsonRpc::RpcObject<Serial>(new Serial(pins[0],pins[1])));
nyatla 85:416f8bbbdf54 14 }
nyatla 85:416f8bbbdf54 15 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 16 }
nyatla 85:416f8bbbdf54 17 static NyLPC_TBool format(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 18 {
nyatla 85:416f8bbbdf54 19 //dddd return none
nyatla 85:416f8bbbdf54 20 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 21 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 22 if(inst!=NULL){
nyatla 85:416f8bbbdf54 23 int p[3];
nyatla 85:416f8bbbdf54 24 if(getParamsInt(mod,i_rpc,p,3,1)){
nyatla 85:416f8bbbdf54 25 inst->format(p[0],(SerialBase::Parity)p[1],p[2]);
nyatla 85:416f8bbbdf54 26 mod->putResult(i_rpc->method.id);
nyatla 85:416f8bbbdf54 27 }
nyatla 85:416f8bbbdf54 28 }
nyatla 85:416f8bbbdf54 29 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 30 };
nyatla 85:416f8bbbdf54 31 static NyLPC_TBool readable(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 32 {
nyatla 85:416f8bbbdf54 33 //d return d
nyatla 85:416f8bbbdf54 34 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 35 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 36 if(inst!=NULL){
nyatla 85:416f8bbbdf54 37 mod->putResult(i_rpc->method.id,"%d",inst->readable());
nyatla 85:416f8bbbdf54 38 }
nyatla 85:416f8bbbdf54 39 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 40 }
nyatla 85:416f8bbbdf54 41 static NyLPC_TBool writeable(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 42 {
nyatla 85:416f8bbbdf54 43 //d return d
nyatla 85:416f8bbbdf54 44 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 45 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 46 if(inst!=NULL){
nyatla 85:416f8bbbdf54 47 mod->putResult(i_rpc->method.id,"%d",inst->writeable());
nyatla 85:416f8bbbdf54 48 }
nyatla 85:416f8bbbdf54 49 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 50 }
nyatla 85:416f8bbbdf54 51 static NyLPC_TBool send_break(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 52 {
nyatla 85:416f8bbbdf54 53 //d return none
nyatla 85:416f8bbbdf54 54 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 55 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 56 if(inst!=NULL){
nyatla 85:416f8bbbdf54 57 mod->putResult(i_rpc->method.id);
nyatla 85:416f8bbbdf54 58 }
nyatla 85:416f8bbbdf54 59 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 60 }
nyatla 85:416f8bbbdf54 61 static NyLPC_TBool putc(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 62 {
nyatla 85:416f8bbbdf54 63 //d return d
nyatla 85:416f8bbbdf54 64 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 65 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 66 if(inst!=NULL){
nyatla 85:416f8bbbdf54 67 int v;
nyatla 85:416f8bbbdf54 68 if(getParamInt(mod,i_rpc,v,1)){
nyatla 85:416f8bbbdf54 69 mod->putResult(i_rpc->method.id,"%d",inst->putc(v));
nyatla 85:416f8bbbdf54 70 }
nyatla 85:416f8bbbdf54 71 }
nyatla 85:416f8bbbdf54 72 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 73 }
nyatla 85:416f8bbbdf54 74 static NyLPC_TBool puts(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 75 {
nyatla 85:416f8bbbdf54 76 //ds return d
nyatla 85:416f8bbbdf54 77 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 78 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 79 if(inst!=NULL){
nyatla 85:416f8bbbdf54 80 const char* s;
nyatla 85:416f8bbbdf54 81 if(getParamString(mod,i_rpc,s,1)){
nyatla 85:416f8bbbdf54 82 mod->putResult(i_rpc->method.id,"%d",inst->puts(s));
nyatla 85:416f8bbbdf54 83 }
nyatla 85:416f8bbbdf54 84 }
nyatla 85:416f8bbbdf54 85 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 86 }
nyatla 85:416f8bbbdf54 87 static NyLPC_TBool getc(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 88 {
nyatla 85:416f8bbbdf54 89 //d return d
nyatla 85:416f8bbbdf54 90 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 91 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 92 if(inst!=NULL){
nyatla 85:416f8bbbdf54 93 mod->putResult(i_rpc->method.id,"%d",inst->getc());
nyatla 85:416f8bbbdf54 94 }
nyatla 85:416f8bbbdf54 95 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 96 }
nyatla 85:416f8bbbdf54 97 static NyLPC_TBool gets(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 98 {
nyatla 85:416f8bbbdf54 99 //dd return s
nyatla 85:416f8bbbdf54 100 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 101 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 102 if(inst!=NULL){
nyatla 85:416f8bbbdf54 103 unsigned char l;
nyatla 85:416f8bbbdf54 104 if(getParamByte(mod,i_rpc,l,1)){
nyatla 85:416f8bbbdf54 105 char* b=new char[l];
nyatla 85:416f8bbbdf54 106 inst->gets(b,l);
nyatla 85:416f8bbbdf54 107 mod->putResult(i_rpc->method.id,"\"%s\"",b);
nyatla 85:416f8bbbdf54 108 delete[] b;
nyatla 85:416f8bbbdf54 109 }
nyatla 85:416f8bbbdf54 110 }
nyatla 85:416f8bbbdf54 111 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 112 }
nyatla 85:416f8bbbdf54 113 static NyLPC_TBool baud(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 114 {
nyatla 85:416f8bbbdf54 115 //d return d
nyatla 85:416f8bbbdf54 116 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 117 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 118 if(inst!=NULL){
nyatla 85:416f8bbbdf54 119 int v;
nyatla 85:416f8bbbdf54 120 if(getParamInt(mod,i_rpc,v,1)){
nyatla 85:416f8bbbdf54 121 inst->baud(v);
nyatla 85:416f8bbbdf54 122 mod->putResult(i_rpc->method.id);
nyatla 85:416f8bbbdf54 123 }
nyatla 85:416f8bbbdf54 124 }
nyatla 85:416f8bbbdf54 125 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 126 }
nyatla 89:8b0a010f33a2 127 /**
nyatla 89:8b0a010f33a2 128 * for binary array
nyatla 89:8b0a010f33a2 129 */
nyatla 89:8b0a010f33a2 130 static NyLPC_TBool puts_2(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 89:8b0a010f33a2 131 {
nyatla 89:8b0a010f33a2 132 //dB return d
nyatla 89:8b0a010f33a2 133 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 89:8b0a010f33a2 134 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 89:8b0a010f33a2 135 if(inst!=NULL){
nyatla 89:8b0a010f33a2 136 const unsigned char* data;
nyatla 89:8b0a010f33a2 137 unsigned char len;
nyatla 89:8b0a010f33a2 138 if(getParamByteArray(mod,i_rpc,data,len,1)){
nyatla 89:8b0a010f33a2 139 for(int i=0;i<len;i++){
nyatla 89:8b0a010f33a2 140 inst->putc(data[i]);
nyatla 89:8b0a010f33a2 141 }
nyatla 89:8b0a010f33a2 142 mod->putResult(i_rpc->method.id,"%d",len);
nyatla 89:8b0a010f33a2 143 }
nyatla 89:8b0a010f33a2 144 }
nyatla 89:8b0a010f33a2 145 return NyLPC_TBool_TRUE;
nyatla 89:8b0a010f33a2 146 }
nyatla 89:8b0a010f33a2 147 /**
nyatla 89:8b0a010f33a2 148 * for binary array
nyatla 89:8b0a010f33a2 149 */
nyatla 89:8b0a010f33a2 150 static NyLPC_TBool gets_2(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 89:8b0a010f33a2 151 {
nyatla 89:8b0a010f33a2 152 //ds return B
nyatla 89:8b0a010f33a2 153 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 89:8b0a010f33a2 154 Serial* inst=(Serial*)getObjectBatch(mod,i_rpc);
nyatla 89:8b0a010f33a2 155 if(inst!=NULL){
nyatla 89:8b0a010f33a2 156 unsigned char l;
nyatla 89:8b0a010f33a2 157 if(getParamByte(mod,i_rpc,l,1)){
nyatla 89:8b0a010f33a2 158 unsigned char* b=new unsigned char[l];
nyatla 89:8b0a010f33a2 159 int i=0;
nyatla 89:8b0a010f33a2 160 for(;;){
nyatla 89:8b0a010f33a2 161 *(b+i)=(unsigned char)(inst->getc());
nyatla 89:8b0a010f33a2 162 i++;
nyatla 89:8b0a010f33a2 163 if(i>=l){
nyatla 89:8b0a010f33a2 164 break;
nyatla 89:8b0a010f33a2 165 }
nyatla 89:8b0a010f33a2 166 };
nyatla 89:8b0a010f33a2 167 mod->putResult(i_rpc->method.id,"\"%.*B\"",l,b);
nyatla 89:8b0a010f33a2 168 delete[] b;
nyatla 89:8b0a010f33a2 169 }
nyatla 89:8b0a010f33a2 170 }
nyatla 89:8b0a010f33a2 171 return NyLPC_TBool_TRUE;
nyatla 89:8b0a010f33a2 172 }
nyatla 85:416f8bbbdf54 173 };
nyatla 85:416f8bbbdf54 174
nyatla 85:416f8bbbdf54 175
nyatla 85:416f8bbbdf54 176
nyatla 85:416f8bbbdf54 177 const static struct NyLPC_TJsonRpcMethodDef func_table[]=
nyatla 85:416f8bbbdf54 178 {
nyatla 85:416f8bbbdf54 179 { "_new1" ,"uu" ,SerialHandler::new1},
nyatla 85:416f8bbbdf54 180 { "format" ,"dddd" ,SerialHandler::format},
nyatla 85:416f8bbbdf54 181 { "readable" ,"d" ,SerialHandler::readable},
nyatla 85:416f8bbbdf54 182 { "writeable" ,"d" ,SerialHandler::writeable},
nyatla 85:416f8bbbdf54 183 { "send_break" ,"d" ,SerialHandler::send_break},
nyatla 85:416f8bbbdf54 184 { "putc" ,"dd" ,SerialHandler::putc},
nyatla 85:416f8bbbdf54 185 { "puts" ,"ds" ,SerialHandler::puts},
nyatla 85:416f8bbbdf54 186 { "getc" ,"d" ,SerialHandler::getc},
nyatla 85:416f8bbbdf54 187 { "gets" ,"db" ,SerialHandler::gets},
nyatla 85:416f8bbbdf54 188 { "baud" ,"dd" ,SerialHandler::baud},
nyatla 89:8b0a010f33a2 189 { "gets_2" ,"db" ,SerialHandler::gets_2},
nyatla 89:8b0a010f33a2 190 { "puts_2" ,"dB" ,SerialHandler::puts_2},
nyatla 85:416f8bbbdf54 191 { NULL ,NULL ,NULL}
nyatla 85:416f8bbbdf54 192 };
nyatla 85:416f8bbbdf54 193
nyatla 85:416f8bbbdf54 194 const struct NyLPC_TJsonRpcClassDef MbedJsApi::RPC_MBED_SERIAL={
nyatla 85:416f8bbbdf54 195 "mbedJS","Serial",func_table
nyatla 85:416f8bbbdf54 196 };
nyatla 85:416f8bbbdf54 197
nyatla 85:416f8bbbdf54 198
nyatla 85:416f8bbbdf54 199
nyatla 85:416f8bbbdf54 200 }
nyatla 85:416f8bbbdf54 201