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/flash/NyLPC_cMiMicConfiglation.h@92:4f77028cce64, 2014-10-01 (annotated)

Committer:
nyatla
Date:
Wed Oct 01 13:58:53 2014 +0000
Revision:
92:4f77028cce64
Parent:
37:fc4b4fd6a649 
?????????????????; K64F??????????????; LPC?????????????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 /*
nyatla 2:b96c1e90d120 2 * cConfiglationStorage.h
nyatla 2:b96c1e90d120 3 *
nyatla 2:b96c1e90d120 4 * Created on: 2011/10/18
nyatla 2:b96c1e90d120 5 * Author: nyatla
nyatla 2:b96c1e90d120 6 */
nyatla 2:b96c1e90d120 7
nyatla 2:b96c1e90d120 8 #include "NyLPC_stdlib.h"
nyatla 37:fc4b4fd6a649 9 #include "NyLPC_net.h"
nyatla 2:b96c1e90d120 10 #ifndef NYLPC_CCONFIGLATIONSTORAGE_H_
nyatla 2:b96c1e90d120 11 #define NYLPC_CCONFIGLATIONSTORAGE_H_
nyatla 2:b96c1e90d120 12
nyatla 12:efe841863fc8 13 #ifdef __cplusplus
nyatla 12:efe841863fc8 14 extern "C" {
nyatla 12:efe841863fc8 15 #endif /* __cplusplus */
nyatla 2:b96c1e90d120 16
nyatla 37:fc4b4fd6a649 17
nyatla 2:b96c1e90d120 18 /**
nyatla 2:b96c1e90d120 19 * IPアドレスはネットワークオーダーで格納する。
nyatla 92:4f77028cce64 20 * 構造体は8バイトアライメントであること。
nyatla 2:b96c1e90d120 21 */
nyatla 37:fc4b4fd6a649 22 struct NyLPC_TMiMicConfigulation{
nyatla 37:fc4b4fd6a649 23 /** ROM焼検出用。0xFFFFFFFFを書く　*/
nyatla 37:fc4b4fd6a649 24 NyLPC_TUInt32 fast_boot;
nyatla 37:fc4b4fd6a649 25 /** ホスト名*/
nyatla 37:fc4b4fd6a649 26 NyLPC_TChar hostname[NyLPC_TcNetConfig_HOSTNAME_LEN];
nyatla 37:fc4b4fd6a649 27 /** MACアドレスの下位4bit*/
nyatla 37:fc4b4fd6a649 28 NyLPC_TUInt32 mac_00_01_02_03;
nyatla 37:fc4b4fd6a649 29 /** MACアドレスの上位2bit*/
nyatla 92:4f77028cce64 30 NyLPC_TUInt32 mac_04_05_xx_xx; //12+NyLPC_TcNetConfig_HOSTNAME_LEN
nyatla 37:fc4b4fd6a649 31 /*
nyatla 37:fc4b4fd6a649 32 * IPv4設定
nyatla 2:b96c1e90d120 33 */
nyatla 37:fc4b4fd6a649 34
nyatla 37:fc4b4fd6a649 35 /**
nyatla 37:fc4b4fd6a649 36 * 0-1bit 起動モード
nyatla 37:fc4b4fd6a649 37 * 0:default,1:DHCP,2:AUTOIP,3:APIPA
nyatla 37:fc4b4fd6a649 38 */
nyatla 37:fc4b4fd6a649 39 NyLPC_TUInt32 ipv4_flags;
nyatla 37:fc4b4fd6a649 40 /** IPV4アドレス*/
nyatla 2:b96c1e90d120 41 NyLPC_TUInt32 ipv4_addr_net;
nyatla 2:b96c1e90d120 42 NyLPC_TUInt32 ipv4_mask_net;
nyatla 92:4f77028cce64 43 NyLPC_TUInt32 ipv4_drut_net; //16
nyatla 37:fc4b4fd6a649 44
nyatla 37:fc4b4fd6a649 45 /*
nyatla 37:fc4b4fd6a649 46 * Service setting
nyatla 37:fc4b4fd6a649 47 */
nyatla 37:fc4b4fd6a649 48
nyatla 37:fc4b4fd6a649 49 /**
nyatla 37:fc4b4fd6a649 50 * Service flags
nyatla 37:fc4b4fd6a649 51 * 0:mdns ON/OFF
nyatla 37:fc4b4fd6a649 52 */
nyatla 37:fc4b4fd6a649 53 NyLPC_TUInt32 srv_flags;
nyatla 37:fc4b4fd6a649 54 /** HTTPポート番号*/
nyatla 92:4f77028cce64 55 NyLPC_TUInt16 http_port; //6
nyatla 92:4f77028cce64 56 //total=(34=(12+16+6)+NyLPC_TcNetConfig_HOSTNAME_LEN)
nyatla 92:4f77028cce64 57 NyLPC_TUInt16 padding32;
nyatla 92:4f77028cce64 58 NyLPC_TUInt32 padding64; //total=40+NyLPC_TcNetConfig_HOSTNAME_LEN
nyatla 2:b96c1e90d120 59 };
nyatla 2:b96c1e90d120 60
nyatla 2:b96c1e90d120 61 /**
nyatla 27:eb66b517efe6 62 * ユーザー定義コンフィギュレーションを持つ場合にtrue
nyatla 27:eb66b517efe6 63 * falseなら初期設定と捉えることも出来ます。
nyatla 27:eb66b517efe6 64 */
nyatla 27:eb66b517efe6 65 NyLPC_TBool NyLPC_cMiMicConfiglation_hasUserConfigulation(void);
nyatla 27:eb66b517efe6 66
nyatla 27:eb66b517efe6 67 /**
nyatla 2:b96c1e90d120 68 * ユーザコンフィギュレーションを更新する。
nyatla 2:b96c1e90d120 69 * この関数は、RTOSが停止中に実行すること。
nyatla 2:b96c1e90d120 70 * この関数は384バイト程度のスタックが必要です。
nyatla 2:b96c1e90d120 71 */
nyatla 37:fc4b4fd6a649 72 NyLPC_TBool NyLPC_cMiMicConfiglation_updateConfigulation(const struct NyLPC_TMiMicConfigulation* i_congfiglation);
nyatla 2:b96c1e90d120 73 /**
nyatla 2:b96c1e90d120 74 * コンフィギュレーション値を返す。
nyatla 2:b96c1e90d120 75 * この関数は、RTOSが停止中に実行すること。
nyatla 2:b96c1e90d120 76 */
nyatla 37:fc4b4fd6a649 77 const struct NyLPC_TMiMicConfigulation* NyLPC_cMiMicConfiglation_loadFromFlash(void);
nyatla 37:fc4b4fd6a649 78 const struct NyLPC_TMiMicConfigulation* NyLPC_cMiMicConfiglation_loadFactoryDefault(void);
nyatla 2:b96c1e90d120 79
nyatla 12:efe841863fc8 80 #ifdef __cplusplus
nyatla 12:efe841863fc8 81 }
nyatla 12:efe841863fc8 82 #endif /* __cplusplus */
nyatla 12:efe841863fc8 83
nyatla 2:b96c1e90d120 84 #endif /* CCONFIGLATIONSTORAGE_H_ */