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が準備されています。
※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.
Import programMbedFileServer
The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.
サンプル
Import programMiMicSimpleHttpd
This is a simplest HTTP server made of libMiMic. It will echo back a request path.
Import programUPnPBasicDevice
Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.
Import programWebSocketSample
MiMicSDK Websocket module sample program.
Import programHttpClientSamlpe
A http client sample program.
Import programTcpSocketClientSamlpe
MiMicSDK Tcp client socket sample program.
Import programUdpSocketSamlpe
Udp socket sample program. This program will send back the received packet.
チュートリアル
- HTTPD解説
- UPnPデバイスの作り方
- MiMicRemoteMCUの紹介(pdf)
- MiMicRemoteMCUのマニュアル(pdf)
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.
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.
Import programMbedFileServer
The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.
Sample
Import programMiMicSimpleHttpd
This is a simplest HTTP server made of libMiMic. It will echo back a request path.
Import programUPnPBasicDevice
Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.
Import programWebSocketSample
MiMicSDK Websocket module sample program.
Import programHttpClientSamlpe
A http client sample program.
Import programTcpSocketClientSamlpe
MiMicSDK Tcp client socket sample program.
Import programUdpSocketSamlpe
Udp socket sample program. This program will send back the received packet.
Tutorial
- HTTPD hello world.
- How to make own UPnP device.
- MiMicRemoteMCUの紹介(pdf)
- MiMicRemoteMCUのマニュアル(pdf)
mbed/NetConfig.h
- Committer:
- nyatla
- Date:
- 2013-06-20
- Revision:
- 38:b0604fee76b0
- Parent:
- 37:fc4b4fd6a649
- Child:
- 48:00d211aac2ec
File content as of revision 38:b0604fee76b0:
#pragma once //////////////////////////////////////////////////////////////////////////////// // NetConfig.h //////////////////////////////////////////////////////////////////////////////// #include "NyLPC_net.h" namespace MiMic { /** * Network configulation class. * The class is used for argument of NetConfig constructor. */ class NetConfig { private: /**service record*/ struct NyLPC_TMDnsServiceRecord _srv_record; void _syncDnsInfo(); public: /** dns record*/ struct NyLPC_TDnsRecord _dns_record; NyLPC_TcNetConfig_t _inst; public: /** * The constructor. * This function initializes instance by onchip configulation data. * @param i_is_factory_default * Factory default flag. * <ul> * <li>true - The function sets factory default setting. * <li>false -The function sets onchip memory configulation (default) * </ul> */ NetConfig(bool i_is_factory_default=false); virtual ~NetConfig(); /** * Set IPv4 ip address to instance. */ void setIpAddr(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1); /** * Set IPv4 network mask value to instance. */ void setNetMask(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1); /** * Set IPv4 default gateway address to instance. */ void setGateway(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1); /** * Set Zero configuration enable flag. * @param v * True, Zero configuration mode. The mimic will try DHCP and AutoIP configuration. * ipaddress,netmask,gateway are ignored. * False, Manual mode. The mimic will set ip address from on chip data. */ void setZeroconf(bool v); /** * This function set a recommended HTTP port number to the application. */ void setSrvHttpPort(unsigned short port); /** * Set mDNS operation flag. * This function recommends to the application to provide mDNS service to network. */ void setSrvMdns(bool i_enable); void setHostName(const char* i_hostname); void setHostName(const char* i_hostname,int len); /** * Set ethernet mac address to instance. */ void setEmac(unsigned char ip6,unsigned char ip5,unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1); /** * Load configulation from text file. * <p>File format example * <pre> * macaddr=00:00:00:00:00:00 * host=MiMic01 * ipaddr=192.168.0.1 * netmask=255.255.255.0 * gateway=192.168.0.254 * srv_http_port=80 * srv_mdns=yes * </pre> * <p>Keys * <ul> * <li>macaddr=[:macaddr:] - 48bit ethernet mac address that are separated by ':'</li> * <li>ipaddr=[:ip:] || AUTO * - 32 bit IP address or auto detection. AUTO will be to try DHCP and AUTOIP. * </li> * <li>netmask=[:ip:]- 32 bit network mask value.</li> * <li>gateway=[:ip:] - 32 bit default gateway address.</li> * <li>srv_http_port=[:UINT16:] - 16bit http service port number(not ZERO)</li> * <li>srv_mdns=[yes|no] - mDNS service flag.</li> * </ul> * </p> * <p>Default setting * <ul> * <li>macaddr=02:01:02:03:04:05 (In case of mbed it is preset value.) * <li>host=MiMic020102030405 * <li>ipaddr =192.168.0.39 * <li>netmask=255.255.255.0 * <li>gateway=192.168.0.254 * <li>srv_http_port=80 * <li>srv_mdns=yes</li> * </ul> * </p> * Maximum line length is 31. * Specified values are override on-chip setting value. * If the same value appeared, then the last one is enabled. * In case of ipaddr=AUTO, gateway and netmask are ignored. * </p> * @return * true if file read. false is not read. */ bool loadFromFile(const char* i_file); }; }