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_cMiMicIpNetIf_protected.h@109:18f12ac01097, 2014-11-19 (annotated)

Committer:
nyatla
Date:
Wed Nov 19 14:45:17 2014 +0000
Revision:
109:18f12ac01097
Child:
110:257739f9b31e
new MiMicIP API;

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_MiMicIpNetIf_protected_H
nyatla 109:18f12ac01097 28 #define NyLPC_MiMicIpNetIf_protected_H
nyatla 109:18f12ac01097 29 #include "NyLPC_cMiMicIpNetIf.h"
nyatla 109:18f12ac01097 30 #include "NyLPC_os.h"
nyatla 109:18f12ac01097 31 #include "NyLPC_cIPv4Arp.h"
nyatla 109:18f12ac01097 32 #include "NyLPC_cIPv4.h"
nyatla 109:18f12ac01097 33 #include "NyLPC_cIPv4IComp.h"
nyatla 109:18f12ac01097 34 #include "../driver/ethernet/EthDev.h"
nyatla 109:18f12ac01097 35 #include "NyLPC_cMiMicIpTcpSocket.h"
nyatla 109:18f12ac01097 36 #include "NyLPC_cMiMicIpUdpSocket.h"
nyatla 109:18f12ac01097 37 #include "NyLPC_cMiMicIpTcpListener.h"
nyatla 109:18f12ac01097 38
nyatla 109:18f12ac01097 39 /**********************************************************************
nyatla 109:18f12ac01097 40 *
nyatla 109:18f12ac01097 41 * NyLPC_TcUipService_t
nyatla 109:18f12ac01097 42 *
nyatla 109:18f12ac01097 43 **********************************************************************/
nyatla 109:18f12ac01097 44 #ifdef __cplusplus
nyatla 109:18f12ac01097 45 extern "C" {
nyatla 109:18f12ac01097 46 #endif /* __cplusplus */
nyatla 109:18f12ac01097 47
nyatla 109:18f12ac01097 48 //#define NyLPC_TcUipService_SIZE_OF_REPLY_BUF 128
nyatla 109:18f12ac01097 49
nyatla 109:18f12ac01097 50
nyatla 109:18f12ac01097 51
nyatla 109:18f12ac01097 52 struct NyLPC_TcMiMicIpNetIf
nyatla 109:18f12ac01097 53 {
nyatla 109:18f12ac01097 54 volatile NyLPC_TUInt16 _status; /**< ステータスビット*/
nyatla 109:18f12ac01097 55 NyLPC_TcSemaphore_t _emac_semapho; /** EMACの制御用セマフォです。*/
nyatla 109:18f12ac01097 56 NyLPC_TcStopwatch_t _arp_sw; /**<ARP用のストップウォッチ*/
nyatla 109:18f12ac01097 57 NyLPC_TcStopwatch_t _periodic_sw; /**<周期実行用のストップウォッチ*/
nyatla 109:18f12ac01097 58 /** ARP処理インスタンス*/
nyatla 109:18f12ac01097 59 NyLPC_TcIPv4Arp_t _arp;
nyatla 109:18f12ac01097 60 /** TCPv4処理インスタンス*/
nyatla 109:18f12ac01097 61 NyLPC_TcIPv4_t _tcpv4;
nyatla 109:18f12ac01097 62 /** ICOMP処理インスタンス*/
nyatla 109:18f12ac01097 63 NyLPC_TcIPv4IComp_t _icomp;
nyatla 109:18f12ac01097 64 /** (Ethernetメモリ排他制御用)*/
nyatla 109:18f12ac01097 65 NyLPC_TcMutex_t _mutex;
nyatla 109:18f12ac01097 66 const struct TiEthernetDevice* _ethif;
nyatla 109:18f12ac01097 67 struct NyLPC_TNetInterfaceInfo _netinfo;
nyatla 109:18f12ac01097 68 };
nyatla 109:18f12ac01097 69
nyatla 109:18f12ac01097 70
nyatla 109:18f12ac01097 71 /**　唯一のサービスインスタンス - Single service instance*/
nyatla 109:18f12ac01097 72 extern NyLPC_TcMiMicIpNetIf_t* _NyLPC_TcMiMicIpNetIf_inst;
nyatla 109:18f12ac01097 73
nyatla 109:18f12ac01097 74 /**
nyatla 109:18f12ac01097 75 * サービスが初期化済みならtrueです。 - true if service was initialized.
nyatla 109:18f12ac01097 76 */
nyatla 109:18f12ac01097 77 #define NyLPC_cMiMicIpNetIf_isInitService() (_NyLPC_TcMiMicIpNetIf_inst!=NULL)
nyatla 109:18f12ac01097 78 /**
nyatla 109:18f12ac01097 79 * サービスが稼働中か返します。
nyatla 109:18f12ac01097 80 */
nyatla 109:18f12ac01097 81 #define NyLPC_cMiMicIpNetIf_isRun() NyLPC_TUInt16_isBitOn(_NyLPC_TcMiMicIpNetIf_inst->_status,NyLPC_TcMiMicIpNetIf_STATUSBIT_IS_RUNNING)
nyatla 109:18f12ac01097 82
nyatla 109:18f12ac01097 83
nyatla 109:18f12ac01097 84 /**********************************************************************
nyatla 109:18f12ac01097 85 * コントロールビットの定義
nyatla 109:18f12ac01097 86 **********************************************************************/
nyatla 109:18f12ac01097 87 //サービスが実行中の場合1
nyatla 109:18f12ac01097 88 #define NyLPC_TcMiMicIpNetIf_STATUSBIT_IS_RUNNING 0
nyatla 109:18f12ac01097 89 #define NyLPC_TcMiMicIpNetIf_ORDER_START 1
nyatla 109:18f12ac01097 90 #define NyLPC_TcMiMicIpNetIf_ORDER_STOP 2
nyatla 109:18f12ac01097 91
nyatla 109:18f12ac01097 92
nyatla 109:18f12ac01097 93
nyatla 109:18f12ac01097 94 #define INST_TYPE_NyLPC_Unknown 0
nyatla 109:18f12ac01097 95 #define INST_TYPE_NyLPC_TcTcpListener 1
nyatla 109:18f12ac01097 96 #define INST_TYPE_NyLPC_TcTcpSocket 2
nyatla 109:18f12ac01097 97
nyatla 109:18f12ac01097 98
nyatla 109:18f12ac01097 99 /**********************************************************************
nyatla 109:18f12ac01097 100 *
nyatla 109:18f12ac01097 101 * IPスタックからコールする関数群
nyatla 109:18f12ac01097 102 *
nyatla 109:18f12ac01097 103 **********************************************************************/
nyatla 109:18f12ac01097 104
nyatla 109:18f12ac01097 105 /**
nyatla 109:18f12ac01097 106 * NyLPC_cUipService_allocTxBufが返却するメモリサイズ。
nyatla 109:18f12ac01097 107 *
nyatla 109:18f12ac01097 108 */
nyatla 109:18f12ac01097 109 #define NyLPC_cMiMicIpNetIf_SYS_TX_BUF_SIZE (64-sizeof(struct NyLPC_TEthernetIIHeader))
nyatla 109:18f12ac01097 110
nyatla 109:18f12ac01097 111
nyatla 109:18f12ac01097 112 /**
nyatla 109:18f12ac01097 113 * IPv4パケットをネットワークに送信します。
nyatla 109:18f12ac01097 114 * この関数は、リエントラントを許容します。
nyatla 109:18f12ac01097 115 * @param i_eth_payload
nyatla 109:18f12ac01097 116 * NyLPC_cUipService_getTxFrame、または、NyLPC_cUipService_recvIPv4Rxで得たバッファに、
nyatla 109:18f12ac01097 117 * IPv4パケットを書きこんだものを指定してください。
nyatla 109:18f12ac01097 118 */
nyatla 109:18f12ac01097 119 void NyLPC_cMiMicIpNetIf_sendIPv4Tx(void* i_eth_payload);
nyatla 109:18f12ac01097 120
nyatla 109:18f12ac01097 121 /**
nyatla 109:18f12ac01097 122 * 送信ペイロードメモリを返します。
nyatla 109:18f12ac01097 123 * この関数は、リエントラントを許容します。
nyatla 109:18f12ac01097 124 * @param i_hint
nyatla 109:18f12ac01097 125 * 取得したいメモリサイズを指定します。(このサイズは、イーサネットヘッダのサイズを含みません。)
nyatla 109:18f12ac01097 126 * このサイズよりも小さなサイズが割り当てられることがあります。
nyatla 109:18f12ac01097 127 * @param o_size
nyatla 109:18f12ac01097 128 * 取得メモリのイーサネットヘッダを除いたペイロード部分の長さ
nyatla 109:18f12ac01097 129 * @return
nyatla 109:18f12ac01097 130 * 成功:IPペイロードのためのメモリブロックを返します。/失敗:NULL
nyatla 109:18f12ac01097 131 * メモリは、[TEthPacket][payload]の構造で返されます。
nyatla 109:18f12ac01097 132 */
nyatla 109:18f12ac01097 133 void* NyLPC_cMiMicIpNetIf_allocTxBuf(NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_size);
nyatla 109:18f12ac01097 134
nyatla 109:18f12ac01097 135 /**
nyatla 109:18f12ac01097 136 * システム用の小さな送信ペイロードメモリを返します。
nyatla 109:18f12ac01097 137 * この関数は、リエントラントを許容します。
nyatla 109:18f12ac01097 138 * 返却するメモリブロックのサイズが小さいこと、メモリが確実に返される点がNyLPC_cUipService_allocTxBufと異なります。
nyatla 109:18f12ac01097 139 * この関数が返すメモリのサイズは、NyLPC_cUipService_SYS_TX_BUF_SIZEの値です。
nyatla 109:18f12ac01097 140 * 関数を使用するコードでは開始時に１度だけNyLPC_cUipService_SYS_TX_BUF_SIZEの値を確認して下さい。
nyatla 109:18f12ac01097 141 */
nyatla 109:18f12ac01097 142 void* NyLPC_cMiMicIpNetIf_allocSysTxBuf(void);
nyatla 109:18f12ac01097 143
nyatla 109:18f12ac01097 144 /**
nyatla 109:18f12ac01097 145 * allocTxbufで確保したメモリを開放します。
nyatla 109:18f12ac01097 146 */
nyatla 109:18f12ac01097 147 void* NyLPC_cMiMicIpNetIf_releaseTxBuf(void* i_buf);
nyatla 109:18f12ac01097 148
nyatla 109:18f12ac01097 149 /**
nyatla 109:18f12ac01097 150 * 指定したIPアドレスを要求するARPリクエストを発行します。
nyatla 109:18f12ac01097 151 */
nyatla 109:18f12ac01097 152 void NyLPC_cMiMicIpNetIf_sendArpRequest(const struct NyLPC_TIPv4Addr* i_addr);
nyatla 109:18f12ac01097 153
nyatla 109:18f12ac01097 154 /**
nyatla 109:18f12ac01097 155 * ARPテーブルに指定したIPがあるかを返します。
nyatla 109:18f12ac01097 156 */
nyatla 109:18f12ac01097 157 NyLPC_TBool NyLPC_cMiMicIpNetIf_hasArpInfo(const struct NyLPC_TIPv4Addr* i_addr);
nyatla 109:18f12ac01097 158
nyatla 109:18f12ac01097 159
nyatla 109:18f12ac01097 160 void NyLPC_cMiMicIpNetIf_releaseTcpSocketMemory(const NyLPC_TcMiMicIpTcpSocket_t* i_inst);
nyatla 109:18f12ac01097 161 void NyLPC_cMiMicIpNetIf_releaseUdpSocketMemory(const NyLPC_TcMiMicIpUdpSocket_t* i_inst);
nyatla 109:18f12ac01097 162 void NyLPC_cMiMicIpNetIf_releaseTcpListenerMemory(const NyLPC_TcMiMicIpTcpListener_t* i_inst);
nyatla 109:18f12ac01097 163
nyatla 109:18f12ac01097 164
nyatla 109:18f12ac01097 165
nyatla 109:18f12ac01097 166 #ifdef __cplusplus
nyatla 109:18f12ac01097 167 }
nyatla 109:18f12ac01097 168 #endif /* __cplusplus */
nyatla 109:18f12ac01097 169
nyatla 109:18f12ac01097 170 #endif
nyatla 109:18f12ac01097 171