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

Committer:
nyatla
Date:
Fri Sep 13 06:38:16 2013 +0000
Revision:
57:bc4330dfa62f
Parent:
43:a182f2b5ff41
update mimic core r329;

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_CTCPLISTENER_H_
nyatla 0:142ee8b12fef 27 #define NYLPC_CTCPLISTENER_H_
nyatla 0:142ee8b12fef 28
nyatla 0:142ee8b12fef 29
nyatla 0:142ee8b12fef 30 #include "NyLPC_stdlib.h"
nyatla 12:efe841863fc8 31 #include "NyLPC_os.h"
nyatla 37:fc4b4fd6a649 32 #include "NyLPC_cBaseSocket.h"
nyatla 37:fc4b4fd6a649 33 #include "NyLPC_cTcpSocket.h"
nyatla 43:a182f2b5ff41 34 #ifdef __cplusplus
nyatla 43:a182f2b5ff41 35 extern "C" {
nyatla 43:a182f2b5ff41 36 #endif /* __cplusplus */
nyatla 43:a182f2b5ff41 37
nyatla 43:a182f2b5ff41 38 typedef struct NyLPC_TcTcpListener NyLPC_TcTcpListener_t;
nyatla 43:a182f2b5ff41 39
nyatla 43:a182f2b5ff41 40 /**********************************************************************
nyatla 43:a182f2b5ff41 41 *
nyatla 43:a182f2b5ff41 42 * NyLPC_TTcpListenerListenQ struct
nyatla 43:a182f2b5ff41 43 *
nyatla 43:a182f2b5ff41 44 **********************************************************************/
nyatla 43:a182f2b5ff41 45
nyatla 43:a182f2b5ff41 46 #define NyLPC_TcTcpListener_NUMBER_OF_Q 10
nyatla 43:a182f2b5ff41 47
nyatla 43:a182f2b5ff41 48 struct NyLPC_TTcpListenerListenQ
nyatla 43:a182f2b5ff41 49 {
nyatla 43:a182f2b5ff41 50 struct NyLPC_TTcpSocketSynParam item[NyLPC_TcTcpListener_NUMBER_OF_Q];
nyatla 43:a182f2b5ff41 51 NyLPC_TUInt16 wp;
nyatla 43:a182f2b5ff41 52 };
nyatla 43:a182f2b5ff41 53
nyatla 43:a182f2b5ff41 54
nyatla 0:142ee8b12fef 55 /**********************************************************************
nyatla 0:142ee8b12fef 56 *
nyatla 0:142ee8b12fef 57 * NyLPC_TcTcpListener class
nyatla 0:142ee8b12fef 58 *
nyatla 0:142ee8b12fef 59 **********************************************************************/
nyatla 0:142ee8b12fef 60
nyatla 0:142ee8b12fef 61 /**
nyatla 0:142ee8b12fef 62 * TCP listenerクラス型です。
nyatla 0:142ee8b12fef 63 */
nyatla 0:142ee8b12fef 64 struct NyLPC_TcTcpListener
nyatla 0:142ee8b12fef 65 {
nyatla 37:fc4b4fd6a649 66 NyLPC_TcBaseSocket_t _super;
nyatla 35:00b8dee1538f 67 NyLPC_TUInt16 _port; /**<ネットワークオーダーのポート番号*/
nyatla 57:bc4330dfa62f 68 // /**
nyatla 57:bc4330dfa62f 69 // * タスク間の調停用Mutex
nyatla 57:bc4330dfa62f 70 // * Listener用の共通Mutexポインタ
nyatla 57:bc4330dfa62f 71 // */
nyatla 57:bc4330dfa62f 72 // NyLPC_TcMutex_t* _mutex;
nyatla 43:a182f2b5ff41 73 /**
nyatla 43:a182f2b5ff41 74 * SYNパケットのキュー
nyatla 43:a182f2b5ff41 75 */
nyatla 43:a182f2b5ff41 76 struct NyLPC_TTcpListenerListenQ _listen_q;
nyatla 0:142ee8b12fef 77 };
nyatla 0:142ee8b12fef 78 /**
nyatla 0:142ee8b12fef 79 * この関数は、TCPのリスナーを初期化します。
nyatla 0:142ee8b12fef 80 * 初期化したリスナーをサービスに登録することにより、listen関数を使用できるようになります。
nyatla 0:142ee8b12fef 81 * サービスへの登録は、NyLPC_cUipService_addListenerを使います。
nyatla 2:b96c1e90d120 82 * @param i_port
nyatla 2:b96c1e90d120 83 * ポート番号。host orderです。
nyatla 0:142ee8b12fef 84 */
nyatla 0:142ee8b12fef 85 NyLPC_TBool NyLPC_cTcpListener_initialize(NyLPC_TcTcpListener_t* i_inst,NyLPC_TUInt16 i_port);
nyatla 0:142ee8b12fef 86
nyatla 2:b96c1e90d120 87 /**
nyatla 2:b96c1e90d120 88 * この関数は、一定時間i_sockに接続を受け付けます。
nyatla 2:b96c1e90d120 89 */
nyatla 0:142ee8b12fef 90 NyLPC_TBool NyLPC_cTcpListener_listen(NyLPC_TcTcpListener_t* i_inst,NyLPC_TcTcpSocket_t* i_sock,NyLPC_TUInt32 i_wait_msec);
nyatla 0:142ee8b12fef 91
nyatla 0:142ee8b12fef 92
nyatla 0:142ee8b12fef 93 #ifdef __cplusplus
nyatla 0:142ee8b12fef 94 }
nyatla 0:142ee8b12fef 95 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 96
nyatla 35:00b8dee1538f 97 #endif /* NYLPC_CTCPLISTENER_H_ */