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_iHttpPtrStream.h@63:157ee3202edb, 2013-10-18 (annotated)

Committer:
nyatla
Date:
Fri Oct 18 12:40:09 2013 +0000
Revision:
63:157ee3202edb
Parent:
58:03b89038b21a 
update core to t338; bugfix; 1.Ethernet driver setting, descripter setting; 2.TCP socket close sequence; 3.HTTP stream

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 1:9f6a78395432 1 /*********************************************************************************
nyatla 1:9f6a78395432 2 * PROJECT: MiMic
nyatla 1:9f6a78395432 3 * --------------------------------------------------------------------------------
nyatla 1:9f6a78395432 4 *
nyatla 1:9f6a78395432 5 * This file is part of MiMic
nyatla 1:9f6a78395432 6 * Copyright (C)2011 Ryo Iizuka
nyatla 1:9f6a78395432 7 *
nyatla 1:9f6a78395432 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 1:9f6a78395432 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 1:9f6a78395432 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 1:9f6a78395432 11 * (at your option) any later version.
nyatla 1:9f6a78395432 12 *
nyatla 1:9f6a78395432 13 * This program is distributed in the hope that it will be useful,
nyatla 1:9f6a78395432 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 1:9f6a78395432 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 1:9f6a78395432 16 * GNU General Public License for more details.
nyatla 1:9f6a78395432 17 *
nyatla 1:9f6a78395432 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 1:9f6a78395432 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 1:9f6a78395432 20 *
nyatla 1:9f6a78395432 21 * For further information please contact.
nyatla 1:9f6a78395432 22 * http://nyatla.jp/
nyatla 1:9f6a78395432 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 1:9f6a78395432 24 *
nyatla 1:9f6a78395432 25 *********************************************************************************/
nyatla 1:9f6a78395432 26 #ifndef NyLPC_TiHttpPtrStream_H_
nyatla 1:9f6a78395432 27 #define NyLPC_TiHttpPtrStream_H_
nyatla 1:9f6a78395432 28
nyatla 1:9f6a78395432 29 /**********************************************************************
nyatla 1:9f6a78395432 30 *
nyatla 1:9f6a78395432 31 * NyLPC_TiHttpPtrStream class
nyatla 1:9f6a78395432 32 *
nyatla 1:9f6a78395432 33 **********************************************************************/
nyatla 1:9f6a78395432 34 #include "NyLPC_stdlib.h"
nyatla 1:9f6a78395432 35
nyatla 1:9f6a78395432 36 #ifdef __cplusplus
nyatla 1:9f6a78395432 37 extern "C" {
nyatla 1:9f6a78395432 38 #endif /* __cplusplus */
nyatla 1:9f6a78395432 39
nyatla 1:9f6a78395432 40 /**
nyatla 1:9f6a78395432 41 * Httpストリームのインタフェイス。
nyatla 1:9f6a78395432 42 */
nyatla 1:9f6a78395432 43 typedef struct NyLPC_TiHttpPtrStream NyLPC_TiHttpPtrStream_t;
nyatla 1:9f6a78395432 44
nyatla 1:9f6a78395432 45 /**
nyatla 1:9f6a78395432 46 * ストリームのエンコーディングモード
nyatla 1:9f6a78395432 47 */
nyatla 1:9f6a78395432 48 typedef NyLPC_TUInt8 NyLPC_TiHttpPtrStream_ET;
nyatla 1:9f6a78395432 49 #define NyLPC_TiHttpPtrStream_ET_NONE 0x00
nyatla 1:9f6a78395432 50 #define NyLPC_TiHttpPtrStream_ET_CHUNKED 0x01
nyatla 1:9f6a78395432 51
nyatla 58:03b89038b21a 52 /**
nyatla 58:03b89038b21a 53 * HTTP通信タイムアウトのデフォルト値
nyatla 58:03b89038b21a 54 */
nyatla 63:157ee3202edb 55 #define NyLPC_TiHttpPtrStream_DEFAULT_HTTP_TIMEOUT (8*1000)
nyatla 1:9f6a78395432 56
nyatla 58:03b89038b21a 57
nyatla 58:03b89038b21a 58 typedef NyLPC_TInt32 (*NyLPC_TiHttpPtrStream_pread)(void* i_inst,const void** o_buf_ptr,NyLPC_TUInt32 i_timeout);
nyatla 1:9f6a78395432 59 typedef NyLPC_TBool (*NyLPC_TiHttpPtrStream_write)(void* i_inst,const void* i_data,NyLPC_TInt32 i_length);
nyatla 1:9f6a78395432 60 typedef void (*NyLPC_TiHttpPtrStream_rseek)(void* i_inst,NyLPC_TUInt16 i_seek);
nyatla 1:9f6a78395432 61 typedef NyLPC_TBool (*NyLPC_TiHttpPtrStream_flush)(void* i_inst);
nyatla 1:9f6a78395432 62 typedef void (*NyLPC_TiHttpPtrStream_setReadEncoding)(void* i_inst,NyLPC_TiHttpPtrStream_ET i_et);
nyatla 1:9f6a78395432 63 typedef void (*NyLPC_TiHttpPtrStream_setWriteEncoding)(void* i_inst,NyLPC_TiHttpPtrStream_ET i_et);
nyatla 1:9f6a78395432 64
nyatla 1:9f6a78395432 65 /**
nyatla 1:9f6a78395432 66 * _interface_httpptrstreamで宣言してください。
nyatla 1:9f6a78395432 67 */
nyatla 1:9f6a78395432 68 struct NyLPC_TiHttpPtrStream_TInterface
nyatla 1:9f6a78395432 69 {
nyatla 1:9f6a78395432 70 NyLPC_TiHttpPtrStream_pread pread;
nyatla 1:9f6a78395432 71 NyLPC_TiHttpPtrStream_write write;
nyatla 1:9f6a78395432 72 NyLPC_TiHttpPtrStream_rseek readSeek;
nyatla 1:9f6a78395432 73 NyLPC_TiHttpPtrStream_flush flush;
nyatla 1:9f6a78395432 74 NyLPC_TiHttpPtrStream_setReadEncoding setreadencoding;
nyatla 1:9f6a78395432 75 NyLPC_TiHttpPtrStream_setWriteEncoding setwriteencoding;
nyatla 1:9f6a78395432 76 };
nyatla 48:00d211aac2ec 77 struct NyLPC_TiHttpPtrStream
nyatla 48:00d211aac2ec 78 {
nyatla 48:00d211aac2ec 79 /**
nyatla 48:00d211aac2ec 80 * 継承クラスで実装すべきハンドラ
nyatla 48:00d211aac2ec 81 */
nyatla 48:00d211aac2ec 82 const struct NyLPC_TiHttpPtrStream_TInterface* absfunc;
nyatla 48:00d211aac2ec 83 };
nyatla 1:9f6a78395432 84
nyatla 1:9f6a78395432 85 /**
nyatla 1:9f6a78395432 86 * ストリームからデータを読み出して、そのポインタを返します。
nyatla 1:9f6a78395432 87 * @return
nyatla 1:9f6a78395432 88 * ストリームから読み込んだデータサイズを返します。
nyatla 1:9f6a78395432 89 * 0の場合はタイムアウトです。
nyatla 1:9f6a78395432 90 * 0未満の場合はエラーです。
nyatla 1:9f6a78395432 91 */
nyatla 58:03b89038b21a 92 #define NyLPC_iHttpPtrStream_pread(i_inst,o_buf_ptr,i_timeout) (i_inst)->absfunc->pread((i_inst),(o_buf_ptr),i_timeout)
nyatla 1:9f6a78395432 93 /**
nyatla 1:9f6a78395432 94 * ストリームへデータを書き込みます。
nyatla 1:9f6a78395432 95 * @param i_length
nyatla 1:9f6a78395432 96 * i_dataのデータ長を指定します。-1の場合、strlenを実行します。
nyatla 1:9f6a78395432 97 * @return
nyatla 1:9f6a78395432 98 * 規定時間内にストリームへの書き込みが完了すると、TRUEを返します。
nyatla 1:9f6a78395432 99 */
nyatla 48:00d211aac2ec 100 #define NyLPC_iHttpPtrStream_write(i_inst,i_data,i_length) (i_inst)->absfunc->write((i_inst),i_data,i_length)
nyatla 48:00d211aac2ec 101 #define NyLPC_iHttpPtrStream_rseek(i_inst,i_seek) (i_inst)->absfunc->readSeek((i_inst),(i_seek))
nyatla 1:9f6a78395432 102 /**
nyatla 1:9f6a78395432 103 * バッファに残っているデータを送信し、空にします。
nyatla 1:9f6a78395432 104 */
nyatla 48:00d211aac2ec 105 #define NyLPC_iHttpPtrStream_flush(i_inst) (i_inst)->absfunc->flush(i_inst)
nyatla 48:00d211aac2ec 106
nyatla 48:00d211aac2ec 107 /**
nyatla 48:00d211aac2ec 108 * 読み出しエンコーディングの設定。
nyatla 48:00d211aac2ec 109 * この関数は削除するかもしれない。使用しないこと。
nyatla 48:00d211aac2ec 110 * @bug 関数が非対称。cHttpBasicBodyParserがチャンク読み出し処理を肩代わりしている?
nyatla 48:00d211aac2ec 111 */
nyatla 48:00d211aac2ec 112 #define NyLPC_iHttpPtrStream_setReadEncoding(i_inst,i_et) (i_inst)->absfunc->setreadencoding((i_inst),i_et)
nyatla 48:00d211aac2ec 113 /**
nyatla 48:00d211aac2ec 114 * 書込みエンコーディングの設定。
nyatla 48:00d211aac2ec 115 */
nyatla 48:00d211aac2ec 116 #define NyLPC_iHttpPtrStream_setWriteEncoding(i_inst,i_et) (i_inst)->absfunc->setwriteencoding((i_inst),i_et)
nyatla 1:9f6a78395432 117
nyatla 1:9f6a78395432 118 #ifdef __cplusplus
nyatla 1:9f6a78395432 119 }
nyatla 1:9f6a78395432 120 #endif /* __cplusplus */
nyatla 1:9f6a78395432 121
nyatla 1:9f6a78395432 122 #endif /* NyLPC_TiHttpPtrStream_H_ */