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/mod/ModWebSocket.cpp@58:03b89038b21a, 2013-09-27 (annotated)

Committer:
nyatla
Date:
Fri Sep 27 12:47:51 2013 +0000
Revision:
58:03b89038b21a
Child:
72:c118a7aa37a3
add classes; checked:modwebsocket; unchecked:tcpsocket,udpsocket,httpclient.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 58:03b89038b21a 1 #include "ModWebSocket.h"
nyatla 58:03b89038b21a 2 #include "../net/httpd/mod/NyLPC_cModWebSocket_protected.h"
nyatla 58:03b89038b21a 3 #include "HttpdConnection.h"
nyatla 58:03b89038b21a 4
nyatla 58:03b89038b21a 5 namespace MiMic
nyatla 58:03b89038b21a 6 {
nyatla 58:03b89038b21a 7 ModWebSocket::ModWebSocket(const char* i_path):ModBaseClass(i_path)
nyatla 58:03b89038b21a 8 {
nyatla 58:03b89038b21a 9 this->_mod=NULL;
nyatla 58:03b89038b21a 10 }
nyatla 58:03b89038b21a 11 ModWebSocket::ModWebSocket()
nyatla 58:03b89038b21a 12 {
nyatla 58:03b89038b21a 13 this->_mod=NULL;
nyatla 58:03b89038b21a 14 }
nyatla 58:03b89038b21a 15 ModWebSocket::~ModWebSocket()
nyatla 58:03b89038b21a 16 {
nyatla 58:03b89038b21a 17 if(this->_mod!=NULL){
nyatla 58:03b89038b21a 18 NyLPC_cModWebSocket_finalize(this->_mod);
nyatla 58:03b89038b21a 19 this->_mod=NULL;
nyatla 58:03b89038b21a 20 }
nyatla 58:03b89038b21a 21 }
nyatla 58:03b89038b21a 22 void ModWebSocket::setParam(const char* i_path)
nyatla 58:03b89038b21a 23 {
nyatla 58:03b89038b21a 24 ModBaseClass::setParam(i_path);
nyatla 58:03b89038b21a 25 }
nyatla 58:03b89038b21a 26
nyatla 58:03b89038b21a 27 bool ModWebSocket::execute(HttpdConnection& i_connection)
nyatla 58:03b89038b21a 28 {
nyatla 58:03b89038b21a 29 if(this->_mod!=NULL){
nyatla 58:03b89038b21a 30 return false;
nyatla 58:03b89038b21a 31 }
nyatla 58:03b89038b21a 32 this->_mod=(NyLPC_TcModWebSocket_t*)malloc(sizeof(NyLPC_TcModWebSocket_t));
nyatla 58:03b89038b21a 33 if(this->_mod==NULL){
nyatla 58:03b89038b21a 34 return false;
nyatla 58:03b89038b21a 35 }
nyatla 58:03b89038b21a 36 //initialize websocket
nyatla 58:03b89038b21a 37 NyLPC_cModWebSocket_initialize(this->_mod,this->_path);
nyatla 58:03b89038b21a 38 if(NyLPC_cModWebSocket_canHandle(this->_mod,i_connection._ref_inst)){
nyatla 58:03b89038b21a 39 if(NyLPC_cModWebSocket_execute(this->_mod,i_connection._ref_inst)){
nyatla 58:03b89038b21a 40 return true;
nyatla 58:03b89038b21a 41 }
nyatla 58:03b89038b21a 42 }
nyatla 58:03b89038b21a 43 NyLPC_cModWebSocket_finalize(this->_mod);
nyatla 58:03b89038b21a 44 free(this->_mod);
nyatla 58:03b89038b21a 45 this->_mod=NULL;
nyatla 58:03b89038b21a 46 return false;
nyatla 58:03b89038b21a 47 }
nyatla 58:03b89038b21a 48 bool ModWebSocket::write(const void* i_tx_buf,int i_tx_size)
nyatla 58:03b89038b21a 49 {
nyatla 58:03b89038b21a 50 if(this->_mod==NULL){
nyatla 58:03b89038b21a 51 return false;
nyatla 58:03b89038b21a 52 }
nyatla 58:03b89038b21a 53 return NyLPC_cModWebSocket_write(this->_mod,i_tx_buf,i_tx_size)?true:false;
nyatla 58:03b89038b21a 54 }
nyatla 58:03b89038b21a 55
nyatla 58:03b89038b21a 56 static NyLPC_TBool fmt_handler(void* i_inst,const void* i_buf,NyLPC_TUInt32 i_len)
nyatla 58:03b89038b21a 57 {
nyatla 58:03b89038b21a 58 return NyLPC_iHttpPtrStream_write((NyLPC_TiHttpPtrStream_t*)i_inst,i_buf,i_len);
nyatla 58:03b89038b21a 59 }
nyatla 58:03b89038b21a 60
nyatla 58:03b89038b21a 61 bool ModWebSocket::writeF(const char* i_fmt,...)
nyatla 58:03b89038b21a 62 {
nyatla 58:03b89038b21a 63 NyLPC_TInt16 l;
nyatla 58:03b89038b21a 64 va_list a;
nyatla 58:03b89038b21a 65 //ストリームの状態を更新する。
nyatla 58:03b89038b21a 66 NyLPC_cModWebSocket_update(this->_mod,0);
nyatla 58:03b89038b21a 67
nyatla 58:03b89038b21a 68 //書式文字列の長さを計算
nyatla 58:03b89038b21a 69 va_start(a,i_fmt);
nyatla 58:03b89038b21a 70 l=NyLPC_cFormatWriter_length(i_fmt,a);
nyatla 58:03b89038b21a 71 va_end(a);
nyatla 58:03b89038b21a 72 if(!NyLPC_cModWebSocket_writePayloadHeader(this->_mod,l)){
nyatla 58:03b89038b21a 73 //CLOSE
nyatla 58:03b89038b21a 74 NyLPC_OnErrorGoto(Error);
nyatla 58:03b89038b21a 75 }
nyatla 58:03b89038b21a 76 va_start(a,i_fmt);
nyatla 58:03b89038b21a 77 if(!NyLPC_cFormatWriter_print(fmt_handler,NyLPC_cHttpdConnection_refStream(this->_mod->_ref_connection),i_fmt,a)){
nyatla 58:03b89038b21a 78 va_end(a);
nyatla 58:03b89038b21a 79 NyLPC_OnErrorGoto(Error);
nyatla 58:03b89038b21a 80 }
nyatla 58:03b89038b21a 81 va_end(a);
nyatla 58:03b89038b21a 82 NyLPC_iHttpPtrStream_flush(NyLPC_cHttpdConnection_refStream(this->_mod->_ref_connection));
nyatla 58:03b89038b21a 83 return true;
nyatla 58:03b89038b21a 84 Error:
nyatla 58:03b89038b21a 85 NyLPC_cHttpdConnection_closeSocket(this->_mod->_ref_connection);
nyatla 58:03b89038b21a 86 this->_mod->_payload_st=NyLPC_TcModWebSocket_ST_CLOSED;
nyatla 58:03b89038b21a 87 return false;
nyatla 58:03b89038b21a 88 }
nyatla 58:03b89038b21a 89
nyatla 58:03b89038b21a 90 int ModWebSocket::read(void* i_rx_buf,int i_rx_size)
nyatla 58:03b89038b21a 91 {
nyatla 58:03b89038b21a 92 if(this->_mod==NULL){
nyatla 58:03b89038b21a 93 return false;
nyatla 58:03b89038b21a 94 }
nyatla 58:03b89038b21a 95 //write here!
nyatla 58:03b89038b21a 96 return NyLPC_cModWebSocket_read(this->_mod,i_rx_buf,i_rx_size);
nyatla 58:03b89038b21a 97 }
nyatla 58:03b89038b21a 98 bool ModWebSocket::canRead()
nyatla 58:03b89038b21a 99 {
nyatla 58:03b89038b21a 100 return NyLPC_cModWebSocket_canRead(this->_mod)?true:false;
nyatla 58:03b89038b21a 101 }
nyatla 58:03b89038b21a 102
nyatla 58:03b89038b21a 103 void ModWebSocket::close()
nyatla 58:03b89038b21a 104 {
nyatla 58:03b89038b21a 105 if(this->_mod==NULL){
nyatla 58:03b89038b21a 106 return;
nyatla 58:03b89038b21a 107 }
nyatla 58:03b89038b21a 108 NyLPC_cModWebSocket_finalize(this->_mod);
nyatla 58:03b89038b21a 109 this->_mod=NULL;
nyatla 58:03b89038b21a 110 return;
nyatla 58:03b89038b21a 111 }
nyatla 58:03b89038b21a 112 }