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_cModUrl.h@7:2b33a8d84eb3, 2013-04-09 (annotated)

Committer:
nyatla
Date:
Tue Apr 09 09:32:25 2013 +0000
Revision:
7:2b33a8d84eb3
Parent:
5:6d67db3875cb
Child:
19:33b9ba0859ee
add local filesysytem module.; change path rule of module initialization.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 5:6d67db3875cb 1 /*********************************************************************************
nyatla 5:6d67db3875cb 2 * PROJECT: MiMic
nyatla 5:6d67db3875cb 3 * --------------------------------------------------------------------------------
nyatla 5:6d67db3875cb 4 *
nyatla 5:6d67db3875cb 5 * This file is part of MiMic
nyatla 5:6d67db3875cb 6 * Copyright (C)2011 Ryo Iizuka
nyatla 5:6d67db3875cb 7 *
nyatla 5:6d67db3875cb 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 5:6d67db3875cb 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 5:6d67db3875cb 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 5:6d67db3875cb 11 * (at your option) any later version.
nyatla 5:6d67db3875cb 12 *
nyatla 5:6d67db3875cb 13 * This program is distributed in the hope that it will be useful,
nyatla 5:6d67db3875cb 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 5:6d67db3875cb 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 5:6d67db3875cb 16 * GNU General Public License for more details.
nyatla 5:6d67db3875cb 17 *
nyatla 5:6d67db3875cb 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 5:6d67db3875cb 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 5:6d67db3875cb 20 *
nyatla 5:6d67db3875cb 21 * For further information please contact.
nyatla 5:6d67db3875cb 22 * http://nyatla.jp/
nyatla 5:6d67db3875cb 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 5:6d67db3875cb 24 *
nyatla 5:6d67db3875cb 25 *********************************************************************************/
nyatla 5:6d67db3875cb 26 #ifndef NYLPC_CMODURL_H_
nyatla 5:6d67db3875cb 27 #define NYLPC_CMODURL_H_
nyatla 5:6d67db3875cb 28
nyatla 5:6d67db3875cb 29 #include "NyLPC_http.h"
nyatla 5:6d67db3875cb 30 #include "../NyLPC_cHttpdConnection.h"
nyatla 5:6d67db3875cb 31 #ifdef __cplusplus
nyatla 5:6d67db3875cb 32 extern "C" {
nyatla 5:6d67db3875cb 33 #endif /* __cplusplus */
nyatla 5:6d67db3875cb 34
nyatla 5:6d67db3875cb 35 /**
nyatla 5:6d67db3875cb 36 * URLを
nyatla 5:6d67db3875cb 37 */
nyatla 5:6d67db3875cb 38 typedef struct NyLPC_TcModUrl NyLPC_TcModUrl_t;
nyatla 5:6d67db3875cb 39
nyatla 5:6d67db3875cb 40
nyatla 5:6d67db3875cb 41 struct NyLPC_TcModUrl
nyatla 5:6d67db3875cb 42 {
nyatla 5:6d67db3875cb 43 struct NyLPC_THttpBasicHeader _header;
nyatla 5:6d67db3875cb 44 };
nyatla 5:6d67db3875cb 45
nyatla 5:6d67db3875cb 46 /**
nyatla 5:6d67db3875cb 47 * コンストラクタ。
nyatla 5:6d67db3875cb 48 */
nyatla 5:6d67db3875cb 49 void NyLPC_cModUrl_initialize(NyLPC_TcModUrl_t* i_inst);
nyatla 5:6d67db3875cb 50 void NyLPC_cModUrl_finalize(NyLPC_TcModUrl_t* i_inst);
nyatla 5:6d67db3875cb 51
nyatla 5:6d67db3875cb 52 /**
nyatla 7:2b33a8d84eb3 53 * コネクションから全てのURLをパースします。
nyatla 7:2b33a8d84eb3 54 * NyLPC_cModUrl_execute2のラッパーです。i_i_pass_prefix_lenに0を指定したときと同じ動作をします。
nyatla 7:2b33a8d84eb3 55 * @param o_url_buf
nyatla 7:2b33a8d84eb3 56 * 取得したURL文字列。i_pass_prefix_lenが指定されている場合は、URLの後半部分です。
nyatla 7:2b33a8d84eb3 57 * 戻り値がTRUEの場合に有効です。
nyatla 7:2b33a8d84eb3 58 * @return
nyatla 7:2b33a8d84eb3 59 * 処理が成功するとTRUEを返します。FALSEの場合、URLのパースに失敗しています。
nyatla 7:2b33a8d84eb3 60 * TRUEの場合は引き続きResponseの送信処理をしてください。FALSEの場合はそのままリクエストハンドラを終了してください。
nyatla 5:6d67db3875cb 61 */
nyatla 7:2b33a8d84eb3 62 #define NyLPC_cModUrl_execute(i_inst,i_connection,o_url_buf,i_length_buf) NyLPC_cModUrl_execute2((i_inst),(i_connection),(o_url_buf),(i_length_buf),0)
nyatla 7:2b33a8d84eb3 63
nyatla 7:2b33a8d84eb3 64 /**
nyatla 7:2b33a8d84eb3 65 * コネクションからURLをパースします。
nyatla 7:2b33a8d84eb3 66 * @param i_i_pass_prefix_len
nyatla 7:2b33a8d84eb3 67 * URLの先頭から取り除く文字数。
nyatla 7:2b33a8d84eb3 68 * 全てのURLを得るには0を指定します。
nyatla 7:2b33a8d84eb3 69 * @param o_url_buf
nyatla 7:2b33a8d84eb3 70 * 取得したURL文字列。i_pass_prefix_lenが指定されている場合は、URLの後半部分です。
nyatla 7:2b33a8d84eb3 71 * 戻り値がTRUEの場合に有効です。
nyatla 7:2b33a8d84eb3 72 * @return
nyatla 7:2b33a8d84eb3 73 * 処理が成功するとTRUEを返します。FALSEの場合、URLのパースに失敗しています。
nyatla 7:2b33a8d84eb3 74 * TRUEの場合は引き続きResponseの送信処理をしてください。FALSEの場合はそのままリクエストハンドラを終了してください。
nyatla 7:2b33a8d84eb3 75 */
nyatla 7:2b33a8d84eb3 76 NyLPC_TBool NyLPC_cModUrl_execute2(NyLPC_TcModUrl_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection,char* o_url_buf,NyLPC_TInt16 i_length_buf,NyLPC_TInt16 i_pass_prefix_len);
nyatla 5:6d67db3875cb 77
nyatla 5:6d67db3875cb 78 /**
nyatla 5:6d67db3875cb 79 * basicヘッダオブジェクトを返します。
nyatla 5:6d67db3875cb 80 */
nyatla 5:6d67db3875cb 81 const struct NyLPC_THttpBasicHeader* NyLPC_cModUrl_getHeader(const NyLPC_TcModUrl_t* i_inst);
nyatla 5:6d67db3875cb 82
nyatla 5:6d67db3875cb 83 /**
nyatla 5:6d67db3875cb 84 * Methodタイプを返します。
nyatla 5:6d67db3875cb 85 */
nyatla 5:6d67db3875cb 86 NyLPC_THttpMethodType NyLPC_cModUrl_getMethod(const NyLPC_TcModUrl_t* i_inst);
nyatla 5:6d67db3875cb 87
nyatla 5:6d67db3875cb 88
nyatla 5:6d67db3875cb 89
nyatla 5:6d67db3875cb 90
nyatla 5:6d67db3875cb 91
nyatla 5:6d67db3875cb 92
nyatla 5:6d67db3875cb 93 #ifdef __cplusplus
nyatla 5:6d67db3875cb 94 }
nyatla 5:6d67db3875cb 95 #endif /* __cplusplus */
nyatla 5:6d67db3875cb 96
nyatla 5:6d67db3875cb 97
nyatla 5:6d67db3875cb 98
nyatla 5:6d67db3875cb 99
nyatla 5:6d67db3875cb 100 #endif /* NYLPC_CMODURL_H_ */