Users » nyatla » Code » libMiMic

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 program MiMicRemoteMCU-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 program MbedFileServer

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

サンプル

Import program MiMicSimpleHttpd

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

Import program UPnPBasicDevice

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

Import program WebSocketSample

MiMicSDK Websocket module sample program.

Import program HttpClientSamlpe

A http client sample program.

Import program TcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import program UdpSocketSamlpe

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 program MiMicRemoteMCU-for-Mbed

Import program MbedFileServer

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

Tutorial

HTTPD hello world.
How to make own UPnP device.
MiMicRemoteMCUの紹介(pdf)
MiMicRemoteMCUのマニュアル(pdf)

Diff: core/http/NyLPC_cHttpBasicHeaderParser.cpp

Revision:: 2:b96c1e90d120
Parent:: 1:9f6a78395432

--- a/core/http/NyLPC_cHttpBasicHeaderParser.cpp	Mon Mar 25 05:23:49 2013 +0000
+++ b/core/http/NyLPC_cHttpBasicHeaderParser.cpp	Wed Mar 27 12:07:47 2013 +0000
@@ -42,23 +42,7 @@
 
 
 
-/**
- * HeaderParserのステータス定義値。
- */
-typedef NyLPC_TUInt8 NyLPC_TcHttpBasicHeaderParser_ST;
-#define NyLPC_TcHttpBasicHeaderParser_ST_START                  ((NyLPC_TcHttpBasicHeaderParser_ST)0x01)//HTTPステータスラインか、リクエストライン
-#define NyLPC_TcHttpBasicHeaderParser_ST_RL_URL                 ((NyLPC_TcHttpBasicHeaderParser_ST)0x12)//URL
-#define NyLPC_TcHttpBasicHeaderParser_ST_RL_VERSION             ((NyLPC_TcHttpBasicHeaderParser_ST)0x13)//VERSION
-#define NyLPC_TcHttpBasicHeaderParser_ST_SL_STATUSCODE          ((NyLPC_TcHttpBasicHeaderParser_ST)0x21)//ステータスコード
-#define NyLPC_TcHttpBasicHeaderParser_ST_SL_REASON              ((NyLPC_TcHttpBasicHeaderParser_ST)0x22)//Reason-Phrase
-#define NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD                ((NyLPC_TcHttpBasicHeaderParser_ST)0x31)//MESSAGE
-#define NyLPC_TcHttpBasicHeaderParser_ST_MSGPARAM               ((NyLPC_TcHttpBasicHeaderParser_ST)0x32)//MESSAGEパラメータ部
-#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONTENTLENGTH      ((NyLPC_TcHttpBasicHeaderParser_ST)0x33)//MESSAGEContentLength
-#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONNECTION         ((NyLPC_TcHttpBasicHeaderParser_ST)0x34)//MESSAGEConnection
-#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_TRANSFERENCODING   ((NyLPC_TcHttpBasicHeaderParser_ST)0x35)//TransferEncoding
-#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_RANGE              ((NyLPC_TcHttpBasicHeaderParser_ST)0x36)//Range
-#define NyLPC_TcHttpBasicHeaderParser_ST_EOH                    ((NyLPC_TcHttpBasicHeaderParser_ST)0x7F)//終わり
-#define NyLPC_TcHttpBasicHeaderParser_ST_ERROR                  ((NyLPC_TcHttpBasicHeaderParser_ST)0x80)//終わり
+
 
 
 
@@ -71,10 +55,7 @@
 #define HTTP_DM ':' 
 
 
-/*
-    プライベート関数
-*/
-#define NyLPC_TcHttpBasicHeaderParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicHeaderParser_ST_ERROR)
+
 
 static NyLPC_TcHttpBasicHeaderParser_ST parseMessage_Connection(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);
 static NyLPC_TcHttpBasicHeaderParser_ST parseMessage_ContentLength(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);
@@ -116,8 +97,8 @@
  */
 static const struct NyLPC_TcHttpBasicHeaderParser_Handler _default_handler=
 {
-        default_message_handler,
-        default_urlHandler
+    default_message_handler,
+    default_urlHandler
 };
 
 
@@ -127,96 +108,224 @@
 ----------------------------------------*/
 
 
-void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst)
+void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const struct NyLPC_TcHttpBasicHeaderParser_Handler* i_handler)
 {
     NyLPC_cStr_initialize(&(i_inst->_wsb),i_inst->_wsb_buf,NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS);
-    i_inst->_handler=&_default_handler;
+    i_inst->_handler=(i_handler==NULL?&_default_handler:i_handler);
+}
+
+/**
+ * parserの初期化
+ */
+void NyLPC_cHttpBasicHeaderParser_parseInit(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out)
+{
+    //出力構造体を初期化
+    o_out->connection=NyLPC_THttpMessgeHeader_Connection_NONE;
+    o_out->content_length=NyLPC_THttpContentLength_INVALID_LENGTH;
+    o_out->transfer_encoding=NyLPC_THttpMessgeHeader_TransferEncoding_NONE;
+    i_inst->_st=NyLPC_TcHttpBasicHeaderParser_ST_START;
+}
+/**
+ * parseCharがNyLPC_TcHttpBasicHeaderParser_ST_EOHを返却したらコールすること。
+ */
+NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseFinish(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out)
+{
+    if(i_inst->_st!=NyLPC_TcHttpBasicHeaderParser_ST_EOH)
+    {
+        return NyLPC_TBool_FALSE;
+    }
+    //整合性チェック
+    if(!testHeader(o_out,&i_inst->_rcode)){
+        i_inst->_st=NyLPC_TcHttpBasicHeaderParser_ST_ERROR;
+        return NyLPC_TBool_FALSE;
+    }
+    return NyLPC_TBool_TRUE;
 }
+/**
+ * 文字列をパースします。
+ * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。
+ * @return
+ * パースした文字列の長さ。-1の場合はエラー。
+ * TRUEの場合、NyLPC_cHttpBasicHeaderParser_getParseStatus関数で状態をチェックして、後続の処理を選択してください。
+ */
+NyLPC_TInt32 NyLPC_cHttpBasicHeaderParser_parseChar(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_c,NyLPC_TInt32 i_size,struct NyLPC_THttpBasicHeader* o_out)
+{
+    int i;
+    NyLPC_TChar c;
+    //Errorチェック
+    if(NyLPC_TcHttpBasicHeaderParser_ST_ERROR==i_inst->_st)
+    {
+        return 0;
+    }
+    for(i=0;i<i_size;i++){
+        c=*(i_c+i);
+        switch(i_inst->_st)
+        {
+        case NyLPC_TcHttpBasicHeaderParser_ST_START:
+            i_inst->_st=parseStartLine(i_inst,c,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_MSGPARAM:
+            i_inst->_st=parseMessageParam(i_inst,c,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD:
+            i_inst->_st=parseMessage1(i_inst,c,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_RL_URL:
+            i_inst->_st=parseRequestUrl(i_inst,c,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_RL_VERSION:
+            i_inst->_st=parseVersion(i_inst,c,NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_SL_STATUSCODE:
+            i_inst->_st=parseStatusCode(i_inst,c,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_SL_REASON:
+            i_inst->_st=parseReason(i_inst,c);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONTENTLENGTH:
+            i_inst->_st=parseMessage_ContentLength(i_inst,c,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONNECTION:
+            i_inst->_st=parseMessage_Connection(i_inst,c,o_out);
+            break;
+        case NyLPC_TcHttpBasicHeaderParser_ST_MSG_TRANSFERENCODING:
+            i_inst->_st=parseMessage_TransferEncoding(i_inst,c,o_out);
+            break;
+        default:
+            i_inst->_rcode=500;
+            i_inst->_st=NyLPC_TcHttpBasicHeaderParser_ST_ERROR;
+        }
+        if(NyLPC_TcHttpBasicHeaderParser_ST_isError(i_inst->_st)){
+            //エラー起こしたら終了。
+            return i;
+        }else if(i_inst->_st==NyLPC_TcHttpBasicHeaderParser_ST_EOH){
+            //ヘッダ終端なら終了。
+            return i+1;
+        }
+    }
+    return i_size;
+}
+
+
 
 /**
  * ストリームから読み出して、パースします。
+ * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。
+ * @return
+ * FALSE-失敗/TRUE-成功
+ * 関数が成功した場合、NyLPC_cHttpBasicHeaderParser_parseFinishでパーサを閉じることが出来ます。
  */
-NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parse(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out)
+NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseStream(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out)
 {
-    NyLPC_TcHttpBasicHeaderParser_ST st;
     const char* rp_base;
     NyLPC_TInt32 rsize;
-    char c;
-    int i;
-
-    //出力構造体を初期化
-    st=NyLPC_TcHttpBasicHeaderParser_ST_START;
-    o_out->connection=NyLPC_THttpMessgeHeader_Connection_NONE;
-    o_out->content_length=NyLPC_THttpContentLength_INVALID_LENGTH;
-    o_out->transfer_encoding=NyLPC_THttpMessgeHeader_TransferEncoding_NONE;
-
     for(;;){
         //タイムアウト付でストリームから読み出し。
         rsize=NyLPC_iHttpPtrStream_pread(i_stream,(const void**)(&rp_base));
         if(rsize<=0){
             return NyLPC_TBool_FALSE;
         }
-        for(i=0;i<rsize;i++){
-            c=*(rp_base+i);
-            switch(st)
-            {
-            case NyLPC_TcHttpBasicHeaderParser_ST_START:
-                st=parseStartLine(i_inst,c,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_MSGPARAM:
-                st=parseMessageParam(i_inst,c,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD:
-                st=parseMessage1(i_inst,c,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_RL_URL:
-                st=parseRequestUrl(i_inst,c,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_RL_VERSION:
-                st=parseVersion(i_inst,c,NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_SL_STATUSCODE:
-                st=parseStatusCode(i_inst,c,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_SL_REASON:
-                st=parseReason(i_inst,c);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONTENTLENGTH:
-                st=parseMessage_ContentLength(i_inst,c,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONNECTION:
-                st=parseMessage_Connection(i_inst,c,o_out);
-                break;
-            case NyLPC_TcHttpBasicHeaderParser_ST_MSG_TRANSFERENCODING:
-                st=parseMessage_TransferEncoding(i_inst,c,o_out);
-                break;
-            default:
-                i_inst->_rcode=500;
-                st=NyLPC_TcHttpBasicHeaderParser_ST_ERROR;
-            }
-            //エラー起こしたら終了。
-            if(NyLPC_TcHttpBasicHeaderParser_ST_isError(st)){
-                return NyLPC_TBool_FALSE;
-            }
+        rsize=NyLPC_cHttpBasicHeaderParser_parseChar(i_inst,rp_base,rsize,o_out);
+        if(i_inst->_st==NyLPC_TcHttpBasicHeaderParser_ST_ERROR){
+            //パース失敗
+            NyLPC_iHttpPtrStream_rseek(i_stream,rsize);
+            return NyLPC_TBool_FALSE;
+        }
+        if(i_inst->_st==NyLPC_TcHttpBasicHeaderParser_ST_EOH){
             //パース成功
-            if(st==NyLPC_TcHttpBasicHeaderParser_ST_EOH){
-                //整合性チェック
-                if(!testHeader(o_out,&i_inst->_rcode)){
-                    st=NyLPC_TcHttpBasicHeaderParser_ST_ERROR;
-                    return NyLPC_TBool_FALSE;
-                }
-                //シーク
-                NyLPC_iHttpPtrStream_rseek(i_stream,i+1);
-                return NyLPC_TBool_TRUE;
-            }
+            NyLPC_iHttpPtrStream_rseek(i_stream,rsize);
+            return NyLPC_TBool_TRUE;
         }
-        //シーク
         NyLPC_iHttpPtrStream_rseek(i_stream,(NyLPC_TUInt16)rsize);
     }
     return NyLPC_TBool_FALSE;
 }
 
 
+///**
+// * ストリームから読み出して、パースします。
+// */
+//NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parse(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out)
+//{
+//  NyLPC_TcHttpBasicHeaderParser_ST st;
+//  const char* rp_base;
+//  NyLPC_TInt32 rsize;
+//  char c;
+//  int i;
+//
+//  //出力構造体を初期化
+//  st=NyLPC_TcHttpBasicHeaderParser_ST_START;
+//  o_out->connection=NyLPC_THttpMessgeHeader_Connection_NONE;
+//  o_out->content_length=NyLPC_THttpContentLength_INVALID_LENGTH;
+//  o_out->transfer_encoding=NyLPC_THttpMessgeHeader_TransferEncoding_NONE;
+//
+//  for(;;){
+//      //タイムアウト付でストリームから読み出し。
+//      rsize=NyLPC_iHttpPtrStream_pread(i_stream,(const void**)(&rp_base));
+//      if(rsize<=0){
+//          return NyLPC_TBool_FALSE;
+//      }
+//      for(i=0;i<rsize;i++){
+//          c=*(rp_base+i);
+//          switch(st)
+//          {
+//          case NyLPC_TcHttpBasicHeaderParser_ST_START:
+//              st=parseStartLine(i_inst,c,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_MSGPARAM:
+//              st=parseMessageParam(i_inst,c,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD:
+//              st=parseMessage1(i_inst,c,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_RL_URL:
+//              st=parseRequestUrl(i_inst,c,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_RL_VERSION:
+//              st=parseVersion(i_inst,c,NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_SL_STATUSCODE:
+//              st=parseStatusCode(i_inst,c,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_SL_REASON:
+//              st=parseReason(i_inst,c);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONTENTLENGTH:
+//              st=parseMessage_ContentLength(i_inst,c,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONNECTION:
+//              st=parseMessage_Connection(i_inst,c,o_out);
+//              break;
+//          case NyLPC_TcHttpBasicHeaderParser_ST_MSG_TRANSFERENCODING:
+//              st=parseMessage_TransferEncoding(i_inst,c,o_out);
+//              break;
+//          default:
+//              i_inst->_rcode=500;
+//              st=NyLPC_TcHttpBasicHeaderParser_ST_ERROR;
+//          }
+//          //エラー起こしたら終了。
+//          if(NyLPC_TcHttpBasicHeaderParser_ST_isError(st)){
+//              return NyLPC_TBool_FALSE;
+//          }
+//          //パース成功
+//          if(st==NyLPC_TcHttpBasicHeaderParser_ST_EOH){
+//              //整合性チェック
+//              if(!testHeader(o_out,&i_inst->_rcode)){
+//                  st=NyLPC_TcHttpBasicHeaderParser_ST_ERROR;
+//                  return NyLPC_TBool_FALSE;
+//              }
+//              //シーク
+//              NyLPC_iHttpPtrStream_rseek(i_stream,i+1);
+//              return NyLPC_TBool_TRUE;
+//          }
+//      }
+//      //シーク
+//      NyLPC_iHttpPtrStream_rseek(i_stream,(NyLPC_TUInt16)rsize);
+//  }
+//  return NyLPC_TBool_FALSE;
+//}
+
+
 
 /*----------------------------------------
     private関数
@@ -701,4 +810,3 @@
 Error:
     return NyLPC_TBool_FALSE;
 }
-

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	28 Mar 2013
Imports:	145
Forks:	1
Commits:	115
Dependents:	14
Dependencies:	0
Followers:	17
Issues:	5

Components

MiMic Webservice library

構成