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/RpcI2CSlave.cpp@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 85:416f8bbbdf54 1 #include "RpcHandlerBase.h"
nyatla 85:416f8bbbdf54 2 namespace MiMic
nyatla 85:416f8bbbdf54 3 {
nyatla 85:416f8bbbdf54 4 class I2CSlaveHandler :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 //u
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<I2CSlave>(new I2CSlave(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 frequency(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 18 {
nyatla 85:416f8bbbdf54 19 //d return d
nyatla 85:416f8bbbdf54 20 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 21 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 22 if(inst!=NULL){
nyatla 85:416f8bbbdf54 23 int v;
nyatla 85:416f8bbbdf54 24 if(getParamInt(mod,i_rpc,v,1)){
nyatla 85:416f8bbbdf54 25 inst->frequency(v);
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 receive(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 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 36 if(inst!=NULL){
nyatla 85:416f8bbbdf54 37 mod->putResult(i_rpc->method.id,"%d",inst->receive());
nyatla 85:416f8bbbdf54 38 }
nyatla 85:416f8bbbdf54 39 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 40 }
nyatla 85:416f8bbbdf54 41 static NyLPC_TBool read1(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 42 {
nyatla 85:416f8bbbdf54 43 //db return dB
nyatla 85:416f8bbbdf54 44 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 45 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 46 if(inst!=NULL){
nyatla 85:416f8bbbdf54 47 unsigned char len;
nyatla 85:416f8bbbdf54 48 if(getParamByte(mod,i_rpc,len,1)){
nyatla 85:416f8bbbdf54 49 char* data=new char[len];
nyatla 85:416f8bbbdf54 50 int r=inst->read(data,len);
nyatla 85:416f8bbbdf54 51 mod->putResult(i_rpc->method.id,"%d,\"%.*B\"",r,(int)len,data);
nyatla 85:416f8bbbdf54 52 delete[] data;
nyatla 85:416f8bbbdf54 53 }
nyatla 85:416f8bbbdf54 54 }
nyatla 85:416f8bbbdf54 55 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 56 }
nyatla 85:416f8bbbdf54 57 static NyLPC_TBool read2(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 58 {
nyatla 85:416f8bbbdf54 59 //dd return d
nyatla 85:416f8bbbdf54 60 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 61 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 62 if(inst!=NULL){
nyatla 85:416f8bbbdf54 63 mod->putResult(i_rpc->method.id,"%d",inst->read());
nyatla 85:416f8bbbdf54 64 }
nyatla 85:416f8bbbdf54 65 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 66 }
nyatla 85:416f8bbbdf54 67 static NyLPC_TBool write1(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 68 {
nyatla 85:416f8bbbdf54 69 //ddBd return d
nyatla 85:416f8bbbdf54 70 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 71 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 72 if(inst!=NULL){
nyatla 85:416f8bbbdf54 73 const unsigned char* data;
nyatla 85:416f8bbbdf54 74 unsigned char len;
nyatla 85:416f8bbbdf54 75 if(getParamByteArray(mod,i_rpc,data,len,1)){
nyatla 85:416f8bbbdf54 76 mod->putResult(i_rpc->method.id,"%d",inst->write((const char*)data,len));
nyatla 85:416f8bbbdf54 77 }
nyatla 85:416f8bbbdf54 78 }
nyatla 85:416f8bbbdf54 79 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 80 }
nyatla 85:416f8bbbdf54 81 static NyLPC_TBool write2(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 82 {
nyatla 85:416f8bbbdf54 83 //dd return d
nyatla 85:416f8bbbdf54 84 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 85 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 86 if(inst!=NULL){
nyatla 85:416f8bbbdf54 87 int data;
nyatla 85:416f8bbbdf54 88 if(getParamInt(mod,i_rpc,data,1)){
nyatla 85:416f8bbbdf54 89 mod->putResult(i_rpc->method.id,"%d",inst->write(data));
nyatla 85:416f8bbbdf54 90 }
nyatla 85:416f8bbbdf54 91 }
nyatla 85:416f8bbbdf54 92 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 93 }
nyatla 85:416f8bbbdf54 94 static NyLPC_TBool address(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 95 {
nyatla 85:416f8bbbdf54 96 //dd return d
nyatla 85:416f8bbbdf54 97 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 98 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 99 if(inst!=NULL){
nyatla 85:416f8bbbdf54 100 int addr;
nyatla 85:416f8bbbdf54 101 if(getParamInt(mod,i_rpc,addr,1)){
nyatla 85:416f8bbbdf54 102 inst->address(addr);
nyatla 85:416f8bbbdf54 103 mod->putResult(i_rpc->method.id);
nyatla 85:416f8bbbdf54 104 }
nyatla 85:416f8bbbdf54 105 }
nyatla 85:416f8bbbdf54 106 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 107 }
nyatla 85:416f8bbbdf54 108 static NyLPC_TBool stop(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 85:416f8bbbdf54 109 {
nyatla 85:416f8bbbdf54 110 //d return d
nyatla 85:416f8bbbdf54 111 ModJsonRpc* mod=((ModJsonRpc::TcJsonRpcEx_t*)i_param)->cppmod_ptr;
nyatla 85:416f8bbbdf54 112 I2CSlave* inst=(I2CSlave*)getObjectBatch(mod,i_rpc);
nyatla 85:416f8bbbdf54 113 if(inst!=NULL){
nyatla 85:416f8bbbdf54 114 inst->stop();
nyatla 85:416f8bbbdf54 115 mod->putResult(i_rpc->method.id);
nyatla 85:416f8bbbdf54 116 }
nyatla 85:416f8bbbdf54 117 return NyLPC_TBool_TRUE;
nyatla 85:416f8bbbdf54 118 }
nyatla 85:416f8bbbdf54 119 };
nyatla 85:416f8bbbdf54 120
nyatla 85:416f8bbbdf54 121
nyatla 85:416f8bbbdf54 122 const static struct NyLPC_TJsonRpcMethodDef func_table[]=
nyatla 85:416f8bbbdf54 123 {
nyatla 85:416f8bbbdf54 124 { "_new1" ,"uu" ,I2CSlaveHandler::new1},
nyatla 85:416f8bbbdf54 125 { "frequency" ,"dd" ,I2CSlaveHandler::frequency},
nyatla 85:416f8bbbdf54 126 { "receive" ,"d" ,I2CSlaveHandler::receive},
nyatla 85:416f8bbbdf54 127 { "read1" ,"db" ,I2CSlaveHandler::read1},
nyatla 85:416f8bbbdf54 128 { "read2" ,"d" ,I2CSlaveHandler::read2},
nyatla 85:416f8bbbdf54 129 { "write1" ,"dB" ,I2CSlaveHandler::write1},
nyatla 85:416f8bbbdf54 130 { "write2" ,"dd" ,I2CSlaveHandler::write2},
nyatla 85:416f8bbbdf54 131 { "address" ,"dd" ,I2CSlaveHandler::address},
nyatla 85:416f8bbbdf54 132 { "stop" ,"d" ,I2CSlaveHandler::stop},
nyatla 85:416f8bbbdf54 133 { NULL ,NULL ,NULL}
nyatla 85:416f8bbbdf54 134 };
nyatla 85:416f8bbbdf54 135
nyatla 85:416f8bbbdf54 136 const struct NyLPC_TJsonRpcClassDef MbedJsApi::RPC_MBED_I2C_SLAVE={
nyatla 85:416f8bbbdf54 137 "mbedJS","I2CSlave",func_table
nyatla 85:416f8bbbdf54 138 };
nyatla 85:416f8bbbdf54 139 }
nyatla 85:416f8bbbdf54 140