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:
Thu May 29 14:29:15 2014 +0000
Revision:
69:8c5f220441f5
Parent:
68:f7def7eb5504
Child:
91:db8279c869d3
r354????; LPC4088?????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 68:f7def7eb5504 1 #include "NyLPC_cEthernetMM.h"
nyatla 68:f7def7eb5504 2 /**
nyatla 68:f7def7eb5504 3 * メモリブロックの数
nyatla 68:f7def7eb5504 4 */
nyatla 68:f7def7eb5504 5 #define NUM_OF_MAX_BUF 3
nyatla 68:f7def7eb5504 6 #define NUM_OF_512_BUF 3
nyatla 68:f7def7eb5504 7 #define NUM_OF_256_BUF 4
nyatla 68:f7def7eb5504 8 #define NUM_OF_128_BUF 16
nyatla 69:8c5f220441f5 9 #define NUM_OF_64_BUF 4
nyatla 68:f7def7eb5504 10
nyatla 68:f7def7eb5504 11 /**
nyatla 68:f7def7eb5504 12 * FULLサイズのEthernetFrame送信メモリのサイズ。
nyatla 68:f7def7eb5504 13 * ここで最大送信サイズを制限する。
nyatla 68:f7def7eb5504 14 * 通常は1460+20+20+14=1514バイト
nyatla 68:f7def7eb5504 15 */
nyatla 68:f7def7eb5504 16 #define MAX_TX_ETHERNET_FRAME_SIZE 1514
nyatla 68:f7def7eb5504 17
nyatla 68:f7def7eb5504 18 /**
nyatla 68:f7def7eb5504 19 * TXメモリブロックの配置
nyatla 69:8c5f220441f5 20 * 9518バイト
nyatla 68:f7def7eb5504 21 */
nyatla 68:f7def7eb5504 22 struct TTxMemoryBlock
nyatla 68:f7def7eb5504 23 {
nyatla 68:f7def7eb5504 24 struct{
nyatla 68:f7def7eb5504 25 struct NyLPC_TTxBufferHeader h;
nyatla 68:f7def7eb5504 26 NyLPC_TUInt8 b[MAX_TX_ETHERNET_FRAME_SIZE];
nyatla 68:f7def7eb5504 27 }buf_max[NUM_OF_MAX_BUF];//(4+MAX_TX_ETHERNET_FRAME_SIZE(1514))*3=? default=4554
nyatla 68:f7def7eb5504 28 struct{
nyatla 68:f7def7eb5504 29 struct NyLPC_TTxBufferHeader h;
nyatla 68:f7def7eb5504 30 NyLPC_TUInt8 b[512];
nyatla 68:f7def7eb5504 31 }buf_512[NUM_OF_512_BUF];//(4+512)*3=1548
nyatla 68:f7def7eb5504 32 struct{
nyatla 68:f7def7eb5504 33 struct NyLPC_TTxBufferHeader h;
nyatla 68:f7def7eb5504 34 NyLPC_TUInt8 b[256];
nyatla 68:f7def7eb5504 35 }buf_256[NUM_OF_256_BUF];//(4+256)*4=1560
nyatla 68:f7def7eb5504 36 struct{
nyatla 68:f7def7eb5504 37 struct NyLPC_TTxBufferHeader h;
nyatla 68:f7def7eb5504 38 NyLPC_TUInt8 b[128];
nyatla 68:f7def7eb5504 39 }buf_128[NUM_OF_128_BUF];//(4+128)*16=1584
nyatla 69:8c5f220441f5 40 struct{
nyatla 69:8c5f220441f5 41 struct NyLPC_TTxBufferHeader h;
nyatla 69:8c5f220441f5 42 NyLPC_TUInt8 b[64];
nyatla 69:8c5f220441f5 43 }buf_64[NUM_OF_64_BUF];//(4+64)*4=272
nyatla 68:f7def7eb5504 44 };
nyatla 68:f7def7eb5504 45 /**
nyatla 68:f7def7eb5504 46 * メモリブロックの配置
nyatla 68:f7def7eb5504 47 */
nyatla 68:f7def7eb5504 48 static struct TTxMemoryBlock* _mem_addr;
nyatla 68:f7def7eb5504 49
nyatla 68:f7def7eb5504 50
nyatla 68:f7def7eb5504 51
nyatla 68:f7def7eb5504 52 /**
nyatla 68:f7def7eb5504 53 * デバック用。使用中のTxブロックの数を返す。
nyatla 68:f7def7eb5504 54 */
nyatla 68:f7def7eb5504 55 int NyLPC_cEthernetMM_dbg_getNumofUsedTx(void)
nyatla 68:f7def7eb5504 56 {
nyatla 68:f7def7eb5504 57 int x;
nyatla 69:8c5f220441f5 58 NyLPC_TUInt8 r1,r2,r3,r4,r5;
nyatla 69:8c5f220441f5 59 r1=r2=r3=r4=r5=0;
nyatla 68:f7def7eb5504 60 for(x=0;x<NUM_OF_MAX_BUF;x++){
nyatla 68:f7def7eb5504 61 if(_mem_addr->buf_max[x].h.is_lock || _mem_addr->buf_max[x].h.ref>0){
nyatla 68:f7def7eb5504 62 r1++;
nyatla 68:f7def7eb5504 63 continue;
nyatla 68:f7def7eb5504 64 }
nyatla 68:f7def7eb5504 65 }
nyatla 68:f7def7eb5504 66 for(x=0;x<NUM_OF_512_BUF;x++){
nyatla 68:f7def7eb5504 67 if(_mem_addr->buf_512[x].h.is_lock || _mem_addr->buf_512[x].h.ref>0){
nyatla 68:f7def7eb5504 68 r2++;
nyatla 68:f7def7eb5504 69 continue;
nyatla 68:f7def7eb5504 70 }
nyatla 68:f7def7eb5504 71 }
nyatla 68:f7def7eb5504 72 for(x=0;x<NUM_OF_256_BUF;x++){
nyatla 68:f7def7eb5504 73 if(_mem_addr->buf_256[x].h.is_lock || _mem_addr->buf_256[x].h.ref>0){
nyatla 68:f7def7eb5504 74 r3++;
nyatla 68:f7def7eb5504 75 continue;
nyatla 68:f7def7eb5504 76 }
nyatla 68:f7def7eb5504 77 }
nyatla 68:f7def7eb5504 78 for(x=0;x<NUM_OF_128_BUF;x++){
nyatla 68:f7def7eb5504 79 if(_mem_addr->buf_128[x].h.is_lock || _mem_addr->buf_128[x].h.ref>0){
nyatla 68:f7def7eb5504 80 r4++;
nyatla 68:f7def7eb5504 81 continue;
nyatla 68:f7def7eb5504 82 }
nyatla 68:f7def7eb5504 83 }
nyatla 69:8c5f220441f5 84 for(x=0;x<NUM_OF_64_BUF;x++){
nyatla 69:8c5f220441f5 85 if(_mem_addr->buf_64[x].h.is_lock || _mem_addr->buf_64[x].h.ref>0){
nyatla 69:8c5f220441f5 86 r5++;
nyatla 69:8c5f220441f5 87 continue;
nyatla 69:8c5f220441f5 88 }
nyatla 69:8c5f220441f5 89 }
nyatla 69:8c5f220441f5 90 return r1+r2+r3+r4+r5;
nyatla 68:f7def7eb5504 91 }
nyatla 68:f7def7eb5504 92
nyatla 68:f7def7eb5504 93
nyatla 68:f7def7eb5504 94 void NyLPC_cEthernetMM_initialize(void* i_memblock_addr)
nyatla 68:f7def7eb5504 95 {
nyatla 68:f7def7eb5504 96 int x;
nyatla 68:f7def7eb5504 97 _mem_addr=i_memblock_addr;
nyatla 68:f7def7eb5504 98 //TXバッファを初期化
nyatla 68:f7def7eb5504 99 for(x=0;x<NUM_OF_MAX_BUF;x++){
nyatla 68:f7def7eb5504 100 _mem_addr->buf_max[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 101 _mem_addr->buf_max[x].h.ref=0;
nyatla 68:f7def7eb5504 102 }
nyatla 68:f7def7eb5504 103 for(x=0;x<NUM_OF_512_BUF;x++){
nyatla 68:f7def7eb5504 104 _mem_addr->buf_512[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 105 _mem_addr->buf_512[x].h.ref=0;
nyatla 68:f7def7eb5504 106 }
nyatla 68:f7def7eb5504 107 for(x=0;x<NUM_OF_256_BUF;x++){
nyatla 68:f7def7eb5504 108 _mem_addr->buf_256[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 109 _mem_addr->buf_256[x].h.ref=0;
nyatla 68:f7def7eb5504 110 }
nyatla 68:f7def7eb5504 111 for(x=0;x<NUM_OF_128_BUF;x++){
nyatla 68:f7def7eb5504 112 _mem_addr->buf_128[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 113 _mem_addr->buf_128[x].h.ref=0;
nyatla 68:f7def7eb5504 114 }
nyatla 69:8c5f220441f5 115 for(x=0;x<NUM_OF_64_BUF;x++){
nyatla 69:8c5f220441f5 116 _mem_addr->buf_64[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 69:8c5f220441f5 117 _mem_addr->buf_64[x].h.ref=0;
nyatla 69:8c5f220441f5 118 }
nyatla 68:f7def7eb5504 119 }
nyatla 68:f7def7eb5504 120
nyatla 68:f7def7eb5504 121 /**
nyatla 68:f7def7eb5504 122 * 空のTxバッファのポインタを返します。
nyatla 68:f7def7eb5504 123 */
nyatla 68:f7def7eb5504 124 struct NyLPC_TTxBufferHeader* NyLPC_cEthernetMM_alloc(NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_size)
nyatla 68:f7def7eb5504 125 {
nyatla 68:f7def7eb5504 126 int i;
nyatla 68:f7def7eb5504 127 //ヒントから、割り当てるメモリブロックを決定
nyatla 69:8c5f220441f5 128
nyatla 69:8c5f220441f5 129 //特殊ブロック
nyatla 69:8c5f220441f5 130 if(i_hint==NyLPC_TcEthernetMM_HINT_CTRL_PACKET){
nyatla 69:8c5f220441f5 131 for(i=0;i<NUM_OF_64_BUF;i++){
nyatla 68:f7def7eb5504 132 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 133 if(_mem_addr->buf_64[i].h.ref>0 || _mem_addr->buf_64[i].h.is_lock){
nyatla 68:f7def7eb5504 134 continue;
nyatla 68:f7def7eb5504 135 }
nyatla 69:8c5f220441f5 136 _mem_addr->buf_64[i].h.ref++;
nyatla 69:8c5f220441f5 137 *o_size=64;
nyatla 69:8c5f220441f5 138 return &(_mem_addr->buf_64[i].h);
nyatla 68:f7def7eb5504 139 }
nyatla 69:8c5f220441f5 140 return NULL;
nyatla 69:8c5f220441f5 141 }
nyatla 69:8c5f220441f5 142
nyatla 69:8c5f220441f5 143 //汎用ブロック
nyatla 69:8c5f220441f5 144 if(i_hint<=128){
nyatla 69:8c5f220441f5 145 goto ALLOC_128;
nyatla 69:8c5f220441f5 146 }else if(i_hint<=256){
nyatla 69:8c5f220441f5 147 goto ALLOC_256;
nyatla 69:8c5f220441f5 148 }else if(i_hint<=512){
nyatla 69:8c5f220441f5 149 goto ALLOC_512;
nyatla 69:8c5f220441f5 150 }else{
nyatla 69:8c5f220441f5 151 goto ALLOC_MAX;
nyatla 69:8c5f220441f5 152 }
nyatla 69:8c5f220441f5 153
nyatla 69:8c5f220441f5 154 ALLOC_MAX:
nyatla 69:8c5f220441f5 155 for(i=0;i<NUM_OF_MAX_BUF;i++){
nyatla 69:8c5f220441f5 156 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 157 if(_mem_addr->buf_max[i].h.ref>0 || _mem_addr->buf_max[i].h.is_lock){
nyatla 69:8c5f220441f5 158 continue;
nyatla 68:f7def7eb5504 159 }
nyatla 69:8c5f220441f5 160 _mem_addr->buf_max[i].h.ref++;
nyatla 69:8c5f220441f5 161 *o_size=MAX_TX_ETHERNET_FRAME_SIZE;
nyatla 69:8c5f220441f5 162 return &(_mem_addr->buf_max[i].h);
nyatla 69:8c5f220441f5 163 }
nyatla 69:8c5f220441f5 164 ALLOC_512:
nyatla 69:8c5f220441f5 165 for(i=0;i<NUM_OF_512_BUF;i++){
nyatla 69:8c5f220441f5 166 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 167 if(_mem_addr->buf_512[i].h.ref>0 || _mem_addr->buf_512[i].h.is_lock){
nyatla 69:8c5f220441f5 168 continue;
nyatla 68:f7def7eb5504 169 }
nyatla 69:8c5f220441f5 170 *o_size=512;
nyatla 69:8c5f220441f5 171 _mem_addr->buf_512[i].h.ref++;
nyatla 69:8c5f220441f5 172 return &(_mem_addr->buf_512[i].h);
nyatla 69:8c5f220441f5 173 }
nyatla 69:8c5f220441f5 174 ALLOC_256:
nyatla 69:8c5f220441f5 175 for(i=0;i<NUM_OF_256_BUF;i++){
nyatla 69:8c5f220441f5 176 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 177 if(_mem_addr->buf_256[i].h.ref>0 || (_mem_addr->buf_256[i].h.is_lock)){
nyatla 69:8c5f220441f5 178 continue;
nyatla 68:f7def7eb5504 179 }
nyatla 69:8c5f220441f5 180 *o_size=256;
nyatla 69:8c5f220441f5 181 _mem_addr->buf_256[i].h.ref++;
nyatla 69:8c5f220441f5 182 return &(_mem_addr->buf_256[i].h);
nyatla 69:8c5f220441f5 183 }
nyatla 69:8c5f220441f5 184 ALLOC_128:
nyatla 69:8c5f220441f5 185 for(i=0;i<NUM_OF_128_BUF;i++){
nyatla 69:8c5f220441f5 186 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 187 if(_mem_addr->buf_128[i].h.ref>0 || (_mem_addr->buf_128[i].h.is_lock)){
nyatla 69:8c5f220441f5 188 continue;
nyatla 69:8c5f220441f5 189 }
nyatla 69:8c5f220441f5 190 *o_size=128;
nyatla 69:8c5f220441f5 191 _mem_addr->buf_128[i].h.ref++;
nyatla 69:8c5f220441f5 192 return &(_mem_addr->buf_128[i].h);
nyatla 68:f7def7eb5504 193 }
nyatla 68:f7def7eb5504 194 return NULL;
nyatla 68:f7def7eb5504 195 }
nyatla 68:f7def7eb5504 196
nyatla 68:f7def7eb5504 197
nyatla 68:f7def7eb5504 198 void NyLPC_cEthernetMM_release(struct NyLPC_TTxBufferHeader* i_buf)
nyatla 68:f7def7eb5504 199 {
nyatla 68:f7def7eb5504 200 //参照カウンタを1減算
nyatla 68:f7def7eb5504 201 NyLPC_Assert(i_buf->ref>0);
nyatla 68:f7def7eb5504 202 i_buf->ref--;
nyatla 68:f7def7eb5504 203 return;
nyatla 68:f7def7eb5504 204 }
nyatla 68:f7def7eb5504 205