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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

チュートリアル

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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Tutorial

Committer:
nyatla
Date:
Mon Mar 25 05:23:49 2013 +0000
Revision:
1:9f6a78395432
Child:
2:b96c1e90d120
MiMic repository r191???

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 1:9f6a78395432 1 /*********************************************************************************
nyatla 1:9f6a78395432 2 * PROJECT: MiMic
nyatla 1:9f6a78395432 3 * --------------------------------------------------------------------------------
nyatla 1:9f6a78395432 4 *
nyatla 1:9f6a78395432 5 * This file is part of MiMic
nyatla 1:9f6a78395432 6 * Copyright (C)2011 Ryo Iizuka
nyatla 1:9f6a78395432 7 *
nyatla 1:9f6a78395432 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 1:9f6a78395432 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 1:9f6a78395432 10 * by the Free Software Foundation, either version 3 of the License, or
nyatla 1:9f6a78395432 11 * (at your option) any later version.
nyatla 1:9f6a78395432 12 *
nyatla 1:9f6a78395432 13 * This program is distributed in the hope that it will be useful,
nyatla 1:9f6a78395432 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 1:9f6a78395432 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 1:9f6a78395432 16 * GNU General Public License for more details.
nyatla 1:9f6a78395432 17 *
nyatla 1:9f6a78395432 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 1:9f6a78395432 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 1:9f6a78395432 20 *
nyatla 1:9f6a78395432 21 * For further information please contact.
nyatla 1:9f6a78395432 22 * http://nyatla.jp/
nyatla 1:9f6a78395432 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 1:9f6a78395432 24 *
nyatla 1:9f6a78395432 25 *********************************************************************************/
nyatla 1:9f6a78395432 26
nyatla 1:9f6a78395432 27 #ifndef NyLPC_TcHttpBasicHeader_H
nyatla 1:9f6a78395432 28 #define NyLPC_TcHttpBasicHeader_H
nyatla 1:9f6a78395432 29 #include "NyLPC_stdlib.h"
nyatla 1:9f6a78395432 30 #include "NyLPC_cHttpStream.h"
nyatla 1:9f6a78395432 31
nyatla 1:9f6a78395432 32 #ifdef __cplusplus
nyatla 1:9f6a78395432 33 extern "C" {
nyatla 1:9f6a78395432 34 #endif /* __cplusplus */
nyatla 1:9f6a78395432 35 /**
nyatla 1:9f6a78395432 36 * このクラスは、Httpヘッダのパーサを定義します。
nyatla 1:9f6a78395432 37 */
nyatla 1:9f6a78395432 38 typedef struct NyLPC_TcHttpBasicHeaderParser NyLPC_TcHttpBasicHeaderParser_t;
nyatla 1:9f6a78395432 39
nyatla 1:9f6a78395432 40
nyatla 1:9f6a78395432 41 /**
nyatla 1:9f6a78395432 42 * HTTPメソッドの定義値。
nyatla 1:9f6a78395432 43 */
nyatla 1:9f6a78395432 44 typedef NyLPC_TUInt8 NyLPC_THttpMethodType;
nyatla 1:9f6a78395432 45 #define NyLPC_THttpMethodType_GET ((NyLPC_THttpMethodType)0x01)
nyatla 1:9f6a78395432 46 #define NyLPC_THttpMethodType_POST ((NyLPC_THttpMethodType)0x02)
nyatla 1:9f6a78395432 47 #define NyLPC_THttpMethodType_HEAD ((NyLPC_THttpMethodType)0x03)
nyatla 1:9f6a78395432 48
nyatla 1:9f6a78395432 49 /**
nyatla 1:9f6a78395432 50 * HTTPバージョンの定義値
nyatla 1:9f6a78395432 51 */
nyatla 1:9f6a78395432 52 typedef NyLPC_TUInt8 NyLPC_THttpVersion;
nyatla 1:9f6a78395432 53 #define NyLPC_THttpVersion_09 ((NyLPC_THttpVersion)0x01)
nyatla 1:9f6a78395432 54 #define NyLPC_THttpVersion_10 ((NyLPC_THttpVersion)0x02)
nyatla 1:9f6a78395432 55 #define NyLPC_THttpVersion_11 ((NyLPC_THttpVersion)0x03)
nyatla 1:9f6a78395432 56 #define NyLPC_THttpVersion_UNKNOWN ((NyLPC_THttpVersion)0x04)
nyatla 1:9f6a78395432 57
nyatla 1:9f6a78395432 58
nyatla 1:9f6a78395432 59 typedef NyLPC_TUInt8 NyLPC_THttpHeaderType;
nyatla 1:9f6a78395432 60 #define NyLPC_THttpHeaderType_REQUEST ((NyLPC_THttpHeaderType)0x01)
nyatla 1:9f6a78395432 61 #define NyLPC_THttpHeaderType_RESPONSE ((NyLPC_THttpHeaderType)0x02)
nyatla 1:9f6a78395432 62
nyatla 1:9f6a78395432 63
nyatla 1:9f6a78395432 64 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_Connection;
nyatla 1:9f6a78395432 65 #define NyLPC_THttpMessgeHeader_Connection_NONE ((NyLPC_THttpMessgeHeader_Connection)0x01)
nyatla 1:9f6a78395432 66 #define NyLPC_THttpMessgeHeader_Connection_CLOSE ((NyLPC_THttpMessgeHeader_Connection)0x02)
nyatla 1:9f6a78395432 67 #define NyLPC_THttpMessgeHeader_Connection_KEEPALIVE ((NyLPC_THttpMessgeHeader_Connection)0x03)
nyatla 1:9f6a78395432 68 #define NyLPC_THttpMessgeHeader_Connection_UNKNOWN ((NyLPC_THttpMessgeHeader_Connection)0x10)
nyatla 1:9f6a78395432 69
nyatla 1:9f6a78395432 70 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_TransferEncoding;
nyatla 1:9f6a78395432 71 #define NyLPC_THttpMessgeHeader_TransferEncoding_NONE ((NyLPC_THttpMessgeHeader_TransferEncoding)0x01) //TEはない
nyatla 1:9f6a78395432 72 #define NyLPC_THttpMessgeHeader_TransferEncoding_CHUNKED ((NyLPC_THttpMessgeHeader_TransferEncoding)0x02)
nyatla 1:9f6a78395432 73 #define NyLPC_THttpMessgeHeader_TransferEncoding_UNKNOWN ((NyLPC_THttpMessgeHeader_TransferEncoding)0x10)
nyatla 1:9f6a78395432 74
nyatla 1:9f6a78395432 75 #define NyLPC_THttpContentLength_INVALID_LENGTH 0xFFFFFFFF
nyatla 1:9f6a78395432 76
nyatla 1:9f6a78395432 77
nyatla 1:9f6a78395432 78
nyatla 1:9f6a78395432 79
nyatla 1:9f6a78395432 80
nyatla 1:9f6a78395432 81 /**
nyatla 1:9f6a78395432 82 * この構造体は、NyLPC_cHttpBasicHeaderParserの結果を格納します。
nyatla 1:9f6a78395432 83 */
nyatla 1:9f6a78395432 84 struct NyLPC_THttpBasicHeader
nyatla 1:9f6a78395432 85 {
nyatla 1:9f6a78395432 86 NyLPC_THttpHeaderType type;
nyatla 1:9f6a78395432 87 union{
nyatla 1:9f6a78395432 88 struct{
nyatla 1:9f6a78395432 89 NyLPC_THttpVersion version;
nyatla 1:9f6a78395432 90 NyLPC_THttpMethodType method;
nyatla 1:9f6a78395432 91 }req;
nyatla 1:9f6a78395432 92 struct{
nyatla 1:9f6a78395432 93 NyLPC_THttpVersion version;
nyatla 1:9f6a78395432 94 NyLPC_TUInt32 status;
nyatla 1:9f6a78395432 95 }res;
nyatla 1:9f6a78395432 96 }startline;
nyatla 1:9f6a78395432 97 NyLPC_THttpMessgeHeader_TransferEncoding transfer_encoding;
nyatla 1:9f6a78395432 98 NyLPC_TUInt32 content_length;
nyatla 1:9f6a78395432 99 NyLPC_THttpMessgeHeader_Connection connection;
nyatla 1:9f6a78395432 100 };
nyatla 1:9f6a78395432 101
nyatla 1:9f6a78395432 102 /**
nyatla 1:9f6a78395432 103 * このヘッダが持続性接続を求めているか判定します。
nyatla 1:9f6a78395432 104 */
nyatla 1:9f6a78395432 105 NyLPC_TBool NyLPC_THttpBasicHeader_isPersistent(const struct NyLPC_THttpBasicHeader* i_struct);
nyatla 1:9f6a78395432 106
nyatla 1:9f6a78395432 107
nyatla 1:9f6a78395432 108
nyatla 1:9f6a78395432 109
nyatla 1:9f6a78395432 110
nyatla 1:9f6a78395432 111
nyatla 1:9f6a78395432 112 /**
nyatla 1:9f6a78395432 113 * コンフィギュレーション値。
nyatla 1:9f6a78395432 114 * ショートパラメータ解析バッファのサイズ
nyatla 1:9f6a78395432 115 */
nyatla 1:9f6a78395432 116 #define NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS 32
nyatla 1:9f6a78395432 117
nyatla 1:9f6a78395432 118
nyatla 1:9f6a78395432 119
nyatla 1:9f6a78395432 120 #define NyLPC_TcHttpBasicHeaderParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicHeaderParser_ST_ERROR)
nyatla 1:9f6a78395432 121
nyatla 1:9f6a78395432 122 /**
nyatla 1:9f6a78395432 123 * 独自のメッセージフィールドを受け取るイベントハンドラです。
nyatla 1:9f6a78395432 124 * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから3種類のメッセージを受け取ります。
nyatla 1:9f6a78395432 125 * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。
nyatla 1:9f6a78395432 126 * <ol>
nyatla 1:9f6a78395432 127 * <li>開始メッセージ - i_nameに有効な文字列を指定して、そのフィールド値が入力される事を伝えます。i_cはnullです。
nyatla 1:9f6a78395432 128 * <li>フィールドメッセージ - i_nameにNULL,i_cに\0以外の文字を指定して、フィールド値が入力されている事を指示します。
nyatla 1:9f6a78395432 129 * <li>フィールドエンド - i_nameにNULL,i_cに0を指定して、フィールドが完了した事を指示します。
nyatla 1:9f6a78395432 130 * </ol>
nyatla 1:9f6a78395432 131 */
nyatla 1:9f6a78395432 132 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_messageHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_name,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);
nyatla 1:9f6a78395432 133 /**
nyatla 1:9f6a78395432 134 * リクエストのURL文字列を受け取るイベントハンドラです。
nyatla 1:9f6a78395432 135 * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから3種類のメッセージを受け取ります。
nyatla 1:9f6a78395432 136 * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。
nyatla 1:9f6a78395432 137 * <ol>
nyatla 1:9f6a78395432 138 * <li>URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。
nyatla 1:9f6a78395432 139 * <li>URLエンド - i_cに0を指定して、URLが完了した事を指示します。
nyatla 1:9f6a78395432 140 * </ol>
nyatla 1:9f6a78395432 141 */
nyatla 1:9f6a78395432 142 /**
nyatla 1:9f6a78395432 143 メッセージハンドラはNyLPC_cHttpBasicHeaderParserから3種類のメッセージを受け取ります。
nyatla 1:9f6a78395432 144 1.URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。
nyatla 1:9f6a78395432 145 2.URLエンド - i_cに0を指定して、URLが完了した事を指示します。
nyatla 1:9f6a78395432 146 */
nyatla 1:9f6a78395432 147 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_urlHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);
nyatla 1:9f6a78395432 148
nyatla 1:9f6a78395432 149
nyatla 1:9f6a78395432 150
nyatla 1:9f6a78395432 151 struct NyLPC_TcHttpBasicHeaderParser_Handler
nyatla 1:9f6a78395432 152 {
nyatla 1:9f6a78395432 153 NyLPC_cHttpBasicHeaderParser_messageHandler messageHandler;
nyatla 1:9f6a78395432 154 NyLPC_cHttpBasicHeaderParser_urlHandler urlHandler;
nyatla 1:9f6a78395432 155 };
nyatla 1:9f6a78395432 156
nyatla 1:9f6a78395432 157
nyatla 1:9f6a78395432 158
nyatla 1:9f6a78395432 159 /**
nyatla 1:9f6a78395432 160 クラス構造体
nyatla 1:9f6a78395432 161 */
nyatla 1:9f6a78395432 162 struct NyLPC_TcHttpBasicHeaderParser
nyatla 1:9f6a78395432 163 {
nyatla 1:9f6a78395432 164 /**継承クラスで実装すべきインタフェイス*/
nyatla 1:9f6a78395432 165 const struct NyLPC_TcHttpBasicHeaderParser_Handler* _handler;
nyatla 1:9f6a78395432 166 NyLPC_TUInt16 _rcode;//_stがERRORの時にエラーコードを格納する。
nyatla 1:9f6a78395432 167 /**ワーク文字列*/
nyatla 1:9f6a78395432 168 NyLPC_TcStr_t _wsb;
nyatla 1:9f6a78395432 169 /**ワーク文字列のバッファ*/
nyatla 1:9f6a78395432 170 char _wsb_buf[NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS];
nyatla 1:9f6a78395432 171 };
nyatla 1:9f6a78395432 172
nyatla 1:9f6a78395432 173
nyatla 1:9f6a78395432 174 void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst);
nyatla 1:9f6a78395432 175 #define NyLPC_cHttpBasicHeaderParser_finalize(i_inst)
nyatla 1:9f6a78395432 176
nyatla 1:9f6a78395432 177 NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parse(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out);
nyatla 1:9f6a78395432 178 /**
nyatla 1:9f6a78395432 179 * parse関数がエラーの場合に、
nyatla 1:9f6a78395432 180 * 候補のエラーのステータスコードを返す。
nyatla 1:9f6a78395432 181 */
nyatla 1:9f6a78395432 182 #define NyLPC_cHttpBasicHeaderParser_getStatusCode(inst) ((inst)->_rcode)
nyatla 1:9f6a78395432 183
nyatla 1:9f6a78395432 184 #ifdef __cplusplus
nyatla 1:9f6a78395432 185 }
nyatla 1:9f6a78395432 186 #endif /* __cplusplus */
nyatla 1:9f6a78395432 187
nyatla 1:9f6a78395432 188 #endif