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/NetConfig.h@50:35e765380772, 2013-08-08 (annotated)

Committer:
nyatla
Date:
Thu Aug 08 15:21:43 2013 +0000
Revision:
50:35e765380772
Parent:
48:00d211aac2ec
Child:
58:03b89038b21a
bugfix; ????????????????; UPnP??????????????

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 // NetConfig.h
nyatla 3:0a94993be1f6 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 5
nyatla 3:0a94993be1f6 6 #include "NyLPC_net.h"
nyatla 3:0a94993be1f6 7
nyatla 37:fc4b4fd6a649 8
nyatla 37:fc4b4fd6a649 9
nyatla 3:0a94993be1f6 10 namespace MiMic
nyatla 3:0a94993be1f6 11 {
nyatla 3:0a94993be1f6 12 /**
nyatla 3:0a94993be1f6 13 * Network configulation class.
nyatla 48:00d211aac2ec 14 * The class is used by Net constructor.
nyatla 3:0a94993be1f6 15 */
nyatla 3:0a94993be1f6 16 class NetConfig
nyatla 3:0a94993be1f6 17 {
nyatla 37:fc4b4fd6a649 18 private:
nyatla 37:fc4b4fd6a649 19 /**service record*/
nyatla 48:00d211aac2ec 20 NyLPC_TcNetConfig_t _inst;
nyatla 37:fc4b4fd6a649 21 struct NyLPC_TMDnsServiceRecord _srv_record;
nyatla 48:00d211aac2ec 22 void _syncServiceInfo();
nyatla 48:00d211aac2ec 23 struct NyLPC_TDnsRecord _dns_record;
nyatla 48:00d211aac2ec 24 struct NyLPC_TUPnPDevDescDevice _upnp_desc;
nyatla 50:35e765380772 25 struct NyLPC_TUPnPDevDescIcon _upnp_icon;
nyatla 48:00d211aac2ec 26 const struct NyLPC_TDnsRecord* _ref_custom_dns_record;
nyatla 48:00d211aac2ec 27 const struct NyLPC_TUPnPDevDescDevice* _ref_custom_upnp_desc;
nyatla 48:00d211aac2ec 28 char _udn[42];//uuid:00000000-0000-0000-0000-000000000000+'\0'
nyatla 3:0a94993be1f6 29 public:
nyatla 48:00d211aac2ec 30 /** wrapped base LPC class.*/
nyatla 48:00d211aac2ec 31 NyLPC_TcNetConfig_t* refBaseInstance(){return &this->_inst;}
nyatla 48:00d211aac2ec 32 /** internal UPnP description*/
nyatla 48:00d211aac2ec 33 const struct NyLPC_TUPnPDevDescDevice* refUPnPDevDesc()const;
nyatla 48:00d211aac2ec 34 /** internal dns record*/
nyatla 48:00d211aac2ec 35 const struct NyLPC_TDnsRecord* refMdnsRecord()const;
nyatla 48:00d211aac2ec 36 /** Thi sfunction returnes recommended HTTP service port number.*/
nyatla 48:00d211aac2ec 37 unsigned short getHttpPort()const{return this->_inst.services.http_port;}
nyatla 3:0a94993be1f6 38 public:
nyatla 3:0a94993be1f6 39 /**
nyatla 3:0a94993be1f6 40 * The constructor.
nyatla 3:0a94993be1f6 41 * This function initializes instance by onchip configulation data.
nyatla 3:0a94993be1f6 42 * @param i_is_factory_default
nyatla 11:c82a7b2899b0 43 * Factory default flag.
nyatla 3:0a94993be1f6 44 * <ul>
nyatla 3:0a94993be1f6 45 * <li>true - The function sets factory default setting.
nyatla 3:0a94993be1f6 46 * <li>false -The function sets onchip memory configulation (default)
nyatla 3:0a94993be1f6 47 * </ul>
nyatla 3:0a94993be1f6 48 */
nyatla 3:0a94993be1f6 49 NetConfig(bool i_is_factory_default=false);
nyatla 37:fc4b4fd6a649 50 virtual ~NetConfig();
nyatla 11:c82a7b2899b0 51 /**
nyatla 11:c82a7b2899b0 52 * Set IPv4 ip address to instance.
nyatla 11:c82a7b2899b0 53 */
nyatla 11:c82a7b2899b0 54 void setIpAddr(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 55 /**
nyatla 11:c82a7b2899b0 56 * Set IPv4 network mask value to instance.
nyatla 11:c82a7b2899b0 57 */
nyatla 11:c82a7b2899b0 58 void setNetMask(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 59
nyatla 11:c82a7b2899b0 60 /**
nyatla 11:c82a7b2899b0 61 * Set IPv4 default gateway address to instance.
nyatla 11:c82a7b2899b0 62 */
nyatla 11:c82a7b2899b0 63 void setGateway(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 64 /**
nyatla 37:fc4b4fd6a649 65 * Set Zero configuration enable flag.
nyatla 37:fc4b4fd6a649 66 * @param v
nyatla 37:fc4b4fd6a649 67 * True, Zero configuration mode. The mimic will try DHCP and AutoIP configuration.
nyatla 37:fc4b4fd6a649 68 * ipaddress,netmask,gateway are ignored.
nyatla 37:fc4b4fd6a649 69 * False, Manual mode. The mimic will set ip address from on chip data.
nyatla 37:fc4b4fd6a649 70 */
nyatla 37:fc4b4fd6a649 71 void setZeroconf(bool v);
nyatla 37:fc4b4fd6a649 72 /**
nyatla 37:fc4b4fd6a649 73 * This function set a recommended HTTP port number to the application.
nyatla 37:fc4b4fd6a649 74 */
nyatla 37:fc4b4fd6a649 75 void setSrvHttpPort(unsigned short port);
nyatla 37:fc4b4fd6a649 76 /**
nyatla 37:fc4b4fd6a649 77 * Set mDNS operation flag.
nyatla 37:fc4b4fd6a649 78 * This function recommends to the application to provide mDNS service to network.
nyatla 37:fc4b4fd6a649 79 */
nyatla 37:fc4b4fd6a649 80 void setSrvMdns(bool i_enable);
nyatla 48:00d211aac2ec 81 /**
nyatla 48:00d211aac2ec 82 * Set UPnP operation flag.
nyatla 48:00d211aac2ec 83 * This function recommends to the application to provide UPnP service to network.
nyatla 48:00d211aac2ec 84 */
nyatla 48:00d211aac2ec 85 void setSrvUPnP(bool i_enable);
nyatla 48:00d211aac2ec 86 /**
nyatla 48:00d211aac2ec 87 * This function sets host name for mDNS.
nyatla 48:00d211aac2ec 88 * This value has effect to the mDNS a record.
nyatla 48:00d211aac2ec 89 * @param i_hostname
nyatla 48:00d211aac2ec 90 * host name.
nyatla 48:00d211aac2ec 91 * NULL terminated string.
nyatla 48:00d211aac2ec 92 */
nyatla 37:fc4b4fd6a649 93 void setHostName(const char* i_hostname);
nyatla 48:00d211aac2ec 94 /**
nyatla 48:00d211aac2ec 95 * This function sets host name for mDNS.
nyatla 48:00d211aac2ec 96 * This is effective for mDNS a record.
nyatla 48:00d211aac2ec 97 * @param i_hostname
nyatla 48:00d211aac2ec 98 * host name.
nyatla 48:00d211aac2ec 99 * @param i_len
nyatla 48:00d211aac2ec 100 * length of host name.
nyatla 48:00d211aac2ec 101 * maximum length is NyLPC_TcNetConfig_HOSTNAME_LEN-1
nyatla 48:00d211aac2ec 102 */
nyatla 37:fc4b4fd6a649 103 void setHostName(const char* i_hostname,int len);
nyatla 37:fc4b4fd6a649 104 /**
nyatla 11:c82a7b2899b0 105 * Set ethernet mac address to instance.
nyatla 11:c82a7b2899b0 106 */
nyatla 11:c82a7b2899b0 107 void setEmac(unsigned char ip6,unsigned char ip5,unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 48:00d211aac2ec 108 /**
nyatla 48:00d211aac2ec 109 * Set FrendlyName to instance.
nyatla 48:00d211aac2ec 110 * This value has effect to the mDNS name and UPnP frendlyName.
nyatla 48:00d211aac2ec 111 */
nyatla 48:00d211aac2ec 112 void setFriendlyName(const char* i_name);
nyatla 48:00d211aac2ec 113 void setUPnPManufactur(const char* i_name,const char* i_url);
nyatla 48:00d211aac2ec 114 void setUPnPModel(const char* i_name,const char* i_number,const char* i_url,const char* i_description);
nyatla 48:00d211aac2ec 115 void setUPnPSerialNumber(const char* i_number);
nyatla 48:00d211aac2ec 116 void setUPnPPresentationURL(const char* i_url);
nyatla 48:00d211aac2ec 117
nyatla 48:00d211aac2ec 118 /**
nyatla 48:00d211aac2ec 119 * Set Time base UDN value.
nyatla 48:00d211aac2ec 120 * UDN is expressed as follows.
nyatla 48:00d211aac2ec 121 * The value of the UDN, must be different for each device.
nyatla 48:00d211aac2ec 122 * [i_time_l]-[i_time_m]-[i_time_h|0x80]-[i_sq&0x3F|0x80]-[MAC ADDRESS]
nyatla 48:00d211aac2ec 123 */
nyatla 48:00d211aac2ec 124 void setUPnPUdn(unsigned long i_time_l,unsigned short i_time_m,unsigned short i_time_h,unsigned short i_sq);
nyatla 50:35e765380772 125 void setUPnPIcon(unsigned short i_width,unsigned short i_height,unsigned short i_depth,const char* i_mimetype,const char* i_url);
nyatla 48:00d211aac2ec 126 /**
nyatla 48:00d211aac2ec 127 * This function sets a custom UPnP device description to instance.
nyatla 48:00d211aac2ec 128 * All UPnP description will be overwritten if set it.
nyatla 48:00d211aac2ec 129 * @param i_ref_description
nyatla 48:00d211aac2ec 130 * Perfect description structure.
nyatla 48:00d211aac2ec 131 */
nyatla 48:00d211aac2ec 132 void setCustomUPnPDescription(const struct NyLPC_TUPnPDevDescDevice* i_ref_description);
nyatla 48:00d211aac2ec 133 /**
nyatla 48:00d211aac2ec 134 * This function sets a custom mDNS record to instance.
nyatla 48:00d211aac2ec 135 * All mDNS record will be overwritten if set it.
nyatla 48:00d211aac2ec 136 * @param i_ref_record
nyatla 48:00d211aac2ec 137 * Perfect DNS record structure.
nyatla 48:00d211aac2ec 138 */
nyatla 48:00d211aac2ec 139 void setCustomMdnsRecord(const struct NyLPC_TDnsRecord* i_ref_record);
nyatla 48:00d211aac2ec 140
nyatla 48:00d211aac2ec 141
nyatla 48:00d211aac2ec 142
nyatla 13:a71705c5e6fd 143 /**
nyatla 13:a71705c5e6fd 144 * Load configulation from text file.
nyatla 13:a71705c5e6fd 145 * <p>File format example
nyatla 13:a71705c5e6fd 146 * <pre>
nyatla 13:a71705c5e6fd 147 * macaddr=00:00:00:00:00:00
nyatla 37:fc4b4fd6a649 148 * host=MiMic01
nyatla 13:a71705c5e6fd 149 * ipaddr=192.168.0.1
nyatla 13:a71705c5e6fd 150 * netmask=255.255.255.0
nyatla 13:a71705c5e6fd 151 * gateway=192.168.0.254
nyatla 37:fc4b4fd6a649 152 * srv_http_port=80
nyatla 37:fc4b4fd6a649 153 * srv_mdns=yes
nyatla 13:a71705c5e6fd 154 * </pre>
nyatla 13:a71705c5e6fd 155 * <p>Keys
nyatla 13:a71705c5e6fd 156 * <ul>
nyatla 13:a71705c5e6fd 157 * <li>macaddr=[:macaddr:] - 48bit ethernet mac address that are separated by ':'</li>
nyatla 37:fc4b4fd6a649 158 * <li>ipaddr=[:ip:] || AUTO
nyatla 37:fc4b4fd6a649 159 * - 32 bit IP address or auto detection. AUTO will be to try DHCP and AUTOIP.
nyatla 37:fc4b4fd6a649 160 * </li>
nyatla 13:a71705c5e6fd 161 * <li>netmask=[:ip:]- 32 bit network mask value.</li>
nyatla 13:a71705c5e6fd 162 * <li>gateway=[:ip:] - 32 bit default gateway address.</li>
nyatla 37:fc4b4fd6a649 163 * <li>srv_http_port=[:UINT16:] - 16bit http service port number(not ZERO)</li>
nyatla 37:fc4b4fd6a649 164 * <li>srv_mdns=[yes|no] - mDNS service flag.</li>
nyatla 37:fc4b4fd6a649 165 * </ul>
nyatla 37:fc4b4fd6a649 166 * </p>
nyatla 37:fc4b4fd6a649 167 * <p>Default setting
nyatla 37:fc4b4fd6a649 168 * <ul>
nyatla 37:fc4b4fd6a649 169 * <li>macaddr=02:01:02:03:04:05 (In case of mbed it is preset value.)
nyatla 37:fc4b4fd6a649 170 * <li>host=MiMic020102030405
nyatla 37:fc4b4fd6a649 171 * <li>ipaddr =192.168.0.39
nyatla 37:fc4b4fd6a649 172 * <li>netmask=255.255.255.0
nyatla 37:fc4b4fd6a649 173 * <li>gateway=192.168.0.254
nyatla 37:fc4b4fd6a649 174 * <li>srv_http_port=80
nyatla 37:fc4b4fd6a649 175 * <li>srv_mdns=yes</li>
nyatla 13:a71705c5e6fd 176 * </ul>
nyatla 13:a71705c5e6fd 177 * </p>
nyatla 13:a71705c5e6fd 178 * Maximum line length is 31.
nyatla 13:a71705c5e6fd 179 * Specified values are override on-chip setting value.
nyatla 13:a71705c5e6fd 180 * If the same value appeared, then the last one is enabled.
nyatla 37:fc4b4fd6a649 181 * In case of ipaddr=AUTO, gateway and netmask are ignored.
nyatla 13:a71705c5e6fd 182 * </p>
nyatla 13:a71705c5e6fd 183 * @return
nyatla 13:a71705c5e6fd 184 * true if file read. false is not read.
nyatla 13:a71705c5e6fd 185 */
nyatla 14:4618692ec239 186 bool loadFromFile(const char* i_file);
nyatla 13:a71705c5e6fd 187 };
nyatla 13:a71705c5e6fd 188 }