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/NyLPC_cHttpdConnection.h@79:baa21f8763cf, 2014-06-24 (annotated)

Committer:
nyatla
Date:
Tue Jun 24 09:37:24 2014 +0000
Revision:
79:baa21f8763cf
Parent:
48:00d211aac2ec
Child:
109:18f12ac01097
MiMic core r375???

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 /*
nyatla 2:b96c1e90d120 2 * NyLPC_cHttpdConnection.h
nyatla 2:b96c1e90d120 3 *
nyatla 2:b96c1e90d120 4 * Created on: 2013/02/07
nyatla 2:b96c1e90d120 5 * Author: nyatla
nyatla 2:b96c1e90d120 6 */
nyatla 2:b96c1e90d120 7
nyatla 2:b96c1e90d120 8 #ifndef NYLPC_CHTTPDCONNECTION_H_
nyatla 2:b96c1e90d120 9 #define NYLPC_CHTTPDCONNECTION_H_
nyatla 2:b96c1e90d120 10 #include "NyLPC_stdlib.h"
nyatla 2:b96c1e90d120 11 #include "NyLPC_cHttpRequestPrefixParser.h"
nyatla 12:efe841863fc8 12
nyatla 12:efe841863fc8 13 #ifdef __cplusplus
nyatla 12:efe841863fc8 14 extern "C" {
nyatla 12:efe841863fc8 15 #endif /* __cplusplus */
nyatla 12:efe841863fc8 16
nyatla 2:b96c1e90d120 17 #ifndef DEFINE_NyLPC_TcHttpd_t
nyatla 2:b96c1e90d120 18 typedef struct NyLPC_TcHttpd NyLPC_TcHttpd_t;
nyatla 2:b96c1e90d120 19 #define DEFINE_NyLPC_TcHttpd_t
nyatla 2:b96c1e90d120 20 #endif
nyatla 2:b96c1e90d120 21
nyatla 2:b96c1e90d120 22
nyatla 79:baa21f8763cf 23 /** HTTPコネクションの受信バッファのサイズ
nyatla 79:baa21f8763cf 24 */
nyatla 79:baa21f8763cf 25 #ifndef NyLPC_cHttpdConnection_SIZE_OF_RX_BUF
nyatla 79:baa21f8763cf 26 # define NyLPC_cHttpdConnection_SIZE_OF_RX_BUF 512
nyatla 79:baa21f8763cf 27 #endif
nyatla 2:b96c1e90d120 28
nyatla 2:b96c1e90d120 29 typedef NyLPC_TUInt8 NyLPC_TcHttpdConnection_Status;
nyatla 2:b96c1e90d120 30
nyatla 2:b96c1e90d120 31 /**　リクエストプレフィクスを読み出した状態*/
nyatla 2:b96c1e90d120 32 #define NyLPC_cHttpdConnection_ReqStatus_LISTEN 0
nyatla 2:b96c1e90d120 33 /** ACCEPT待ち*/
nyatla 2:b96c1e90d120 34 #define NyLPC_cHttpdConnection_ReqStatus_ACCEPT 1
nyatla 2:b96c1e90d120 35 /**　コネクションは接続済*/
nyatla 2:b96c1e90d120 36 #define NyLPC_cHttpdConnection_ReqStatus_PREFETCH 2
nyatla 2:b96c1e90d120 37 /**　リクエストパース待ち*/
nyatla 2:b96c1e90d120 38 #define NyLPC_cHttpdConnection_ReqStatus_REQPARSE 3
nyatla 2:b96c1e90d120 39 /**　リクエストパース済*/
nyatla 2:b96c1e90d120 40 #define NyLPC_cHttpdConnection_ReqStatus_END 4
nyatla 41:2389bd6b6f74 41 #define NyLPC_cHttpdConnection_ReqStatus_BODYPARSE 5
nyatla 2:b96c1e90d120 42
nyatla 2:b96c1e90d120 43
nyatla 2:b96c1e90d120 44
nyatla 2:b96c1e90d120 45
nyatla 2:b96c1e90d120 46 /**　レスポンスヘッダ送付済*/
nyatla 2:b96c1e90d120 47 #define NyLPC_cHttpdConnection_ResStatus_HEAD 1
nyatla 2:b96c1e90d120 48 /**　レスポンスヘッダ送付済*/
nyatla 2:b96c1e90d120 49 #define NyLPC_cHttpdConnection_ResStatus_BODY 2
nyatla 2:b96c1e90d120 50 /**　レスポンスBODY送付済*/
nyatla 2:b96c1e90d120 51 #define NyLPC_cHttpdConnection_ResStatus_CLOSED 3
nyatla 2:b96c1e90d120 52 /** エラーが発生した。*/
nyatla 2:b96c1e90d120 53 #define NyLPC_cHttpdConnection_ResStatus_ERROR 4
nyatla 2:b96c1e90d120 54
nyatla 2:b96c1e90d120 55
nyatla 2:b96c1e90d120 56
nyatla 2:b96c1e90d120 57 /**
nyatla 2:b96c1e90d120 58 * Httpdのハンドラが引き渡す、HTTPDコネクションクラス。
nyatla 2:b96c1e90d120 59 *
nyatla 2:b96c1e90d120 60 */
nyatla 2:b96c1e90d120 61 #ifndef DEFINE_NyLPC_TcHttpdConnection_t
nyatla 2:b96c1e90d120 62 typedef struct NyLPC_TcHttpdConnection NyLPC_TcHttpdConnection_t;
nyatla 2:b96c1e90d120 63 #define DEFINE_NyLPC_TcHttpdConnection_t
nyatla 2:b96c1e90d120 64 #endif
nyatla 2:b96c1e90d120 65 struct NyLPC_TcHttpdConnection
nyatla 2:b96c1e90d120 66 {
nyatla 2:b96c1e90d120 67 NyLPC_TUInt8 _req_status;//リクエストステータス
nyatla 2:b96c1e90d120 68 NyLPC_TUInt8 _res_status;//レスポンスステータス
nyatla 2:b96c1e90d120 69 NyLPC_TUInt8 _connection_message_mode;//COnnection:closeをヘッダに書き込むかのフラグ
nyatla 2:b96c1e90d120 70 NyLPC_TcHttpd_t* _parent_httpd; //NyLPC_cHttpd
nyatla 2:b96c1e90d120 71 NyLPC_TcTcpSocket_t _socket;
nyatla 79:baa21f8763cf 72 NyLPC_TUInt8 _rxbuf[NyLPC_cHttpdConnection_SIZE_OF_RX_BUF];
nyatla 2:b96c1e90d120 73 NyLPC_TcHttpStream_t _in_stream;
nyatla 2:b96c1e90d120 74 NyLPC_TcHttpRequestPrefixParser_t _pparser;
nyatla 2:b96c1e90d120 75 union{
nyatla 2:b96c1e90d120 76 NyLPC_TcHttpBodyWriter_t _body_writer;
nyatla 2:b96c1e90d120 77 NyLPC_TcHttpHeaderWriter_t _head_writer;
nyatla 2:b96c1e90d120 78 };
nyatla 2:b96c1e90d120 79 };
nyatla 2:b96c1e90d120 80
nyatla 2:b96c1e90d120 81 /**
nyatla 2:b96c1e90d120 82 * @param i_parent_httpd
nyatla 2:b96c1e90d120 83 *
nyatla 2:b96c1e90d120 84 */
nyatla 2:b96c1e90d120 85 void NyLPC_cHttpdConnection_initialize(NyLPC_TcHttpdConnection_t* i_inst,NyLPC_TcHttpd_t* i_parent_httpd);
nyatla 2:b96c1e90d120 86 void NyLPC_cHttpdConnection_finalize(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 87
nyatla 41:2389bd6b6f74 88 /**
nyatla 41:2389bd6b6f74 89 * 100 Continueをストリームに送信する。
nyatla 41:2389bd6b6f74 90 * HTTP/1.1でPOSTメッセージを受け付けた場合にコールすること。
nyatla 41:2389bd6b6f74 91 * この関数はステータスがNyLPC_cHttpdConnection_ResStatus_HEADの時だけ実行できる。
nyatla 41:2389bd6b6f74 92 */
nyatla 41:2389bd6b6f74 93 NyLPC_TBool NyLPC_cHttpdConnection_send100Continue(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 94
nyatla 2:b96c1e90d120 95
nyatla 2:b96c1e90d120 96 /**
nyatla 2:b96c1e90d120 97 * レスポンスヘッダを送信します。
nyatla 2:b96c1e90d120 98 * BodyはChunkedエンコーディングで送信します。
nyatla 48:00d211aac2ec 99 * @param i_additional_header
nyatla 48:00d211aac2ec 100 * メッセージフィールドに追加する文字列です。
nyatla 48:00d211aac2ec 101 * \r\nで終端下文字列を指定して下さい。
nyatla 2:b96c1e90d120 102 */
nyatla 2:b96c1e90d120 103 NyLPC_TBool NyLPC_cHttpdConnection_sendResponseHeader(NyLPC_TcHttpdConnection_t* i_inst,NyLPC_TUInt16 i_response_code,const NyLPC_TChar* i_content_type,const NyLPC_TChar* i_additional_header);
nyatla 2:b96c1e90d120 104 /**
nyatla 2:b96c1e90d120 105 * レスポンスヘッダを送信します。
nyatla 2:b96c1e90d120 106 * BodyはContentLengthを伴って送信します。Body送信時にサイズチェックは行いません。
nyatla 48:00d211aac2ec 107 * @param i_content_length
nyatla 2:b96c1e90d120 108 * 最大で0x0fffffffを指定できます。
nyatla 48:00d211aac2ec 109 * @param i_additional_header
nyatla 48:00d211aac2ec 110 * メッセージフィールドに追加する文字列です。
nyatla 48:00d211aac2ec 111 * \r\nで終端下文字列を指定して下さい。
nyatla 2:b96c1e90d120 112 */
nyatla 2:b96c1e90d120 113 NyLPC_TBool NyLPC_cHttpdConnection_sendResponseHeader2(NyLPC_TcHttpdConnection_t* i_inst,NyLPC_TUInt16 i_response_code,const NyLPC_TChar* i_content_type,NyLPC_TUInt32 i_content_length,const NyLPC_TChar* i_additional_header);
nyatla 2:b96c1e90d120 114 /**
nyatla 2:b96c1e90d120 115 * レスポンスBodyを送信します。
nyatla 2:b96c1e90d120 116 * 関数を実行後、_res_statusはBODYかERRORに遷移します。
nyatla 2:b96c1e90d120 117 */
nyatla 2:b96c1e90d120 118 NyLPC_TBool NyLPC_cHttpdConnection_sendResponseBody(NyLPC_TcHttpdConnection_t* i_inst,const void* i_data,NyLPC_TUInt32 i_size);
nyatla 2:b96c1e90d120 119
nyatla 2:b96c1e90d120 120 /**
nyatla 2:b96c1e90d120 121 * レスポンスBodyを書式出力して送信します。
nyatla 2:b96c1e90d120 122 * 関数を実行後、_res_statusはBODYかERRORに遷移します。
nyatla 2:b96c1e90d120 123 */
nyatla 2:b96c1e90d120 124 NyLPC_TBool NyLPC_cHttpdConnection_sendResponseBodyF(NyLPC_TcHttpdConnection_t* i_inst,const char* i_fmt,...);
nyatla 2:b96c1e90d120 125
nyatla 12:efe841863fc8 126
nyatla 7:2b33a8d84eb3 127 /**
nyatla 7:2b33a8d84eb3 128 * Httpd全体で唯一のロックを取得する。
nyatla 7:2b33a8d84eb3 129 */
nyatla 7:2b33a8d84eb3 130 void NyLPC_cHttpdConnection_lock(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 7:2b33a8d84eb3 131
nyatla 7:2b33a8d84eb3 132 /**
nyatla 7:2b33a8d84eb3 133 * Httpd全体で唯一のロックを開放する。
nyatla 7:2b33a8d84eb3 134 */
nyatla 7:2b33a8d84eb3 135 void NyLPC_cHttpdConnection_unlock(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 136
nyatla 2:b96c1e90d120 137
nyatla 2:b96c1e90d120 138 /**
nyatla 2:b96c1e90d120 139 * コネクションのStreamを返します。
nyatla 2:b96c1e90d120 140 */
nyatla 48:00d211aac2ec 141 #define NyLPC_cHttpdConnection_refStream(i_inst) (&(i_inst->_in_stream.super))
nyatla 2:b96c1e90d120 142
nyatla 19:33b9ba0859ee 143 #define NyLPC_cHttpdConnection_getMethod(i_inst) ((i_inst)->_pparser.method)
nyatla 19:33b9ba0859ee 144 #define NyLPC_cHttpdConnection_getReqStatus(i_inst) ((i_inst)->_req_status)
nyatla 2:b96c1e90d120 145
nyatla 12:efe841863fc8 146 #ifdef __cplusplus
nyatla 12:efe841863fc8 147 }
nyatla 12:efe841863fc8 148 #endif /* __cplusplus */
nyatla 2:b96c1e90d120 149
nyatla 2:b96c1e90d120 150 #endif /* NYLPC_CHTTPDCONNECTION_H_ */