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/RpcDigitalOut.cpp@76:b375b3d750d8, 2014-06-14 (annotated)

Committer:
nyatla
Date:
Sat Jun 14 17:42:11 2014 +0000
Revision:
76:b375b3d750d8
Parent:
75:2a18df0ef111
Child:
77:8651d3c19a55
MiMic core r361???; JsonRPC????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 72:c118a7aa37a3 1 #include "mod/ModJsonRpc.h"
nyatla 75:2a18df0ef111 2 #include "MbedJsApi.h"
nyatla 72:c118a7aa37a3 3 #include "mbed.h"
nyatla 72:c118a7aa37a3 4 namespace MiMic
nyatla 72:c118a7aa37a3 5 {
nyatla 76:b375b3d750d8 6
nyatla 76:b375b3d750d8 7
nyatla 72:c118a7aa37a3 8 class RpcHandlerBase
nyatla 72:c118a7aa37a3 9 {
nyatla 72:c118a7aa37a3 10 public:
nyatla 76:b375b3d750d8 11 static void addNewObjectBatch(ModJsonRpc& i_mod,unsigned int i_id,ModJsonRpc::BasicRpcObject* i_new_object)
nyatla 72:c118a7aa37a3 12 {
nyatla 72:c118a7aa37a3 13 int i=i_mod.addObject(i_new_object);
nyatla 72:c118a7aa37a3 14 if(i<0){
nyatla 72:c118a7aa37a3 15 delete i_new_object;
nyatla 72:c118a7aa37a3 16 i_mod.putError(i_id,ModJsonRpc::INVALID_PARAMS);
nyatla 72:c118a7aa37a3 17 return;
nyatla 72:c118a7aa37a3 18 }
nyatla 72:c118a7aa37a3 19 i_mod.putResult(i_id,"%d",i);
nyatla 72:c118a7aa37a3 20 return;
nyatla 72:c118a7aa37a3 21 }
nyatla 72:c118a7aa37a3 22 static void* getObjectBatch(ModJsonRpc& i_mod,unsigned int i_id,int i_iid)
nyatla 72:c118a7aa37a3 23 {
nyatla 72:c118a7aa37a3 24 void* ret=i_mod.getObject(i_iid);
nyatla 72:c118a7aa37a3 25 if(ret==NULL){
nyatla 72:c118a7aa37a3 26 i_mod.putError(i_id,ModJsonRpc::INTERNAL_ERROR);
nyatla 72:c118a7aa37a3 27 }
nyatla 72:c118a7aa37a3 28 return ret;
nyatla 72:c118a7aa37a3 29 }
nyatla 72:c118a7aa37a3 30 };
nyatla 72:c118a7aa37a3 31
nyatla 72:c118a7aa37a3 32 class DigitalOutHandler :RpcHandlerBase
nyatla 72:c118a7aa37a3 33 {
nyatla 72:c118a7aa37a3 34 public:
nyatla 72:c118a7aa37a3 35 static NyLPC_TBool new1(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 72:c118a7aa37a3 36 {
nyatla 72:c118a7aa37a3 37 ModJsonRpc* mod=(ModJsonRpc*)i_param;
nyatla 72:c118a7aa37a3 38 NyLPC_TUInt32 pin;
nyatla 72:c118a7aa37a3 39 if(!NyLPC_TJsonRpcParserResult_getUInt32(i_rpc,0,&pin)){
nyatla 72:c118a7aa37a3 40 mod->putError(i_rpc->method.id,ModJsonRpc::INVALID_PARAMS);
nyatla 72:c118a7aa37a3 41 }else{
nyatla 76:b375b3d750d8 42 addNewObjectBatch(*mod,i_rpc->method.id,new ModJsonRpc::RpcObject<DigitalOut>(new DigitalOut(MbedJsApi::pinId2PinName(pin))));
nyatla 72:c118a7aa37a3 43 }
nyatla 72:c118a7aa37a3 44 return NyLPC_TBool_TRUE;
nyatla 72:c118a7aa37a3 45 }
nyatla 72:c118a7aa37a3 46 static NyLPC_TBool new2(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 72:c118a7aa37a3 47 {
nyatla 72:c118a7aa37a3 48 ModJsonRpc* mod=(ModJsonRpc*)i_param;
nyatla 72:c118a7aa37a3 49 NyLPC_TUInt32 pin;
nyatla 72:c118a7aa37a3 50 NyLPC_TInt32 value;
nyatla 72:c118a7aa37a3 51 //pin number
nyatla 72:c118a7aa37a3 52 if( (!NyLPC_TJsonRpcParserResult_getUInt32(i_rpc,0,&pin)) ||
nyatla 72:c118a7aa37a3 53 (!NyLPC_TJsonRpcParserResult_getInt32(i_rpc,1,&value)))
nyatla 72:c118a7aa37a3 54 {
nyatla 72:c118a7aa37a3 55 mod->putError(i_rpc->method.id,ModJsonRpc::INVALID_PARAMS);
nyatla 72:c118a7aa37a3 56 }else{
nyatla 76:b375b3d750d8 57 addNewObjectBatch(*mod,i_rpc->method.id,new ModJsonRpc::RpcObject<DigitalOut>(new DigitalOut(MbedJsApi::pinId2PinName(pin),value)));
nyatla 72:c118a7aa37a3 58 }
nyatla 72:c118a7aa37a3 59 return NyLPC_TBool_TRUE;
nyatla 72:c118a7aa37a3 60 }
nyatla 72:c118a7aa37a3 61 static NyLPC_TBool write(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 72:c118a7aa37a3 62 {
nyatla 72:c118a7aa37a3 63 ModJsonRpc* mod=(ModJsonRpc*)i_param;
nyatla 72:c118a7aa37a3 64 NyLPC_TInt32 iid,value;
nyatla 72:c118a7aa37a3 65 if( (!NyLPC_TJsonRpcParserResult_getInt32(i_rpc,0,&iid)) ||
nyatla 72:c118a7aa37a3 66 (!NyLPC_TJsonRpcParserResult_getInt32(i_rpc,1,&value)))
nyatla 72:c118a7aa37a3 67 {
nyatla 72:c118a7aa37a3 68 mod->putError(i_rpc->method.id,ModJsonRpc::INVALID_PARAMS);
nyatla 72:c118a7aa37a3 69 }else{
nyatla 72:c118a7aa37a3 70 DigitalOut* inst=(DigitalOut*)getObjectBatch(*mod,i_rpc->method.id,iid);
nyatla 72:c118a7aa37a3 71 if(inst!=NULL){
nyatla 72:c118a7aa37a3 72 inst->write(value);
nyatla 72:c118a7aa37a3 73 mod->putResult(i_rpc->method.id,"");
nyatla 72:c118a7aa37a3 74 }
nyatla 72:c118a7aa37a3 75 }
nyatla 72:c118a7aa37a3 76 return NyLPC_TBool_TRUE;
nyatla 72:c118a7aa37a3 77 }
nyatla 72:c118a7aa37a3 78 static NyLPC_TBool read(const union NyLPC_TJsonRpcParserResult* i_rpc,void* i_param)
nyatla 72:c118a7aa37a3 79 {
nyatla 72:c118a7aa37a3 80 ModJsonRpc* mod=(ModJsonRpc*)i_param;
nyatla 72:c118a7aa37a3 81 NyLPC_TInt32 iid;
nyatla 72:c118a7aa37a3 82 if( (!NyLPC_TJsonRpcParserResult_getInt32(i_rpc,0,&iid)))
nyatla 72:c118a7aa37a3 83 {
nyatla 72:c118a7aa37a3 84 mod->putError(i_rpc->method.id,ModJsonRpc::INVALID_PARAMS);
nyatla 72:c118a7aa37a3 85 }else{
nyatla 72:c118a7aa37a3 86 DigitalOut* inst=(DigitalOut*)getObjectBatch(*mod,i_rpc->method.id,iid);
nyatla 72:c118a7aa37a3 87 if(inst!=NULL){
nyatla 72:c118a7aa37a3 88 int v=inst->read();
nyatla 72:c118a7aa37a3 89 mod->putResult(i_rpc->method.id,"%d",v);
nyatla 72:c118a7aa37a3 90 }
nyatla 72:c118a7aa37a3 91 }
nyatla 72:c118a7aa37a3 92 return NyLPC_TBool_TRUE;
nyatla 72:c118a7aa37a3 93 }
nyatla 72:c118a7aa37a3 94 };
nyatla 72:c118a7aa37a3 95
nyatla 72:c118a7aa37a3 96
nyatla 72:c118a7aa37a3 97
nyatla 75:2a18df0ef111 98 const static struct NyLPC_TJsonRpcMethodDef func_table[]=
nyatla 75:2a18df0ef111 99 {
nyatla 75:2a18df0ef111 100 { "_new1" ,"u" ,DigitalOutHandler::new1},
nyatla 75:2a18df0ef111 101 { "_new2" ,"ud" ,DigitalOutHandler::new2},
nyatla 75:2a18df0ef111 102 { "write" ,"dd" ,DigitalOutHandler::write},
nyatla 75:2a18df0ef111 103 { "read" ,"d" ,DigitalOutHandler::read},
nyatla 75:2a18df0ef111 104 { NULL ,NULL ,NULL}
nyatla 75:2a18df0ef111 105 };
nyatla 75:2a18df0ef111 106
nyatla 75:2a18df0ef111 107 const struct NyLPC_TJsonRpcClassDef MbedJsApi::RPC_MBED_DIGITAL_OUT={
nyatla 75:2a18df0ef111 108 "mbedJS","DigitalOut",func_table
nyatla 75:2a18df0ef111 109 };
nyatla 72:c118a7aa37a3 110
nyatla 72:c118a7aa37a3 111
nyatla 72:c118a7aa37a3 112
nyatla 72:c118a7aa37a3 113 }