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_cModRomFiles.cpp@2:b96c1e90d120, 2013-03-27 (annotated)

Committer:
nyatla
Date:
Wed Mar 27 12:07:47 2013 +0000
Revision:
2:b96c1e90d120
Child:
7:2b33a8d84eb3
???????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 /*********************************************************************************
nyatla 2:b96c1e90d120 2 * PROJECT: MiMic
nyatla 2:b96c1e90d120 3 * --------------------------------------------------------------------------------
nyatla 2:b96c1e90d120 4 *
nyatla 2:b96c1e90d120 5 * This file is part of MiMic
nyatla 2:b96c1e90d120 6 * Copyright (C)2011 Ryo Iizuka
nyatla 2:b96c1e90d120 7 *
nyatla 2:b96c1e90d120 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 2:b96c1e90d120 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 2:b96c1e90d120 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 2:b96c1e90d120 11 * (at your option) any later version.
nyatla 2:b96c1e90d120 12 *
nyatla 2:b96c1e90d120 13 * This program is distributed in the hope that it will be useful,
nyatla 2:b96c1e90d120 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 2:b96c1e90d120 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 2:b96c1e90d120 16 * GNU General Public License for more details.
nyatla 2:b96c1e90d120 17 *
nyatla 2:b96c1e90d120 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 2:b96c1e90d120 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 2:b96c1e90d120 20 *
nyatla 2:b96c1e90d120 21 * For further information please contact.
nyatla 2:b96c1e90d120 22 * http://nyatla.jp/
nyatla 2:b96c1e90d120 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 2:b96c1e90d120 24 *
nyatla 2:b96c1e90d120 25 *********************************************************************************/
nyatla 2:b96c1e90d120 26 #include "NyLPC_cModRomFiles_protected.h"
nyatla 2:b96c1e90d120 27 #include "NyLPC_stdlib.h"
nyatla 2:b96c1e90d120 28 #include "../http/NyLPC_cHttpShortRequestHeaderParser.h"
nyatla 2:b96c1e90d120 29 #include "NyLPC_cHttpModUtils_protected.h"
nyatla 2:b96c1e90d120 30 #include "../NyLPC_cHttpdConnection_protected.h"
nyatla 2:b96c1e90d120 31
nyatla 2:b96c1e90d120 32
nyatla 2:b96c1e90d120 33 /**
nyatla 2:b96c1e90d120 34 * コンストラクタ。
nyatla 2:b96c1e90d120 35 * @param i_ref_path
nyatla 2:b96c1e90d120 36 * 16文字以内のルートパスを指定します。文字列は外部参照です。インスタンスをfinalizeするまで維持してください。
nyatla 2:b96c1e90d120 37 * 文字列は/で開始され/で終了する必要があります。
nyatla 2:b96c1e90d120 38 * path:= /({.,14}/)?
nyatla 2:b96c1e90d120 39 * @param i_data
nyatla 2:b96c1e90d120 40 * ROMFile構造体の配列の先頭アドレス
nyatla 2:b96c1e90d120 41 */
nyatla 2:b96c1e90d120 42 void NyLPC_cModRomFiles_initialize(NyLPC_TcModRomFiles_t* i_inst,const NyLPC_TChar* i_ref_root_path,const struct NyLPC_TRomFileData* i_data,int i_num_of_data)
nyatla 2:b96c1e90d120 43 {
nyatla 2:b96c1e90d120 44 i_inst->_data=i_data;
nyatla 2:b96c1e90d120 45 i_inst->_num_of_data=i_num_of_data;
nyatla 2:b96c1e90d120 46 i_inst->_ref_root_path=i_ref_root_path;
nyatla 2:b96c1e90d120 47 }
nyatla 2:b96c1e90d120 48 void NyLPC_cModRomFiles_finalize(NyLPC_TcModRomFiles_t* i_inst)
nyatla 2:b96c1e90d120 49 {
nyatla 2:b96c1e90d120 50 }
nyatla 2:b96c1e90d120 51
nyatla 2:b96c1e90d120 52 /**
nyatla 2:b96c1e90d120 53 * モジュールがコネクションをハンドリングできるかを返します。
nyatla 2:b96c1e90d120 54 */
nyatla 2:b96c1e90d120 55 NyLPC_TBool NyLPC_cModRomFiles_canHandle(NyLPC_TcModRomFiles_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection)
nyatla 2:b96c1e90d120 56 {
nyatla 2:b96c1e90d120 57 const NyLPC_TChar* in_url;
nyatla 2:b96c1e90d120 58 const NyLPC_TChar* base_url=i_inst->_ref_root_path;
nyatla 2:b96c1e90d120 59 in_url=NyLPC_cHttpdConnection_getUrlPrefix(i_connection);
nyatla 2:b96c1e90d120 60 size_t base_url_len=strlen(base_url);
nyatla 2:b96c1e90d120 61 if(strlen(in_url)<base_url_len){
nyatla 2:b96c1e90d120 62 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 63 }
nyatla 2:b96c1e90d120 64 if(strncmp(in_url,base_url,base_url_len)!=0){
nyatla 2:b96c1e90d120 65 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 66 }
nyatla 2:b96c1e90d120 67 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 68 }
nyatla 2:b96c1e90d120 69
nyatla 2:b96c1e90d120 70 /**
nyatla 2:b96c1e90d120 71 * URL解析の為の各兆クラス
nyatla 2:b96c1e90d120 72 */
nyatla 2:b96c1e90d120 73
nyatla 2:b96c1e90d120 74
nyatla 2:b96c1e90d120 75
nyatla 2:b96c1e90d120 76
nyatla 2:b96c1e90d120 77
nyatla 2:b96c1e90d120 78 static NyLPC_TBool NyLPC_cModRomFiles_messageHandler(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_name,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out)
nyatla 2:b96c1e90d120 79 {
nyatla 2:b96c1e90d120 80 (void)i_inst;
nyatla 2:b96c1e90d120 81 (void)i_name;
nyatla 2:b96c1e90d120 82 (void)i_c;
nyatla 2:b96c1e90d120 83 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 84 }
nyatla 2:b96c1e90d120 85 static NyLPC_TBool NyLPC_cModRomFiles_urlHandler(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out)
nyatla 2:b96c1e90d120 86 {
nyatla 2:b96c1e90d120 87 struct NyLPC_TRomFileRequestHeader* out=(struct NyLPC_TRomFileRequestHeader*)o_out;
nyatla 2:b96c1e90d120 88 //読み飛ばし
nyatla 2:b96c1e90d120 89 if(out->_prefix_len<0){
nyatla 2:b96c1e90d120 90 out->_prefix_len++;
nyatla 2:b96c1e90d120 91 return NyLPC_TBool_TRUE;//読み飛ばし
nyatla 2:b96c1e90d120 92 }
nyatla 2:b96c1e90d120 93 //終端確認
nyatla 2:b96c1e90d120 94 out->url[out->_prefix_len]=i_c;
nyatla 2:b96c1e90d120 95 if(i_c=='\0'){
nyatla 2:b96c1e90d120 96 return NyLPC_TBool_TRUE;//読み飛ばし
nyatla 2:b96c1e90d120 97 }
nyatla 2:b96c1e90d120 98 //蓄積チェック
nyatla 2:b96c1e90d120 99 out->_prefix_len++;
nyatla 2:b96c1e90d120 100 if(out->_prefix_len>=out->url_max){
nyatla 2:b96c1e90d120 101 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 102 }
nyatla 2:b96c1e90d120 103 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 104 }
nyatla 2:b96c1e90d120 105 /**
nyatla 2:b96c1e90d120 106 * デフォルトハンドラ
nyatla 2:b96c1e90d120 107 */
nyatla 2:b96c1e90d120 108 static const struct NyLPC_TcHttpBasicHeaderParser_Handler _handler=
nyatla 2:b96c1e90d120 109 {
nyatla 2:b96c1e90d120 110 NyLPC_cModRomFiles_messageHandler,
nyatla 2:b96c1e90d120 111 NyLPC_cModRomFiles_urlHandler
nyatla 2:b96c1e90d120 112 };
nyatla 2:b96c1e90d120 113
nyatla 2:b96c1e90d120 114
nyatla 2:b96c1e90d120 115
nyatla 2:b96c1e90d120 116 /**
nyatla 2:b96c1e90d120 117 * モジュールを実行します。
nyatla 2:b96c1e90d120 118 */
nyatla 2:b96c1e90d120 119 NyLPC_TBool NyLPC_cModRomFiles_execute(NyLPC_TcModRomFiles_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection)
nyatla 2:b96c1e90d120 120 {
nyatla 2:b96c1e90d120 121 int i;
nyatla 2:b96c1e90d120 122 NyLPC_TUInt16 status_code;
nyatla 2:b96c1e90d120 123 NyLPC_TChar urls[32];
nyatla 2:b96c1e90d120 124 struct NyLPC_TRomFileRequestHeader header;
nyatla 2:b96c1e90d120 125
nyatla 2:b96c1e90d120 126 //connectonの状態を確認
nyatla 2:b96c1e90d120 127 if(!NyLPC_cHttpdConnection_getReqStatus(i_connection)==NyLPC_cHttpdConnection_ReqStatus_REQPARSE)
nyatla 2:b96c1e90d120 128 {
nyatla 2:b96c1e90d120 129 NyLPC_OnErrorGoto(Error1);
nyatla 2:b96c1e90d120 130 }
nyatla 2:b96c1e90d120 131 //リクエストParse済へ遷移
nyatla 2:b96c1e90d120 132 NyLPC_cHttpdConnection_setReqStatusParsed(i_connection);
nyatla 2:b96c1e90d120 133
nyatla 2:b96c1e90d120 134 //URL解析の準備
nyatla 2:b96c1e90d120 135 header.url_max=32;
nyatla 2:b96c1e90d120 136 header.url=urls;
nyatla 2:b96c1e90d120 137 //URLパース
nyatla 2:b96c1e90d120 138 status_code=NyLPC_cModRomFiles_getUrlSuffix(i_inst,i_connection,&header);
nyatla 2:b96c1e90d120 139 if(status_code!=200)
nyatla 2:b96c1e90d120 140 {
nyatla 2:b96c1e90d120 141 //エラー送信
nyatla 2:b96c1e90d120 142 NyLPC_cHttpdConnection_sendResponseHeader2(i_connection,status_code,"text/html",0,NULL);
nyatla 2:b96c1e90d120 143 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 144 }
nyatla 2:b96c1e90d120 145 //URL比較
nyatla 2:b96c1e90d120 146 for(i=i_inst->_num_of_data-1;i>=0;i--)
nyatla 2:b96c1e90d120 147 {
nyatla 2:b96c1e90d120 148 if(strcmp(urls,i_inst->_data[i].name)!=0){
nyatla 2:b96c1e90d120 149 continue;
nyatla 2:b96c1e90d120 150 }
nyatla 2:b96c1e90d120 151 //Connection Modeの設定 1.1 && !closeの場合はCONTINUE
nyatla 2:b96c1e90d120 152 if(header.super.connection!=NyLPC_THttpMessgeHeader_Connection_CLOSE && header.super.startline.req.version==NyLPC_THttpVersion_11)
nyatla 2:b96c1e90d120 153 {
nyatla 2:b96c1e90d120 154 NyLPC_cHttpdConnection_setConnectionMode(i_connection,NyLPC_TcHttpdConnection_CONNECTION_MODE_CONTINUE);
nyatla 2:b96c1e90d120 155 }
nyatla 2:b96c1e90d120 156 return NyLPC_cHttpdModUtils_sendFixedContentBatch(i_connection,i_inst->_data[i].content_type,i_inst->_data[i].data,i_inst->_data[i].size>0?i_inst->_data[i].size:strlen(i_inst->_data[i].data));
nyatla 2:b96c1e90d120 157 }
nyatla 2:b96c1e90d120 158 //404Error
nyatla 2:b96c1e90d120 159 NyLPC_cHttpdConnection_sendResponseHeader2(i_connection,404,"text/html",0,NULL);
nyatla 2:b96c1e90d120 160 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 161 Error1:
nyatla 2:b96c1e90d120 162 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 163 }
nyatla 2:b96c1e90d120 164
nyatla 2:b96c1e90d120 165
nyatla 2:b96c1e90d120 166 /**
nyatla 2:b96c1e90d120 167 * URLサフィックスを取得する。
nyatla 2:b96c1e90d120 168 */
nyatla 2:b96c1e90d120 169 NyLPC_TUInt16 NyLPC_cModRomFiles_getUrlSuffix(NyLPC_TcModRomFiles_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection,struct NyLPC_TRomFileRequestHeader* header)
nyatla 2:b96c1e90d120 170 {
nyatla 2:b96c1e90d120 171 NyLPC_TcHttpBasicHeaderParser_t parser;
nyatla 2:b96c1e90d120 172 //URL解析の準備
nyatla 2:b96c1e90d120 173 header->_prefix_len=-(NyLPC_TInt16)strlen(i_inst->_ref_root_path);
nyatla 2:b96c1e90d120 174 NyLPC_cHttpBasicHeaderParser_initialize(&parser,&_handler);
nyatla 2:b96c1e90d120 175 //プリフェッチしたデータを流す
nyatla 2:b96c1e90d120 176 NyLPC_cHttpBasicHeaderParser_parseInit(&parser,&(header->super));
nyatla 2:b96c1e90d120 177 NyLPC_cHttpdConnection_pushPrefetchInfo(i_connection,&parser,&(header->super));
nyatla 2:b96c1e90d120 178 //後続をストリームから取り込む
nyatla 2:b96c1e90d120 179 if(!NyLPC_cHttpBasicHeaderParser_parseStream(&parser,NyLPC_cHttpdConnection_refStream(i_connection),&(header->super))){
nyatla 2:b96c1e90d120 180 NyLPC_OnErrorGoto(Error2);
nyatla 2:b96c1e90d120 181 }
nyatla 2:b96c1e90d120 182 if(!NyLPC_cHttpBasicHeaderParser_parseFinish(&parser,&(header->super))){
nyatla 2:b96c1e90d120 183 NyLPC_OnErrorGoto(Error2);
nyatla 2:b96c1e90d120 184 }
nyatla 2:b96c1e90d120 185 NyLPC_cHttpShortRequestHeaderParser_finalize(&parser);
nyatla 2:b96c1e90d120 186 return 200;
nyatla 2:b96c1e90d120 187 Error2:
nyatla 2:b96c1e90d120 188 //BadRequest
nyatla 2:b96c1e90d120 189 return 400;
nyatla 2:b96c1e90d120 190 }