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/net/upnp/NyLPC_UPnP_types.h@48:00d211aac2ec, 2013-08-07 (annotated)

Committer:
nyatla
Date:
Wed Aug 07 13:53:02 2013 +0000
Revision:
48:00d211aac2ec
backup

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 48:00d211aac2ec 1 #ifndef NyLPC_TCUPnP_types_H
nyatla 48:00d211aac2ec 2 #define NyLPC_TCUPnP_types_H
nyatla 48:00d211aac2ec 3 #include "NyLPC_stdlib.h"
nyatla 48:00d211aac2ec 4
nyatla 48:00d211aac2ec 5 #ifdef __cplusplus
nyatla 48:00d211aac2ec 6 extern "C" {
nyatla 48:00d211aac2ec 7 #endif /* __cplusplus */
nyatla 48:00d211aac2ec 8
nyatla 48:00d211aac2ec 9 struct NyLPC_TUPnPDevDescIcon{
nyatla 48:00d211aac2ec 10 const NyLPC_TChar* mimetype;
nyatla 48:00d211aac2ec 11 NyLPC_TInt16 width;
nyatla 48:00d211aac2ec 12 NyLPC_TInt16 height;
nyatla 48:00d211aac2ec 13 NyLPC_TInt32 depth;
nyatla 48:00d211aac2ec 14 const NyLPC_TChar* url;
nyatla 48:00d211aac2ec 15 };
nyatla 48:00d211aac2ec 16
nyatla 48:00d211aac2ec 17 /**
nyatla 48:00d211aac2ec 18 * UPnP ServiceRecord
nyatla 48:00d211aac2ec 19 */
nyatla 48:00d211aac2ec 20 struct NyLPC_TUPnPDevDescService
nyatla 48:00d211aac2ec 21 {
nyatla 48:00d211aac2ec 22 /** Required*/
nyatla 48:00d211aac2ec 23 const NyLPC_TChar* scpd_url;
nyatla 48:00d211aac2ec 24 /** Required*/
nyatla 48:00d211aac2ec 25 const NyLPC_TChar* service_type;
nyatla 48:00d211aac2ec 26 /** Required*/
nyatla 48:00d211aac2ec 27 const NyLPC_TChar* service_id;
nyatla 48:00d211aac2ec 28 };
nyatla 48:00d211aac2ec 29
nyatla 48:00d211aac2ec 30 struct NyLPC_TUPnPDevDescDevice
nyatla 48:00d211aac2ec 31 {
nyatla 48:00d211aac2ec 32 /** Required*/
nyatla 48:00d211aac2ec 33 const NyLPC_TChar* device_type;
nyatla 48:00d211aac2ec 34 /** Required*/
nyatla 48:00d211aac2ec 35 const NyLPC_TChar* frendly_name;
nyatla 48:00d211aac2ec 36 /** Required*/
nyatla 48:00d211aac2ec 37 const NyLPC_TChar* manufacturer;
nyatla 48:00d211aac2ec 38 /** Optional*/
nyatla 48:00d211aac2ec 39 const NyLPC_TChar* manufacturer_url;
nyatla 48:00d211aac2ec 40 /** Recommended*/
nyatla 48:00d211aac2ec 41 const NyLPC_TChar* model_descriprion;
nyatla 48:00d211aac2ec 42 /** Required*/
nyatla 48:00d211aac2ec 43 const NyLPC_TChar* model_name;
nyatla 48:00d211aac2ec 44 /** Recommended*/
nyatla 48:00d211aac2ec 45 const NyLPC_TChar* model_number;
nyatla 48:00d211aac2ec 46 /** Optional*/
nyatla 48:00d211aac2ec 47 const NyLPC_TChar* model_url;
nyatla 48:00d211aac2ec 48 /** Recommended*/
nyatla 48:00d211aac2ec 49 const NyLPC_TChar* serial_number;
nyatla 48:00d211aac2ec 50 /** Required*/
nyatla 48:00d211aac2ec 51 const NyLPC_TChar* udn;
nyatla 48:00d211aac2ec 52 /** Optional*/
nyatla 48:00d211aac2ec 53 const NyLPC_TChar* upc;
nyatla 48:00d211aac2ec 54 /** Recommended*/
nyatla 48:00d211aac2ec 55 const NyLPC_TChar* presentation_url;
nyatla 48:00d211aac2ec 56 NyLPC_TInt8 number_of_devices;
nyatla 48:00d211aac2ec 57 NyLPC_TInt8 number_of_service;
nyatla 48:00d211aac2ec 58 NyLPC_TInt8 number_of_icon;
nyatla 48:00d211aac2ec 59 NyLPC_TInt8 _padding;
nyatla 48:00d211aac2ec 60 /** Required if number_of_devices>0
nyatla 48:00d211aac2ec 61 * UPnPデバイス構造体のポインタへの配列
nyatla 48:00d211aac2ec 62 */
nyatla 48:00d211aac2ec 63 const struct NyLPC_TUPnPDevDescDevice** devices;
nyatla 48:00d211aac2ec 64 /**
nyatla 48:00d211aac2ec 65 * Optional
nyatla 48:00d211aac2ec 66 * UPnPサービス構造体のポインタへの配列
nyatla 48:00d211aac2ec 67 */
nyatla 48:00d211aac2ec 68 const struct NyLPC_TUPnPDevDescService* services;
nyatla 48:00d211aac2ec 69 /** Required if number_of_icon>0*/
nyatla 48:00d211aac2ec 70 const struct NyLPC_TUPnPDevDescIcon* icons;
nyatla 48:00d211aac2ec 71 };
nyatla 48:00d211aac2ec 72
nyatla 48:00d211aac2ec 73 #ifdef __cplusplus
nyatla 48:00d211aac2ec 74 }
nyatla 48:00d211aac2ec 75 #endif /* __cplusplus */
nyatla 48:00d211aac2ec 76
nyatla 48:00d211aac2ec 77
nyatla 48:00d211aac2ec 78
nyatla 48:00d211aac2ec 79 #endif