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 22 12:59:50 2014 +0000
Revision:
68:f7def7eb5504
Child:
69:8c5f220441f5
MiMic-core ?344???;

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