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/http/NyLPC_cHttpBodyParser.c@58:03b89038b21a, 2013-09-27 (annotated)

Committer:
nyatla
Date:
Fri Sep 27 12:47:51 2013 +0000
Revision:
58:03b89038b21a
Parent:
48:00d211aac2ec 
add classes; checked:modwebsocket; unchecked:tcpsocket,udpsocket,httpclient.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 41:2389bd6b6f74 1 #include "NyLPC_cHttpBodyParser.h"
nyatla 41:2389bd6b6f74 2
nyatla 58:03b89038b21a 3 #define HTTP_TIMEOUT NyLPC_TiHttpPtrStream_DEFAULT_HTTP_TIMEOUT
nyatla 58:03b89038b21a 4
nyatla 41:2389bd6b6f74 5 static NyLPC_TBool bodyHandler(NyLPC_TcHttpBasicBodyParser_t* i_inst,NyLPC_TChar i_c)
nyatla 41:2389bd6b6f74 6 {
nyatla 41:2389bd6b6f74 7 NyLPC_TcHttpBodyParser_t* inst=(NyLPC_TcHttpBodyParser_t*)i_inst;
nyatla 41:2389bd6b6f74 8 *(inst->ref_buf+inst->len)=i_c;
nyatla 41:2389bd6b6f74 9 inst->len++;
nyatla 41:2389bd6b6f74 10 return inst->buf_size>inst->len;
nyatla 41:2389bd6b6f74 11 }
nyatla 41:2389bd6b6f74 12
nyatla 41:2389bd6b6f74 13 static struct NyLPC_TcHttpBasicBodyParser_Handler _bh={bodyHandler};
nyatla 41:2389bd6b6f74 14
nyatla 41:2389bd6b6f74 15 void NyLPC_cHttpBodyParser_initialize(NyLPC_TcHttpBodyParser_t* i_inst)
nyatla 41:2389bd6b6f74 16 {
nyatla 41:2389bd6b6f74 17 NyLPC_cHttpBasicBodyParser_initialize(&i_inst->_super,&_bh);
nyatla 41:2389bd6b6f74 18 }
nyatla 41:2389bd6b6f74 19 void NyLPC_cHttpBodyParser_finalize(NyLPC_TcHttpBodyParser_t* i_inst)
nyatla 41:2389bd6b6f74 20 {
nyatla 41:2389bd6b6f74 21 NyLPC_cHttpBasicBodyParser_finalize(&i_inst->_super);
nyatla 41:2389bd6b6f74 22 }
nyatla 41:2389bd6b6f74 23
nyatla 41:2389bd6b6f74 24
nyatla 41:2389bd6b6f74 25 /**
nyatla 41:2389bd6b6f74 26 * @param i_out
nyatla 41:2389bd6b6f74 27 * 読み出したデータサイズ。戻り値trueの場合のみ有効。0の場合終端。
nyatla 41:2389bd6b6f74 28 * @return
nyatla 41:2389bd6b6f74 29 * エラーの発生状況
nyatla 41:2389bd6b6f74 30 */
nyatla 48:00d211aac2ec 31 NyLPC_TBool NyLPC_cHttpBodyParser_parseStream(NyLPC_TcHttpBodyParser_t* i_inst,NyLPC_TiHttpPtrStream_t* i_stream,NyLPC_TChar* i_buf,NyLPC_TInt16 i_buf_size,NyLPC_TInt16* i_out)
nyatla 41:2389bd6b6f74 32 {
nyatla 41:2389bd6b6f74 33 NyLPC_TcHttpBodyParser_t* inst=(NyLPC_TcHttpBodyParser_t*)i_inst;
nyatla 41:2389bd6b6f74 34 const char* rp_base;
nyatla 41:2389bd6b6f74 35 NyLPC_TInt32 rsize;
nyatla 41:2389bd6b6f74 36 inst->len=0;
nyatla 41:2389bd6b6f74 37 inst->buf_size=i_buf_size;
nyatla 41:2389bd6b6f74 38 inst->ref_buf=i_buf;
nyatla 41:2389bd6b6f74 39 if(i_inst->_super._status==NyLPC_TcHttpBasicBodyParser_ST_EOB){
nyatla 41:2389bd6b6f74 40 *i_out=0;
nyatla 41:2389bd6b6f74 41 return NyLPC_TBool_TRUE;
nyatla 41:2389bd6b6f74 42 }
nyatla 41:2389bd6b6f74 43 for(;;){
nyatla 41:2389bd6b6f74 44 //タイムアウト付でストリームから読み出し。
nyatla 58:03b89038b21a 45 rsize=NyLPC_iHttpPtrStream_pread(i_stream,(const void**)(&rp_base),HTTP_TIMEOUT);
nyatla 41:2389bd6b6f74 46 if(rsize<=0){
nyatla 41:2389bd6b6f74 47 //Read失敗
nyatla 41:2389bd6b6f74 48 return NyLPC_TBool_FALSE;
nyatla 41:2389bd6b6f74 49 }
nyatla 41:2389bd6b6f74 50 rsize=NyLPC_cHttpBasicBodyParser_parseChar(&i_inst->_super,rp_base,rsize);
nyatla 41:2389bd6b6f74 51 if(i_inst->_super._status==NyLPC_TcHttpBasicBodyParser_ST_ERROR){
nyatla 41:2389bd6b6f74 52 //パース失敗
nyatla 41:2389bd6b6f74 53 return NyLPC_TBool_FALSE;
nyatla 41:2389bd6b6f74 54 }
nyatla 41:2389bd6b6f74 55 NyLPC_iHttpPtrStream_rseek(i_stream,(NyLPC_TUInt16)rsize);
nyatla 41:2389bd6b6f74 56 *i_out=i_inst->len;
nyatla 41:2389bd6b6f74 57 return NyLPC_TBool_TRUE;
nyatla 41:2389bd6b6f74 58 }
nyatla 41:2389bd6b6f74 59 }