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/httpd/mod/NyLPC_cModMiMicSetting.h@48:00d211aac2ec, 2013-08-07 (annotated)

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 /*********************************************************************************
nyatla 2:b96c1e90d120 2 * PROJECT: MiMic
nyatla 2:b96c1e90d120 3 * --------------------------------------------------------------------------------
nyatla 2:b96c1e90d120 4 *
nyatla 2:b96c1e90d120 5 * This file is part of MiMic
nyatla 2:b96c1e90d120 6 * Copyright (C)2011 Ryo Iizuka
nyatla 2:b96c1e90d120 7 *
nyatla 2:b96c1e90d120 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 2:b96c1e90d120 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 2:b96c1e90d120 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 2:b96c1e90d120 11 * (at your option) any later version.
nyatla 2:b96c1e90d120 12 *
nyatla 2:b96c1e90d120 13 * This program is distributed in the hope that it will be useful,
nyatla 2:b96c1e90d120 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 2:b96c1e90d120 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 2:b96c1e90d120 16 * GNU General Public License for more details.
nyatla 2:b96c1e90d120 17 *
nyatla 2:b96c1e90d120 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 2:b96c1e90d120 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 2:b96c1e90d120 20 *
nyatla 2:b96c1e90d120 21 * For further information please contact.
nyatla 2:b96c1e90d120 22 * http://nyatla.jp/
nyatla 2:b96c1e90d120 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 2:b96c1e90d120 24 *
nyatla 2:b96c1e90d120 25 *********************************************************************************/
nyatla 2:b96c1e90d120 26 #ifndef NYLPC_CMODMIMICSETTING_H_
nyatla 2:b96c1e90d120 27 #define NYLPC_CMODMIMICSETTING_H_
nyatla 19:33b9ba0859ee 28 #include "NyLPC_http.h"
nyatla 2:b96c1e90d120 29 #include "../NyLPC_cHttpdConnection.h"
nyatla 2:b96c1e90d120 30 #include "NyLPC_cModRomFiles.h"
nyatla 2:b96c1e90d120 31 #ifdef __cplusplus
nyatla 2:b96c1e90d120 32 extern "C" {
nyatla 2:b96c1e90d120 33 #endif /* __cplusplus */
nyatla 2:b96c1e90d120 34
nyatla 2:b96c1e90d120 35 /**
nyatla 2:b96c1e90d120 36 * MiMicの動作設定CGIです。MiMicの設定値をオンチップフラッシュへ保存/読み出しします。
nyatla 37:fc4b4fd6a649 37 * uipServiceはNyLPC_TcNetConfig_tを継承したインスタンスで初期化してください。
nyatla 2:b96c1e90d120 38 *
nyatla 2:b96c1e90d120 39 * JSONAPIとして、以下のAPIを提供します。
nyatla 2:b96c1e90d120 40 * ./setup.api?c=[update|get]&p=[:param:]
nyatla 2:b96c1e90d120 41 * MiMicの動作設定と取得を行います。
nyatla 2:b96c1e90d120 42 * c=get 現在の状態をjson形式で返却する。
nyatla 2:b96c1e90d120 43 * {
nyatla 2:b96c1e90d120 44 * application: [:string:],
nyatla 2:b96c1e90d120 45 * mac00010203: [:HEX32:],
nyatla 2:b96c1e90d120 46 * mac0405xxxx: [:HEX32:],
nyatla 2:b96c1e90d120 47 * ip: [:HEX32:],
nyatla 2:b96c1e90d120 48 * mask: [:HEX32:],
nyatla 37:fc4b4fd6a649 49 * droute: [:HEX32:],
nyatla 37:fc4b4fd6a649 50 *
nyatla 37:fc4b4fd6a649 51 * port: [:HEX16:],
nyatla 2:b96c1e90d120 52 * access\":%u}",
nyatla 37:fc4b4fd6a649 53 * c=update pパラメタ/hostの内容でFlashをアップデートする。
nyatla 37:fc4b4fd6a649 54 * pパラメタは32bitの16進数文字列。
nyatla 37:fc4b4fd6a649 55 * [ 0] emac_0123 ビックエンディアン48bit値+パディング16bit
nyatla 37:fc4b4fd6a649 56 * [ 1] emac_45xx :
nyatla 37:fc4b4fd6a649 57 * [emac4][emac5][x][x]
nyatla 37:fc4b4fd6a649 58 * [ 2] ipv4_flags IPV4設定フラグ
nyatla 37:fc4b4fd6a649 59 * [ 3] ipv4_ip IPアドレス。32bit値。ビックエンディアン
nyatla 37:fc4b4fd6a649 60 * [ 4] ipv4_mask サブネットマスク。32bit値。ビックエンディアン
nyatla 37:fc4b4fd6a649 61 * [ 5] ipv4_deoute defaultrootアドレス。32bit値。ビックエンディアン
nyatla 37:fc4b4fd6a649 62 * [ 6] service_flag
nyatla 48:00d211aac2ec 63 * See NyLPC_cNetConfig.h
nyatla 37:fc4b4fd6a649 64 * [ 7] http_param HTTPサービスポート番号。2桁のHEX値である。ビックエンディアン。値16bit、パディング16bit
nyatla 37:fc4b4fd6a649 65 * [port_h][port_l][x][x]
nyatla 2:b96c1e90d120 66 */
nyatla 2:b96c1e90d120 67 typedef struct NyLPC_TcModMiMicSetting NyLPC_TcModMiMicSetting_t;
nyatla 2:b96c1e90d120 68
nyatla 2:b96c1e90d120 69
nyatla 2:b96c1e90d120 70 struct NyLPC_TcModMiMicSetting
nyatla 2:b96c1e90d120 71 {
nyatla 2:b96c1e90d120 72 NyLPC_TcModRomFiles_t super;
nyatla 2:b96c1e90d120 73 };
nyatla 2:b96c1e90d120 74
nyatla 2:b96c1e90d120 75 /**
nyatla 2:b96c1e90d120 76 * コンストラクタ。
nyatla 2:b96c1e90d120 77 */
nyatla 2:b96c1e90d120 78 void NyLPC_cModMiMicSetting_initialize(NyLPC_TcModMiMicSetting_t* i_inst,const NyLPC_TChar* i_ref_root_path);
nyatla 2:b96c1e90d120 79 void NyLPC_cModMiMicSetting_finalize(NyLPC_TcModMiMicSetting_t* i_inst);
nyatla 2:b96c1e90d120 80
nyatla 2:b96c1e90d120 81 /**
nyatla 2:b96c1e90d120 82 * モジュールがコネクションをハンドリングできるかを返します。
nyatla 2:b96c1e90d120 83 */
nyatla 2:b96c1e90d120 84 NyLPC_TBool NyLPC_cModMiMicSetting_canHandle(NyLPC_TcModMiMicSetting_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
nyatla 2:b96c1e90d120 85 /**
nyatla 2:b96c1e90d120 86 * モジュールを実行します。
nyatla 19:33b9ba0859ee 87 * @return 処理に成功したか
nyatla 2:b96c1e90d120 88 */
nyatla 2:b96c1e90d120 89 NyLPC_TBool NyLPC_cModMiMicSetting_execute(NyLPC_TcModMiMicSetting_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
nyatla 2:b96c1e90d120 90
nyatla 2:b96c1e90d120 91
nyatla 2:b96c1e90d120 92 #ifdef __cplusplus
nyatla 2:b96c1e90d120 93 }
nyatla 2:b96c1e90d120 94 #endif /* __cplusplus */
nyatla 2:b96c1e90d120 95
nyatla 19:33b9ba0859ee 96 #endif /* NYLPC_CHTTPSHORTHTTPHEADERPARSER_H_ */