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:
Sun Apr 21 01:21:41 2013 +0000
Revision:
13:a71705c5e6fd
Parent:
11:c82a7b2899b0
a lot changes.; add format text reader. ;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 3:0a94993be1f6 1 #include "NetConfig.h"
nyatla 11:c82a7b2899b0 2 #include "NyLPC_uip.h"
nyatla 11:c82a7b2899b0 3 #include "NyLPC_uip_ethernet.h"
nyatla 13:a71705c5e6fd 4 #include <stdio.h>
nyatla 13:a71705c5e6fd 5 #include <stdlib.h>
nyatla 13:a71705c5e6fd 6 #include "mbed.h"
nyatla 3:0a94993be1f6 7 namespace MiMic
nyatla 3:0a94993be1f6 8 {
nyatla 3:0a94993be1f6 9
nyatla 3:0a94993be1f6 10 NetConfig::NetConfig(bool i_is_factory_default)
nyatla 3:0a94993be1f6 11 {
nyatla 11:c82a7b2899b0 12 NyLPC_cNetConfig_initialize(&(this->_inst),i_is_factory_default);
nyatla 3:0a94993be1f6 13 }
nyatla 3:0a94993be1f6 14 NetConfig::~NetConfig()
nyatla 3:0a94993be1f6 15 {
nyatla 3:0a94993be1f6 16 NyLPC_cNetConfig_finalize(&(this->_inst));
nyatla 3:0a94993be1f6 17 }
nyatla 11:c82a7b2899b0 18 /**
nyatla 11:c82a7b2899b0 19 * Set IPv4 ip address to instance.
nyatla 11:c82a7b2899b0 20 */
nyatla 11:c82a7b2899b0 21 void NetConfig::setIpAddr(unsigned char ip1,unsigned char ip2,unsigned char ip3,unsigned char ip4)
nyatla 11:c82a7b2899b0 22 {
nyatla 11:c82a7b2899b0 23 NyLPC_TIPv4Addr_set(&(this->_inst.interface_setting.ethernet.ip_addr),ip1,ip2,ip3,ip4);
nyatla 11:c82a7b2899b0 24 }
nyatla 11:c82a7b2899b0 25 /**
nyatla 11:c82a7b2899b0 26 * Set IPv4 network mask value to instance.
nyatla 11:c82a7b2899b0 27 */
nyatla 11:c82a7b2899b0 28 void NetConfig::setNetMask(unsigned char ip1,unsigned char ip2,unsigned char ip3,unsigned char ip4)
nyatla 11:c82a7b2899b0 29 {
nyatla 11:c82a7b2899b0 30 NyLPC_TIPv4Addr_set(&(this->_inst.interface_setting.ethernet.netmask),ip1,ip2,ip3,ip4);
nyatla 11:c82a7b2899b0 31 }
nyatla 11:c82a7b2899b0 32 /**
nyatla 11:c82a7b2899b0 33 * Set IPv4 default gateway address to instance.
nyatla 11:c82a7b2899b0 34 */
nyatla 11:c82a7b2899b0 35 void NetConfig::setGateway(unsigned char ip1,unsigned char ip2,unsigned char ip3,unsigned char ip4)
nyatla 11:c82a7b2899b0 36 {
nyatla 11:c82a7b2899b0 37 NyLPC_TIPv4Addr_set(&(this->_inst.interface_setting.ethernet.dr_addr),ip4,ip3,ip2,ip1);
nyatla 11:c82a7b2899b0 38 }
nyatla 11:c82a7b2899b0 39 /**
nyatla 11:c82a7b2899b0 40 * Set ethernet mac address to instance.
nyatla 11:c82a7b2899b0 41 */
nyatla 11:c82a7b2899b0 42 void NetConfig::setEmac(unsigned char a1,unsigned char a2,unsigned char a3,unsigned char a4,unsigned char a5,unsigned char a6)
nyatla 11:c82a7b2899b0 43 {
nyatla 11:c82a7b2899b0 44 NyLPC_TEthAddr_set(&(this->_inst.interface_setting.ethernet.eth_mac),a1,a2,a3,a4,a5,a6);
nyatla 11:c82a7b2899b0 45 }
nyatla 13:a71705c5e6fd 46 bool NetConfig::loadFromFile(const char* i_file)
nyatla 13:a71705c5e6fd 47 {
nyatla 13:a71705c5e6fd 48 const static char* tbl[]={"macaddr","ipaddr","netmask","gateway"};
nyatla 13:a71705c5e6fd 49 char tmp[32];
nyatla 13:a71705c5e6fd 50 unsigned char v[6];
nyatla 13:a71705c5e6fd 51 const char* p;
nyatla 13:a71705c5e6fd 52 const char* key;
nyatla 13:a71705c5e6fd 53 int l;
nyatla 13:a71705c5e6fd 54 FILE* fp = fopen(i_file,"r");
nyatla 13:a71705c5e6fd 55 if(fp==NULL){
nyatla 13:a71705c5e6fd 56 return false;
nyatla 13:a71705c5e6fd 57 }
nyatla 13:a71705c5e6fd 58 //read from values
nyatla 13:a71705c5e6fd 59 while(fgets(tmp,31,fp)){
nyatla 13:a71705c5e6fd 60 p=NyLPC_cFormatTextReader_seekSpace(tmp)+tmp;//skip space
nyatla 13:a71705c5e6fd 61 l=NyLPC_cFormatTextReader_readWord(p,&key);
nyatla 13:a71705c5e6fd 62 for(int i=0;i<4;i++){
nyatla 13:a71705c5e6fd 63 if(l>=0 && NyLPC_strnicmp(key,tbl[i],l)==0){
nyatla 13:a71705c5e6fd 64 p+=l;//skip keyname
nyatla 13:a71705c5e6fd 65 p=NyLPC_cFormatTextReader_seekSpace(p)+p;//skip space
nyatla 13:a71705c5e6fd 66 if(*p!='='){
nyatla 13:a71705c5e6fd 67 break;//check equal
nyatla 13:a71705c5e6fd 68 }
nyatla 13:a71705c5e6fd 69 p++;
nyatla 13:a71705c5e6fd 70 p=NyLPC_cFormatTextReader_seekSpace(p)+p;//skip space
nyatla 13:a71705c5e6fd 71 switch(i){
nyatla 13:a71705c5e6fd 72 case 0:
nyatla 13:a71705c5e6fd 73 if(NyLPC_cFormatTextReader_readMacAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 74 this->setEmac(v[0],v[1],v[2],v[3],v[4],v[5]);
nyatla 13:a71705c5e6fd 75 }
nyatla 13:a71705c5e6fd 76 break;
nyatla 13:a71705c5e6fd 77 case 1:
nyatla 13:a71705c5e6fd 78 if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 79 this->setIpAddr(v[0],v[1],v[2],v[3]);
nyatla 13:a71705c5e6fd 80 }
nyatla 13:a71705c5e6fd 81 break;
nyatla 13:a71705c5e6fd 82 case 2:
nyatla 13:a71705c5e6fd 83 if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 84 this->setNetMask(v[0],v[1],v[2],v[3]);
nyatla 13:a71705c5e6fd 85 }
nyatla 13:a71705c5e6fd 86 break;
nyatla 13:a71705c5e6fd 87 case 3:
nyatla 13:a71705c5e6fd 88 if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 89 this->setGateway(v[0],v[1],v[2],v[3]);
nyatla 13:a71705c5e6fd 90 }
nyatla 13:a71705c5e6fd 91 break;
nyatla 13:a71705c5e6fd 92 default:
nyatla 13:a71705c5e6fd 93 break;
nyatla 13:a71705c5e6fd 94 }
nyatla 13:a71705c5e6fd 95 }
nyatla 13:a71705c5e6fd 96 }
nyatla 13:a71705c5e6fd 97 }
nyatla 13:a71705c5e6fd 98 fclose(fp);
nyatla 13:a71705c5e6fd 99 return true;
nyatla 13:a71705c5e6fd 100 }
nyatla 3:0a94993be1f6 101
nyatla 3:0a94993be1f6 102 };