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:
Wed Aug 07 13:53:02 2013 +0000
Revision:
48:00d211aac2ec
Child:
109:18f12ac01097
backup

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 48:00d211aac2ec 1 /*
nyatla 48:00d211aac2ec 2 * NyLPC_cSsdpSocket.h
nyatla 48:00d211aac2ec 3 *
nyatla 48:00d211aac2ec 4 * Created on: 2013/07/26
nyatla 48:00d211aac2ec 5 * Author: nyatla
nyatla 48:00d211aac2ec 6 */
nyatla 48:00d211aac2ec 7
nyatla 48:00d211aac2ec 8 #ifndef NYLPC_CSSDPSOCKET_H_
nyatla 48:00d211aac2ec 9 #define NYLPC_CSSDPSOCKET_H_
nyatla 48:00d211aac2ec 10 #include "NyLPC_UPnP_types.h"
nyatla 48:00d211aac2ec 11 #include "NyLPC_uipService.h"
nyatla 48:00d211aac2ec 12
nyatla 48:00d211aac2ec 13 #ifdef __cplusplus
nyatla 48:00d211aac2ec 14 extern "C" {
nyatla 48:00d211aac2ec 15 #endif /* __cplusplus */
nyatla 48:00d211aac2ec 16
nyatla 48:00d211aac2ec 17 /**
nyatla 48:00d211aac2ec 18 * DeviceDescriptionに含まれる最大デバイス数
nyatla 48:00d211aac2ec 19 */
nyatla 48:00d211aac2ec 20 #define NyLPC_TcSsdpSocket_MAX_DEVICES 5
nyatla 48:00d211aac2ec 21
nyatla 48:00d211aac2ec 22 /**
nyatla 48:00d211aac2ec 23 * @bug
nyatla 48:00d211aac2ec 24 * TTLが64(4であるべき)
nyatla 48:00d211aac2ec 25 */
nyatla 48:00d211aac2ec 26 typedef struct NyLPC_TcSsdpSocket NyLPC_TcSsdpSocket_t;
nyatla 48:00d211aac2ec 27
nyatla 48:00d211aac2ec 28 struct NyLPC_TcSsdpSocket
nyatla 48:00d211aac2ec 29 {
nyatla 48:00d211aac2ec 30 NyLPC_TcUdpSocket_t super;
nyatla 48:00d211aac2ec 31 NyLPC_TcStopwatch_t _periodic_sw;
nyatla 48:00d211aac2ec 32 /**
nyatla 48:00d211aac2ec 33 * locationパス
nyatla 48:00d211aac2ec 34 */
nyatla 48:00d211aac2ec 35 const NyLPC_TChar* location_path;
nyatla 48:00d211aac2ec 36 /**
nyatla 48:00d211aac2ec 37 * DeviceDescriptionをホストするサーバアドレス
nyatla 48:00d211aac2ec 38 */
nyatla 48:00d211aac2ec 39 NyLPC_TUInt16 location_port;
nyatla 48:00d211aac2ec 40 NyLPC_TUInt8 number_of_device;
nyatla 48:00d211aac2ec 41 /**
nyatla 48:00d211aac2ec 42 * bit0:SSDPサービスの開始要求
nyatla 48:00d211aac2ec 43 * bit1:SSDPサービスの停止要求
nyatla 48:00d211aac2ec 44 * bit2:SSDPサービスの実行状態(1:start,0:stop)
nyatla 48:00d211aac2ec 45 */
nyatla 48:00d211aac2ec 46 volatile NyLPC_TUInt8 _flags;
nyatla 48:00d211aac2ec 47 /**
nyatla 48:00d211aac2ec 48 * デバイスレコードの配列へのポインタ。
nyatla 48:00d211aac2ec 49 * この値は、initialize関数でセットされたrootdeviceを水平展開したものです。
nyatla 48:00d211aac2ec 50 * 0番目のレコードはルートデバイスです。
nyatla 48:00d211aac2ec 51 */
nyatla 48:00d211aac2ec 52 const struct NyLPC_TUPnPDevDescDevice* ref_device_record[NyLPC_TcSsdpSocket_MAX_DEVICES];
nyatla 48:00d211aac2ec 53 };
nyatla 48:00d211aac2ec 54
nyatla 48:00d211aac2ec 55 /**
nyatla 48:00d211aac2ec 56 * DeviceRecordを参照したSSDPソケットインスタンスを生成します。
nyatla 48:00d211aac2ec 57 * この関数はuipServiceが開始する前に実行してください。
nyatla 48:00d211aac2ec 58 * @param i_inst
nyatla 48:00d211aac2ec 59 * @param i_ref_dev_record
nyatla 48:00d211aac2ec 60 * 0番目のデバイスがルートデバイス、以降は embeddedデバイスになります。
nyatla 48:00d211aac2ec 61 * このオブジェクトはインスタンスが破棄されるまでの間維持してください。
nyatla 48:00d211aac2ec 62 * @param i_number_of_devices
nyatla 48:00d211aac2ec 63 * @param i_server_port
nyatla 48:00d211aac2ec 64 * @param i_ref_location_path
nyatla 48:00d211aac2ec 65 * deviceDescriptionのホストパスを設定します。
nyatla 48:00d211aac2ec 66 * 例えば"upnp"の場合、locationはhttp://[:ip:]:[:port:]/upnp/ddesc.xmlとなります。
nyatla 48:00d211aac2ec 67 */
nyatla 48:00d211aac2ec 68 void NyLPC_cSsdpSocket_initialize(
nyatla 48:00d211aac2ec 69 NyLPC_TcSsdpSocket_t* i_inst,
nyatla 48:00d211aac2ec 70 const struct NyLPC_TUPnPDevDescDevice* i_ref_dev_record,
nyatla 48:00d211aac2ec 71 NyLPC_TUInt16 i_server_port,const NyLPC_TChar* i_ref_location_path);
nyatla 48:00d211aac2ec 72
nyatla 48:00d211aac2ec 73 void NyLPC_cSsdpSocket_finalize(NyLPC_TcSsdpSocket_t* i_inst);
nyatla 48:00d211aac2ec 74 /**
nyatla 48:00d211aac2ec 75 * SSDPサービスを開始します。
nyatla 48:00d211aac2ec 76 */
nyatla 48:00d211aac2ec 77 void NyLPC_cSsdpSocket_start(NyLPC_TcSsdpSocket_t* i_inst);
nyatla 48:00d211aac2ec 78 /**
nyatla 48:00d211aac2ec 79 * SSDPサービスを停止します。
nyatla 48:00d211aac2ec 80 */
nyatla 48:00d211aac2ec 81 void NyLPC_cSsdpSocket_stop(NyLPC_TcSsdpSocket_t* i_inst);
nyatla 48:00d211aac2ec 82
nyatla 48:00d211aac2ec 83
nyatla 48:00d211aac2ec 84 #ifdef __cplusplus
nyatla 48:00d211aac2ec 85 }
nyatla 48:00d211aac2ec 86 #endif /* __cplusplus */
nyatla 48:00d211aac2ec 87
nyatla 48:00d211aac2ec 88
nyatla 48:00d211aac2ec 89
nyatla 48:00d211aac2ec 90
nyatla 48:00d211aac2ec 91
nyatla 48:00d211aac2ec 92
nyatla 48:00d211aac2ec 93
nyatla 48:00d211aac2ec 94
nyatla 48:00d211aac2ec 95
nyatla 48:00d211aac2ec 96
nyatla 48:00d211aac2ec 97
nyatla 48:00d211aac2ec 98
nyatla 48:00d211aac2ec 99
nyatla 48:00d211aac2ec 100 #endif /* NYLPC_CSSDPSOCKET_H_ */