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

Files at this revision

API Documentation at this revision

Comitter:
nyatla
Date:
Fri Aug 09 05:19:01 2013 +0000
Parent:
50:35e765380772
Child:
52:2b047f8788ab
Commit message:
bugfix; update onchip contents; update MiMic core library to r301

Changed in this revision

core/NyLPC_cMiMicEnv.h Show annotated file Show diff for this revision Revisions of this file
core/net/NyLPC_cNetConfig.h Show annotated file Show diff for this revision Revisions of this file
core/net/httpd/mod/NyLPC_cMocMiMicSetting.c Show annotated file Show diff for this revision Revisions of this file
mbed/Net.cpp Show annotated file Show diff for this revision Revisions of this file
mbed/NetConfig.cpp Show annotated file Show diff for this revision Revisions of this file
--- a/core/NyLPC_cMiMicEnv.h	Thu Aug 08 15:21:43 2013 +0000
+++ b/core/NyLPC_cMiMicEnv.h	Fri Aug 09 05:19:01 2013 +0000
@@ -13,7 +13,7 @@
 #endif /* __cplusplus */
 
 
-#define NyLPC_cMiMicEnv_VERSION "MiMic/1.4.30"
+#define NyLPC_cMiMicEnv_VERSION "MiMic/1.4.50"
 
 
 #ifdef __cplusplus
--- a/core/net/NyLPC_cNetConfig.h	Thu Aug 08 15:21:43 2013 +0000
+++ b/core/net/NyLPC_cNetConfig.h	Fri Aug 09 05:19:01 2013 +0000
@@ -71,20 +71,20 @@
 
     /** インタフェイス層の設定*/
 };
-#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_MASK 3
-#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_MANUAL 0
-#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_DHCP 1
-#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_AUTOIP 2
+#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_MASK   0x00000003
+#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_MANUAL 0x00000000
+#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_DHCP   0x00000001
+#define NyLPC_TcNetConfig_IPV4_FLAG_MODE_AUTOIP 0x00000002
 #define NyLPC_TcNetConfig_IPV4_FLAG_MODE_APIPA (NyLPC_TcNetConfig_IPV4_FLAG_MODE_DHCP|NyLPC_TcNetConfig_IPV4_FLAG_MODE_AUTOIP)
 /*--------------------------------------------------
  * NyLPC_TcNetConfig.services.flags
  --------------------------------------------------*/
 
 /**
- * MDNSサービスの有効・無効
+ * MDNSサービスの有効・無効(いまのところビットパターンなので注意!)
  */
-#define NyLPC_TcNetConfig_SERVICE_FLAG_MDNS 1
-#define NyLPC_TcNetConfig_SERVICE_FLAG_UPNP 2
+#define NyLPC_TcNetConfig_SERVICE_FLAG_MDNS 0x00000001
+#define NyLPC_TcNetConfig_SERVICE_FLAG_UPNP 0x00000002
 
 
 /**
--- a/core/net/httpd/mod/NyLPC_cMocMiMicSetting.c	Thu Aug 08 15:21:43 2013 +0000
+++ b/core/net/httpd/mod/NyLPC_cMocMiMicSetting.c	Fri Aug 09 05:19:01 2013 +0000
@@ -33,7 +33,7 @@
 #include "../../NyLPC_cNet.h"
 #include <ctype.h>
 
-#define MOD_VERSION "ModMiMicSetting/1.3"
+#define MOD_VERSION "ModMiMicSetting/1.4"
 #define SIZE_OF_SETUP_PARAM 8
 struct TModMiMicSettingRequest
 {
--- a/mbed/Net.cpp	Thu Aug 08 15:21:43 2013 +0000
+++ b/mbed/Net.cpp	Fri Aug 09 05:19:01 2013 +0000
@@ -7,6 +7,7 @@
 #include "mbed.h"
 namespace MiMic
 {
+
     const char* Net::UPNP_ROOT_PATH="upnp";
 
     Net::Net()
@@ -42,12 +43,12 @@
             }
         }
         //start mDNS
-        if(base_cfg->services.flags & NyLPC_TcNetConfig_SERVICE_FLAG_MDNS !=0){
+        if((base_cfg->services.flags & NyLPC_TcNetConfig_SERVICE_FLAG_MDNS) !=0){
             this->_mdns=(NyLPC_TcMDnsServer_t*)malloc(sizeof(NyLPC_TcMDnsServer_t));
             NyLPC_cMDnsServer_initialize(this->_mdns,i_cfg.refMdnsRecord());        
         }
         //start UPnP
-        if(base_cfg->services.flags & NyLPC_TcNetConfig_SERVICE_FLAG_UPNP !=0){
+        if((base_cfg->services.flags & NyLPC_TcNetConfig_SERVICE_FLAG_UPNP) !=0){
             this->_upnp=(NyLPC_TcUPnP_t*)malloc(sizeof(NyLPC_TcUPnP_t));
             NyLPC_cUPnP_initialize(this->_upnp,i_cfg.getHttpPort(),UPNP_ROOT_PATH,i_cfg.refUPnPDevDesc());        
 
--- a/mbed/NetConfig.cpp	Thu Aug 08 15:21:43 2013 +0000
+++ b/mbed/NetConfig.cpp	Fri Aug 09 05:19:01 2013 +0000
@@ -12,7 +12,7 @@
  */
 const static char* UPNP_DEVICE_TYPE ="urn:schemas-upnp-org:device:Basic:1";
 const static char* UPNP_DEFAULT_FRENDLY_NAME="MiMic Device(LPC176x)";
-const static char* UPNP_DEFAULT_MANUFACTUR_NAME="MiMicProject@nyatla.jp";
+const static char* UPNP_DEFAULT_MANUFACTUR_NAME="nyatla.jp";
 const static char* UPNP_DEFAULT_MANUFACTUR_URL="http://nyatla.jp/";
 const static char* UPNP_DEFAULT_MODEL_NAME="MiMic UPnP device.";
 const static char* STR_EMPTY="";
@@ -43,7 +43,7 @@
     strcpy(v.hostname,"MiMic");
     NyLPC_uitoa2(NyLPC_TcIPv4Config_getEtherMac000120203(&(v.super)),v.hostname+ 5,16,8);
     NyLPC_uitoa2((NyLPC_TcIPv4Config_getEtherMac0405xxxx(&(v.super))>>16)&0xffff,v.hostname+13,16,4);
-    v.services.flags=NyLPC_TcNetConfig_SERVICE_FLAG_MDNS;
+    v.services.flags=NyLPC_TcNetConfig_SERVICE_FLAG_MDNS|NyLPC_TcNetConfig_SERVICE_FLAG_UPNP;
 }
 
 static void updateOnchipConfig(NyLPC_TcNetConfig& v)
@@ -270,6 +270,7 @@
 
 bool NetConfig::loadFromFile(const char* i_file)
 {
+#define NUMBER_OF_NAME 8
     const static char* tbl[]= {
         "macaddr",  //0
         "ipaddr",   //1
@@ -277,7 +278,8 @@
         "gateway",  //3
         "srv_http_port",//4
         "srv_mdns",//5
-        "host",//6
+        "srv_upnp"  //6
+        "host",//7
     };
     char tmp[32];
     union {
@@ -296,7 +298,7 @@
     while(fgets(tmp,31,fp)) {
         p=NyLPC_cFormatTextReader_seekSpace(tmp)+tmp;//skip space
         l=NyLPC_cFormatTextReader_readWord(p,&key);
-        for(int i=0; i<7; i++) {
+        for(int i=0; i<NUMBER_OF_NAME; i++) {
             if(l>=0 && NyLPC_strnicmp(key,tbl[i],l)==0) {
                 p+=l;//skip keyname
                 p=NyLPC_cFormatTextReader_seekSpace(p)+p;//skip space
@@ -349,6 +351,14 @@
                         break;
                     case 6:
                         l=NyLPC_cFormatTextReader_readWord(p,&t);
+                        if((*t=='y' || *t=='Y')) {
+                            this->setSrvUPnP(true);
+                        } else if((*t=='n' || *t=='N')) {
+                            this->setSrvUPnP(false);
+                        }
+                        break;
+                    case 7:
+                        l=NyLPC_cFormatTextReader_readWord(p,&t);
                         if(l>1) {
                             this->setHostName(t,l);
                         }