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

mbed/mod/ModWebSocket.h@72:c118a7aa37a3, 2014-06-13 (annotated)

Committer:
nyatla
Date:
Fri Jun 13 11:06:33 2014 +0000
Revision:
72:c118a7aa37a3
Parent:
58:03b89038b21a
Child:
81:e5e4f2264d24
mbedAPI???????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 58:03b89038b21a 1 #pragma once
nyatla 58:03b89038b21a 2 #include "NyLPC_net.h"
nyatla 58:03b89038b21a 3 #include "ModBaseClass.h"
nyatla 58:03b89038b21a 4 #include "HttpdConnection.h"
nyatla 58:03b89038b21a 5 #include "Httpd.h"
nyatla 58:03b89038b21a 6 #include "Net.h"
nyatla 58:03b89038b21a 7
nyatla 58:03b89038b21a 8 namespace MiMic
nyatla 58:03b89038b21a 9 {
nyatla 58:03b89038b21a 10 class HttpdConnection;
nyatla 58:03b89038b21a 11
nyatla 58:03b89038b21a 12 /**
nyatla 58:03b89038b21a 13 * This class is Websocket module.
nyatla 58:03b89038b21a 14 * The class provides 3 services.
nyatla 58:03b89038b21a 15 * <ul>
nyatla 58:03b89038b21a 16 * <li>d.xml - a device description.</li>
nyatla 58:03b89038b21a 17 * <li>control/xx - soap handler</li>
nyatla 58:03b89038b21a 18 * <li>event/xx -event handler.</li>
nyatla 58:03b89038b21a 19 * </ul>
nyatla 58:03b89038b21a 20 */
nyatla 58:03b89038b21a 21 class ModWebSocket:ModBaseClass
nyatla 58:03b89038b21a 22 {
nyatla 58:03b89038b21a 23 private:
nyatla 58:03b89038b21a 24 protected:
nyatla 58:03b89038b21a 25 NyLPC_TcModWebSocket_t* _mod;
nyatla 58:03b89038b21a 26 public:
nyatla 58:03b89038b21a 27 ModWebSocket();
nyatla 58:03b89038b21a 28 ModWebSocket(const char* i_path);
nyatla 58:03b89038b21a 29 virtual ~ModWebSocket();
nyatla 58:03b89038b21a 30 void setParam(const char* i_path);
nyatla 58:03b89038b21a 31 /**
nyatla 58:03b89038b21a 32 * This function executes websocket negotiation to the current connection.
nyatla 58:03b89038b21a 33 * Should be handle websocket session if function successful.
nyatla 58:03b89038b21a 34 * @return
nyatla 58:03b89038b21a 35 * true if negotiation successful;otherwishe false.
nyatla 58:03b89038b21a 36 */
nyatla 58:03b89038b21a 37 bool execute(HttpdConnection& i_connection);
nyatla 58:03b89038b21a 38 /**
nyatla 58:03b89038b21a 39 * Write data to websocket stream.
nyatla 58:03b89038b21a 40 * @return
nyatla 58:03b89038b21a 41 * true if successful;otherwishe false and connection closed.
nyatla 58:03b89038b21a 42 */
nyatla 58:03b89038b21a 43 bool write(const void* i_tx_buf,int i_tx_size);
nyatla 58:03b89038b21a 44 /**
nyatla 58:03b89038b21a 45 * This function sends data to websocket stream.
nyatla 58:03b89038b21a 46 * @param i_fmt
nyatla 58:03b89038b21a 47 * printf like format text.
nyatla 58:03b89038b21a 48 * @param ...
nyatla 58:03b89038b21a 49 * argument list for i_fmt
nyatla 58:03b89038b21a 50 */
nyatla 72:c118a7aa37a3 51 bool writeFormat(const char* i_fmt,...);
nyatla 58:03b89038b21a 52
nyatla 58:03b89038b21a 53 /**
nyatla 58:03b89038b21a 54 * This function receives data from websocket stream.
nyatla 58:03b89038b21a 55 * @return
nyatla 58:03b89038b21a 56 * <ul>
nyatla 58:03b89038b21a 57 * <li>r<0 Error. The socket already closed.
nyatla 58:03b89038b21a 58 * <li>r==0 Timeout. The connection is continued.
nyatla 58:03b89038b21a 59 * <li>r>0 Success. Received data size.
nyatla 58:03b89038b21a 60 * </ul>
nyatla 58:03b89038b21a 61 * If an Error found, application should be call close and exit handler.
nyatla 58:03b89038b21a 62 */
nyatla 58:03b89038b21a 63 int read(void* i_rx_buf,int i_rx_size);
nyatla 58:03b89038b21a 64 /**
nyatla 58:03b89038b21a 65 * This function terminates websocket connection.
nyatla 58:03b89038b21a 66 * Should be called if execute function successful.
nyatla 58:03b89038b21a 67 */
nyatla 58:03b89038b21a 68 void close();
nyatla 58:03b89038b21a 69 /**
nyatla 58:03b89038b21a 70 * This function returns read function status.
nyatla 58:03b89038b21a 71 * This is to confirm that "read" can call without blocking.
nyatla 58:03b89038b21a 72 * @return
nyatla 58:03b89038b21a 73 * true if can be call "read" with no-wait. otherwise, "read" might be wait.
nyatla 58:03b89038b21a 74 */
nyatla 58:03b89038b21a 75 bool canRead();
nyatla 58:03b89038b21a 76
nyatla 58:03b89038b21a 77
nyatla 58:03b89038b21a 78 };
nyatla 58:03b89038b21a 79 }