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

mbed/HttpdConnection.cpp@81:e5e4f2264d24, 2014-06-24 (annotated)

Committer:
nyatla
Date:
Tue Jun 24 14:34:39 2014 +0000
Revision:
81:e5e4f2264d24
Parent:
43:a182f2b5ff41 
???????????????JsonRPC??????????; LPC4088/LPC1768??????????;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 4:909dc70956e7 1 #include "HttpdConnection.h"
nyatla 4:909dc70956e7 2 namespace MiMic
nyatla 4:909dc70956e7 3 {
nyatla 18:1970fec78229 4
nyatla 18:1970fec78229 5 int HttpdConnection::getMethodType()
nyatla 18:1970fec78229 6 {
nyatla 18:1970fec78229 7 return NyLPC_cHttpdConnection_getMethod(this->_ref_inst);
nyatla 18:1970fec78229 8 }
nyatla 18:1970fec78229 9
nyatla 18:1970fec78229 10 bool HttpdConnection::isMethodType(int i_method_type)
nyatla 18:1970fec78229 11 {
nyatla 18:1970fec78229 12 return NyLPC_cHttpdConnection_getMethod(this->_ref_inst)==i_method_type;
nyatla 18:1970fec78229 13 }
nyatla 18:1970fec78229 14
nyatla 4:909dc70956e7 15 HttpdConnection::HttpdConnection(NyLPC_TcHttpdConnection* i_ref_inst)
nyatla 4:909dc70956e7 16 {
nyatla 4:909dc70956e7 17 this->_ref_inst=i_ref_inst;
nyatla 4:909dc70956e7 18 }
nyatla 43:a182f2b5ff41 19 bool HttpdConnection::sendError(unsigned short i_status_code)
nyatla 43:a182f2b5ff41 20 {
nyatla 43:a182f2b5ff41 21 return NyLPC_TBool_TRUE==NyLPC_cHttpdConnection_sendResponseHeader2(this->_ref_inst,i_status_code,"text/html",0,NULL);
nyatla 43:a182f2b5ff41 22 }
nyatla 4:909dc70956e7 23 bool HttpdConnection::sendHeader(unsigned short i_status_code,const char* i_content_type,const char* i_additional_header)
nyatla 4:909dc70956e7 24 {
nyatla 4:909dc70956e7 25 return NyLPC_TBool_TRUE==NyLPC_cHttpdConnection_sendResponseHeader(this->_ref_inst,i_status_code,i_content_type,i_additional_header);
nyatla 4:909dc70956e7 26 }
nyatla 4:909dc70956e7 27 bool HttpdConnection::sendHeader(unsigned short i_status_code,const char* i_content_type,const char* i_additional_header,unsigned int i_length)
nyatla 4:909dc70956e7 28 {
nyatla 4:909dc70956e7 29 return NyLPC_TBool_TRUE==NyLPC_cHttpdConnection_sendResponseHeader2(this->_ref_inst,i_status_code,i_content_type,i_length,i_additional_header);
nyatla 4:909dc70956e7 30 }
nyatla 4:909dc70956e7 31 bool HttpdConnection::sendBody(const void* i_data,NyLPC_TUInt32 i_size)
nyatla 4:909dc70956e7 32 {
nyatla 4:909dc70956e7 33 return NyLPC_TBool_TRUE==NyLPC_cHttpdConnection_sendResponseBody(this->_ref_inst,i_data,i_size);
nyatla 4:909dc70956e7 34 }
nyatla 4:909dc70956e7 35 bool HttpdConnection::sendBodyF(const char* i_fmt,...)
nyatla 4:909dc70956e7 36 {
nyatla 4:909dc70956e7 37 va_list a;
nyatla 4:909dc70956e7 38 if(this->_ref_inst->_res_status!=NyLPC_cHttpdConnection_ResStatus_BODY)
nyatla 4:909dc70956e7 39 {
nyatla 4:909dc70956e7 40 NyLPC_OnErrorGoto(Error);
nyatla 4:909dc70956e7 41 }
nyatla 4:909dc70956e7 42 //Bodyの書込み
nyatla 4:909dc70956e7 43 va_start(a,i_fmt);
nyatla 4:909dc70956e7 44 if(!NyLPC_cHttpBodyWriter_formatV(&(this->_ref_inst->_body_writer),i_fmt,a)){
nyatla 4:909dc70956e7 45 NyLPC_OnErrorGoto(Error_Send);
nyatla 4:909dc70956e7 46 }
nyatla 4:909dc70956e7 47 va_end(a);
nyatla 4:909dc70956e7 48 return true;
nyatla 4:909dc70956e7 49 Error_Send:
nyatla 4:909dc70956e7 50 va_end(a);
nyatla 4:909dc70956e7 51 NyLPC_cHttpBodyWriter_finalize(&(this->_ref_inst->_in_stream));
nyatla 4:909dc70956e7 52 Error:
nyatla 4:909dc70956e7 53 this->_ref_inst->_res_status=NyLPC_cHttpdConnection_ResStatus_ERROR;
nyatla 4:909dc70956e7 54 return false;
nyatla 7:2b33a8d84eb3 55 }
nyatla 7:2b33a8d84eb3 56 void HttpdConnection::lockHttpd()
nyatla 7:2b33a8d84eb3 57 {
nyatla 7:2b33a8d84eb3 58 NyLPC_cHttpdConnection_lock(this->_ref_inst);
nyatla 7:2b33a8d84eb3 59 }
nyatla 19:33b9ba0859ee 60 void HttpdConnection::unlockHttpd()
nyatla 7:2b33a8d84eb3 61 {
nyatla 7:2b33a8d84eb3 62 NyLPC_cHttpdConnection_unlock(this->_ref_inst);
nyatla 7:2b33a8d84eb3 63 }
nyatla 81:e5e4f2264d24 64 void HttpdConnection::breakPersistentConnection()
nyatla 81:e5e4f2264d24 65 {
nyatla 81:e5e4f2264d24 66 NyLPC_cHttpdConnection_setConnectionMode(this->_ref_inst,NyLPC_TcHttpdConnection_CONNECTION_MODE_CLOSE);
nyatla 81:e5e4f2264d24 67 }
nyatla 4:909dc70956e7 68 }