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_cModFileIoBaseClass.h@41:2389bd6b6f74, 2013-06-30 (annotated)

Committer:
nyatla
Date:
Sun Jun 30 14:17:42 2013 +0000
Revision:
41:2389bd6b6f74
update core r270;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 41:2389bd6b6f74 1 /*
nyatla 41:2389bd6b6f74 2 * NyLPC_cModRemoteMcu.h
nyatla 41:2389bd6b6f74 3 *
nyatla 41:2389bd6b6f74 4 * Created on: 2013/03/07
nyatla 41:2389bd6b6f74 5 * Author: nyatla
nyatla 41:2389bd6b6f74 6 */
nyatla 41:2389bd6b6f74 7
nyatla 41:2389bd6b6f74 8 #ifndef NYLPC_cModFileIoBaseClass_H_
nyatla 41:2389bd6b6f74 9 #define NYLPC_cModFileIoBaseClass_H_
nyatla 41:2389bd6b6f74 10
nyatla 41:2389bd6b6f74 11 #include "NyLPC_http.h"
nyatla 41:2389bd6b6f74 12 #include "NyLPC_stdlib.h"
nyatla 41:2389bd6b6f74 13 #include "../NyLPC_cHttpdConnection.h"
nyatla 41:2389bd6b6f74 14 #include "NyLPC_cModRomFiles.h"
nyatla 41:2389bd6b6f74 15 #ifdef __cplusplus
nyatla 41:2389bd6b6f74 16 extern "C" {
nyatla 41:2389bd6b6f74 17 #endif /* __cplusplus */
nyatla 41:2389bd6b6f74 18
nyatla 41:2389bd6b6f74 19 /**
nyatla 41:2389bd6b6f74 20 * ファイルアップロードの為の基本シーケンスを提供する抽象クラスです。
nyatla 41:2389bd6b6f74 21 * 継承クラスで_abstruct_function以下の関数に実体を設定して使います。
nyatla 41:2389bd6b6f74 22 */
nyatla 41:2389bd6b6f74 23 typedef struct NyLPC_TcModFileIoBaseClass NyLPC_TcModFileIoBaseClass_t;
nyatla 41:2389bd6b6f74 24
nyatla 41:2389bd6b6f74 25 /*
nyatla 41:2389bd6b6f74 26 * Abstruct関数の定義
nyatla 41:2389bd6b6f74 27 */
nyatla 41:2389bd6b6f74 28
nyatla 41:2389bd6b6f74 29 /**
nyatla 41:2389bd6b6f74 30 * i_fnameの内容をi_body_parserの内容で更新します。
nyatla 41:2389bd6b6f74 31 * この関数はHTTPD_LOCKがかかった状態でコールされます。
nyatla 41:2389bd6b6f74 32 * 関数にはコネクションにHTTP応答を返却する実装をしてください。
nyatla 41:2389bd6b6f74 33 * @return
nyatla 41:2389bd6b6f74 34 * 処理が失敗した場合はFALSEを返します。FALSEを返すとCallerはHTTPセッションを切断します。
nyatla 41:2389bd6b6f74 35 */
nyatla 41:2389bd6b6f74 36 typedef NyLPC_TBool (*NyLPC_cModFileIoBaseClass_uploadFunction)(NyLPC_TcHttpdConnection_t* i_connection,const NyLPC_TChar* i_fname,NyLPC_TcHttpBodyParser_t* i_body_parser);
nyatla 41:2389bd6b6f74 37 /**
nyatla 41:2389bd6b6f74 38 * i_fnameのファイルを作成します。
nyatla 41:2389bd6b6f74 39 * この関数はHTTPD_LOCKがかかった状態でコールされます。
nyatla 41:2389bd6b6f74 40 * 関数にはコネクションにHTTP応答を返却する実装をしてください。
nyatla 41:2389bd6b6f74 41 * @return
nyatla 41:2389bd6b6f74 42 * 処理が失敗した場合はFALSEを返します。FALSEを返すとCallerはHTTPセッションを切断します。
nyatla 41:2389bd6b6f74 43 */
nyatla 41:2389bd6b6f74 44 typedef NyLPC_TBool (*NyLPC_cModFileIoBaseClass_createFunction)(NyLPC_TcHttpdConnection_t* i_connection,const NyLPC_TChar* i_fname);
nyatla 41:2389bd6b6f74 45 /**
nyatla 41:2389bd6b6f74 46 * i_fnameのファイルを削除します。
nyatla 41:2389bd6b6f74 47 * この関数はHTTPD_LOCKがかかった状態でコールされます。
nyatla 41:2389bd6b6f74 48 * 関数にはコネクションにHTTP応答を返却する実装をしてください。
nyatla 41:2389bd6b6f74 49 * @return
nyatla 41:2389bd6b6f74 50 * 処理が失敗した場合はFALSEを返します。FALSEを返すとCallerはHTTPセッションを切断します。
nyatla 41:2389bd6b6f74 51 */
nyatla 41:2389bd6b6f74 52 typedef NyLPC_TBool (*NyLPC_cModFileIoBaseClass_removeFunction)(NyLPC_TcHttpdConnection_t* i_connection,const NyLPC_TChar* i_fname);
nyatla 41:2389bd6b6f74 53
nyatla 41:2389bd6b6f74 54 /**
nyatla 41:2389bd6b6f74 55 * Abstruct関数テーブル
nyatla 41:2389bd6b6f74 56 */
nyatla 41:2389bd6b6f74 57 struct NyLPC_TcModFileIoBaseClass_AbstructFunction
nyatla 41:2389bd6b6f74 58 {
nyatla 41:2389bd6b6f74 59 NyLPC_cModFileIoBaseClass_uploadFunction upload;
nyatla 41:2389bd6b6f74 60 NyLPC_cModFileIoBaseClass_createFunction create;
nyatla 41:2389bd6b6f74 61 NyLPC_cModFileIoBaseClass_removeFunction remove;
nyatla 41:2389bd6b6f74 62 };
nyatla 41:2389bd6b6f74 63
nyatla 41:2389bd6b6f74 64 /**
nyatla 41:2389bd6b6f74 65 * クラス構造体
nyatla 41:2389bd6b6f74 66 */
nyatla 41:2389bd6b6f74 67 struct NyLPC_TcModFileIoBaseClass
nyatla 41:2389bd6b6f74 68 {
nyatla 41:2389bd6b6f74 69 NyLPC_TcModRomFiles_t super;
nyatla 41:2389bd6b6f74 70 /**
nyatla 41:2389bd6b6f74 71 * 処理関数へのポインタ構造体
nyatla 41:2389bd6b6f74 72 */
nyatla 41:2389bd6b6f74 73 struct NyLPC_TcModFileIoBaseClass_AbstructFunction _abstruct_function;
nyatla 41:2389bd6b6f74 74 };
nyatla 41:2389bd6b6f74 75
nyatla 41:2389bd6b6f74 76 /**
nyatla 41:2389bd6b6f74 77 * コンストラクタ。
nyatla 41:2389bd6b6f74 78 */
nyatla 41:2389bd6b6f74 79 void NyLPC_cModFileIoBaseClass_initialize(NyLPC_TcModFileIoBaseClass_t* i_inst,const NyLPC_TChar* i_ref_root_path);
nyatla 41:2389bd6b6f74 80 void NyLPC_cModFileIoBaseClass_finalize(NyLPC_TcModFileIoBaseClass_t* i_inst);
nyatla 41:2389bd6b6f74 81
nyatla 41:2389bd6b6f74 82 /**
nyatla 41:2389bd6b6f74 83 * モジュールがコネクションをハンドリングできるかを返します。
nyatla 41:2389bd6b6f74 84 */
nyatla 41:2389bd6b6f74 85 NyLPC_TBool NyLPC_cModFileIoBaseClass_canHandle(NyLPC_TcModFileIoBaseClass_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
nyatla 41:2389bd6b6f74 86 /**
nyatla 41:2389bd6b6f74 87 * モジュールを実行します。
nyatla 41:2389bd6b6f74 88 * この関数は、リクエストを解析して、抽象関数upload,create,deleteの何れかに該当する場合はそれを呼び出します。
nyatla 41:2389bd6b6f74 89 * @return
nyatla 41:2389bd6b6f74 90 * 処理に成功したか
nyatla 41:2389bd6b6f74 91 */
nyatla 41:2389bd6b6f74 92 NyLPC_TBool NyLPC_cModFileIoBaseClass_execute(NyLPC_TcModFileIoBaseClass_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
nyatla 41:2389bd6b6f74 93
nyatla 41:2389bd6b6f74 94 #ifdef __cplusplus
nyatla 41:2389bd6b6f74 95 }
nyatla 41:2389bd6b6f74 96 #endif /* __cplusplus */
nyatla 41:2389bd6b6f74 97
nyatla 41:2389bd6b6f74 98 #endif /* NYLPC_CMODREMOTEMCU_H_ */