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/netif/mimicip/NyLPC_cMiMicIpTcpSocket.h@110:257739f9b31e, 2015-03-15 (annotated)

Committer:
nyatla
Date:
Sun Mar 15 09:33:38 2015 +0000
Revision:
110:257739f9b31e
Parent:
109:18f12ac01097 
51d1c88c8a56d6295311cfd20aa197a9cd650b2d; ????; NetworkInterface???????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 109:18f12ac01097 1 /*********************************************************************************
nyatla 109:18f12ac01097 2 * PROJECT: MiMic
nyatla 109:18f12ac01097 3 * --------------------------------------------------------------------------------
nyatla 109:18f12ac01097 4 *
nyatla 109:18f12ac01097 5 * This file is part of MiMic
nyatla 109:18f12ac01097 6 * Copyright (C)2011 Ryo Iizuka
nyatla 109:18f12ac01097 7 *
nyatla 109:18f12ac01097 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 109:18f12ac01097 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 109:18f12ac01097 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 109:18f12ac01097 11 * (at your option) any later version.
nyatla 109:18f12ac01097 12 *
nyatla 109:18f12ac01097 13 * This program is distributed in the hope that it will be useful,
nyatla 109:18f12ac01097 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 109:18f12ac01097 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 109:18f12ac01097 16 * GNU General Public License for more details.
nyatla 109:18f12ac01097 17 *
nyatla 109:18f12ac01097 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 109:18f12ac01097 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 109:18f12ac01097 20 *
nyatla 109:18f12ac01097 21 * For further information please contact.
nyatla 109:18f12ac01097 22 * http://nyatla.jp/
nyatla 109:18f12ac01097 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 109:18f12ac01097 24 *
nyatla 109:18f12ac01097 25 *********************************************************************************/
nyatla 109:18f12ac01097 26 #ifndef NYLPC_CMIMICIPTCPSOCKET_H_
nyatla 109:18f12ac01097 27 #define NYLPC_CMIMICIPTCPSOCKET_H_
nyatla 109:18f12ac01097 28
nyatla 109:18f12ac01097 29
nyatla 109:18f12ac01097 30
nyatla 109:18f12ac01097 31 #include "NyLPC_os.h"
nyatla 109:18f12ac01097 32 #include "../NyLPC_NetIf_ip_types.h"
nyatla 109:18f12ac01097 33 #include "NyLPC_cIPv4Payload.h"
nyatla 110:257739f9b31e 34 #include "../NyLPC_iTcpSocket.h"
nyatla 110:257739f9b31e 35 #include "NyLPC_cIPv4.h"
nyatla 109:18f12ac01097 36
nyatla 109:18f12ac01097 37 #ifdef __cplusplus
nyatla 109:18f12ac01097 38 extern "C" {
nyatla 109:18f12ac01097 39 #endif /* __cplusplus */
nyatla 109:18f12ac01097 40
nyatla 109:18f12ac01097 41
nyatla 109:18f12ac01097 42 typedef struct NyLPC_TcMiMicIpTcpSocket NyLPC_TcMiMicIpTcpSocket_t;
nyatla 109:18f12ac01097 43
nyatla 109:18f12ac01097 44
nyatla 109:18f12ac01097 45 /**********************************************************************
nyatla 109:18f12ac01097 46 *
nyatla 109:18f12ac01097 47 * NyLPC_TTcpListenerSynInfo　struct
nyatla 109:18f12ac01097 48 *
nyatla 109:18f12ac01097 49 **********************************************************************/
nyatla 109:18f12ac01097 50
nyatla 109:18f12ac01097 51
nyatla 109:18f12ac01097 52 struct NyLPC_TTcpSocketSynParam
nyatla 109:18f12ac01097 53 {
nyatla 109:18f12ac01097 54 struct NyLPC_TIPv4Addr srcaddr;
nyatla 109:18f12ac01097 55 NyLPC_TUInt16 rport;
nyatla 109:18f12ac01097 56 NyLPC_TUInt16 mss;
nyatla 109:18f12ac01097 57 NyLPC_TUInt32 rcv_nxt32;
nyatla 109:18f12ac01097 58 };
nyatla 109:18f12ac01097 59
nyatla 109:18f12ac01097 60
nyatla 109:18f12ac01097 61 /**********************************************************************
nyatla 109:18f12ac01097 62 *
nyatla 109:18f12ac01097 63 * NyLPC_TcTcpSocket_TxQItem　struct
nyatla 109:18f12ac01097 64 *
nyatla 109:18f12ac01097 65 **********************************************************************/
nyatla 109:18f12ac01097 66
nyatla 109:18f12ac01097 67 /**
nyatla 109:18f12ac01097 68 * TXキューの数。この値は8未満にしてください。
nyatla 109:18f12ac01097 69 */
nyatla 109:18f12ac01097 70 #define NyLPC_TcTcpSocket_NUMBER_OF_TXQ 4
nyatla 109:18f12ac01097 71
nyatla 109:18f12ac01097 72 struct NyLPC_TcTcpSocket_TxQItem
nyatla 109:18f12ac01097 73 {
nyatla 109:18f12ac01097 74 //最終更新時刻
nyatla 109:18f12ac01097 75 NyLPC_TUInt32 tick_of_sent;
nyatla 109:18f12ac01097 76 //このパケットのRTO(秒間隔)
nyatla 109:18f12ac01097 77 NyLPC_TUInt32 rto32;
nyatla 109:18f12ac01097 78 void* packet;
nyatla 109:18f12ac01097 79 //パケットのACK番号。この番号を受信できれば、再送パケットは消去可能である。
nyatla 109:18f12ac01097 80 NyLPC_TUInt32 ackno;
nyatla 109:18f12ac01097 81 };
nyatla 109:18f12ac01097 82
nyatla 109:18f12ac01097 83 /**********************************************************************
nyatla 109:18f12ac01097 84 *
nyatla 109:18f12ac01097 85 * uip_conn　struct
nyatla 109:18f12ac01097 86 *
nyatla 109:18f12ac01097 87 **********************************************************************/
nyatla 109:18f12ac01097 88
nyatla 109:18f12ac01097 89 struct uip_conn
nyatla 109:18f12ac01097 90 {
nyatla 109:18f12ac01097 91 struct NyLPC_TIPv4Addr ripaddr; /**< The IP address of the remote host. */
nyatla 109:18f12ac01097 92 const struct NyLPC_TIPv4Addr* lipaddr; /**< ローカルIP*/
nyatla 109:18f12ac01097 93 NyLPC_TUInt16 lport; /**< The local TCP port, in network byte order. */
nyatla 109:18f12ac01097 94 NyLPC_TUInt16 rport; /**< The local remote TCP port, in network byte order. */
nyatla 109:18f12ac01097 95 NyLPC_TUInt32 rcv_nxt32; /**< The sequence number that we expect to receive next. */
nyatla 109:18f12ac01097 96 NyLPC_TUInt32 snd_nxt32; /**< 送信用sqカウンター*/
nyatla 109:18f12ac01097 97 NyLPC_TUInt16 peer_mss; /**< PeerのMSS*/
nyatla 109:18f12ac01097 98 NyLPC_TUInt16 default_mss; /**< Peerの初期MMS*/
nyatla 109:18f12ac01097 99 /**Peerのウインドウサイズ*/
nyatla 109:18f12ac01097 100 NyLPC_TUInt16 peer_win;
nyatla 109:18f12ac01097 101 NyLPC_TUInt16 _padding;
nyatla 109:18f12ac01097 102 /**現在ソケットのRTO*/
nyatla 109:18f12ac01097 103 NyLPC_TUInt32 current_rto32;
nyatla 109:18f12ac01097 104 };
nyatla 109:18f12ac01097 105
nyatla 109:18f12ac01097 106
nyatla 109:18f12ac01097 107
nyatla 109:18f12ac01097 108
nyatla 109:18f12ac01097 109
nyatla 109:18f12ac01097 110
nyatla 109:18f12ac01097 111
nyatla 109:18f12ac01097 112
nyatla 109:18f12ac01097 113 /**********************************************************************
nyatla 109:18f12ac01097 114 *
nyatla 109:18f12ac01097 115 * NyLPC_TcTcpSocket class
nyatla 109:18f12ac01097 116 *
nyatla 109:18f12ac01097 117 **********************************************************************/
nyatla 109:18f12ac01097 118
nyatla 109:18f12ac01097 119 /**
nyatla 109:18f12ac01097 120 * uipサービスを使用したTCPソケットクラスです。
nyatla 109:18f12ac01097 121 * この関数は2つのタスクから呼び出されます。
nyatla 109:18f12ac01097 122 * [uipTask] -> [cTcpSocket] <- [Application]
nyatla 109:18f12ac01097 123 * ApplicationとuipTaskとの間での排他処理はインスタンスで制御されています。
nyatla 109:18f12ac01097 124 * Application側からのコールは内部でuipTaskとの間で排他処理を実行します。
nyatla 109:18f12ac01097 125 * Application側からのコールはリエントラントではありません。
nyatla 109:18f12ac01097 126 */
nyatla 109:18f12ac01097 127
nyatla 109:18f12ac01097 128 struct NyLPC_TcMiMicIpTcpSocket
nyatla 109:18f12ac01097 129 {
nyatla 110:257739f9b31e 130 struct NyLPC_TiTcpSocket _super;
nyatla 110:257739f9b31e 131 NyLPC_TcIPv4_t* _parent_ipv4;
nyatla 110:257739f9b31e 132 //この変数は、uipタスクの実行する関数のみが変更する。
nyatla 109:18f12ac01097 133 struct uip_conn uip_connr;
nyatla 109:18f12ac01097 134 NyLPC_TcFifoBuffer_t rxbuf;
nyatla 109:18f12ac01097 135 struct{
nyatla 109:18f12ac01097 136 NyLPC_TUInt8 rp;
nyatla 109:18f12ac01097 137 NyLPC_TUInt8 wp;
nyatla 109:18f12ac01097 138 //送信キュー
nyatla 109:18f12ac01097 139 struct NyLPC_TcTcpSocket_TxQItem txq[NyLPC_TcTcpSocket_NUMBER_OF_TXQ];
nyatla 109:18f12ac01097 140 }txbuf;
nyatla 109:18f12ac01097 141 volatile NyLPC_TUInt8 tcpstateflags; /**< TCP state and flags. */
nyatla 109:18f12ac01097 142 };
nyatla 109:18f12ac01097 143
nyatla 109:18f12ac01097 144 NyLPC_TBool NyLPC_cMiMicIpTcpSocket_initialize(NyLPC_TcMiMicIpTcpSocket_t* i_inst,void* i_rbuf,NyLPC_TUInt16 i_rbuf_len);
nyatla 109:18f12ac01097 145
nyatla 109:18f12ac01097 146
nyatla 109:18f12ac01097 147 #ifdef __cplusplus
nyatla 109:18f12ac01097 148 }
nyatla 109:18f12ac01097 149 #endif /* __cplusplus */
nyatla 109:18f12ac01097 150
nyatla 109:18f12ac01097 151 #endif /* NYLPC_CTCPSOCKET_H_ */