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/Net.cpp@109:18f12ac01097, 2014-11-19 (annotated)

Committer:
nyatla
Date:
Wed Nov 19 14:45:17 2014 +0000
Revision:
109:18f12ac01097
Parent:
108:8dae2a2682e7
Child:
110:257739f9b31e
new MiMicIP API;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 3:0a94993be1f6 1 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 2 // Net.h
nyatla 3:0a94993be1f6 3 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 4 #include "Net.h"
nyatla 3:0a94993be1f6 5 #include "NetConfig.h"
nyatla 37:fc4b4fd6a649 6 #include "mbed.h"
nyatla 108:8dae2a2682e7 7
nyatla 3:0a94993be1f6 8 namespace MiMic
nyatla 3:0a94993be1f6 9 {
nyatla 51:45d42af201c2 10
nyatla 50:35e765380772 11 const char* Net::UPNP_ROOT_PATH="upnp";
nyatla 50:35e765380772 12
nyatla 37:fc4b4fd6a649 13 Net::Net()
nyatla 3:0a94993be1f6 14 {
nyatla 109:18f12ac01097 15 NyLPC_cNetIf_initialize();
nyatla 37:fc4b4fd6a649 16 this->_mdns=NULL;
nyatla 48:00d211aac2ec 17 this->_upnp=NULL;
nyatla 3:0a94993be1f6 18 }
nyatla 3:0a94993be1f6 19 Net::~Net()
nyatla 3:0a94993be1f6 20 {
nyatla 109:18f12ac01097 21 NyLPC_cNetIf_finalize();
nyatla 3:0a94993be1f6 22 }
nyatla 37:fc4b4fd6a649 23 void Net::start(NetConfig& i_cfg)
nyatla 37:fc4b4fd6a649 24 {
nyatla 48:00d211aac2ec 25 NyLPC_TcNetConfig_t* base_cfg=i_cfg.refBaseInstance();
nyatla 37:fc4b4fd6a649 26 //DHCP & autoIP request
nyatla 108:8dae2a2682e7 27 if((base_cfg->tcp_mode & NyLPC_TcNetConfig_IPV4_FLAG_MODE_MASK)!=0){
nyatla 37:fc4b4fd6a649 28 for(;;){
nyatla 37:fc4b4fd6a649 29 //DHCP
nyatla 48:00d211aac2ec 30 if((base_cfg->tcp_mode & NyLPC_TcNetConfig_IPV4_FLAG_MODE_DHCP)!=0){
nyatla 109:18f12ac01097 31 if(NyLPC_cNetIf_requestAddrDhcp(&(base_cfg->super),3)){
nyatla 37:fc4b4fd6a649 32 break;
nyatla 37:fc4b4fd6a649 33 }
nyatla 37:fc4b4fd6a649 34 }
nyatla 37:fc4b4fd6a649 35 //AUTOIP
nyatla 48:00d211aac2ec 36 if((base_cfg->tcp_mode & NyLPC_TcNetConfig_IPV4_FLAG_MODE_AUTOIP)!=0){
nyatla 109:18f12ac01097 37 if(NyLPC_cNetIf_requestAddrApipa(&(base_cfg->super),3)){
nyatla 37:fc4b4fd6a649 38 break;
nyatla 37:fc4b4fd6a649 39 }
nyatla 37:fc4b4fd6a649 40 }
nyatla 37:fc4b4fd6a649 41 }
nyatla 37:fc4b4fd6a649 42 }
nyatla 37:fc4b4fd6a649 43 //start mDNS
nyatla 51:45d42af201c2 44 if((base_cfg->services.flags & NyLPC_TcNetConfig_SERVICE_FLAG_MDNS) !=0){
nyatla 37:fc4b4fd6a649 45 this->_mdns=(NyLPC_TcMDnsServer_t*)malloc(sizeof(NyLPC_TcMDnsServer_t));
nyatla 48:00d211aac2ec 46 NyLPC_cMDnsServer_initialize(this->_mdns,i_cfg.refMdnsRecord());
nyatla 37:fc4b4fd6a649 47 }
nyatla 48:00d211aac2ec 48 //start UPnP
nyatla 51:45d42af201c2 49 if((base_cfg->services.flags & NyLPC_TcNetConfig_SERVICE_FLAG_UPNP) !=0){
nyatla 48:00d211aac2ec 50 this->_upnp=(NyLPC_TcUPnP_t*)malloc(sizeof(NyLPC_TcUPnP_t));
nyatla 50:35e765380772 51 NyLPC_cUPnP_initialize(this->_upnp,i_cfg.getHttpPort(),UPNP_ROOT_PATH,i_cfg.refUPnPDevDesc());
nyatla 48:00d211aac2ec 52
nyatla 48:00d211aac2ec 53 }
nyatla 109:18f12ac01097 54 NyLPC_cNetIf_start(&(base_cfg->super));
nyatla 49:d4334acc3ec3 55 if(this->_upnp!=NULL){
nyatla 49:d4334acc3ec3 56 NyLPC_cUPnP_start(this->_upnp);
nyatla 50:35e765380772 57 }
nyatla 37:fc4b4fd6a649 58 }
nyatla 37:fc4b4fd6a649 59 void Net::stop()
nyatla 37:fc4b4fd6a649 60 {
nyatla 109:18f12ac01097 61 NyLPC_cNetIf_stop();
nyatla 37:fc4b4fd6a649 62 //stop mDNS
nyatla 37:fc4b4fd6a649 63 if(this->_mdns!=NULL){
nyatla 37:fc4b4fd6a649 64 NyLPC_cMDnsServer_finalize(this->_mdns);
nyatla 37:fc4b4fd6a649 65 free(this->_mdns);
nyatla 37:fc4b4fd6a649 66 this->_mdns=NULL;
nyatla 37:fc4b4fd6a649 67 }
nyatla 37:fc4b4fd6a649 68 }
nyatla 37:fc4b4fd6a649 69
nyatla 109:18f12ac01097 70 }