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@68:f7def7eb5504, 2014-05-22 (annotated)

Committer:
nyatla
Date:
Thu May 22 12:59:50 2014 +0000
Revision:
68:f7def7eb5504
Parent:
51:45d42af201c2
Child:
108:8dae2a2682e7
MiMic-core ?344???;

Who changed what in which revision?

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