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:
Fri Sep 13 06:38:16 2013 +0000
Revision:
57:bc4330dfa62f
Parent:
43:a182f2b5ff41
update mimic core r329;

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 #include "NyLPC_cModRomFiles_protected.h"
nyatla 2:b96c1e90d120 27 #include "NyLPC_stdlib.h"
nyatla 7:2b33a8d84eb3 28 #include "NyLPC_http.h"
nyatla 14:4618692ec239 29 #include "../NyLPC_cHttpdUtils.h"
nyatla 2:b96c1e90d120 30 #include "../NyLPC_cHttpdConnection_protected.h"
nyatla 2:b96c1e90d120 31
nyatla 2:b96c1e90d120 32
nyatla 2:b96c1e90d120 33 /**
nyatla 2:b96c1e90d120 34 * コンストラクタ。
nyatla 2:b96c1e90d120 35 * @param i_ref_path
nyatla 2:b96c1e90d120 36 * 16文字以内のルートパスを指定します。文字列は外部参照です。インスタンスをfinalizeするまで維持してください。
nyatla 2:b96c1e90d120 37 * 文字列は/で開始され/で終了する必要があります。
nyatla 2:b96c1e90d120 38 * path:= /({.,14}/)?
nyatla 2:b96c1e90d120 39 * @param i_data
nyatla 2:b96c1e90d120 40 * ROMFile構造体の配列の先頭アドレス
nyatla 2:b96c1e90d120 41 */
nyatla 2:b96c1e90d120 42 void NyLPC_cModRomFiles_initialize(NyLPC_TcModRomFiles_t* i_inst,const NyLPC_TChar* i_ref_root_path,const struct NyLPC_TRomFileData* i_data,int i_num_of_data)
nyatla 2:b96c1e90d120 43 {
nyatla 7:2b33a8d84eb3 44 NyLPC_cModUrl_initialize(&(i_inst->super));
nyatla 2:b96c1e90d120 45 i_inst->_data=i_data;
nyatla 2:b96c1e90d120 46 i_inst->_num_of_data=i_num_of_data;
nyatla 2:b96c1e90d120 47 i_inst->_ref_root_path=i_ref_root_path;
nyatla 2:b96c1e90d120 48 }
nyatla 2:b96c1e90d120 49 void NyLPC_cModRomFiles_finalize(NyLPC_TcModRomFiles_t* i_inst)
nyatla 2:b96c1e90d120 50 {
nyatla 7:2b33a8d84eb3 51 NyLPC_cModUrl_finalize(&(i_inst->super));
nyatla 2:b96c1e90d120 52 }
nyatla 2:b96c1e90d120 53
nyatla 2:b96c1e90d120 54 /**
nyatla 2:b96c1e90d120 55 * モジュールがコネクションをハンドリングできるかを返します。
nyatla 2:b96c1e90d120 56 */
nyatla 2:b96c1e90d120 57 NyLPC_TBool NyLPC_cModRomFiles_canHandle(NyLPC_TcModRomFiles_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection)
nyatla 2:b96c1e90d120 58 {
nyatla 2:b96c1e90d120 59 const NyLPC_TChar* in_url;
nyatla 2:b96c1e90d120 60 const NyLPC_TChar* base_url=i_inst->_ref_root_path;
nyatla 19:33b9ba0859ee 61 //connectonの状態を確認
nyatla 19:33b9ba0859ee 62 if(!NyLPC_cHttpdConnection_getReqStatus(i_connection)==NyLPC_cHttpdConnection_ReqStatus_REQPARSE)
nyatla 19:33b9ba0859ee 63 {
nyatla 19:33b9ba0859ee 64 return NyLPC_TBool_FALSE;
nyatla 19:33b9ba0859ee 65 }
nyatla 2:b96c1e90d120 66 in_url=NyLPC_cHttpdConnection_getUrlPrefix(i_connection);
nyatla 2:b96c1e90d120 67 size_t base_url_len=strlen(base_url);
nyatla 7:2b33a8d84eb3 68 //check '/'+base_url+'/'
nyatla 7:2b33a8d84eb3 69 if(strlen(in_url)-2<base_url_len){
nyatla 2:b96c1e90d120 70 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 71 }
nyatla 7:2b33a8d84eb3 72 if(in_url[0]!='/' || strncmp(in_url+1,base_url,base_url_len)!=0 || in_url[base_url_len+1]!='/'){
nyatla 2:b96c1e90d120 73 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 74 }
nyatla 2:b96c1e90d120 75 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 76 }
nyatla 2:b96c1e90d120 77
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_cModRomFiles_execute(NyLPC_TcModRomFiles_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection)
nyatla 2:b96c1e90d120 84 {
nyatla 2:b96c1e90d120 85 int i;
nyatla 7:2b33a8d84eb3 86 char url[32];
nyatla 19:33b9ba0859ee 87 NyLPC_TUInt8 method_type;
nyatla 19:33b9ba0859ee 88 //URLサフィックスを取得(rootpath+'2'*2)
nyatla 19:33b9ba0859ee 89 if(!NyLPC_cModUrl_execute2(&(i_inst->super),i_connection,url,32,strlen(i_inst->_ref_root_path)+2,NyLPC_cModUrl_ParseMode_PATH_ONLY))
nyatla 2:b96c1e90d120 90 {
nyatla 19:33b9ba0859ee 91 //Response処理はモジュール内で実行済
nyatla 19:33b9ba0859ee 92 NyLPC_OnErrorGoto(Error1);
nyatla 2:b96c1e90d120 93 }
nyatla 19:33b9ba0859ee 94 //GETかHEADに制限
nyatla 19:33b9ba0859ee 95 method_type=NyLPC_cHttpdConnection_getMethod(i_connection);
nyatla 19:33b9ba0859ee 96 if(method_type!=NyLPC_THttpMethodType_GET && method_type!=NyLPC_THttpMethodType_HEAD)
nyatla 2:b96c1e90d120 97 {
nyatla 19:33b9ba0859ee 98 NyLPC_cHttpdUtils_sendErrorResponse(i_connection,405);
nyatla 19:33b9ba0859ee 99 NyLPC_OnErrorGoto(Error1);
nyatla 7:2b33a8d84eb3 100 }
nyatla 7:2b33a8d84eb3 101 if(strlen(url)==0)
nyatla 7:2b33a8d84eb3 102 {
nyatla 7:2b33a8d84eb3 103 //PrefixがURLよりも短ければ403エラーで処理終了。
nyatla 19:33b9ba0859ee 104 NyLPC_cHttpdUtils_sendErrorResponse(i_connection,403);
nyatla 19:33b9ba0859ee 105 NyLPC_OnErrorGoto(Error1);
nyatla 2:b96c1e90d120 106 }
nyatla 2:b96c1e90d120 107 //URL比較
nyatla 2:b96c1e90d120 108 for(i=i_inst->_num_of_data-1;i>=0;i--)
nyatla 2:b96c1e90d120 109 {
nyatla 7:2b33a8d84eb3 110 if(strcmp(url,i_inst->_data[i].name)!=0){
nyatla 2:b96c1e90d120 111 continue;
nyatla 2:b96c1e90d120 112 }
nyatla 43:a182f2b5ff41 113 //Request::ConnectionがClose設定,又はHTTP1.1では無い場合,CLOSE
nyatla 43:a182f2b5ff41 114 if(i_inst->super._header.connection==NyLPC_THttpMessgeHeader_Connection_CLOSE || i_inst->super._header.startline.req.version!=NyLPC_THttpVersion_11)
nyatla 2:b96c1e90d120 115 {
nyatla 43:a182f2b5ff41 116 NyLPC_cHttpdConnection_setConnectionMode(i_connection,NyLPC_TcHttpdConnection_CONNECTION_MODE_CLOSE);
nyatla 2:b96c1e90d120 117 }
nyatla 57:bc4330dfa62f 118 return NyLPC_cHttpdUtils_sendFixedContentBatch(i_connection,i_inst->_data[i].content_type,i_inst->_data[i].data,(i_inst->_data[i].size>0)?i_inst->_data[i].size:strlen(i_inst->_data[i].data));
nyatla 2:b96c1e90d120 119 }
nyatla 2:b96c1e90d120 120 //404Error
nyatla 19:33b9ba0859ee 121 NyLPC_cHttpdUtils_sendErrorResponse(i_connection,404);
nyatla 19:33b9ba0859ee 122 Error1:
nyatla 19:33b9ba0859ee 123 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 124 }