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/uip/NyLPC_cTcpSocket.h@12:efe841863fc8, 2013-04-20 (annotated)

Committer:
nyatla
Date:
Sat Apr 20 05:03:57 2013 +0000
Revision:
12:efe841863fc8
Parent:
2:b96c1e90d120
Child:
20:3b0b444b4deb
MiMic r218

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 0:142ee8b12fef 1 /*********************************************************************************
nyatla 0:142ee8b12fef 2 * PROJECT: MiMic
nyatla 0:142ee8b12fef 3 * --------------------------------------------------------------------------------
nyatla 0:142ee8b12fef 4 *
nyatla 0:142ee8b12fef 5 * This file is part of MiMic
nyatla 0:142ee8b12fef 6 * Copyright (C)2011 Ryo Iizuka
nyatla 0:142ee8b12fef 7 *
nyatla 0:142ee8b12fef 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 0:142ee8b12fef 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 0:142ee8b12fef 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 0:142ee8b12fef 11 * (at your option) any later version.
nyatla 0:142ee8b12fef 12 *
nyatla 0:142ee8b12fef 13 * This program is distributed in the hope that it will be useful,
nyatla 0:142ee8b12fef 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 0:142ee8b12fef 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 0:142ee8b12fef 16 * GNU General Public License for more details.
nyatla 0:142ee8b12fef 17 *
nyatla 0:142ee8b12fef 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 0:142ee8b12fef 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 0:142ee8b12fef 20 *
nyatla 0:142ee8b12fef 21 * For further information please contact.
nyatla 0:142ee8b12fef 22 * http://nyatla.jp/
nyatla 0:142ee8b12fef 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 0:142ee8b12fef 24 *
nyatla 0:142ee8b12fef 25 *********************************************************************************/
nyatla 0:142ee8b12fef 26 #ifndef NYLPC_CTCPSOCKET_H_
nyatla 0:142ee8b12fef 27 #define NYLPC_CTCPSOCKET_H_
nyatla 0:142ee8b12fef 28
nyatla 0:142ee8b12fef 29
nyatla 0:142ee8b12fef 30
nyatla 12:efe841863fc8 31 #include "NyLPC_cIPv4Payload.h"
nyatla 0:142ee8b12fef 32 #include "NyLPC_uip.h"
nyatla 12:efe841863fc8 33 #include "NyLPC_os.h"
nyatla 0:142ee8b12fef 34
nyatla 0:142ee8b12fef 35 #ifdef __cplusplus
nyatla 0:142ee8b12fef 36 extern "C" {
nyatla 0:142ee8b12fef 37 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 38
nyatla 0:142ee8b12fef 39
nyatla 0:142ee8b12fef 40 typedef struct NyLPC_TcTcpSocket NyLPC_TcTcpSocket_t;
nyatla 0:142ee8b12fef 41
nyatla 0:142ee8b12fef 42 /**
nyatla 0:142ee8b12fef 43 * TXキューの数。この値は8未満にしてください。
nyatla 0:142ee8b12fef 44 */
nyatla 0:142ee8b12fef 45 #define NyLPC_TcTcpSocket_NUMBER_OF_TXQ 4
nyatla 0:142ee8b12fef 46
nyatla 0:142ee8b12fef 47 struct NyLPC_TcTcpSocket_TxQItem
nyatla 0:142ee8b12fef 48 {
nyatla 0:142ee8b12fef 49 //最終更新時刻
nyatla 0:142ee8b12fef 50 NyLPC_TUInt32 tick_of_sent;
nyatla 0:142ee8b12fef 51 //このパケットのRTO(秒間隔)
nyatla 0:142ee8b12fef 52 NyLPC_TUInt32 rto32;
nyatla 0:142ee8b12fef 53 NyLPC_TcIPv4Payload_t data;
nyatla 0:142ee8b12fef 54 //パケットのACK番号。この番号を受信できれば、再送パケットは消去可能である。
nyatla 0:142ee8b12fef 55 NyLPC_TUInt32 ackno;
nyatla 0:142ee8b12fef 56 };
nyatla 0:142ee8b12fef 57
nyatla 0:142ee8b12fef 58 struct uip_conn
nyatla 0:142ee8b12fef 59 {
nyatla 0:142ee8b12fef 60 struct NyLPC_TIPv4Addr ripaddr; /**< The IP address of the remote host. */
nyatla 0:142ee8b12fef 61 const struct NyLPC_TIPv4Addr* lipaddr; /**< ローカルIP*/
nyatla 0:142ee8b12fef 62 NyLPC_TUInt16 lport; /**< The local TCP port, in network byte order. */
nyatla 0:142ee8b12fef 63 NyLPC_TUInt16 rport; /**< The local remote TCP port, in network byte order. */
nyatla 0:142ee8b12fef 64 NyLPC_TUInt32 rcv_nxt32; /**< The sequence number that we expect to receive next. */
nyatla 0:142ee8b12fef 65 NyLPC_TUInt32 snd_nxt32; /**< 送信用sqカウンター*/
nyatla 0:142ee8b12fef 66 NyLPC_TUInt16 peer_mss; /**< PeerのMSS*/
nyatla 0:142ee8b12fef 67 NyLPC_TUInt16 default_mss; /**< Peerの初期MMS*/
nyatla 0:142ee8b12fef 68 /**Peerのウインドウサイズ*/
nyatla 0:142ee8b12fef 69 NyLPC_TUInt16 peer_win;
nyatla 0:142ee8b12fef 70 NyLPC_TUInt16 _padding;
nyatla 0:142ee8b12fef 71 /**現在ソケットのRTO*/
nyatla 0:142ee8b12fef 72 NyLPC_TUInt32 current_rto32;
nyatla 0:142ee8b12fef 73 };
nyatla 0:142ee8b12fef 74
nyatla 0:142ee8b12fef 75
nyatla 0:142ee8b12fef 76
nyatla 0:142ee8b12fef 77
nyatla 0:142ee8b12fef 78
nyatla 0:142ee8b12fef 79
nyatla 0:142ee8b12fef 80
nyatla 0:142ee8b12fef 81
nyatla 0:142ee8b12fef 82 /**********************************************************************
nyatla 0:142ee8b12fef 83 *
nyatla 0:142ee8b12fef 84 * NyLPC_TcTcpSocket class
nyatla 0:142ee8b12fef 85 *
nyatla 0:142ee8b12fef 86 **********************************************************************/
nyatla 0:142ee8b12fef 87
nyatla 0:142ee8b12fef 88 /**
nyatla 0:142ee8b12fef 89 * uipサービスを使用したTCPソケットクラスです。
nyatla 0:142ee8b12fef 90 */
nyatla 0:142ee8b12fef 91
nyatla 0:142ee8b12fef 92 struct NyLPC_TcTcpSocket
nyatla 0:142ee8b12fef 93 {
nyatla 0:142ee8b12fef 94 //この変数は、uipタスクの実行する関数のみが変更する。
nyatla 0:142ee8b12fef 95 struct uip_conn uip_connr;
nyatla 0:142ee8b12fef 96 NyLPC_TcFifoBuffer_t rxbuf;
nyatla 0:142ee8b12fef 97 struct{
nyatla 0:142ee8b12fef 98 NyLPC_TUInt8 rp;
nyatla 0:142ee8b12fef 99 NyLPC_TUInt8 wp;
nyatla 0:142ee8b12fef 100 //送信キュー
nyatla 0:142ee8b12fef 101 struct NyLPC_TcTcpSocket_TxQItem txq[NyLPC_TcTcpSocket_NUMBER_OF_TXQ];
nyatla 0:142ee8b12fef 102 }txbuf;
nyatla 0:142ee8b12fef 103 volatile NyLPC_TUInt8 tcpstateflags; /**< TCP state and flags. */
nyatla 0:142ee8b12fef 104
nyatla 0:142ee8b12fef 105 NyLPC_TcMutex_t _smutex;
nyatla 0:142ee8b12fef 106 };
nyatla 0:142ee8b12fef 107
nyatla 0:142ee8b12fef 108 /**
nyatla 0:142ee8b12fef 109 * 初期化関数です。
nyatla 0:142ee8b12fef 110 * uipserviceは初期化済である必要があります。
nyatla 0:142ee8b12fef 111 * また、暫定条件として、サービスが停止中である必要もあります。
nyatla 0:142ee8b12fef 112 * @param i_recv_buf
nyatla 0:142ee8b12fef 113 * 受信バッファを指定します。
nyatla 0:142ee8b12fef 114 */
nyatla 0:142ee8b12fef 115 NyLPC_TBool NyLPC_cTcpSocket_initialize(NyLPC_TcTcpSocket_t* i_inst,void* i_rbuf,NyLPC_TUInt16 i_rbuf_len);
nyatla 0:142ee8b12fef 116 /**
nyatla 0:142ee8b12fef 117 * 終期化関数です。
nyatla 0:142ee8b12fef 118 * uipserviceは初期化済である必要があります。
nyatla 0:142ee8b12fef 119 * また、暫定条件として、サービスが停止中である必要もあります。
nyatla 0:142ee8b12fef 120 */
nyatla 2:b96c1e90d120 121 void NyLPC_cTcpSocket_finalize(NyLPC_TcTcpSocket_t* i_inst);
nyatla 0:142ee8b12fef 122
nyatla 0:142ee8b12fef 123 NyLPC_TBool NyLPC_cTcpSocket_accept(NyLPC_TcTcpSocket_t* i_inst,NyLPC_TUInt32 i_wait_in_msec);
nyatla 0:142ee8b12fef 124 NyLPC_TInt32 NyLPC_cTcpSocket_precv(NyLPC_TcTcpSocket_t* i_inst,const void** o_buf_ptr,NyLPC_TUInt32 i_wait_msec);
nyatla 0:142ee8b12fef 125 void NyLPC_cTcpSocket_pseek(NyLPC_TcTcpSocket_t* i_inst,NyLPC_TUInt16 i_seek);
nyatla 0:142ee8b12fef 126 /**
nyatla 0:142ee8b12fef 127 * 送信タイムアウトは、規定時間内にＡＣＫを受信できない場合であり、
nyatla 0:142ee8b12fef 128 * 送信未達は保障されません。
nyatla 0:142ee8b12fef 129 * エラーを検出したら、基本的にはソケットをクローズしてください。
nyatla 0:142ee8b12fef 130 * @param i_wait_msec
nyatla 0:142ee8b12fef 131 * ACKの合計待ち時間を指定します。現在は、RTT推定ができないため、TCPの再送を考慮して、最低でも10秒(10000)程度を指定してください。
nyatla 0:142ee8b12fef 132 * @return
nyatla 0:142ee8b12fef 133 * 送信したバイト数を返します。エラーならば0未満の数を返します。
nyatla 0:142ee8b12fef 134 *
nyatla 0:142ee8b12fef 135 */
nyatla 0:142ee8b12fef 136 NyLPC_TInt16 NyLPC_cTcpSocket_send(NyLPC_TcTcpSocket_t* i_inst,const void* i_buf_ptr,int i_len,NyLPC_TUInt32 i_wait_in_msec);
nyatla 0:142ee8b12fef 137 void NyLPC_cTcpSocket_close(NyLPC_TcTcpSocket_t* i_inst,NyLPC_TUInt32 i_wait_in_msec);
nyatla 0:142ee8b12fef 138
nyatla 0:142ee8b12fef 139
nyatla 0:142ee8b12fef 140 /**
nyatla 0:142ee8b12fef 141 * NyLPC_cTcpSocket_psendで送信するための送信バッファ準備します。
nyatla 0:142ee8b12fef 142 * @param i_hint
nyatla 0:142ee8b12fef 143 * 確保したいメモリブロックのサイズを指定します。
nyatla 0:142ee8b12fef 144 * アロケータは出来る限り希望に沿ってメモリを返します。
nyatla 0:142ee8b12fef 145 * @return
nyatla 0:142ee8b12fef 146 * 成功した場合、送信バッファを返します。
nyatla 0:142ee8b12fef 147 * アプリケーションは、可能な限り速やかにデータを書き込んで、NyLPC_cTcpSocket_psendをコールしてください。
nyatla 0:142ee8b12fef 148 */
nyatla 0:142ee8b12fef 149 void* NyLPC_cTcpSocket_allocSendBuf(NyLPC_TcTcpSocket_t* i_inst,NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_buf_size,NyLPC_TUInt32 i_wait_in_msec);
nyatla 0:142ee8b12fef 150
nyatla 0:142ee8b12fef 151 /**
nyatla 0:142ee8b12fef 152 * NyLPC_cTcpSocket_allocSendBufで確保したメモリを開放します。
nyatla 0:142ee8b12fef 153 */
nyatla 0:142ee8b12fef 154 void NyLPC_cTcpSocket_releaseSendBuf(NyLPC_TcTcpSocket_t* i_inst,void* i_buf_ptr);
nyatla 0:142ee8b12fef 155
nyatla 0:142ee8b12fef 156 /**
nyatla 0:142ee8b12fef 157 * 事前にAllocしたTxパケットを送信します。
nyatla 0:142ee8b12fef 158 * このAPIはゼロコピー送信をサポートするためのものです。
nyatla 0:142ee8b12fef 159 * @param i_buf_ptr
nyatla 0:142ee8b12fef 160 * allocSendBufで取得したメモリを指定します。
nyatla 0:142ee8b12fef 161 */
nyatla 0:142ee8b12fef 162 NyLPC_TBool NyLPC_cTcpSocket_psend(NyLPC_TcTcpSocket_t* i_inst,void* i_buf_ptr,int i_len,NyLPC_TUInt32 i_wait_in_msec);
nyatla 0:142ee8b12fef 163
nyatla 0:142ee8b12fef 164
nyatla 0:142ee8b12fef 165 #ifdef __cplusplus
nyatla 0:142ee8b12fef 166 }
nyatla 0:142ee8b12fef 167 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 168
nyatla 2:b96c1e90d120 169 #endif /* NYLPC_CTCPSOCKET_H_ */