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/NyLPC_cNetConfig.h@11:c82a7b2899b0, 2013-04-20 (annotated)

Committer:
nyatla
Date:
Sat Apr 20 03:47:14 2013 +0000
Revision:
11:c82a7b2899b0
Parent:
2:b96c1e90d120
Child:
12:efe841863fc8
update under os/ files.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 #ifndef NYLPC_CNETCONFIG_H_
nyatla 2:b96c1e90d120 2 #define NYLPC_CNETCONFIG_H_
nyatla 2:b96c1e90d120 3
nyatla 2:b96c1e90d120 4 #include "NyLPC_stdlib.h"
nyatla 2:b96c1e90d120 5 #include "NyLPC_uipService.h"
nyatla 2:b96c1e90d120 6
nyatla 2:b96c1e90d120 7 #define NyLPC_cNetConfig_INTERFACE_TYPE_ETHERNET 1
nyatla 2:b96c1e90d120 8
nyatla 2:b96c1e90d120 9 /**
nyatla 2:b96c1e90d120 10 * クラス型を定義します。
nyatla 2:b96c1e90d120 11 * NyLPC_cNetConfigクラスは、NyLPC_NetConfigの初期化データを保持します。
nyatla 2:b96c1e90d120 12 * 初期化データのロード・セーブ機能を提供します。
nyatla 2:b96c1e90d120 13 */
nyatla 2:b96c1e90d120 14 typedef struct NyLPC_TcNetConfig NyLPC_TcNetConfig_t;
nyatla 2:b96c1e90d120 15
nyatla 2:b96c1e90d120 16
nyatla 2:b96c1e90d120 17 /**
nyatla 2:b96c1e90d120 18 * NyLPC_TcFifoBufferクラスの構造体です。
nyatla 2:b96c1e90d120 19 */
nyatla 2:b96c1e90d120 20 struct NyLPC_TcNetConfig
nyatla 2:b96c1e90d120 21 {
nyatla 2:b96c1e90d120 22 /** Must be 1*/
nyatla 2:b96c1e90d120 23 NyLPC_TUInt16 version;
nyatla 2:b96c1e90d120 24 /** 配列の最大サイズ*/
nyatla 2:b96c1e90d120 25 NyLPC_TUInt16 interface_type;
nyatla 2:b96c1e90d120 26 /** インタフェイス層の設定*/
nyatla 2:b96c1e90d120 27 union{
nyatla 2:b96c1e90d120 28 /** Ethernet mac address */
nyatla 2:b96c1e90d120 29 NyLPC_TcIPv4Config_t ethernet;
nyatla 2:b96c1e90d120 30 //
nyatla 2:b96c1e90d120 31 // struct{
nyatla 2:b96c1e90d120 32 // struct NyLPC_TEthAddr mac_addr;
nyatla 2:b96c1e90d120 33 // }ethernet2;
nyatla 2:b96c1e90d120 34 }interface_setting;
nyatla 2:b96c1e90d120 35 // /** ip addressの設定*/
nyatla 2:b96c1e90d120 36 // struct{
nyatla 2:b96c1e90d120 37 // struct NyLPC_TIPv4Addr ip;
nyatla 2:b96c1e90d120 38 // struct NyLPC_TIPv4Addr mask;
nyatla 2:b96c1e90d120 39 // struct NyLPC_TIPv4Addr gateway;
nyatla 2:b96c1e90d120 40 // }ipv4;
nyatla 2:b96c1e90d120 41 };
nyatla 2:b96c1e90d120 42
nyatla 2:b96c1e90d120 43 /**
nyatla 2:b96c1e90d120 44 * インスタンスを初期化します。
nyatla 2:b96c1e90d120 45 */
nyatla 11:c82a7b2899b0 46 void NyLPC_cNetConfig_initialize(NyLPC_TcNetConfig_t* i_inst,NyLPC_TBool i_is_factory_default);
nyatla 2:b96c1e90d120 47 /**
nyatla 2:b96c1e90d120 48 * インスタンスを終期化します。
nyatla 2:b96c1e90d120 49 */
nyatla 2:b96c1e90d120 50 #define NyLPC_cNetConfig_finalize(i_inst);
nyatla 2:b96c1e90d120 51
nyatla 2:b96c1e90d120 52 #endif /* NYLPC_CNETCONFIG_H_ */