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:
Sun Apr 21 01:21:41 2013 +0000
Parent:
12:efe841863fc8
Child:
14:4618692ec239
Commit message:
a lot changes.; add format text reader. ;

Changed in this revision

core/NyLPC_stdlib.c Show annotated file Show diff for this revision Revisions of this file
core/http/NyLPC_cHttpBodyWriter.c Show annotated file Show diff for this revision Revisions of this file
core/include/NyLPC_stdlib.h Show annotated file Show diff for this revision Revisions of this file
core/net/NyLPC_cNetConfig.c 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/uip/NyLPC_cIPv4Config.h Show annotated file Show diff for this revision Revisions of this file
core/utils/NyLPC_cFormatTextReader.c Show annotated file Show diff for this revision Revisions of this file
core/utils/NyLPC_cFormatTextReader.h Show annotated file Show diff for this revision Revisions of this file
cpp/ModLocalFileSystem.cpp Show annotated file Show diff for this revision Revisions of this file
cpp/NetConfig.cpp Show annotated file Show diff for this revision Revisions of this file
cpp/NetConfig.h Show annotated file Show diff for this revision Revisions of this file
--- a/core/NyLPC_stdlib.c	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/NyLPC_stdlib.c	Sun Apr 21 01:21:41 2013 +0000
@@ -119,26 +119,37 @@
 
 
 
-
 /**
  * same as itoa
  */
 void NyLPC_itoa(int i_n,char* o_out,int i_digit)
 {
-     int i, sign;
+     int i, sign,v;
      if ((sign = i_n) < 0){
          i_n = -i_n;
      }
      i = 0;
      do{
-         o_out[i++] = i_n % 10 + '0';
-     }while ((i_n /= 10) > 0);
+         v=i_n % i_digit;
+         o_out[i++] = v<10?(v+'0'):(v+'a'-10);
+     }while ((i_n /= i_digit) > 0);
      if (sign < 0){
          o_out[i++] = '-';
      }
      o_out[i] = '\0';
      NyLPC_reverse(o_out);
 }
+void NyLPC_uitoa(int i_n,char* o_out,unsigned int i_digit)
+{
+     int i = 0;
+     int v;
+     do{
+         v=i_n % i_digit;
+         o_out[i++] = v<10?(v+'0'):(v+'a'-10);
+     }while ((i_n /= i_digit) > 0);
+     o_out[i] = '\0';
+     NyLPC_reverse(o_out);
+}
 
 void NyLPC_reverse(char* s)
 {
--- a/core/http/NyLPC_cHttpBodyWriter.c	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/http/NyLPC_cHttpBodyWriter.c	Sun Apr 21 01:21:41 2013 +0000
@@ -198,7 +198,7 @@
                     NyLPC_cHttpBodyWriter_write((NyLPC_TcHttpBodyWriter_t*)i_inst,wk,ol);
                     ol=0;
                 }
-                NyLPC_itoa((va_arg(args,int)),wk,16);
+                NyLPC_uitoa((va_arg(args,int)),wk,16);
                 //強制コミット
                 NyLPC_cHttpBodyWriter_write((NyLPC_TcHttpBodyWriter_t*)i_inst,wk,strlen(wk));
                 rp++;
--- a/core/include/NyLPC_stdlib.h	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/include/NyLPC_stdlib.h	Sun Apr 21 01:21:41 2013 +0000
@@ -469,6 +469,10 @@
  */
 void NyLPC_itoa(int i_n,char* o_out,int i_digit);
 
+
+void NyLPC_uitoa(int i_n,char* o_out,unsigned int i_digit);
+
+
 /**
  * Same as reverse
  */
@@ -515,4 +519,6 @@
 
 
 
+
+
 #endif
--- a/core/net/NyLPC_cNetConfig.c	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/net/NyLPC_cNetConfig.c	Sun Apr 21 01:21:41 2013 +0000
@@ -35,8 +35,6 @@
     }else{
         update(i_inst,NyLPC_cMiMicConfiglation_loadFromFlash());
     }
-
-
 }
 
 /**
--- a/core/net/NyLPC_cNetConfig.h	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/net/NyLPC_cNetConfig.h	Sun Apr 21 01:21:41 2013 +0000
@@ -23,7 +23,7 @@
 {
     /** Must be 1*/
     NyLPC_TUInt16 version;
-    /** 配列の最大サイズ*/
+    /** インタフェイスタイプ*/
     NyLPC_TUInt16 interface_type;
     /** インタフェイス層の設定*/
     union{
@@ -34,18 +34,15 @@
 //          struct NyLPC_TEthAddr mac_addr;
 //      }ethernet2;
     }interface_setting;
-//  /** ip addressの設定*/
-//  struct{
-//      struct NyLPC_TIPv4Addr ip;
-//      struct NyLPC_TIPv4Addr mask;
-//      struct NyLPC_TIPv4Addr gateway;
-//  }ipv4;
 };
 
 /**
  * インスタンスを初期化します。
  */
 void NyLPC_cNetConfig_initialize(NyLPC_TcNetConfig_t* i_inst,NyLPC_TBool i_is_factory_default);
+
+
+
 /**
  * インスタンスを終期化します。
  */
--- a/core/uip/NyLPC_cIPv4Config.h	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/uip/NyLPC_cIPv4Config.h	Sun Apr 21 01:21:41 2013 +0000
@@ -79,6 +79,7 @@
  */
 void NyLPC_cIPv4Config_initialzeForEthernet(NyLPC_TcIPv4Config_t* i_inst,const struct NyLPC_TEthAddr* i_ether_addr,NyLPC_TUInt16 i_ether_frame_len);
 
+
 /**
  * デストラクタです。インスタンスを破棄して、確保している動的リソースを元に戻します。
  * @param i_inst
--- a/core/utils/NyLPC_cFormatTextReader.c	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/utils/NyLPC_cFormatTextReader.c	Sun Apr 21 01:21:41 2013 +0000
@@ -9,6 +9,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include "NyLPC_cFormatTextReader.h"
+
 /**
  * [a-zA-Z0-9_-]で構成されるワードを取得します。
  * This function peek a word from string.
@@ -61,6 +62,7 @@
  */
 NyLPC_TInt32 NyLPC_cFormatTextReader_readMacAddr(const NyLPC_TChar* buf,NyLPC_TUInt8 v[6])
 {
+
     NyLPC_TInt32 t,i;
     const NyLPC_TChar* p=buf;
     for(i=0;i<6;i++){
@@ -68,17 +70,17 @@
         for(;isxdigit(*p);p++){
             t=t*16+NyLPC_ctox(*p);
             if(t>255){
-                return 0;
+                return -1;
             }
         }
         v[i]=t;
         if(i<5){
             if(*p!=':'){
-                return 0;
+                return -2;
             }
             p++;
         }else if(!isspace(*p) && *p!='\0'){
-            return 0;
+            return -3;
         }
     }
     return (p-buf);
--- a/core/utils/NyLPC_cFormatTextReader.h	Sat Apr 20 05:03:57 2013 +0000
+++ b/core/utils/NyLPC_cFormatTextReader.h	Sun Apr 21 01:21:41 2013 +0000
@@ -9,7 +9,9 @@
 
 #ifndef NYLPC_CFORMATTEXTREADER_H_
 #define NYLPC_CFORMATTEXTREADER_H_
-
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
 
 /**
  * [a-zA-Z0-9_-]で構成されるワードを取得します。
@@ -40,6 +42,8 @@
  * 読み飛ばしたスペース
  */
 NyLPC_TInt32 NyLPC_cFormatTextReader_seekSpace(const NyLPC_TChar* s);
-
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
 
 #endif /* NYLPC_CFORMATTEXTREADER_H_ */
--- a/cpp/ModLocalFileSystem.cpp	Sat Apr 20 05:03:57 2013 +0000
+++ b/cpp/ModLocalFileSystem.cpp	Sun Apr 21 01:21:41 2013 +0000
@@ -2,6 +2,7 @@
 #include "HttpdConnection.h"
 #include <stdio.h>
 #include <stdlib.h>
+#include "mbed.h"
 #define ModLocalFile_SIZE_OF_BUF 256
 #define SIZE_OF_FILENAME (32)
 static char buf[ModLocalFile_SIZE_OF_BUF];
@@ -48,7 +49,19 @@
                 return true;
             }
             NyLPC_cModUrl_finalize(&mod);
+        }/*
+        DIR *d;
+        struct dirent *p;
+        d = opendir(buf);
+        if ( d != NULL )
+        {
+            if(i_connection.sendHeader(200,"text/plain",NULL)){
+            while ( (p = readdir(d)) != NULL )
+            {
+               i_connection.sendBodyF( p->d_name,strlen(p->d_name));
+            }
         }
+        closedir(d);*/
         {        
             //Httpd lock
             i_connection.lockHttpd();            
--- a/cpp/NetConfig.cpp	Sat Apr 20 05:03:57 2013 +0000
+++ b/cpp/NetConfig.cpp	Sun Apr 21 01:21:41 2013 +0000
@@ -1,6 +1,9 @@
 #include "NetConfig.h"
 #include "NyLPC_uip.h"
 #include "NyLPC_uip_ethernet.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include "mbed.h"
 namespace MiMic
 {
 
@@ -40,6 +43,60 @@
     {
         NyLPC_TEthAddr_set(&(this->_inst.interface_setting.ethernet.eth_mac),a1,a2,a3,a4,a5,a6);
     }
-    
+    bool NetConfig::loadFromFile(const char* i_file)
+    {
+        const static char* tbl[]={"macaddr","ipaddr","netmask","gateway"};
+        char tmp[32];
+        unsigned char v[6];
+        const char* p;
+        const char* key;
+        int l;
+        FILE* fp = fopen(i_file,"r");
+        if(fp==NULL){
+            return false;
+        }
+        //read from values
+        while(fgets(tmp,31,fp)){
+            p=NyLPC_cFormatTextReader_seekSpace(tmp)+tmp;//skip space
+            l=NyLPC_cFormatTextReader_readWord(p,&key);
+            for(int i=0;i<4;i++){
+                if(l>=0 && NyLPC_strnicmp(key,tbl[i],l)==0){
+                    p+=l;//skip keyname
+                    p=NyLPC_cFormatTextReader_seekSpace(p)+p;//skip space
+                    if(*p!='='){
+                        break;//check equal
+                    }
+                    p++;
+                    p=NyLPC_cFormatTextReader_seekSpace(p)+p;//skip space
+                    switch(i){
+                    case 0:
+                        if(NyLPC_cFormatTextReader_readMacAddr(p,v)!=0){
+                            this->setEmac(v[0],v[1],v[2],v[3],v[4],v[5]);
+                        }
+                        break;
+                    case 1:
+                        if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
+                            this->setIpAddr(v[0],v[1],v[2],v[3]);
+                        }
+                        break;
+                    case 2:
+                        if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
+                            this->setNetMask(v[0],v[1],v[2],v[3]);
+                        }
+                        break;
+                    case 3:
+                        if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
+                            this->setGateway(v[0],v[1],v[2],v[3]);
+                        }
+                        break;
+                    default:
+                        break;
+                    }
+                }
+            }
+        }
+        fclose(fp);
+        return true;
+    }   
 
 };
\ No newline at end of file
--- a/cpp/NetConfig.h	Sat Apr 20 05:03:57 2013 +0000
+++ b/cpp/NetConfig.h	Sun Apr 21 01:21:41 2013 +0000
@@ -45,5 +45,30 @@
          * 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);
-    };
-   }
\ No newline at end of file
+        /**
+         * Load configulation from text file.
+         * <p>File format example
+         * <pre>
+         * macaddr=00:00:00:00:00:00
+         * ipaddr=192.168.0.1
+         * netmask=255.255.255.0
+         * gateway=192.168.0.254
+         * </pre>
+         * <p>Keys
+         * <ul>
+         * <li>macaddr=[:macaddr:] - 48bit ethernet mac address that are separated by ':'</li>
+         * <li>ipaddr=[:ip:] - 32 bit IP address</li>
+         * <li>netmask=[:ip:]- 32 bit network mask value.</li>
+         * <li>gateway=[:ip:] - 32 bit default gateway address.</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.
+         * </p>
+         * @return
+         * true if file read. false is not read.
+         */
+         bool NetConfig::loadFromFile(const char* i_file);
+   };
+}
\ No newline at end of file