Ryo Iizuka / libMiMic

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.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

チュートリアル

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.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

Tutorial

mbed/NetConfig.cpp@29:e19aab0c4156, 2013-05-04 (annotated)

Committer:
nyatla
Date:
Sat May 04 12:11:59 2013 +0000
Revision:
29:e19aab0c4156
Parent:
27:eb66b517efe6
Child:
30:d971af48e93b
update platform selector

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 27:eb66b517efe6 3 #include "NyLPC_flash.h"
nyatla 11:c82a7b2899b0 4 #include "NyLPC_uip_ethernet.h"
nyatla 29:e19aab0c4156 5 #include "utils/PlatformInfo.h"
nyatla 13:a71705c5e6fd 6 #include <stdio.h>
nyatla 13:a71705c5e6fd 7 #include <stdlib.h>
nyatla 13:a71705c5e6fd 8 #include "mbed.h"
nyatla 27:eb66b517efe6 9
nyatla 27:eb66b517efe6 10 extern "C" void mbed_mac_address(char *s);
nyatla 29:e19aab0c4156 11 void overrideMacAddrIfmbed(NyLPC_TcNetConfig& v)
nyatla 27:eb66b517efe6 12 {
nyatla 27:eb66b517efe6 13 mbed_mac_address((char*)(v.interface_setting.ethernet.eth_mac.addr));
nyatla 27:eb66b517efe6 14 }
nyatla 27:eb66b517efe6 15 void updateOnchipConfig(NyLPC_TcNetConfig& v)
nyatla 27:eb66b517efe6 16 {
nyatla 27:eb66b517efe6 17 struct NyLPC_TMimicConfigulation cfg_image;
nyatla 27:eb66b517efe6 18 //パラメータ→ROMイメージ変換
nyatla 27:eb66b517efe6 19 cfg_image.fast_boot=0xffffffff;
nyatla 27:eb66b517efe6 20 cfg_image.mac_00_01_02_03=NyLPC_TcIPv4Config_getEtherMac000120203(&(v.interface_setting.ethernet));
nyatla 27:eb66b517efe6 21 cfg_image.mac_04_05_xx_xx=NyLPC_TcIPv4Config_getEtherMac0405xxxx(&(v.interface_setting.ethernet));
nyatla 27:eb66b517efe6 22 cfg_image.ipv4_addr_net =NyLPC_ntohl(v.interface_setting.ethernet.ip_addr.v);
nyatla 27:eb66b517efe6 23 cfg_image.ipv4_mask_net =NyLPC_ntohl(v.interface_setting.ethernet.netmask.v);
nyatla 27:eb66b517efe6 24 cfg_image.ipv4_drut_net =NyLPC_ntohl(v.interface_setting.ethernet.dr_addr.v);
nyatla 27:eb66b517efe6 25 cfg_image.ipv4_port = 80;//dummy!
nyatla 27:eb66b517efe6 26 cfg_image.accessmode= 0x0000FFFF;//dummy!
nyatla 27:eb66b517efe6 27 //FreeRTOSの停止
nyatla 27:eb66b517efe6 28 NyLPC_cIsr_enterCritical();
nyatla 27:eb66b517efe6 29 //Flashへの書き込み
nyatla 27:eb66b517efe6 30 NyLPC_cMiMicConfiglation_updateConfigulation(&cfg_image);
nyatla 27:eb66b517efe6 31 //FreeRTOSの復帰
nyatla 27:eb66b517efe6 32 NyLPC_cIsr_exitCritical();
nyatla 27:eb66b517efe6 33 }
nyatla 3:0a94993be1f6 34 namespace MiMic
nyatla 3:0a94993be1f6 35 {
nyatla 3:0a94993be1f6 36
nyatla 3:0a94993be1f6 37 NetConfig::NetConfig(bool i_is_factory_default)
nyatla 3:0a94993be1f6 38 {
nyatla 11:c82a7b2899b0 39 NyLPC_cNetConfig_initialize(&(this->_inst),i_is_factory_default);
nyatla 27:eb66b517efe6 40 //check mbed
nyatla 29:e19aab0c4156 41 if(!PlatformInfo::getPlatformType()==PlatformInfo::PF_MBED)
nyatla 27:eb66b517efe6 42 {
nyatla 27:eb66b517efe6 43 return;
nyatla 27:eb66b517efe6 44 }
nyatla 27:eb66b517efe6 45
nyatla 27:eb66b517efe6 46 if(!NyLPC_cMiMicConfiglation_hasUserConfigulation()){
nyatla 27:eb66b517efe6 47 //is 1st read?
nyatla 27:eb66b517efe6 48 //mbed override
nyatla 27:eb66b517efe6 49 overrideMacAddrIfmbed((this->_inst));
nyatla 27:eb66b517efe6 50 //save
nyatla 27:eb66b517efe6 51 updateOnchipConfig((this->_inst));
nyatla 27:eb66b517efe6 52 }else{
nyatla 27:eb66b517efe6 53 //2nd read
nyatla 27:eb66b517efe6 54 if(i_is_factory_default){
nyatla 27:eb66b517efe6 55 //mbed override
nyatla 27:eb66b517efe6 56 overrideMacAddrIfmbed((this->_inst));
nyatla 27:eb66b517efe6 57 }else{
nyatla 27:eb66b517efe6 58 //nothing to do
nyatla 27:eb66b517efe6 59 }
nyatla 27:eb66b517efe6 60 }
nyatla 3:0a94993be1f6 61 }
nyatla 3:0a94993be1f6 62 NetConfig::~NetConfig()
nyatla 3:0a94993be1f6 63 {
nyatla 3:0a94993be1f6 64 NyLPC_cNetConfig_finalize(&(this->_inst));
nyatla 3:0a94993be1f6 65 }
nyatla 11:c82a7b2899b0 66 /**
nyatla 11:c82a7b2899b0 67 * Set IPv4 ip address to instance.
nyatla 11:c82a7b2899b0 68 */
nyatla 11:c82a7b2899b0 69 void NetConfig::setIpAddr(unsigned char ip1,unsigned char ip2,unsigned char ip3,unsigned char ip4)
nyatla 11:c82a7b2899b0 70 {
nyatla 11:c82a7b2899b0 71 NyLPC_TIPv4Addr_set(&(this->_inst.interface_setting.ethernet.ip_addr),ip1,ip2,ip3,ip4);
nyatla 11:c82a7b2899b0 72 }
nyatla 11:c82a7b2899b0 73 /**
nyatla 11:c82a7b2899b0 74 * Set IPv4 network mask value to instance.
nyatla 11:c82a7b2899b0 75 */
nyatla 11:c82a7b2899b0 76 void NetConfig::setNetMask(unsigned char ip1,unsigned char ip2,unsigned char ip3,unsigned char ip4)
nyatla 11:c82a7b2899b0 77 {
nyatla 11:c82a7b2899b0 78 NyLPC_TIPv4Addr_set(&(this->_inst.interface_setting.ethernet.netmask),ip1,ip2,ip3,ip4);
nyatla 11:c82a7b2899b0 79 }
nyatla 11:c82a7b2899b0 80 /**
nyatla 11:c82a7b2899b0 81 * Set IPv4 default gateway address to instance.
nyatla 11:c82a7b2899b0 82 */
nyatla 11:c82a7b2899b0 83 void NetConfig::setGateway(unsigned char ip1,unsigned char ip2,unsigned char ip3,unsigned char ip4)
nyatla 11:c82a7b2899b0 84 {
nyatla 23:3a5e991c1f10 85 NyLPC_TIPv4Addr_set(&(this->_inst.interface_setting.ethernet.dr_addr),ip1,ip2,ip3,ip4);
nyatla 11:c82a7b2899b0 86 }
nyatla 11:c82a7b2899b0 87 /**
nyatla 11:c82a7b2899b0 88 * Set ethernet mac address to instance.
nyatla 11:c82a7b2899b0 89 */
nyatla 11:c82a7b2899b0 90 void NetConfig::setEmac(unsigned char a1,unsigned char a2,unsigned char a3,unsigned char a4,unsigned char a5,unsigned char a6)
nyatla 11:c82a7b2899b0 91 {
nyatla 11:c82a7b2899b0 92 NyLPC_TEthAddr_set(&(this->_inst.interface_setting.ethernet.eth_mac),a1,a2,a3,a4,a5,a6);
nyatla 11:c82a7b2899b0 93 }
nyatla 13:a71705c5e6fd 94 bool NetConfig::loadFromFile(const char* i_file)
nyatla 13:a71705c5e6fd 95 {
nyatla 13:a71705c5e6fd 96 const static char* tbl[]={"macaddr","ipaddr","netmask","gateway"};
nyatla 13:a71705c5e6fd 97 char tmp[32];
nyatla 13:a71705c5e6fd 98 unsigned char v[6];
nyatla 13:a71705c5e6fd 99 const char* p;
nyatla 13:a71705c5e6fd 100 const char* key;
nyatla 13:a71705c5e6fd 101 int l;
nyatla 13:a71705c5e6fd 102 FILE* fp = fopen(i_file,"r");
nyatla 13:a71705c5e6fd 103 if(fp==NULL){
nyatla 13:a71705c5e6fd 104 return false;
nyatla 13:a71705c5e6fd 105 }
nyatla 13:a71705c5e6fd 106 //read from values
nyatla 13:a71705c5e6fd 107 while(fgets(tmp,31,fp)){
nyatla 13:a71705c5e6fd 108 p=NyLPC_cFormatTextReader_seekSpace(tmp)+tmp;//skip space
nyatla 13:a71705c5e6fd 109 l=NyLPC_cFormatTextReader_readWord(p,&key);
nyatla 13:a71705c5e6fd 110 for(int i=0;i<4;i++){
nyatla 13:a71705c5e6fd 111 if(l>=0 && NyLPC_strnicmp(key,tbl[i],l)==0){
nyatla 13:a71705c5e6fd 112 p+=l;//skip keyname
nyatla 13:a71705c5e6fd 113 p=NyLPC_cFormatTextReader_seekSpace(p)+p;//skip space
nyatla 13:a71705c5e6fd 114 if(*p!='='){
nyatla 13:a71705c5e6fd 115 break;//check equal
nyatla 13:a71705c5e6fd 116 }
nyatla 13:a71705c5e6fd 117 p++;
nyatla 13:a71705c5e6fd 118 p=NyLPC_cFormatTextReader_seekSpace(p)+p;//skip space
nyatla 13:a71705c5e6fd 119 switch(i){
nyatla 13:a71705c5e6fd 120 case 0:
nyatla 13:a71705c5e6fd 121 if(NyLPC_cFormatTextReader_readMacAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 122 this->setEmac(v[0],v[1],v[2],v[3],v[4],v[5]);
nyatla 13:a71705c5e6fd 123 }
nyatla 13:a71705c5e6fd 124 break;
nyatla 13:a71705c5e6fd 125 case 1:
nyatla 13:a71705c5e6fd 126 if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 127 this->setIpAddr(v[0],v[1],v[2],v[3]);
nyatla 13:a71705c5e6fd 128 }
nyatla 13:a71705c5e6fd 129 break;
nyatla 13:a71705c5e6fd 130 case 2:
nyatla 13:a71705c5e6fd 131 if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 132 this->setNetMask(v[0],v[1],v[2],v[3]);
nyatla 13:a71705c5e6fd 133 }
nyatla 13:a71705c5e6fd 134 break;
nyatla 13:a71705c5e6fd 135 case 3:
nyatla 13:a71705c5e6fd 136 if(NyLPC_cFormatTextReader_readIpAddr(p,v)!=0){
nyatla 13:a71705c5e6fd 137 this->setGateway(v[0],v[1],v[2],v[3]);
nyatla 13:a71705c5e6fd 138 }
nyatla 13:a71705c5e6fd 139 break;
nyatla 13:a71705c5e6fd 140 default:
nyatla 13:a71705c5e6fd 141 break;
nyatla 13:a71705c5e6fd 142 }
nyatla 13:a71705c5e6fd 143 }
nyatla 13:a71705c5e6fd 144 }
nyatla 13:a71705c5e6fd 145 }
nyatla 13:a71705c5e6fd 146 fclose(fp);
nyatla 13:a71705c5e6fd 147 return true;
nyatla 13:a71705c5e6fd 148 }
nyatla 3:0a94993be1f6 149
nyatla 3:0a94993be1f6 150 };