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_cHttpBasicBodyParser.h@41:2389bd6b6f74, 2013-06-30 (annotated)

Committer:
nyatla
Date:
Sun Jun 30 14:17:42 2013 +0000
Revision:
41:2389bd6b6f74
update core r270;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 41:2389bd6b6f74 1 /*********************************************************************************
nyatla 41:2389bd6b6f74 2 * PROJECT: MiMic
nyatla 41:2389bd6b6f74 3 * --------------------------------------------------------------------------------
nyatla 41:2389bd6b6f74 4 *
nyatla 41:2389bd6b6f74 5 * This file is part of MiMic
nyatla 41:2389bd6b6f74 6 * Copyright (C)2011 Ryo Iizuka
nyatla 41:2389bd6b6f74 7 *
nyatla 41:2389bd6b6f74 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 41:2389bd6b6f74 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 41:2389bd6b6f74 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 41:2389bd6b6f74 11 * (at your option) any later version.
nyatla 41:2389bd6b6f74 12 *
nyatla 41:2389bd6b6f74 13 * This program is distributed in the hope that it will be useful,
nyatla 41:2389bd6b6f74 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 41:2389bd6b6f74 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 41:2389bd6b6f74 16 * GNU General Public License for more details.
nyatla 41:2389bd6b6f74 17 *
nyatla 41:2389bd6b6f74 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 41:2389bd6b6f74 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 41:2389bd6b6f74 20 *
nyatla 41:2389bd6b6f74 21 * For further information please contact.
nyatla 41:2389bd6b6f74 22 * http://nyatla.jp/
nyatla 41:2389bd6b6f74 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 41:2389bd6b6f74 24 *
nyatla 41:2389bd6b6f74 25 *********************************************************************************/
nyatla 41:2389bd6b6f74 26
nyatla 41:2389bd6b6f74 27 #ifndef NyLPC_TcHttpBasicBodyParser_H
nyatla 41:2389bd6b6f74 28 #define NyLPC_TcHttpBasicBodyParser_H
nyatla 41:2389bd6b6f74 29 #include "NyLPC_stdlib.h"
nyatla 41:2389bd6b6f74 30 #include "NyLPC_cHttpStream.h"
nyatla 41:2389bd6b6f74 31 #include "NyLPC_cHttpBasicHeaderParser.h"
nyatla 41:2389bd6b6f74 32 #ifdef __cplusplus
nyatla 41:2389bd6b6f74 33 extern "C" {
nyatla 41:2389bd6b6f74 34 #endif /* __cplusplus */
nyatla 41:2389bd6b6f74 35
nyatla 41:2389bd6b6f74 36
nyatla 41:2389bd6b6f74 37
nyatla 41:2389bd6b6f74 38
nyatla 41:2389bd6b6f74 39
nyatla 41:2389bd6b6f74 40 /**
nyatla 41:2389bd6b6f74 41 * このクラスは、HttpBodyのパーサを定義します。
nyatla 41:2389bd6b6f74 42 * BasicBodyParserは結果値をコールバック関数で通知します。
nyatla 41:2389bd6b6f74 43 */
nyatla 41:2389bd6b6f74 44 typedef struct NyLPC_TcHttpBasicBodyParser NyLPC_TcHttpBasicBodyParser_t;
nyatla 41:2389bd6b6f74 45
nyatla 41:2389bd6b6f74 46 /**
nyatla 41:2389bd6b6f74 47 * BodyParserのステータス定義値。
nyatla 41:2389bd6b6f74 48 */
nyatla 41:2389bd6b6f74 49 typedef NyLPC_TUInt8 NyLPC_TcHttpBasicBodyParser_ST;
nyatla 41:2389bd6b6f74 50 #define NyLPC_TcHttpBasicBodyParser_ST_CHUNK_HEADER_START ((NyLPC_TcHttpBasicBodyParser_ST)0x11)//ヘッダ解析待ち
nyatla 41:2389bd6b6f74 51 #define NyLPC_TcHttpBasicBodyParser_ST_CHUNK_HEADER_SP ((NyLPC_TcHttpBasicBodyParser_ST)0x12)//ヘッダ解析中
nyatla 41:2389bd6b6f74 52 #define NyLPC_TcHttpBasicBodyParser_ST_CHUNK_HEADER_EXT ((NyLPC_TcHttpBasicBodyParser_ST)0x13)//ヘッダ解析中
nyatla 41:2389bd6b6f74 53 #define NyLPC_TcHttpBasicBodyParser_ST_CHUNK_BODY ((NyLPC_TcHttpBasicBodyParser_ST)0x14)//フッタ解析中
nyatla 41:2389bd6b6f74 54 #define NyLPC_TcHttpBasicBodyParser_ST_CHUNK_FOOTER ((NyLPC_TcHttpBasicBodyParser_ST)0x15)//フッタ解析中
nyatla 41:2389bd6b6f74 55 #define NyLPC_TcHttpBasicBodyParser_ST_CHUNK_END ((NyLPC_TcHttpBasicBodyParser_ST)0x16)//フッタ解析中
nyatla 41:2389bd6b6f74 56 #define NyLPC_TcHttpBasicBodyParser_ST_BODY ((NyLPC_TcHttpBasicBodyParser_ST)0x17)//BODYパース中
nyatla 41:2389bd6b6f74 57 #define NyLPC_TcHttpBasicBodyParser_ST_EOB ((NyLPC_TcHttpBasicBodyParser_ST)0x7F)//BODY確定
nyatla 41:2389bd6b6f74 58 #define NyLPC_TcHttpBasicBodyParser_ST_ERROR ((NyLPC_TcHttpBasicBodyParser_ST)0x80)//終わり
nyatla 41:2389bd6b6f74 59 #define NyLPC_TcHttpBasicBodyParser_ST_NULL ((NyLPC_TcHttpBasicBodyParser_ST)0x00)//初期状態
nyatla 41:2389bd6b6f74 60
nyatla 41:2389bd6b6f74 61
nyatla 41:2389bd6b6f74 62 #define NyLPC_TcHttpBasicBodyParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicBodyParser_ST_ERROR)
nyatla 41:2389bd6b6f74 63
nyatla 41:2389bd6b6f74 64
nyatla 41:2389bd6b6f74 65 /**
nyatla 41:2389bd6b6f74 66 * parserのHandler
nyatla 41:2389bd6b6f74 67 */
nyatla 41:2389bd6b6f74 68 typedef NyLPC_TBool (*NyLPC_TcHttpBasicBodyParser_bodyHandler) (NyLPC_TcHttpBasicBodyParser_t* i_inst,NyLPC_TChar i_c);
nyatla 41:2389bd6b6f74 69
nyatla 41:2389bd6b6f74 70 struct NyLPC_TcHttpBasicBodyParser_Handler
nyatla 41:2389bd6b6f74 71 {
nyatla 41:2389bd6b6f74 72 NyLPC_TcHttpBasicBodyParser_bodyHandler bodyHandler;
nyatla 41:2389bd6b6f74 73 };
nyatla 41:2389bd6b6f74 74
nyatla 41:2389bd6b6f74 75
nyatla 41:2389bd6b6f74 76
nyatla 41:2389bd6b6f74 77
nyatla 41:2389bd6b6f74 78 /**
nyatla 41:2389bd6b6f74 79 * クラス構造体
nyatla 41:2389bd6b6f74 80 */
nyatla 41:2389bd6b6f74 81 struct NyLPC_TcHttpBasicBodyParser
nyatla 41:2389bd6b6f74 82 {
nyatla 41:2389bd6b6f74 83 NyLPC_THttpMessgeHeader_TransferEncoding _encode_type;
nyatla 41:2389bd6b6f74 84 NyLPC_TcHttpBasicBodyParser_ST _status;
nyatla 41:2389bd6b6f74 85 union{
nyatla 41:2389bd6b6f74 86 struct{
nyatla 41:2389bd6b6f74 87 int recv_len;
nyatla 41:2389bd6b6f74 88 }chunked;
nyatla 41:2389bd6b6f74 89 struct{
nyatla 41:2389bd6b6f74 90 NyLPC_TUInt32 content_length;
nyatla 41:2389bd6b6f74 91 }normal;
nyatla 41:2389bd6b6f74 92 }_data;
nyatla 41:2389bd6b6f74 93 struct NyLPC_TcHttpBasicBodyParser_Handler* _handler;
nyatla 41:2389bd6b6f74 94 };
nyatla 41:2389bd6b6f74 95
nyatla 41:2389bd6b6f74 96
nyatla 41:2389bd6b6f74 97 void NyLPC_cHttpBasicBodyParser_initialize(NyLPC_TcHttpBasicBodyParser_t* i_inst,struct NyLPC_TcHttpBasicBodyParser_Handler* i_handler);
nyatla 41:2389bd6b6f74 98 #define NyLPC_cHttpBasicBodyParser_finalize(i_inst)
nyatla 41:2389bd6b6f74 99 #define NyLPC_cHttpBasicBodyParser_getState(i_v) ((i_v)->_status)
nyatla 41:2389bd6b6f74 100
nyatla 41:2389bd6b6f74 101 /**
nyatla 41:2389bd6b6f74 102 * パーサの開始処理をします。
nyatla 41:2389bd6b6f74 103 * 関数は、parseInit->parseChar[n回]->(parseStream)->parseFinishの順でコールします。
nyatla 41:2389bd6b6f74 104 * parseChar、又はparseStreamでエラーが発生した場合は、後続の関数を呼び出すことは出来ません。
nyatla 41:2389bd6b6f74 105 * parseCharでEOHに達した場合、parseCharまたはparseStreamを続けて呼ぶことは出来ません。
nyatla 41:2389bd6b6f74 106 * parseFinishはparseCharまたはparseStreamでEOHに達した場合のみ呼び出すことが出来ます。
nyatla 41:2389bd6b6f74 107 */
nyatla 41:2389bd6b6f74 108 void NyLPC_cHttpBasicBodyParser_parseInit(NyLPC_TcHttpBasicBodyParser_t* i_instt,const struct NyLPC_THttpBasicHeader* i_info);
nyatla 41:2389bd6b6f74 109
nyatla 41:2389bd6b6f74 110 /**
nyatla 41:2389bd6b6f74 111 * パーサの処理を閉じます。
nyatla 41:2389bd6b6f74 112 * @return
nyatla 41:2389bd6b6f74 113 * パース処理が正常に終了したかの真偽値
nyatla 41:2389bd6b6f74 114 */
nyatla 41:2389bd6b6f74 115 NyLPC_TBool NyLPC_cHttpBasicBodyParser_parseFinish(NyLPC_TcHttpBasicBodyParser_t* i_inst);
nyatla 41:2389bd6b6f74 116
nyatla 41:2389bd6b6f74 117 /**
nyatla 41:2389bd6b6f74 118 * HTTPストリームをパースします。
nyatla 41:2389bd6b6f74 119 * @return
nyatla 41:2389bd6b6f74 120 */
nyatla 41:2389bd6b6f74 121 NyLPC_TInt32 NyLPC_cHttpBasicBodyParser_parseChar(NyLPC_TcHttpBasicBodyParser_t* i_inst,const NyLPC_TChar* i_c,NyLPC_TInt32 i_size);
nyatla 41:2389bd6b6f74 122
nyatla 41:2389bd6b6f74 123
nyatla 41:2389bd6b6f74 124 /**
nyatla 41:2389bd6b6f74 125 * ストリームから読み出して、EOHに達するまでパースします。
nyatla 41:2389bd6b6f74 126 * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。
nyatla 41:2389bd6b6f74 127 * @return
nyatla 41:2389bd6b6f74 128 * 処理が正常に終了したかを返します。
nyatla 41:2389bd6b6f74 129 * TRUEの場合、ステータスはEOHに達しています。(parseFinishをコールできます。)
nyatla 41:2389bd6b6f74 130 */
nyatla 41:2389bd6b6f74 131 //NyLPC_TcHttpBasicBodyParser_ST NyLPC_cHttpBasicHeaderParser_parseStream(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,NyLPC_TChar* i_buf,NyLPC_TUInt16 i_buf_size,NyLPC_TUInt16 i_out_size);
nyatla 41:2389bd6b6f74 132
nyatla 41:2389bd6b6f74 133 #ifdef __cplusplus
nyatla 41:2389bd6b6f74 134 }
nyatla 41:2389bd6b6f74 135 #endif /* __cplusplus */
nyatla 41:2389bd6b6f74 136
nyatla 41:2389bd6b6f74 137 #endif