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

core/net/NyLPC_cNetConfig.cpp@11:c82a7b2899b0, 2013-04-20 (annotated)

Committer:
nyatla
Date:
Sat Apr 20 03:47:14 2013 +0000
Revision:
11:c82a7b2899b0
Parent:
2:b96c1e90d120 
update under os/ files.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 #include "NyLPC_cNetConfig.h"
nyatla 11:c82a7b2899b0 2 #include "../flash/NyLPC_cMiMicConfiglation.h"
nyatla 2:b96c1e90d120 3 /**
nyatla 2:b96c1e90d120 4 * IPアドレスはネットワークオーダーで格納する。
nyatla 2:b96c1e90d120 5 * 構造体は4バイトアライメントであること。
nyatla 2:b96c1e90d120 6 */
nyatla 2:b96c1e90d120 7 struct TNetConfigMemMap
nyatla 2:b96c1e90d120 8 {
nyatla 2:b96c1e90d120 9 /**
nyatla 2:b96c1e90d120 10 * ROM焼検出用。0xFFFFFFFFを書く
nyatla 2:b96c1e90d120 11 */
nyatla 2:b96c1e90d120 12 NyLPC_TUInt32 fast_boot;
nyatla 2:b96c1e90d120 13 NyLPC_TUInt16 version;
nyatla 2:b96c1e90d120 14 NyLPC_TUInt16 interface_type;
nyatla 2:b96c1e90d120 15 NyLPC_TUInt32 mac_00_01_02_03;
nyatla 2:b96c1e90d120 16 NyLPC_TUInt32 mac_04_05_xx_xx;
nyatla 2:b96c1e90d120 17 /** network order ip address*/
nyatla 2:b96c1e90d120 18 NyLPC_TUInt32 ipv4_addr_net;
nyatla 2:b96c1e90d120 19 /** network order mask value*/
nyatla 2:b96c1e90d120 20 NyLPC_TUInt32 ipv4_mask_net;
nyatla 2:b96c1e90d120 21 /** network order route*/
nyatla 2:b96c1e90d120 22 NyLPC_TUInt32 ipv4_drut_net;
nyatla 2:b96c1e90d120 23 // NyLPC_TUInt32 ipv4_port;
nyatla 2:b96c1e90d120 24 // NyLPC_TUInt32 accessmode;
nyatla 2:b96c1e90d120 25 };
nyatla 2:b96c1e90d120 26
nyatla 11:c82a7b2899b0 27 static void update(NyLPC_TcNetConfig_t* i_inst,const struct NyLPC_TMimicConfigulation* pdata);
nyatla 11:c82a7b2899b0 28
nyatla 2:b96c1e90d120 29
nyatla 11:c82a7b2899b0 30 void NyLPC_cNetConfig_initialize(NyLPC_TcNetConfig_t* i_inst,NyLPC_TBool i_is_factory_default)
nyatla 2:b96c1e90d120 31 {
nyatla 11:c82a7b2899b0 32 if(i_is_factory_default)
nyatla 11:c82a7b2899b0 33 {
nyatla 11:c82a7b2899b0 34 update(i_inst,NyLPC_cMiMicConfiglation_loadFactoryDefault());
nyatla 11:c82a7b2899b0 35 }else{
nyatla 11:c82a7b2899b0 36 update(i_inst,NyLPC_cMiMicConfiglation_loadFromFlash());
nyatla 11:c82a7b2899b0 37 }
nyatla 2:b96c1e90d120 38
nyatla 2:b96c1e90d120 39
nyatla 2:b96c1e90d120 40 }
nyatla 2:b96c1e90d120 41
nyatla 2:b96c1e90d120 42 /**
nyatla 2:b96c1e90d120 43 * ユーザコンフィギュレーションを更新する。
nyatla 2:b96c1e90d120 44 * この関数をコールするときは、割込/FreeRTOSを一時停止すること。
nyatla 2:b96c1e90d120 45 */
nyatla 2:b96c1e90d120 46 /*
nyatla 2:b96c1e90d120 47 NyLPC_TBool NyLPC_cNetConfig_saveToOnchipFlash(NyLPC_TcNetConfig_t* i_inst)
nyatla 2:b96c1e90d120 48 {
nyatla 2:b96c1e90d120 49 NyLPC_TUInt8* pdata;
nyatla 2:b96c1e90d120 50 NyLPC_TcOnchipFlashWriter_t s;
nyatla 2:b96c1e90d120 51 struct TNetConfigMemMap tmp;
nyatla 2:b96c1e90d120 52 NyLPC_cOnchipFlashWriter_initialize(&s);
nyatla 2:b96c1e90d120 53 //書込みデータを作成
nyatla 2:b96c1e90d120 54 tmp.fast_boot=0xffffffff;
nyatla 2:b96c1e90d120 55 tmp.version =i_inst->version;
nyatla 2:b96c1e90d120 56 tmp.interface_type=NyLPC_cNetConfig_INTERFACE_TYPE_ETHERNET;
nyatla 2:b96c1e90d120 57 pdata=i_inst->interface_setting.ethernet.eth_mac.addr;
nyatla 2:b96c1e90d120 58 tmp.mac_00_01_02_03=(((NyLPC_TUInt32)pdata[0])<<24)|(((NyLPC_TUInt32)pdata[1])<<16)|(((NyLPC_TUInt32)pdata[2])<<8)|(((NyLPC_TUInt32)pdata[3])<<0);
nyatla 2:b96c1e90d120 59 tmp.mac_04_05_xx_xx=(((NyLPC_TUInt32)pdata[4])<<24)|(((NyLPC_TUInt32)pdata[5])<<16);
nyatla 2:b96c1e90d120 60 tmp.ipv4_addr_net=i_inst->interface_setting.ethernet.ip_addr.v;
nyatla 2:b96c1e90d120 61 tmp.ipv4_mask_net=i_inst->interface_setting.ethernet.netmask.v;
nyatla 2:b96c1e90d120 62 tmp.ipv4_drut_net=i_inst->interface_setting.ethernet.dr_addr.v;
nyatla 2:b96c1e90d120 63
nyatla 2:b96c1e90d120 64 //イレース
nyatla 2:b96c1e90d120 65 if(!NyLPC_cOnchipFlashWriter_elase(&s,MIMIC_CONFIGLATION_FLASH_SECTOR,MIMIC_CONFIGLATION_FLASH_SECTOR)){
nyatla 2:b96c1e90d120 66 NyLPC_OnErrorGoto(Error);
nyatla 2:b96c1e90d120 67 }
nyatla 2:b96c1e90d120 68 //コンフィギュレーションを書き込む。
nyatla 2:b96c1e90d120 69 if(!NyLPC_cOnchipFlashWriter_writeSector(&s,MIMIC_CONFIGLATION_FLASH_SECTOR,0x00000000,&tmp,sizeof(struct TNetConfigMemMap))){
nyatla 2:b96c1e90d120 70 NyLPC_OnErrorGoto(Error);
nyatla 2:b96c1e90d120 71 }
nyatla 2:b96c1e90d120 72 //ユーザコンフィギュレーションをONにする。
nyatla 2:b96c1e90d120 73 if(setUserConfigulation()){
nyatla 2:b96c1e90d120 74 NyLPC_OnErrorGoto(Error);
nyatla 2:b96c1e90d120 75 }
nyatla 2:b96c1e90d120 76 NyLPC_cOnchipFlashWriter_finalize(&s);
nyatla 2:b96c1e90d120 77 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 78 Error:
nyatla 2:b96c1e90d120 79 NyLPC_cOnchipFlashWriter_finalize(&s);
nyatla 2:b96c1e90d120 80 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 81 }
nyatla 2:b96c1e90d120 82 */
nyatla 2:b96c1e90d120 83
nyatla 2:b96c1e90d120 84
nyatla 2:b96c1e90d120 85 #define ETHERNET_FRAME_LEN 1480
nyatla 11:c82a7b2899b0 86 static void update(NyLPC_TcNetConfig_t* i_inst,const struct NyLPC_TMimicConfigulation* pdata)
nyatla 2:b96c1e90d120 87 {
nyatla 2:b96c1e90d120 88 struct NyLPC_TEthAddr ea;
nyatla 2:b96c1e90d120 89 struct NyLPC_TIPv4Addr ip,mask,drt;
nyatla 2:b96c1e90d120 90 //値の読み出し
nyatla 2:b96c1e90d120 91 ea.addr[0]=(NyLPC_TUInt8)((pdata->mac_00_01_02_03>>24)&0xff);
nyatla 2:b96c1e90d120 92 ea.addr[1]=(NyLPC_TUInt8)((pdata->mac_00_01_02_03>>16)&0xff);
nyatla 2:b96c1e90d120 93 ea.addr[2]=(NyLPC_TUInt8)((pdata->mac_00_01_02_03>> 8)&0xff);
nyatla 2:b96c1e90d120 94 ea.addr[3]=(NyLPC_TUInt8)((pdata->mac_00_01_02_03>> 0)&0xff);
nyatla 2:b96c1e90d120 95 ea.addr[4]=(NyLPC_TUInt8)((pdata->mac_04_05_xx_xx>>24)&0xff);
nyatla 2:b96c1e90d120 96 ea.addr[5]=(NyLPC_TUInt8)((pdata->mac_04_05_xx_xx>>16)&0xff);
nyatla 2:b96c1e90d120 97 ip.v=NyLPC_htonl(pdata->ipv4_addr_net);
nyatla 2:b96c1e90d120 98 mask.v=NyLPC_htonl(pdata->ipv4_mask_net);
nyatla 2:b96c1e90d120 99 drt.v=NyLPC_htonl(pdata->ipv4_drut_net);
nyatla 2:b96c1e90d120 100 i_inst->version=1;
nyatla 2:b96c1e90d120 101 i_inst->interface_type=NyLPC_cNetConfig_INTERFACE_TYPE_ETHERNET;
nyatla 2:b96c1e90d120 102 NyLPC_cIPv4Config_initialzeForEthernet(&i_inst->interface_setting.ethernet,&ea,ETHERNET_FRAME_LEN);
nyatla 2:b96c1e90d120 103 NyLPC_cIPv4Config_setDefaultRoute(&i_inst->interface_setting.ethernet,&drt);
nyatla 2:b96c1e90d120 104 NyLPC_cIPv4Config_setIp(&i_inst->interface_setting.ethernet,&ip,&mask);
nyatla 2:b96c1e90d120 105 return;
nyatla 2:b96c1e90d120 106 }
nyatla 2:b96c1e90d120 107
nyatla 2:b96c1e90d120 108
nyatla 11:c82a7b2899b0 109