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_protected.h@114:f6aef16d4e60, 2016-06-04 (annotated)

Committer:
nyatla
Date:
Sat Jun 04 06:51:04 2016 +0000
Revision:
114:f6aef16d4e60
Parent:
110:257739f9b31e 
include????????; ???????????

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
nyatla 109:18f12ac01097 27 #ifndef NYLPC_CMIMICIPTCPSOCKET_PROTECTED_H_
nyatla 109:18f12ac01097 28 #define NYLPC_CMIMICIPTCPSOCKET_PROTECTED_H_
nyatla 109:18f12ac01097 29 #include "NyLPC_cMiMicIpTcpSocket.h"
nyatla 109:18f12ac01097 30 #include "../NyLPC_cIPv4Config.h"
nyatla 109:18f12ac01097 31 #include "NyLPC_cIPv4Payload_protected.h"
nyatla 109:18f12ac01097 32 #ifdef __cplusplus
nyatla 109:18f12ac01097 33 extern "C" {
nyatla 109:18f12ac01097 34 #endif /* __cplusplus */
nyatla 109:18f12ac01097 35
nyatla 109:18f12ac01097 36 /**********************************************************************
nyatla 109:18f12ac01097 37 * ステータス値の定義
nyatla 109:18f12ac01097 38 **********************************************************************/
nyatla 109:18f12ac01097 39 #define UIP_CLOSED 0
nyatla 109:18f12ac01097 40 #define UIP_SYN_RCVD 1
nyatla 109:18f12ac01097 41 #define UIP_SYN_SENT 2
nyatla 109:18f12ac01097 42 #define UIP_ESTABLISHED 3
nyatla 109:18f12ac01097 43 #define UIP_FIN_WAIT_1 4
nyatla 109:18f12ac01097 44 #define UIP_FIN_WAIT_2 5
nyatla 109:18f12ac01097 45 #define UIP_CLOSING 6
nyatla 109:18f12ac01097 46 #define UIP_TIME_WAIT 7
nyatla 109:18f12ac01097 47 #define UIP_CLOSE_WAIT 8
nyatla 109:18f12ac01097 48 #define UIP_LAST_ACK 9
nyatla 109:18f12ac01097 49
nyatla 109:18f12ac01097 50
nyatla 109:18f12ac01097 51
nyatla 109:18f12ac01097 52
nyatla 109:18f12ac01097 53
nyatla 109:18f12ac01097 54
nyatla 109:18f12ac01097 55
nyatla 109:18f12ac01097 56
nyatla 109:18f12ac01097 57 /**
nyatla 109:18f12ac01097 58 * パース結果をもとに、ソケットのuipconnectionを初期化します。
nyatla 109:18f12ac01097 59 * この関数は、cUipServiceからのみコールできます。
nyatla 109:18f12ac01097 60 */
nyatla 109:18f12ac01097 61 void NyLPC_cMiMicIpTcpSocket_initConnection(NyLPC_TcMiMicIpTcpSocket_t* i_inst,const NyLPC_TcIPv4Config_t* i_config,const NyLPC_TcIPv4Payload_t* i_ipp);
nyatla 109:18f12ac01097 62
nyatla 109:18f12ac01097 63 /**
nyatla 109:18f12ac01097 64 * TCPペイロードを処理して、応答パケットをペイロードに返します。
nyatla 109:18f12ac01097 65 * uipサービスタスクが実行する関数です。
nyatla 109:18f12ac01097 66 * @return
nyatla 109:18f12ac01097 67 * 応答パケットを格納したメモリブロックを返します。
nyatla 109:18f12ac01097 68 * このメモリは、NyLPC_cUipService_allocSysTxBuf関数で確保されたメモリです。
nyatla 109:18f12ac01097 69 */
nyatla 109:18f12ac01097 70 void* NyLPC_cMiMicIpTcpSocket_parseRx(
nyatla 109:18f12ac01097 71 NyLPC_TcMiMicIpTcpSocket_t* i_inst,
nyatla 109:18f12ac01097 72 const NyLPC_TcIPv4Payload_t* i_ipp);
nyatla 109:18f12ac01097 73
nyatla 109:18f12ac01097 74 /**
nyatla 109:18f12ac01097 75 * 定期的に実行する関数。最低でも1s単位で実行してください。
nyatla 109:18f12ac01097 76 * uipサービスタスクが実行する関数です。
nyatla 109:18f12ac01097 77 */
nyatla 109:18f12ac01097 78 void NyLPC_cMiMicIpTcpSocket_periodic(
nyatla 109:18f12ac01097 79 NyLPC_TcMiMicIpTcpSocket_t* i_inst);
nyatla 109:18f12ac01097 80
nyatla 109:18f12ac01097 81 /**
nyatla 109:18f12ac01097 82 * CLOSEステータスのソケットを、SYN情報の内容でSYNRECV状態にします。
nyatla 109:18f12ac01097 83 * この関数は、NyLPC_TcTcpListenerクラスからコールされます。
nyatla 109:18f12ac01097 84 * @return
nyatla 109:18f12ac01097 85 * 遷移に成功すると、TRUEを返します。
nyatla 109:18f12ac01097 86 */
nyatla 109:18f12ac01097 87 NyLPC_TBool NyLPC_cMiMicIpTcpSocket_listenSyn(NyLPC_TcMiMicIpTcpSocket_t* i_inst,const struct NyLPC_TTcpSocketSynParam* i_lq,NyLPC_TUInt16 i_lport);
nyatla 109:18f12ac01097 88
nyatla 109:18f12ac01097 89
nyatla 109:18f12ac01097 90 /**
nyatla 109:18f12ac01097 91 * uipサービスタスクが実行する関数です。
nyatla 109:18f12ac01097 92 * サービスの開始を通知します。
nyatla 109:18f12ac01097 93 * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。
nyatla 109:18f12ac01097 94 */
nyatla 109:18f12ac01097 95 void NyLPC_cMiMicIpTcpSocket_startService(NyLPC_TcMiMicIpTcpSocket_t* i_inst,const NyLPC_TcIPv4Config_t* i_config);
nyatla 109:18f12ac01097 96
nyatla 109:18f12ac01097 97 /**
nyatla 109:18f12ac01097 98 * uipサービスタスクが実行する関数です。
nyatla 109:18f12ac01097 99 * サービスの停止を通知します。
nyatla 109:18f12ac01097 100 * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。
nyatla 109:18f12ac01097 101 */
nyatla 109:18f12ac01097 102 void NyLPC_cMiMicIpTcpSocket_stopService(NyLPC_TcMiMicIpTcpSocket_t* i_inst);
nyatla 109:18f12ac01097 103
nyatla 109:18f12ac01097 104
nyatla 109:18f12ac01097 105 void* NyLPC_cMiMicIpTcpSocket_allocTcpReverseRstAck(
nyatla 109:18f12ac01097 106 const NyLPC_TcIPv4Payload_t* i_src);
nyatla 109:18f12ac01097 107
nyatla 110:257739f9b31e 108 /**
nyatla 110:257739f9b31e 109 * ローカルポートを返します。
nyatla 110:257739f9b31e 110 */
nyatla 110:257739f9b31e 111 #define NyLPC_cMiMicIpTcpSocket_getLocalPort(i) ((i)->uip_connr.lport)
nyatla 110:257739f9b31e 112 #define NyLPC_cMiMicIpTcpSocket_isClosed(i) ((i)->tcpstateflags==UIP_CLOSED)
nyatla 109:18f12ac01097 113 #ifdef __cplusplus
nyatla 109:18f12ac01097 114 }
nyatla 109:18f12ac01097 115 #endif /* __cplusplus */
nyatla 109:18f12ac01097 116
nyatla 109:18f12ac01097 117 #endif /* NYLPC_CTCPSOCKET_PROTECTED_H_ */