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:
Tue Jun 10 03:30:41 2014 +0000
Revision:
71:855020258513
Parent:
58:03b89038b21a
MiMic-core ?358???; modJsonRPC???????????;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 57:bc4330dfa62f 1 #ifndef NYLPC_CMODWEBSOCKET_H_
nyatla 57:bc4330dfa62f 2 #define NYLPC_CMODWEBSOCKET_H_
nyatla 57:bc4330dfa62f 3
nyatla 57:bc4330dfa62f 4 /*********************************************************************************
nyatla 57:bc4330dfa62f 5 * PROJECT: MiMic
nyatla 57:bc4330dfa62f 6 * --------------------------------------------------------------------------------
nyatla 57:bc4330dfa62f 7 *
nyatla 57:bc4330dfa62f 8 * This file is part of MiMic
nyatla 57:bc4330dfa62f 9 * Copyright (C)2011 Ryo Iizuka
nyatla 57:bc4330dfa62f 10 *
nyatla 57:bc4330dfa62f 11 * MiMic is free software: you can redistribute it and/or modify
nyatla 57:bc4330dfa62f 12 * it under the terms of the GNU Lesser General Public License as published
nyatla 57:bc4330dfa62f 13 * by the Free Software Foundation, either version 3 of the License, or
nyatla 57:bc4330dfa62f 14 * (at your option) any later version.
nyatla 57:bc4330dfa62f 15 *
nyatla 57:bc4330dfa62f 16 * This program is distributed in the hope that it will be useful,
nyatla 57:bc4330dfa62f 17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 57:bc4330dfa62f 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 57:bc4330dfa62f 19 * GNU General Public License for more details.
nyatla 57:bc4330dfa62f 20 *
nyatla 57:bc4330dfa62f 21 * You should have received a copy of the GNU Lesser General Public License
nyatla 57:bc4330dfa62f 22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 57:bc4330dfa62f 23 *
nyatla 57:bc4330dfa62f 24 * For further information please contact.
nyatla 57:bc4330dfa62f 25 * http://nyatla.jp/
nyatla 57:bc4330dfa62f 26 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 57:bc4330dfa62f 27 *
nyatla 57:bc4330dfa62f 28 *********************************************************************************/
nyatla 57:bc4330dfa62f 29 #include "NyLPC_stdlib.h"
nyatla 57:bc4330dfa62f 30 #include "NyLPC_http.h"
nyatla 57:bc4330dfa62f 31 #include "../NyLPC_cHttpdConnection_protected.h"
nyatla 57:bc4330dfa62f 32 #include "../NyLPC_cHttpdUtils.h"
nyatla 71:855020258513 33 #include "NyLPC_cModRomFiles.h"
nyatla 57:bc4330dfa62f 34
nyatla 57:bc4330dfa62f 35 #ifdef __cplusplus
nyatla 57:bc4330dfa62f 36 extern "C" {
nyatla 57:bc4330dfa62f 37 #endif /* __cplusplus */
nyatla 57:bc4330dfa62f 38
nyatla 57:bc4330dfa62f 39 /**
nyatla 57:bc4330dfa62f 40 * ファイルアップロードの為の基本シーケンスを提供する抽象クラスです。
nyatla 57:bc4330dfa62f 41 * 継承クラスで_abstruct_function以下の関数に実体を設定して使います。
nyatla 57:bc4330dfa62f 42 */
nyatla 57:bc4330dfa62f 43 typedef struct NyLPC_TcModWebSocket NyLPC_TcModWebSocket_t;
nyatla 57:bc4330dfa62f 44
nyatla 57:bc4330dfa62f 45
nyatla 57:bc4330dfa62f 46 #define NyLPC_TcModWebSocket_FRAME_TYPE_BIN 0x01
nyatla 57:bc4330dfa62f 47 #define NyLPC_TcModWebSocket_FRAME_TYPE_TXT 0x02
nyatla 57:bc4330dfa62f 48
nyatla 58:03b89038b21a 49 typedef NyLPC_TUInt8 NyLPC_TcModWebSocket_ST;
nyatla 58:03b89038b21a 50 /**
nyatla 58:03b89038b21a 51 * パケットヘッダの受信待ちである。
nyatla 58:03b89038b21a 52 */
nyatla 58:03b89038b21a 53 #define NyLPC_TcModWebSocket_ST_START_PAYLOAD 0x02
nyatla 58:03b89038b21a 54 /**
nyatla 58:03b89038b21a 55 * ペイロードの読み取り中である。
nyatla 58:03b89038b21a 56 */
nyatla 58:03b89038b21a 57 #define NyLPC_TcModWebSocket_ST_READ_PAYLOAD 0x03
nyatla 58:03b89038b21a 58 /**
nyatla 58:03b89038b21a 59 * WebSocketは閉じられた。
nyatla 58:03b89038b21a 60 */
nyatla 58:03b89038b21a 61 #define NyLPC_TcModWebSocket_ST_CLOSED 0x04
nyatla 58:03b89038b21a 62
nyatla 57:bc4330dfa62f 63 /**
nyatla 57:bc4330dfa62f 64 * クラス構造体
nyatla 57:bc4330dfa62f 65 */
nyatla 57:bc4330dfa62f 66 struct NyLPC_TcModWebSocket
nyatla 57:bc4330dfa62f 67 {
nyatla 57:bc4330dfa62f 68 NyLPC_TcModRomFiles_t super;
nyatla 57:bc4330dfa62f 69 /**
nyatla 57:bc4330dfa62f 70 * サブプロトコル。NULLの場合0
nyatla 57:bc4330dfa62f 71 */
nyatla 57:bc4330dfa62f 72 const NyLPC_TChar* _ref_sub_protocol;
nyatla 57:bc4330dfa62f 73 /**ペイロードの解析ステータス*/
nyatla 58:03b89038b21a 74 NyLPC_TcModWebSocket_ST _payload_st;
nyatla 57:bc4330dfa62f 75 NyLPC_TUInt8 _frame_type;
nyatla 57:bc4330dfa62f 76 /**
nyatla 57:bc4330dfa62f 77 * BIT0: MASK value
nyatla 57:bc4330dfa62f 78 */
nyatla 57:bc4330dfa62f 79 NyLPC_TUInt8 _frame_flags_bits;
nyatla 57:bc4330dfa62f 80 NyLPC_TUInt8 _frame_mask[4];
nyatla 57:bc4330dfa62f 81 /** ペイロードサイズ*/
nyatla 57:bc4330dfa62f 82 NyLPC_TUInt16 payload_size;
nyatla 57:bc4330dfa62f 83 /** ペイロード位置*/
nyatla 57:bc4330dfa62f 84 NyLPC_TUInt16 payload_ptr;
nyatla 57:bc4330dfa62f 85 NyLPC_TcHttpdConnection_t* _ref_connection;
nyatla 57:bc4330dfa62f 86 };
nyatla 57:bc4330dfa62f 87
nyatla 71:855020258513 88
nyatla 71:855020258513 89 /**
nyatla 71:855020258513 90 * NyLPC_cModWebSocket_readCB関数のコールバックハンドラです。
nyatla 71:855020258513 91 * @return
nyatla 71:855020258513 92 * -1    :エラーが発生したことを通知します。NyLPC_cModWebSocket_readCBは負数を返してクローズします。
nyatla 71:855020258513 93 * 0    :読出しの中断を通知します。NyLPC_cModWebSocket_readCBは読み取ったデータ数を記録して正常終了します。
nyatla 71:855020258513 94 * 1    :読出しの継続を通知します。NyLPC_cModWebSocket_readCBは継続してデータを通知します。
nyatla 71:855020258513 95 */
nyatla 71:855020258513 96 typedef NyLPC_TInt32 (*NyLPC_TcModWebSocket_onRreadCB)(void* i_param,NyLPC_TChar i_c);
nyatla 71:855020258513 97
nyatla 57:bc4330dfa62f 98 /**
nyatla 57:bc4330dfa62f 99 * コンストラクタ。
nyatla 57:bc4330dfa62f 100 */
nyatla 57:bc4330dfa62f 101 void NyLPC_cModWebSocket_initialize(NyLPC_TcModWebSocket_t* i_inst,const NyLPC_TChar* i_ref_root_path);
nyatla 57:bc4330dfa62f 102
nyatla 57:bc4330dfa62f 103 void NyLPC_cModWebSocket_finalize(NyLPC_TcModWebSocket_t* i_inst);
nyatla 57:bc4330dfa62f 104
nyatla 57:bc4330dfa62f 105 /**
nyatla 57:bc4330dfa62f 106 * モジュールがコネクションをハンドリングできるかを返します。
nyatla 57:bc4330dfa62f 107 */
nyatla 57:bc4330dfa62f 108 NyLPC_TBool NyLPC_cModWebSocket_canHandle(NyLPC_TcModWebSocket_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
nyatla 57:bc4330dfa62f 109
nyatla 57:bc4330dfa62f 110 /**
nyatla 57:bc4330dfa62f 111 * モジュールを実行します。
nyatla 57:bc4330dfa62f 112 */
nyatla 57:bc4330dfa62f 113 NyLPC_TBool NyLPC_cModWebSocket_execute(NyLPC_TcModWebSocket_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
nyatla 57:bc4330dfa62f 114
nyatla 58:03b89038b21a 115 /**
nyatla 58:03b89038b21a 116 * NyLPC_cModWebSocket_read関数がブロック無しに完了できるかを返します。
nyatla 58:03b89038b21a 117 * NyLPC_cModWebSocket_readで処理をブロックしたくない場合に使います。
nyatla 58:03b89038b21a 118 * アプリケーションはこの関数を頻繁にチェックして、trueの場合は速やかにNyLPC_cModWebSocket_readを実行してください。
nyatla 58:03b89038b21a 119 */
nyatla 58:03b89038b21a 120 NyLPC_TBool NyLPC_cModWebSocket_canRead(const NyLPC_TcModWebSocket_t* i_inst);
nyatla 58:03b89038b21a 121
nyatla 58:03b89038b21a 122
nyatla 71:855020258513 123 /**
nyatla 71:855020258513 124 * 受信データをコールバック関数に通知するNyLPC_cModWebSocket_readです。
nyatla 71:855020258513 125 * @param i_cb
nyatla 71:855020258513 126 * NyLPC_TcModWebSocket_onRreadCBのi_paramに設定する数値です。
nyatla 71:855020258513 127 * @return
nyatla 71:855020258513 128 * n>0:データ受信
nyatla 71:855020258513 129 * 0 :タイムアウト。コネクションの状態は変化しない。
nyatla 71:855020258513 130 * -1 :エラー コネクションはNyLPC_TcModWebSocket_ST_CLOSEDへ遷移する。
nyatla 71:855020258513 131 */
nyatla 71:855020258513 132 NyLPC_TInt16 NyLPC_cModWebSocket_readCB(NyLPC_TcModWebSocket_t* i_inst,NyLPC_TcModWebSocket_onRreadCB i_cb,void* i_cb_param);
nyatla 71:855020258513 133
nyatla 57:bc4330dfa62f 134
nyatla 57:bc4330dfa62f 135 /**
nyatla 58:03b89038b21a 136 * ストリームからデータを受信して、可能ならi_bufに最大i_buf_lenバイトのデータを受信します。
nyatla 58:03b89038b21a 137 * この関数はデータ以外のパケットも処理します。
nyatla 57:bc4330dfa62f 138 * @return
nyatla 57:bc4330dfa62f 139 * n>0:受信成功。nバイトのデータを受信した。
nyatla 57:bc4330dfa62f 140 * 0 :タイムアウト。コネクションの状態は変化しない。
nyatla 57:bc4330dfa62f 141 * -1 :エラー。 コネクションはNyLPC_TcModWebSocket_ST_CLOSEDへ遷移する。
nyatla 57:bc4330dfa62f 142 */
nyatla 57:bc4330dfa62f 143 NyLPC_TInt16 NyLPC_cModWebSocket_read(NyLPC_TcModWebSocket_t* i_inst,void* i_buf,NyLPC_TInt16 i_buf_len);
nyatla 57:bc4330dfa62f 144 /**
nyatla 57:bc4330dfa62f 145 * i_bufからi_lenバイトのデータを送信します。データは1ペーロードとしてクライアントへ送信されます。
nyatla 58:03b89038b21a 146 * この関数はデータ以外のパケットも処理します。
nyatla 57:bc4330dfa62f 147 * @return
nyatla 57:bc4330dfa62f 148 * true: 送信に成功した。
nyatla 57:bc4330dfa62f 149 * false:送信に失敗した。 コネクションはNyLPC_TcModWebSocket_ST_CLOSEDへ遷移する。
nyatla 57:bc4330dfa62f 150 */
nyatla 58:03b89038b21a 151 NyLPC_TBool NyLPC_cModWebSocket_write(NyLPC_TcModWebSocket_t* i_inst,const void* i_buf,NyLPC_TInt16 i_len);
nyatla 57:bc4330dfa62f 152 /**
nyatla 57:bc4330dfa62f 153 * 書式文字列を出力します。
nyatla 57:bc4330dfa62f 154 */
nyatla 57:bc4330dfa62f 155 NyLPC_TBool NyLPC_cModWebSocket_writeFormat(NyLPC_TcModWebSocket_t* i_inst,const NyLPC_TChar* i_fmt,...);
nyatla 71:855020258513 156 NyLPC_TBool NyLPC_cModWebSocket_writeFormatV(NyLPC_TcModWebSocket_t* i_inst,const NyLPC_TChar* i_fmt,va_list args);
nyatla 57:bc4330dfa62f 157
nyatla 58:03b89038b21a 158
nyatla 57:bc4330dfa62f 159 /**
nyatla 71:855020258513 160 * 書式文字列を出力した場合の文字数を返します。
nyatla 71:855020258513 161 * この関数は、startBulkWrite関数のi_lenパラメータに渡す値を計算するときに使います。
nyatla 71:855020258513 162 */
nyatla 71:855020258513 163 NyLPC_TInt16 NyLPC_cModWebSocket_testFormatV(NyLPC_TcModWebSocket_t* i_inst,const NyLPC_TChar* i_fmt,va_list args);
nyatla 71:855020258513 164 NyLPC_TInt16 NyLPC_cModWebSocket_testFormat(NyLPC_TcModWebSocket_t* i_inst,const NyLPC_TChar* i_fmt,...);
nyatla 71:855020258513 165
nyatla 71:855020258513 166 /**
nyatla 71:855020258513 167 * バルク書き込みを開始します。
nyatla 71:855020258513 168 * バルク書き込みは、endBulkWrite関数をコールするまでにwriteBulk関数で入力されたデータを、1つのi_lenサイズのWebsocketパケットとして送信します。
nyatla 71:855020258513 169 * バルク書き込み中は、通常のwrite関数を使用することができません。
nyatla 71:855020258513 170 * @param i_len
nyatla 71:855020258513 171 * NyLPC_cModWebSocket_endBulkFormatでバルク書き込みを終了するまでに入力するデータサイズを指定します。
nyatla 71:855020258513 172 */
nyatla 71:855020258513 173 NyLPC_TBool NyLPC_cModWebSocket_startBulkWrite(NyLPC_TcModWebSocket_t* i_inst,NyLPC_TInt16 i_len);
nyatla 71:855020258513 174 /**
nyatla 71:855020258513 175 * バルク書き込みを終了します。
nyatla 71:855020258513 176 * この関数をコールする前に、startBulkWrite関数のi_lenで指定した大きさのデータを入力し終えている必要があります。
nyatla 71:855020258513 177 * 過不足があった場合、WebSocketセッションが破壊されます。
nyatla 71:855020258513 178 */
nyatla 71:855020258513 179 NyLPC_TBool NyLPC_cModWebSocket_endBulkWrite(NyLPC_TcModWebSocket_t* i_inst);
nyatla 71:855020258513 180 NyLPC_TBool NyLPC_cModWebSocket_writeBulkFormatV(NyLPC_TcModWebSocket_t* i_inst,const NyLPC_TChar* i_fmt,va_list args);
nyatla 71:855020258513 181 NyLPC_TBool NyLPC_cModWebSocket_writeBulkFormat(NyLPC_TcModWebSocket_t* i_inst,const NyLPC_TChar* i_fmt,...);
nyatla 71:855020258513 182
nyatla 71:855020258513 183 /**
nyatla 57:bc4330dfa62f 184 * CLOSEパケットを送信してコネクションを閉じます。
nyatla 58:03b89038b21a 185 * この関数はデータ以外のパケットも処理します。
nyatla 57:bc4330dfa62f 186 * i_codeにはWebsocketのコード
nyatla 57:bc4330dfa62f 187 */
nyatla 57:bc4330dfa62f 188 void NyLPC_cModWebSocket_close(NyLPC_TcModWebSocket_t* i_inst,NyLPC_TUInt16 i_code);
nyatla 57:bc4330dfa62f 189
nyatla 57:bc4330dfa62f 190 #ifdef __cplusplus
nyatla 57:bc4330dfa62f 191 }
nyatla 57:bc4330dfa62f 192 #endif /* __cplusplus */
nyatla 57:bc4330dfa62f 193
nyatla 57:bc4330dfa62f 194 #endif /* NYLPC_CMODWEBSOCKET_H_ */