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

core/net/httpd/NyLPC_cHttpdThread.c@109:18f12ac01097, 2014-11-19 (annotated)

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 #include "NyLPC_cHttpd_protected.h"
nyatla 2:b96c1e90d120 2 #include "NyLPC_cHttpdConnection.h"
nyatla 2:b96c1e90d120 3 #include "NyLPC_cHttpdConnection_protected.h"
nyatla 40:d4e62303ad85 4 #include "NyLPC_cHttpdThread_protected.h"
nyatla 2:b96c1e90d120 5
nyatla 2:b96c1e90d120 6
nyatla 2:b96c1e90d120 7 static int server(void* p);
nyatla 2:b96c1e90d120 8
nyatla 109:18f12ac01097 9 NyLPC_TBool NyLPC_cHttpdThread_initialize(NyLPC_TcHttpdThread_t* i_inst,NyLPC_TcHttpd_t* i_parent,NyLPC_TInt32 i_prio)
nyatla 2:b96c1e90d120 10 {
nyatla 109:18f12ac01097 11 if(!NyLPC_cHttpdConnection_initialize(&(i_inst->_connection),i_parent)){
nyatla 109:18f12ac01097 12 return NyLPC_TBool_FALSE;
nyatla 109:18f12ac01097 13 }
nyatla 79:baa21f8763cf 14 NyLPC_cThread_initialize(&(i_inst->_super),NyLPC_cHttpdThread_SIZE_OF_THREAD_STACK,i_prio);
nyatla 109:18f12ac01097 15 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 16 }
nyatla 2:b96c1e90d120 17 void NyLPC_cHttpdThread_finalize(NyLPC_TcHttpdThread_t* i_inst)
nyatla 2:b96c1e90d120 18 {
nyatla 2:b96c1e90d120 19 NyLPC_cThread_finalize(&i_inst->_super);
nyatla 2:b96c1e90d120 20 NyLPC_cHttpdConnection_finalize(&(i_inst->_connection));
nyatla 2:b96c1e90d120 21 }
nyatla 2:b96c1e90d120 22
nyatla 109:18f12ac01097 23 NyLPC_TBool NyLPC_cHttpdThread_start(NyLPC_TcHttpdThread_t* i_inst,NyLPC_TiTcpListener_t* i_listener)
nyatla 2:b96c1e90d120 24 {
nyatla 2:b96c1e90d120 25 //停止中？
nyatla 2:b96c1e90d120 26 if(!NyLPC_cThread_isTerminated(&(i_inst->_super))){
nyatla 2:b96c1e90d120 27 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 28 }
nyatla 2:b96c1e90d120 29 //リスニング
nyatla 2:b96c1e90d120 30 if(!NyLPC_cHttpdConnection_listenSocket(&(i_inst->_connection),i_listener)){
nyatla 2:b96c1e90d120 31 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 32 }
nyatla 2:b96c1e90d120 33 //Accept可能なので開始。
nyatla 2:b96c1e90d120 34 NyLPC_cThread_start(&(i_inst->_super),server,&i_inst->_connection);
nyatla 2:b96c1e90d120 35 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 36
nyatla 2:b96c1e90d120 37 }
nyatla 2:b96c1e90d120 38
nyatla 2:b96c1e90d120 39
nyatla 2:b96c1e90d120 40
nyatla 2:b96c1e90d120 41
nyatla 2:b96c1e90d120 42 //Httpのセッション関数
nyatla 2:b96c1e90d120 43 static int server(void* p)
nyatla 2:b96c1e90d120 44 {
nyatla 2:b96c1e90d120 45 NyLPC_TcHttpdConnection_t* inst=(NyLPC_TcHttpdConnection_t*)p;
nyatla 2:b96c1e90d120 46 //コネクションをAccept
nyatla 2:b96c1e90d120 47 if(!NyLPC_cHttpdConnection_acceptSocket(inst)){
nyatla 2:b96c1e90d120 48 NyLPC_OnErrorGoto(Error);
nyatla 2:b96c1e90d120 49 }
nyatla 2:b96c1e90d120 50 //コネクション数の追加
nyatla 2:b96c1e90d120 51 NyLPC_cHttpd_incNumOfConnection(inst->_parent_httpd);
nyatla 2:b96c1e90d120 52
nyatla 2:b96c1e90d120 53
nyatla 2:b96c1e90d120 54 //サブネットアクセスの確認
nyatla 2:b96c1e90d120 55 for(;;){
nyatla 2:b96c1e90d120 56 //リクエストのプレフィクスを取得
nyatla 2:b96c1e90d120 57 if(!NyLPC_cHttpdConnection_prefetch(inst)){
nyatla 2:b96c1e90d120 58 //Prefetch出来ないならループ終了。
nyatla 2:b96c1e90d120 59 break;
nyatla 2:b96c1e90d120 60 }
nyatla 43:a182f2b5ff41 61 //持続性接続の初期モードを設定
nyatla 79:baa21f8763cf 62 if(NyLPC_cHttpd_getNumOfConnection(inst->_parent_httpd)>NyLPC_cHttpd_MAX_PERSISTENT_CONNECTION){
nyatla 43:a182f2b5ff41 63 NyLPC_cHttpdConnection_setConnectionMode(inst,NyLPC_TcHttpdConnection_CONNECTION_MODE_CLOSE);
nyatla 43:a182f2b5ff41 64 }else{
nyatla 43:a182f2b5ff41 65 NyLPC_cHttpdConnection_setConnectionMode(inst,NyLPC_TcHttpdConnection_CONNECTION_MODE_CONTINUE);
nyatla 43:a182f2b5ff41 66 }
nyatla 2:b96c1e90d120 67 {//handler
nyatla 3:0a94993be1f6 68 (inst->_parent_httpd->function.onRequest)(inst);
nyatla 2:b96c1e90d120 69 }
nyatla 2:b96c1e90d120 70 //HTTP層のクローズ
nyatla 2:b96c1e90d120 71 if(!NyLPC_cHttpdConnection_closeResponse(inst)){
nyatla 2:b96c1e90d120 72 break;
nyatla 2:b96c1e90d120 73 }
nyatla 2:b96c1e90d120 74 //次のプリフェッチを準備。
nyatla 2:b96c1e90d120 75 if(!NyLPC_cHttpdConnection_prevNextPrefetch(inst)){
nyatla 2:b96c1e90d120 76 break;
nyatla 2:b96c1e90d120 77 }
nyatla 2:b96c1e90d120 78 }
nyatla 2:b96c1e90d120 79 NyLPC_cHttpd_decNumOfConnection(inst->_parent_httpd);
nyatla 2:b96c1e90d120 80 NyLPC_cHttpdConnection_closeSocket(inst);
nyatla 2:b96c1e90d120 81 return 0;
nyatla 2:b96c1e90d120 82 Error:
nyatla 2:b96c1e90d120 83 NyLPC_cHttpdConnection_closeSocket(inst);
nyatla 2:b96c1e90d120 84 return -1;
nyatla 2:b96c1e90d120 85 }
nyatla 40:d4e62303ad85 86