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:
Mon Mar 25 05:23:49 2013 +0000
Revision:
1:9f6a78395432
Child:
2:b96c1e90d120
MiMic repository r191???

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 1:9f6a78395432 1 /*********************************************************************************
nyatla 1:9f6a78395432 2 * PROJECT: MiMic
nyatla 1:9f6a78395432 3 * --------------------------------------------------------------------------------
nyatla 1:9f6a78395432 4 *
nyatla 1:9f6a78395432 5 * This file is part of MiMic
nyatla 1:9f6a78395432 6 * Copyright (C)2011 Ryo Iizuka
nyatla 1:9f6a78395432 7 *
nyatla 1:9f6a78395432 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 1:9f6a78395432 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 1:9f6a78395432 10 * by the Free Software Foundation, either version 3 of the License, or
nyatla 1:9f6a78395432 11 * (at your option) any later version.
nyatla 1:9f6a78395432 12 *
nyatla 1:9f6a78395432 13 * This program is distributed in the hope that it will be useful,
nyatla 1:9f6a78395432 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 1:9f6a78395432 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 1:9f6a78395432 16 * GNU General Public License for more details.
nyatla 1:9f6a78395432 17 *
nyatla 1:9f6a78395432 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 1:9f6a78395432 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 1:9f6a78395432 20 *
nyatla 1:9f6a78395432 21 * For further information please contact.
nyatla 1:9f6a78395432 22 * http://nyatla.jp/
nyatla 1:9f6a78395432 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 1:9f6a78395432 24 *
nyatla 1:9f6a78395432 25 *********************************************************************************/
nyatla 1:9f6a78395432 26 #include <stdlib.h>
nyatla 1:9f6a78395432 27
nyatla 1:9f6a78395432 28 #include "NyLPC_cHttpHeaderWriter.h"
nyatla 1:9f6a78395432 29 #include "NyLPC_cHttpdConfig.h"
nyatla 1:9f6a78395432 30
nyatla 1:9f6a78395432 31
nyatla 1:9f6a78395432 32 /**
nyatla 1:9f6a78395432 33 * Httpリクエストヘッダに対応したHttpヘッダライタを構築します。
nyatla 1:9f6a78395432 34 */
nyatla 1:9f6a78395432 35 NyLPC_TBool NyLPC_cHttpHeaderWriter_initialize(NyLPC_TcHttpHeaderWriter_t* i_inst,NyLPC_TcHttpStream_t* i_ref_stream,const struct NyLPC_THttpBasicHeader* i_req_header)
nyatla 1:9f6a78395432 36 {
nyatla 1:9f6a78395432 37 i_inst->_is_chunked=NyLPC_TUInt8_FALSE;
nyatla 1:9f6a78395432 38 i_inst->_content_length=0;
nyatla 1:9f6a78395432 39 i_inst->_ref_stream=i_ref_stream;
nyatla 1:9f6a78395432 40 i_inst->_is_error=NyLPC_TUInt8_FALSE;
nyatla 1:9f6a78395432 41 //書込エンコーディングをなしにセット
nyatla 1:9f6a78395432 42 NyLPC_iHttpPtrStream_setWriteEncoding(i_inst->_ref_stream,NyLPC_TiHttpPtrStream_ET_NONE);
nyatla 1:9f6a78395432 43 //必要に応じてリクエストの内容をパース
nyatla 1:9f6a78395432 44 if(i_req_header!=NULL){
nyatla 1:9f6a78395432 45 if(i_req_header->type!=NyLPC_THttpHeaderType_REQUEST){
nyatla 1:9f6a78395432 46 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 47 }
nyatla 1:9f6a78395432 48 //コネクションの持続性を決定
nyatla 1:9f6a78395432 49 if((i_req_header->connection==NyLPC_THttpMessgeHeader_Connection_CLOSE)||
nyatla 1:9f6a78395432 50 (i_req_header->startline.req.version!=NyLPC_THttpVersion_11))
nyatla 1:9f6a78395432 51 {
nyatla 1:9f6a78395432 52 i_inst->_is_close=NyLPC_TUInt8_TRUE;
nyatla 1:9f6a78395432 53 }else{
nyatla 1:9f6a78395432 54 i_inst->_is_close=NyLPC_TUInt8_FALSE;
nyatla 1:9f6a78395432 55 }
nyatla 1:9f6a78395432 56 }else{
nyatla 1:9f6a78395432 57 i_inst->_is_close=NyLPC_TUInt8_TRUE;
nyatla 1:9f6a78395432 58 }
nyatla 1:9f6a78395432 59 return NyLPC_TBool_TRUE;
nyatla 1:9f6a78395432 60 }
nyatla 1:9f6a78395432 61
nyatla 1:9f6a78395432 62 #define NyLPC_cHttpHttpWriter_finalize(i)
nyatla 1:9f6a78395432 63
nyatla 1:9f6a78395432 64
nyatla 1:9f6a78395432 65 void NyLPC_cHttpHeaderWriter_setChunked(NyLPC_TcHttpHeaderWriter_t* i_inst)
nyatla 1:9f6a78395432 66 {
nyatla 1:9f6a78395432 67 i_inst->_is_chunked=NyLPC_TUInt8_TRUE;
nyatla 1:9f6a78395432 68 return;
nyatla 1:9f6a78395432 69 }
nyatla 1:9f6a78395432 70 void NyLPC_cHttpHeaderWriter_setContentLength(NyLPC_TcHttpHeaderWriter_t* i_inst,NyLPC_TUInt32 i_content_length)
nyatla 1:9f6a78395432 71 {
nyatla 1:9f6a78395432 72 i_inst->_content_length=i_content_length;
nyatla 1:9f6a78395432 73 return;
nyatla 1:9f6a78395432 74 }
nyatla 1:9f6a78395432 75 void NyLPC_cHttpHeaderWriter_setClose(NyLPC_TcHttpHeaderWriter_t* i_inst)
nyatla 1:9f6a78395432 76 {
nyatla 1:9f6a78395432 77 i_inst->_is_close=NyLPC_TUInt8_TRUE;
nyatla 1:9f6a78395432 78 return;
nyatla 1:9f6a78395432 79 }
nyatla 1:9f6a78395432 80
nyatla 1:9f6a78395432 81
nyatla 1:9f6a78395432 82
nyatla 1:9f6a78395432 83 const static struct{
nyatla 1:9f6a78395432 84 NyLPC_TUInt16 code;
nyatla 1:9f6a78395432 85 const NyLPC_TChar* message;
nyatla 1:9f6a78395432 86 }status_line_tbl[]={
nyatla 1:9f6a78395432 87 {200,"OK"},
nyatla 1:9f6a78395432 88 {400,"Bad Request"},
nyatla 1:9f6a78395432 89 {403,"Forbidden"},
nyatla 1:9f6a78395432 90 {404,"Not Found"},
nyatla 1:9f6a78395432 91 {500,"Internal Server Error"},
nyatla 1:9f6a78395432 92 {0,NULL}//これ最後にしてね。
nyatla 1:9f6a78395432 93 };
nyatla 1:9f6a78395432 94 const static char* getStatusMessage(NyLPC_TUInt16 i_status)
nyatla 1:9f6a78395432 95 {
nyatla 1:9f6a78395432 96 int i=0;
nyatla 1:9f6a78395432 97 while(status_line_tbl[i].code!=0){
nyatla 1:9f6a78395432 98 if(i_status==status_line_tbl[i].code){
nyatla 1:9f6a78395432 99 return status_line_tbl[i].message;
nyatla 1:9f6a78395432 100 }
nyatla 1:9f6a78395432 101 i++;
nyatla 1:9f6a78395432 102 }
nyatla 1:9f6a78395432 103 return NULL;
nyatla 1:9f6a78395432 104 }
nyatla 1:9f6a78395432 105
nyatla 1:9f6a78395432 106 static NyLPC_TBool writeln(NyLPC_TcHttpStream_t* i_inst,const void* i_data,NyLPC_TInt16 i_length)
nyatla 1:9f6a78395432 107 {
nyatla 1:9f6a78395432 108 if(NyLPC_iHttpPtrStream_write(i_inst,i_data,i_length)){
nyatla 1:9f6a78395432 109 if(NyLPC_iHttpPtrStream_write(i_inst,"\r\n",2)){
nyatla 1:9f6a78395432 110 return NyLPC_TBool_TRUE;
nyatla 1:9f6a78395432 111 }
nyatla 1:9f6a78395432 112 }
nyatla 1:9f6a78395432 113 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 114 }
nyatla 1:9f6a78395432 115
nyatla 1:9f6a78395432 116
nyatla 1:9f6a78395432 117
nyatla 1:9f6a78395432 118 #define TIMEOUT 10*1000
nyatla 1:9f6a78395432 119
nyatla 1:9f6a78395432 120 /**
nyatla 1:9f6a78395432 121 * ステータスラインと、標準メッセージヘッダを出力します。
nyatla 1:9f6a78395432 122 */
nyatla 1:9f6a78395432 123 NyLPC_TBool NyLPC_cHttpHeaderWriter_writeHeader(NyLPC_TcHttpHeaderWriter_t* i_inst,NyLPC_TUInt16 i_status)
nyatla 1:9f6a78395432 124 {
nyatla 1:9f6a78395432 125 NyLPC_TChar v[12];
nyatla 1:9f6a78395432 126 const char* m=getStatusMessage(i_status);
nyatla 1:9f6a78395432 127 //エラー状態ならなにもしない。
nyatla 1:9f6a78395432 128 if(i_inst->_is_error){
nyatla 1:9f6a78395432 129 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 130 }
nyatla 1:9f6a78395432 131 //検索に失敗したら500番に変更
nyatla 1:9f6a78395432 132 if(m==NULL){
nyatla 1:9f6a78395432 133 i_status=500;
nyatla 1:9f6a78395432 134 m=getStatusMessage(500);
nyatla 1:9f6a78395432 135 }
nyatla 1:9f6a78395432 136 //ステータスラインの記述
nyatla 1:9f6a78395432 137 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,"HTTP/1.1 ",9)){
nyatla 1:9f6a78395432 138 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 139 }
nyatla 1:9f6a78395432 140 NyLPC_itoa(i_status,v,10);
nyatla 1:9f6a78395432 141 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,v,-1)){
nyatla 1:9f6a78395432 142 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 143 }
nyatla 1:9f6a78395432 144 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream," ",1)){
nyatla 1:9f6a78395432 145 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 146 }
nyatla 1:9f6a78395432 147 if(!writeln(i_inst->_ref_stream,m,-1)){
nyatla 1:9f6a78395432 148 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 149 }
nyatla 1:9f6a78395432 150 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,"Server: " NyLPC_cHttpdConfig_SERVER "\r\n",-1)){
nyatla 1:9f6a78395432 151 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 152 }
nyatla 1:9f6a78395432 153 if(i_inst->_is_close){
nyatla 1:9f6a78395432 154 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,"Connection: CLOSE\r\n",-1)){
nyatla 1:9f6a78395432 155 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 156 }
nyatla 1:9f6a78395432 157 }
nyatla 1:9f6a78395432 158 //ヘッダの記述
nyatla 1:9f6a78395432 159 if(i_inst->_is_chunked){
nyatla 1:9f6a78395432 160 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,"Transfer-Encoding: chunked\r\n",-1)){
nyatla 1:9f6a78395432 161 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 162 }
nyatla 1:9f6a78395432 163 }else{
nyatla 1:9f6a78395432 164 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,"Content-Length: ",-1)){
nyatla 1:9f6a78395432 165 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 166 }
nyatla 1:9f6a78395432 167 NyLPC_itoa(i_inst->_content_length,v,10);
nyatla 1:9f6a78395432 168 if(!writeln(i_inst->_ref_stream,v,-1)){
nyatla 1:9f6a78395432 169 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 170 }
nyatla 1:9f6a78395432 171 }
nyatla 1:9f6a78395432 172 //送信サイズをリセット
nyatla 1:9f6a78395432 173 i_inst->_size_of_sent=0;
nyatla 1:9f6a78395432 174 return NyLPC_TBool_TRUE;
nyatla 1:9f6a78395432 175 Error:
nyatla 1:9f6a78395432 176 i_inst->_is_error=NyLPC_TUInt8_FALSE;
nyatla 1:9f6a78395432 177 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 178 }
nyatla 1:9f6a78395432 179 /**
nyatla 1:9f6a78395432 180 * 独自定義のメッセージヘッダを記述します。
nyatla 1:9f6a78395432 181 */
nyatla 1:9f6a78395432 182 NyLPC_TBool NyLPC_cHttpHeaderWriter_writeMessage(NyLPC_TcHttpHeaderWriter_t* i_inst,const NyLPC_TChar* i_name,const NyLPC_TChar* i_field)
nyatla 1:9f6a78395432 183 {
nyatla 1:9f6a78395432 184 //エラー状態ならなにもしない。
nyatla 1:9f6a78395432 185 if(i_inst->_is_error){
nyatla 1:9f6a78395432 186 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 187 }
nyatla 1:9f6a78395432 188 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,i_name,-1)){
nyatla 1:9f6a78395432 189 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 190 }
nyatla 1:9f6a78395432 191 if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,": ",2)){
nyatla 1:9f6a78395432 192 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 193 }
nyatla 1:9f6a78395432 194 if(!writeln(i_inst->_ref_stream,i_field,-1)){
nyatla 1:9f6a78395432 195 NyLPC_OnErrorGoto(Error);
nyatla 1:9f6a78395432 196 }
nyatla 1:9f6a78395432 197 return NyLPC_TBool_TRUE;
nyatla 1:9f6a78395432 198 Error:
nyatla 1:9f6a78395432 199 i_inst->_is_error=NyLPC_TUInt8_FALSE;
nyatla 1:9f6a78395432 200 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 201 }
nyatla 1:9f6a78395432 202
nyatla 1:9f6a78395432 203 /**
nyatla 1:9f6a78395432 204 * Httpヘッダの書き込みを完了します。
nyatla 1:9f6a78395432 205 * 続けてbody転送が可能な場合は、必要に応じてエンコーディングモードを更新します。
nyatla 1:9f6a78395432 206 * @return
nyatla 1:9f6a78395432 207 * 現在のストリームのステータスを返します。
nyatla 1:9f6a78395432 208 */
nyatla 1:9f6a78395432 209 NyLPC_TBool NyLPC_cHttpHeaderWriter_close(NyLPC_TcHttpHeaderWriter_t* i_inst)
nyatla 1:9f6a78395432 210 {
nyatla 1:9f6a78395432 211 //エラー状態ならなにもしない。
nyatla 1:9f6a78395432 212 if(i_inst->_is_error){
nyatla 1:9f6a78395432 213 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 214 }
nyatla 1:9f6a78395432 215 if(NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,"\r\n",2)){
nyatla 1:9f6a78395432 216 if( NyLPC_iHttpPtrStream_flush(i_inst->_ref_stream)){
nyatla 1:9f6a78395432 217 return NyLPC_TBool_TRUE;
nyatla 1:9f6a78395432 218 }
nyatla 1:9f6a78395432 219 }
nyatla 1:9f6a78395432 220 return NyLPC_TBool_FALSE;
nyatla 1:9f6a78395432 221 }
nyatla 1:9f6a78395432 222
nyatla 1:9f6a78395432 223
nyatla 1:9f6a78395432 224