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.

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.

チュートリアル

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.

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

Committer:
nyatla
Date:
Fri Apr 26 05:26:34 2013 +0000
Revision:
17:f29e1ca90e3d
Child:
36:f02596009a02
update ModLocalFileSystem list API.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 17:f29e1ca90e3d 1 #include "NyLPC_http.h"
nyatla 17:f29e1ca90e3d 2 #include "NyLPC_stdlib.h"
nyatla 17:f29e1ca90e3d 3 #include "mbed.h"
nyatla 17:f29e1ca90e3d 4 #include "UrlReader.h"
nyatla 17:f29e1ca90e3d 5 namespace MiMic
nyatla 17:f29e1ca90e3d 6 {
nyatla 17:f29e1ca90e3d 7 UrlReader::UrlReader(const char* i_ref_url)
nyatla 17:f29e1ca90e3d 8 {
nyatla 17:f29e1ca90e3d 9 this->_ref_str=i_ref_url;
nyatla 17:f29e1ca90e3d 10 }
nyatla 17:f29e1ca90e3d 11 bool UrlReader::getPath(const char* &path,int &l)
nyatla 17:f29e1ca90e3d 12 {
nyatla 17:f29e1ca90e3d 13 return NyLPC_cUrlReader_getPath(this->_ref_str,&path,(NyLPC_TInt32*)&l);
nyatla 17:f29e1ca90e3d 14 }
nyatla 17:f29e1ca90e3d 15 /**
nyatla 17:f29e1ca90e3d 16 * @param i_ref_str
nyatla 17:f29e1ca90e3d 17 * URL text for read.
nyatla 17:f29e1ca90e3d 18 * This is referenced pointer. Must hold it until an instance is closed.
nyatla 17:f29e1ca90e3d 19 */
nyatla 17:f29e1ca90e3d 20 void UrlReader::setUrl(const char* i_ref_url)
nyatla 17:f29e1ca90e3d 21 {
nyatla 17:f29e1ca90e3d 22 this->_ref_str=i_ref_url;
nyatla 17:f29e1ca90e3d 23 }
nyatla 17:f29e1ca90e3d 24 //bool hasHost(const char* key);
nyatla 17:f29e1ca90e3d 25 //bool getHost(const char* i_ref_url);
nyatla 17:f29e1ca90e3d 26 //bool hasPath(const char* i_ref_url);
nyatla 17:f29e1ca90e3d 27 //bool getPath(const char* i_ref_url);
nyatla 17:f29e1ca90e3d 28 /**
nyatla 17:f29e1ca90e3d 29 * This function confirms URL has a query key.
nyatla 17:f29e1ca90e3d 30 * @param key
nyatla 17:f29e1ca90e3d 31 * key name.
nyatla 17:f29e1ca90e3d 32 */
nyatla 17:f29e1ca90e3d 33 bool UrlReader::hasQueryKey(const char* key)
nyatla 17:f29e1ca90e3d 34 {
nyatla 17:f29e1ca90e3d 35 return NyLPC_cUrlReader_findKeyValue(this->_ref_str,key)!=NULL;
nyatla 17:f29e1ca90e3d 36 }
nyatla 17:f29e1ca90e3d 37 bool UrlReader::getQueryStr(const char* key,const char* &o_ref_val,int &o_val_len)
nyatla 17:f29e1ca90e3d 38 {
nyatla 17:f29e1ca90e3d 39 return NyLPC_cUrlReader_getStr(this->_ref_str,key,&o_ref_val,(NyLPC_TInt32*)&o_val_len)==NyLPC_TBool_TRUE;
nyatla 17:f29e1ca90e3d 40 }
nyatla 17:f29e1ca90e3d 41 bool UrlReader::getQueryUInt(const char* key,unsigned int &v)
nyatla 17:f29e1ca90e3d 42 {
nyatla 17:f29e1ca90e3d 43 return NyLPC_cUrlReader_getUInt(this->_ref_str,key,(NyLPC_TUInt32*)&v)==NyLPC_TBool_TRUE;
nyatla 17:f29e1ca90e3d 44 }
nyatla 17:f29e1ca90e3d 45 bool UrlReader::getQueryInt(const char* key,int &v)
nyatla 17:f29e1ca90e3d 46 {
nyatla 17:f29e1ca90e3d 47 return NyLPC_cUrlReader_getInt(this->_ref_str,key,(NyLPC_TInt32*)&v)==NyLPC_TBool_TRUE;
nyatla 17:f29e1ca90e3d 48 }
nyatla 17:f29e1ca90e3d 49 bool UrlReader::isQueryEqualStr(const char* key,const char* v)
nyatla 17:f29e1ca90e3d 50 {
nyatla 17:f29e1ca90e3d 51 const char* kv;
nyatla 17:f29e1ca90e3d 52 NyLPC_TInt32 l;
nyatla 17:f29e1ca90e3d 53 if(NyLPC_cUrlReader_getStr(this->_ref_str,key,&kv,&l)){
nyatla 17:f29e1ca90e3d 54 return strncmp(v,kv,l)==0;
nyatla 17:f29e1ca90e3d 55 }
nyatla 17:f29e1ca90e3d 56 return false;
nyatla 17:f29e1ca90e3d 57 }
nyatla 17:f29e1ca90e3d 58 bool UrlReader::isQueryEqualUInt(const char* key,unsigned int v)
nyatla 17:f29e1ca90e3d 59 {
nyatla 17:f29e1ca90e3d 60 NyLPC_TUInt32 l;
nyatla 17:f29e1ca90e3d 61 if(NyLPC_cUrlReader_getUInt(this->_ref_str,key,&l)){
nyatla 17:f29e1ca90e3d 62 return l==v;
nyatla 17:f29e1ca90e3d 63 }
nyatla 17:f29e1ca90e3d 64 return false;
nyatla 17:f29e1ca90e3d 65 }
nyatla 17:f29e1ca90e3d 66 bool UrlReader::isQueryEqualInt(const char* key,int v)
nyatla 17:f29e1ca90e3d 67 {
nyatla 17:f29e1ca90e3d 68 NyLPC_TInt32 l;
nyatla 17:f29e1ca90e3d 69 if(NyLPC_cUrlReader_getInt(this->_ref_str,key,&l)){
nyatla 17:f29e1ca90e3d 70 return l==v;
nyatla 17:f29e1ca90e3d 71 }
nyatla 17:f29e1ca90e3d 72 return false;
nyatla 17:f29e1ca90e3d 73 }
nyatla 17:f29e1ca90e3d 74
nyatla 17:f29e1ca90e3d 75 }