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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

チュートリアル

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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Tutorial

Committer:
nyatla
Date:
Wed Nov 19 14:45:17 2014 +0000
Revision:
109:18f12ac01097
Parent:
57:bc4330dfa62f
new MiMicIP API;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 /*
nyatla 2:b96c1e90d120 2 * NyLPC_cHttpdConnection.h
nyatla 2:b96c1e90d120 3 *
nyatla 2:b96c1e90d120 4 * Created on: 2013/02/07
nyatla 2:b96c1e90d120 5 * Author: nyatla
nyatla 2:b96c1e90d120 6 */
nyatla 2:b96c1e90d120 7
nyatla 2:b96c1e90d120 8 #ifndef NYLPC_CHTTPDCONNECTION_PROTECTED_H_
nyatla 2:b96c1e90d120 9 #define NYLPC_CHTTPDCONNECTION_PROTECTED_H_
nyatla 109:18f12ac01097 10 #include "NyLPC_netif.h"
nyatla 109:18f12ac01097 11 #include "NyLPC_stdlib.h"
nyatla 2:b96c1e90d120 12 #include "NyLPC_cHttpdConnection.h"
nyatla 14:4618692ec239 13 #include "NyLPC_cHttpdUtils.h"
nyatla 12:efe841863fc8 14
nyatla 12:efe841863fc8 15 #ifdef __cplusplus
nyatla 12:efe841863fc8 16 extern "C" {
nyatla 12:efe841863fc8 17 #endif /* __cplusplus */
nyatla 12:efe841863fc8 18
nyatla 2:b96c1e90d120 19 /**
nyatla 2:b96c1e90d120 20 * コネクションモード
nyatla 2:b96c1e90d120 21 */
nyatla 2:b96c1e90d120 22 typedef NyLPC_TUInt8 NyLPC_TcHttpdConnection_CONNECTION_MODE;
nyatla 2:b96c1e90d120 23 /**
nyatla 2:b96c1e90d120 24 * 持続性接続
nyatla 2:b96c1e90d120 25 */
nyatla 2:b96c1e90d120 26 #define NyLPC_TcHttpdConnection_CONNECTION_MODE_CONTINUE 1
nyatla 2:b96c1e90d120 27 /**
nyatla 2:b96c1e90d120 28 * 持続性接続キャンセル
nyatla 2:b96c1e90d120 29 */
nyatla 2:b96c1e90d120 30 #define NyLPC_TcHttpdConnection_CONNECTION_MODE_CLOSE 2
nyatla 2:b96c1e90d120 31
nyatla 2:b96c1e90d120 32 /**
nyatla 2:b96c1e90d120 33 * URL Prefixを返却します。
nyatla 2:b96c1e90d120 34 */
nyatla 2:b96c1e90d120 35 const NyLPC_TChar* NyLPC_cHttpdConnection_getUrlPrefix(const NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 36
nyatla 2:b96c1e90d120 37 /**
nyatla 2:b96c1e90d120 38 * コネクションステータスをパース済みに設定します。
nyatla 2:b96c1e90d120 39 * HttpModで処理を行った後にコールします。
nyatla 2:b96c1e90d120 40 */
nyatla 2:b96c1e90d120 41 void NyLPC_cHttpdConnection_setReqStatusParsed(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 42
nyatla 2:b96c1e90d120 43
nyatla 2:b96c1e90d120 44 /**
nyatla 57:bc4330dfa62f 45 * コネクションをHTTPレベルで閉じます。
nyatla 57:bc4330dfa62f 46 * ResponseステータスはCLOSEDになります。Requestステータスは変化しません。
nyatla 2:b96c1e90d120 47 */
nyatla 2:b96c1e90d120 48 NyLPC_TBool NyLPC_cHttpdConnection_closeResponse(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 49
nyatla 2:b96c1e90d120 50
nyatla 2:b96c1e90d120 51 /**
nyatla 2:b96c1e90d120 52 * ソケットをlistenします。LISTEN状態のソケットに使えます。
nyatla 2:b96c1e90d120 53 */
nyatla 109:18f12ac01097 54 NyLPC_TBool NyLPC_cHttpdConnection_listenSocket(NyLPC_TcHttpdConnection_t* i_inst,NyLPC_TiTcpListener_t* i_listener);
nyatla 2:b96c1e90d120 55
nyatla 2:b96c1e90d120 56 /**
nyatla 2:b96c1e90d120 57 * コネクションのソケットをacceptします。
nyatla 2:b96c1e90d120 58 * listenSocketが成功したソケットにだけ使えます。
nyatla 2:b96c1e90d120 59 * 関数が成功すると、REQStatusがHEADに遷移します。
nyatla 2:b96c1e90d120 60 */
nyatla 2:b96c1e90d120 61 NyLPC_TBool NyLPC_cHttpdConnection_acceptSocket(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 62
nyatla 2:b96c1e90d120 63 /**
nyatla 57:bc4330dfa62f 64 * コネクションのソケットを閉じます。
nyatla 57:bc4330dfa62f 65 * ResponseステータスはCLOSEDになり、RequestステータスはLISTENになります。
nyatla 2:b96c1e90d120 66 */
nyatla 2:b96c1e90d120 67 void NyLPC_cHttpdConnection_closeSocket(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 68
nyatla 2:b96c1e90d120 69 /**
nyatla 2:b96c1e90d120 70 * ヘッダをprefetchします。
nyatla 2:b96c1e90d120 71 */
nyatla 2:b96c1e90d120 72 NyLPC_TBool NyLPC_cHttpdConnection_prefetch(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 73
nyatla 2:b96c1e90d120 74 /**
nyatla 2:b96c1e90d120 75 * コネクションのプリフェッチデータをヘッダパーサへpushします。
nyatla 2:b96c1e90d120 76 */
nyatla 2:b96c1e90d120 77 NyLPC_TBool NyLPC_cHttpdConnection_pushPrefetchInfo(NyLPC_TcHttpdConnection_t* i_inst,NyLPC_TcHttpBasicHeaderParser_t* i_header_parser,struct NyLPC_THttpBasicHeader* o_out);
nyatla 2:b96c1e90d120 78
nyatla 2:b96c1e90d120 79
nyatla 2:b96c1e90d120 80 /**
nyatla 2:b96c1e90d120 81 * 次のプリフェッチを準備する。
nyatla 2:b96c1e90d120 82 */
nyatla 2:b96c1e90d120 83 NyLPC_TBool NyLPC_cHttpdConnection_prevNextPrefetch(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 84
nyatla 2:b96c1e90d120 85 /**
nyatla 2:b96c1e90d120 86 * リクエストのパースを完了する。
nyatla 2:b96c1e90d120 87 */
nyatla 2:b96c1e90d120 88 void NyLPC_cHttpdConnection_requestParsed(NyLPC_TcHttpdConnection_t* i_inst);
nyatla 2:b96c1e90d120 89
nyatla 41:2389bd6b6f74 90
nyatla 2:b96c1e90d120 91 /**
nyatla 2:b96c1e90d120 92 * コネクションのモードをセットする。
nyatla 2:b96c1e90d120 93 * この関数はhttpdハンドラのコールするモジュールが呼び出すことが有る。
nyatla 2:b96c1e90d120 94 * HTTPリクエストのバージョンが1.1かつconnectionがCLOSEで無い場合、CONTINUEを指定することで持続性接続に設定できる。
nyatla 2:b96c1e90d120 95 * 関数は、NyLPC_cHttpdConnection_sendResponseHeaderをコールする前に実行すること。
nyatla 2:b96c1e90d120 96 */
nyatla 43:a182f2b5ff41 97 #define NyLPC_cHttpdConnection_setConnectionMode(i_inst,i_mode) (i_inst)->_connection_message_mode=(i_mode)
nyatla 2:b96c1e90d120 98
nyatla 2:b96c1e90d120 99 NyLPC_TUInt16 NyLPC_cHttpd_incNumOfConnection(NyLPC_TcHttpd_t* i_inst);
nyatla 2:b96c1e90d120 100 NyLPC_TUInt16 NyLPC_cHttpd_decNumOfConnection(NyLPC_TcHttpd_t* i_inst);
nyatla 2:b96c1e90d120 101
nyatla 12:efe841863fc8 102 #ifdef __cplusplus
nyatla 12:efe841863fc8 103 }
nyatla 12:efe841863fc8 104 #endif /* __cplusplus */
nyatla 2:b96c1e90d120 105 #endif /* NYLPC_CHTTPDCONNECTION_H_ */