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@37:fc4b4fd6a649, 2013-06-19 (annotated)

Committer:
nyatla
Date:
Wed Jun 19 09:33:01 2013 +0000
Revision:
37:fc4b4fd6a649
Parent:
17:f29e1ca90e3d
Child:
38:b0604fee76b0
update; MiMic Core r263; add mDNS service,DHCP client,APIPA client

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 11:c82a7b2899b0 14 * The class is used for argument of NetConfig 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 37:fc4b4fd6a649 20 struct NyLPC_TMDnsServiceRecord _srv_record;
nyatla 3:0a94993be1f6 21 public:
nyatla 37:fc4b4fd6a649 22 /** dns record*/
nyatla 37:fc4b4fd6a649 23 struct NyLPC_TDnsRecord _dns_record;
nyatla 3:0a94993be1f6 24 NyLPC_TcNetConfig_t _inst;
nyatla 3:0a94993be1f6 25 public:
nyatla 3:0a94993be1f6 26 /**
nyatla 3:0a94993be1f6 27 * The constructor.
nyatla 3:0a94993be1f6 28 * This function initializes instance by onchip configulation data.
nyatla 3:0a94993be1f6 29 * @param i_is_factory_default
nyatla 11:c82a7b2899b0 30 * Factory default flag.
nyatla 3:0a94993be1f6 31 * <ul>
nyatla 3:0a94993be1f6 32 * <li>true - The function sets factory default setting.
nyatla 3:0a94993be1f6 33 * <li>false -The function sets onchip memory configulation (default)
nyatla 3:0a94993be1f6 34 * </ul>
nyatla 3:0a94993be1f6 35 */
nyatla 3:0a94993be1f6 36 NetConfig(bool i_is_factory_default=false);
nyatla 37:fc4b4fd6a649 37 virtual ~NetConfig();
nyatla 11:c82a7b2899b0 38 /**
nyatla 11:c82a7b2899b0 39 * Set IPv4 ip address to instance.
nyatla 11:c82a7b2899b0 40 */
nyatla 11:c82a7b2899b0 41 void setIpAddr(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 42 /**
nyatla 11:c82a7b2899b0 43 * Set IPv4 network mask value to instance.
nyatla 11:c82a7b2899b0 44 */
nyatla 11:c82a7b2899b0 45 void setNetMask(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 46
nyatla 11:c82a7b2899b0 47 /**
nyatla 11:c82a7b2899b0 48 * Set IPv4 default gateway address to instance.
nyatla 11:c82a7b2899b0 49 */
nyatla 11:c82a7b2899b0 50 void setGateway(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 51 /**
nyatla 37:fc4b4fd6a649 52 * Set Zero configuration enable flag.
nyatla 37:fc4b4fd6a649 53 * @param v
nyatla 37:fc4b4fd6a649 54 * True, Zero configuration mode. The mimic will try DHCP and AutoIP configuration.
nyatla 37:fc4b4fd6a649 55 * ipaddress,netmask,gateway are ignored.
nyatla 37:fc4b4fd6a649 56 * False, Manual mode. The mimic will set ip address from on chip data.
nyatla 37:fc4b4fd6a649 57 */
nyatla 37:fc4b4fd6a649 58 void setZeroconf(bool v);
nyatla 37:fc4b4fd6a649 59 /**
nyatla 37:fc4b4fd6a649 60 * This function set a recommended HTTP port number to the application.
nyatla 37:fc4b4fd6a649 61 */
nyatla 37:fc4b4fd6a649 62 void setSrvHttpPort(unsigned short port);
nyatla 37:fc4b4fd6a649 63 /**
nyatla 37:fc4b4fd6a649 64 * Set mDNS operation flag.
nyatla 37:fc4b4fd6a649 65 * This function recommends to the application to provide mDNS service to network.
nyatla 37:fc4b4fd6a649 66 */
nyatla 37:fc4b4fd6a649 67 void setSrvMdns(bool i_enable);
nyatla 37:fc4b4fd6a649 68 void setHostName(const char* i_hostname);
nyatla 37:fc4b4fd6a649 69 void setHostName(const char* i_hostname,int len);
nyatla 37:fc4b4fd6a649 70 /**
nyatla 11:c82a7b2899b0 71 * Set ethernet mac address to instance.
nyatla 11:c82a7b2899b0 72 */
nyatla 11:c82a7b2899b0 73 void setEmac(unsigned char ip6,unsigned char ip5,unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 37:fc4b4fd6a649 74
nyatla 13:a71705c5e6fd 75 /**
nyatla 13:a71705c5e6fd 76 * Load configulation from text file.
nyatla 13:a71705c5e6fd 77 * <p>File format example
nyatla 13:a71705c5e6fd 78 * <pre>
nyatla 13:a71705c5e6fd 79 * macaddr=00:00:00:00:00:00
nyatla 37:fc4b4fd6a649 80 * host=MiMic01
nyatla 13:a71705c5e6fd 81 * ipaddr=192.168.0.1
nyatla 13:a71705c5e6fd 82 * netmask=255.255.255.0
nyatla 13:a71705c5e6fd 83 * gateway=192.168.0.254
nyatla 37:fc4b4fd6a649 84 * srv_http_port=80
nyatla 37:fc4b4fd6a649 85 * srv_mdns=yes
nyatla 13:a71705c5e6fd 86 * </pre>
nyatla 13:a71705c5e6fd 87 * <p>Keys
nyatla 13:a71705c5e6fd 88 * <ul>
nyatla 13:a71705c5e6fd 89 * <li>macaddr=[:macaddr:] - 48bit ethernet mac address that are separated by ':'</li>
nyatla 37:fc4b4fd6a649 90 * <li>ipaddr=[:ip:] || AUTO
nyatla 37:fc4b4fd6a649 91 * - 32 bit IP address or auto detection. AUTO will be to try DHCP and AUTOIP.
nyatla 37:fc4b4fd6a649 92 * </li>
nyatla 13:a71705c5e6fd 93 * <li>netmask=[:ip:]- 32 bit network mask value.</li>
nyatla 13:a71705c5e6fd 94 * <li>gateway=[:ip:] - 32 bit default gateway address.</li>
nyatla 37:fc4b4fd6a649 95 * <li>srv_http_port=[:UINT16:] - 16bit http service port number(not ZERO)</li>
nyatla 37:fc4b4fd6a649 96 * <li>srv_mdns=[yes|no] - mDNS service flag.</li>
nyatla 37:fc4b4fd6a649 97 * </ul>
nyatla 37:fc4b4fd6a649 98 * </p>
nyatla 37:fc4b4fd6a649 99 * <p>Default setting
nyatla 37:fc4b4fd6a649 100 * <ul>
nyatla 37:fc4b4fd6a649 101 * <li>macaddr=02:01:02:03:04:05 (In case of mbed it is preset value.)
nyatla 37:fc4b4fd6a649 102 * <li>host=MiMic020102030405
nyatla 37:fc4b4fd6a649 103 * <li>ipaddr =192.168.0.39
nyatla 37:fc4b4fd6a649 104 * <li>netmask=255.255.255.0
nyatla 37:fc4b4fd6a649 105 * <li>gateway=192.168.0.254
nyatla 37:fc4b4fd6a649 106 * <li>srv_http_port=80
nyatla 37:fc4b4fd6a649 107 * <li>srv_mdns=yes</li>
nyatla 13:a71705c5e6fd 108 * </ul>
nyatla 13:a71705c5e6fd 109 * </p>
nyatla 13:a71705c5e6fd 110 * Maximum line length is 31.
nyatla 13:a71705c5e6fd 111 * Specified values are override on-chip setting value.
nyatla 13:a71705c5e6fd 112 * If the same value appeared, then the last one is enabled.
nyatla 37:fc4b4fd6a649 113 * In case of ipaddr=AUTO, gateway and netmask are ignored.
nyatla 13:a71705c5e6fd 114 * </p>
nyatla 13:a71705c5e6fd 115 * @return
nyatla 13:a71705c5e6fd 116 * true if file read. false is not read.
nyatla 13:a71705c5e6fd 117 */
nyatla 14:4618692ec239 118 bool loadFromFile(const char* i_file);
nyatla 13:a71705c5e6fd 119 };
nyatla 13:a71705c5e6fd 120 }