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.h@71:855020258513, 2014-06-10 (annotated)

Committer:
nyatla
Date:
Tue Jun 10 03:30:41 2014 +0000
Revision:
71:855020258513
Child:
72:c118a7aa37a3
MiMic-core ?358???; modJsonRPC???????????;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 71:855020258513 1 /*********************************************************************************
nyatla 71:855020258513 2 * PROJECT: MiMic
nyatla 71:855020258513 3 * --------------------------------------------------------------------------------
nyatla 71:855020258513 4 *
nyatla 71:855020258513 5 * This file is part of MiMic
nyatla 71:855020258513 6 * Copyright (C)2011 Ryo Iizuka
nyatla 71:855020258513 7 *
nyatla 71:855020258513 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 71:855020258513 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 71:855020258513 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 71:855020258513 11 * (at your option) any later version.
nyatla 71:855020258513 12 *
nyatla 71:855020258513 13 * This program is distributed in the hope that it will be useful,
nyatla 71:855020258513 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 71:855020258513 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 71:855020258513 16 * GNU General Public License for more details.
nyatla 71:855020258513 17 *
nyatla 71:855020258513 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 71:855020258513 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 71:855020258513 20 *
nyatla 71:855020258513 21 * For further information please contact.
nyatla 71:855020258513 22 * http://nyatla.jp/
nyatla 71:855020258513 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 71:855020258513 24 *
nyatla 71:855020258513 25 *********************************************************************************/
nyatla 71:855020258513 26 #ifndef NYLPC_CMODJSONRPC_H_
nyatla 71:855020258513 27 #define NYLPC_CMODJSONRPC_H_
nyatla 71:855020258513 28 #include "NyLPC_http.h"
nyatla 71:855020258513 29 #include "../NyLPC_cHttpdConnection.h"
nyatla 71:855020258513 30 #include "NyLPC_cModWebSocket.h"
nyatla 71:855020258513 31 #ifdef __cplusplus
nyatla 71:855020258513 32 extern "C" {
nyatla 71:855020258513 33 #endif /* __cplusplus */
nyatla 71:855020258513 34
nyatla 71:855020258513 35 /**
nyatla 71:855020258513 36 * WebSocketストリームからJSONRPC電文を取り込むモジュールです。
nyatla 71:855020258513 37 */
nyatla 71:855020258513 38 typedef struct NyLPC_TcModJsonRpc NyLPC_TcModJsonRpc_t;
nyatla 71:855020258513 39
nyatla 71:855020258513 40
nyatla 71:855020258513 41 /**
nyatla 71:855020258513 42 * クラス構造体
nyatla 71:855020258513 43 */
nyatla 71:855020258513 44 struct NyLPC_TcModJsonRpc
nyatla 71:855020258513 45 {
nyatla 71:855020258513 46 NyLPC_TcModWebSocket_t super;
nyatla 71:855020258513 47 NyLPC_TcJsonRpcParser_t _rpc_parser;
nyatla 71:855020258513 48 union NyLPC_TJsonRpcParserResult _result;
nyatla 71:855020258513 49 };
nyatla 71:855020258513 50
nyatla 71:855020258513 51
nyatla 71:855020258513 52 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 53 void NyLPC_cModJsonRpc_finalize(NyLPC_TcModJsonRpc_t* i_inst);
nyatla 71:855020258513 54 #define NyLPC_cModJsonRpc_canHandle(i,c) NyLPC_cModWebSocket_canHandle(&((i)->super),(c))
nyatla 71:855020258513 55 #define NyLPC_cModJsonRpc_close(i,t) NyLPC_cModWebSocket_close(&((i)->super),(t))
nyatla 71:855020258513 56
nyatla 71:855020258513 57
nyatla 71:855020258513 58 NyLPC_TBool NyLPC_cModJsonRpc_execute(NyLPC_TcModJsonRpc_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
nyatla 71:855020258513 59
nyatla 71:855020258513 60 /**
nyatla 71:855020258513 61 * Execute実行後に繰り返し実行できます。
nyatla 71:855020258513 62 * trueを返却した場合は、NyLPC_cModJsonRpc_getRpcCall関数で結果を取得できるか調べてください。
nyatla 71:855020258513 63 * @return
nyatla 71:855020258513 64 * JSONRPCの処理を継続して行えるかを返します。
nyatla 71:855020258513 65 * falseの場合、JSONRPCの構文解析は失敗し、Websocketは閉じられます。Websocketの受信ループを終了してください。
nyatla 71:855020258513 66 */
nyatla 71:855020258513 67 NyLPC_TBool NyLPC_cModJsonRpc_processRpcMessage(NyLPC_TcModJsonRpc_t* i_inst);
nyatla 71:855020258513 68
nyatla 71:855020258513 69 /**
nyatla 71:855020258513 70 * JSONRPCの構文解析結果を返します。
nyatla 71:855020258513 71 * @return
nyatla 71:855020258513 72 * JSONRPC電文が確定した場合、結果を格納した構造体を返します。構造体の有効期限は、次回にNyLPC_cModJsonRpc_processRpcMessageを実行するまでです。
nyatla 71:855020258513 73 * NULLを返した場合は、引き続きNyLPC_cModJsonRpc_processRpcMessageを実行する必要があります。
nyatla 71:855020258513 74 */
nyatla 71:855020258513 75 const union NyLPC_TJsonRpcParserResult* NyLPC_cModJsonRpc_getMessage(NyLPC_TcModJsonRpc_t* i_inst);
nyatla 71:855020258513 76
nyatla 71:855020258513 77 NyLPC_TBool NyLPC_cModJsonRpc_putResult(NyLPC_TcModJsonRpc_t* i_inst,NyLPC_TUInt32 i_id,NyLPC_TInt32 i_result,const NyLPC_TChar* i_params_fmt,...);
nyatla 71:855020258513 78
nyatla 71:855020258513 79 #ifdef __cplusplus
nyatla 71:855020258513 80 }
nyatla 71:855020258513 81 #endif /* __cplusplus */
nyatla 71:855020258513 82
nyatla 71:855020258513 83 #endif /* NYLPC_CMODJSONRPC_H_ */
nyatla 71:855020258513 84