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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

チュートリアル

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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Tutorial

Revision:
109:18f12ac01097
Child:
110:257739f9b31e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/netif/mimicip/NyLPC_cMiMicIpNetIf_protected.h	Wed Nov 19 14:45:17 2014 +0000
@@ -0,0 +1,171 @@
+/*********************************************************************************
+ * PROJECT: MiMic
+ * --------------------------------------------------------------------------------
+ *
+ * This file is part of MiMic
+ * Copyright (C)2011 Ryo Iizuka
+ *
+ * MiMic is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * For further information please contact.
+ *  http://nyatla.jp/
+ *  <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
+ *
+ *********************************************************************************/
+
+#ifndef NyLPC_MiMicIpNetIf_protected_H
+#define NyLPC_MiMicIpNetIf_protected_H
+#include "NyLPC_cMiMicIpNetIf.h"
+#include "NyLPC_os.h"
+#include "NyLPC_cIPv4Arp.h"
+#include "NyLPC_cIPv4.h"
+#include "NyLPC_cIPv4IComp.h"
+#include "../driver/ethernet/EthDev.h"
+#include "NyLPC_cMiMicIpTcpSocket.h"
+#include "NyLPC_cMiMicIpUdpSocket.h"
+#include "NyLPC_cMiMicIpTcpListener.h"
+
+/**********************************************************************
+ *
+ * NyLPC_TcUipService_t
+ *
+ **********************************************************************/
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+//#define NyLPC_TcUipService_SIZE_OF_REPLY_BUF 128
+
+
+
+struct NyLPC_TcMiMicIpNetIf
+{
+    volatile NyLPC_TUInt16  _status;            /**< ステータスビット*/
+    NyLPC_TcSemaphore_t _emac_semapho;  /** EMACの制御用セマフォです。*/
+    NyLPC_TcStopwatch_t _arp_sw;        /**<ARP用のストップウォッチ*/
+    NyLPC_TcStopwatch_t _periodic_sw;   /**<周期実行用のストップウォッチ*/
+    /** ARP処理インスタンス*/
+    NyLPC_TcIPv4Arp_t _arp;
+    /** TCPv4処理インスタンス*/
+    NyLPC_TcIPv4_t _tcpv4;
+    /** ICOMP処理インスタンス*/
+    NyLPC_TcIPv4IComp_t _icomp;
+    /** (Ethernetメモリ排他制御用)*/
+    NyLPC_TcMutex_t _mutex;
+    const struct TiEthernetDevice* _ethif;
+    struct NyLPC_TNetInterfaceInfo _netinfo;
+};
+
+
+/** 唯一のサービスインスタンス - Single service instance*/
+extern NyLPC_TcMiMicIpNetIf_t* _NyLPC_TcMiMicIpNetIf_inst;
+
+/**
+ * サービスが初期化済みならtrueです。 - true if service was initialized.
+ */
+#define NyLPC_cMiMicIpNetIf_isInitService() (_NyLPC_TcMiMicIpNetIf_inst!=NULL)
+/**
+ * サービスが稼働中か返します。
+ */
+#define NyLPC_cMiMicIpNetIf_isRun() NyLPC_TUInt16_isBitOn(_NyLPC_TcMiMicIpNetIf_inst->_status,NyLPC_TcMiMicIpNetIf_STATUSBIT_IS_RUNNING)
+
+
+/**********************************************************************
+ * コントロールビットの定義
+ **********************************************************************/
+//サービスが実行中の場合1
+#define NyLPC_TcMiMicIpNetIf_STATUSBIT_IS_RUNNING 0
+#define NyLPC_TcMiMicIpNetIf_ORDER_START          1
+#define NyLPC_TcMiMicIpNetIf_ORDER_STOP           2
+
+
+
+#define INST_TYPE_NyLPC_Unknown 0
+#define INST_TYPE_NyLPC_TcTcpListener 1
+#define INST_TYPE_NyLPC_TcTcpSocket 2
+
+
+/**********************************************************************
+ *
+ * IPスタックからコールする関数群
+ *
+ **********************************************************************/
+
+/**
+ * NyLPC_cUipService_allocTxBufが返却するメモリサイズ。
+ *
+ */
+#define NyLPC_cMiMicIpNetIf_SYS_TX_BUF_SIZE (64-sizeof(struct NyLPC_TEthernetIIHeader))
+
+
+/**
+ * IPv4パケットをネットワークに送信します。
+ * この関数は、リエントラントを許容します。
+ * @param i_eth_payload
+ * NyLPC_cUipService_getTxFrame、または、NyLPC_cUipService_recvIPv4Rxで得たバッファに、
+ * IPv4パケットを書きこんだものを指定してください。
+ */
+void NyLPC_cMiMicIpNetIf_sendIPv4Tx(void* i_eth_payload);
+
+/**
+ * 送信ペイロードメモリを返します。
+ * この関数は、リエントラントを許容します。
+ * @param i_hint
+ * 取得したいメモリサイズを指定します。(このサイズは、イーサネットヘッダのサイズを含みません。)
+ * このサイズよりも小さなサイズが割り当てられることがあります。
+ * @param o_size
+ * 取得メモリのイーサネットヘッダを除いたペイロード部分の長さ
+ * @return
+ * 成功:IPペイロードのためのメモリブロックを返します。/失敗:NULL
+ * メモリは、[TEthPacket][payload]の構造で返されます。
+ */
+void* NyLPC_cMiMicIpNetIf_allocTxBuf(NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_size);
+
+/**
+ * システム用の小さな送信ペイロードメモリを返します。
+ * この関数は、リエントラントを許容します。
+ * 返却するメモリブロックのサイズが小さいこと、メモリが確実に返される点がNyLPC_cUipService_allocTxBufと異なります。
+ * この関数が返すメモリのサイズは、NyLPC_cUipService_SYS_TX_BUF_SIZEの値です。
+ * 関数を使用するコードでは開始時に1度だけNyLPC_cUipService_SYS_TX_BUF_SIZEの値を確認して下さい。
+ */
+void* NyLPC_cMiMicIpNetIf_allocSysTxBuf(void);
+
+/**
+ * allocTxbufで確保したメモリを開放します。
+ */
+void* NyLPC_cMiMicIpNetIf_releaseTxBuf(void* i_buf);
+
+/**
+ * 指定したIPアドレスを要求するARPリクエストを発行します。
+ */
+void NyLPC_cMiMicIpNetIf_sendArpRequest(const struct NyLPC_TIPv4Addr* i_addr);
+
+/**
+ * ARPテーブルに指定したIPがあるかを返します。
+ */
+NyLPC_TBool NyLPC_cMiMicIpNetIf_hasArpInfo(const struct NyLPC_TIPv4Addr* i_addr);
+
+
+void NyLPC_cMiMicIpNetIf_releaseTcpSocketMemory(const NyLPC_TcMiMicIpTcpSocket_t* i_inst);
+void NyLPC_cMiMicIpNetIf_releaseUdpSocketMemory(const NyLPC_TcMiMicIpUdpSocket_t* i_inst);
+void NyLPC_cMiMicIpNetIf_releaseTcpListenerMemory(const NyLPC_TcMiMicIpTcpListener_t* i_inst);
+
+
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif
+