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:
Sat Sep 27 13:33:26 2014 +0000
Revision:
91:db8279c869d3
Parent:
69:8c5f220441f5
NyLPC_TTxBufferHeader???????????????????; ???????????; K64F???????????

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 */
nyatla 91:db8279c869d3 6 static struct NyLPC_TcEthernetMM_TxMemoryBlock* _mem_addr;
nyatla 68:f7def7eb5504 7
nyatla 68:f7def7eb5504 8
nyatla 68:f7def7eb5504 9
nyatla 68:f7def7eb5504 10 /**
nyatla 68:f7def7eb5504 11 * デバック用。使用中のTxブロックの数を返す。
nyatla 68:f7def7eb5504 12 */
nyatla 68:f7def7eb5504 13 int NyLPC_cEthernetMM_dbg_getNumofUsedTx(void)
nyatla 68:f7def7eb5504 14 {
nyatla 68:f7def7eb5504 15 int x;
nyatla 69:8c5f220441f5 16 NyLPC_TUInt8 r1,r2,r3,r4,r5;
nyatla 69:8c5f220441f5 17 r1=r2=r3=r4=r5=0;
nyatla 91:db8279c869d3 18 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_MAX_BUF;x++){
nyatla 68:f7def7eb5504 19 if(_mem_addr->buf_max[x].h.is_lock || _mem_addr->buf_max[x].h.ref>0){
nyatla 68:f7def7eb5504 20 r1++;
nyatla 68:f7def7eb5504 21 continue;
nyatla 68:f7def7eb5504 22 }
nyatla 68:f7def7eb5504 23 }
nyatla 91:db8279c869d3 24 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_512_BUF;x++){
nyatla 68:f7def7eb5504 25 if(_mem_addr->buf_512[x].h.is_lock || _mem_addr->buf_512[x].h.ref>0){
nyatla 68:f7def7eb5504 26 r2++;
nyatla 68:f7def7eb5504 27 continue;
nyatla 68:f7def7eb5504 28 }
nyatla 68:f7def7eb5504 29 }
nyatla 91:db8279c869d3 30 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_256_BUF;x++){
nyatla 68:f7def7eb5504 31 if(_mem_addr->buf_256[x].h.is_lock || _mem_addr->buf_256[x].h.ref>0){
nyatla 68:f7def7eb5504 32 r3++;
nyatla 68:f7def7eb5504 33 continue;
nyatla 68:f7def7eb5504 34 }
nyatla 68:f7def7eb5504 35 }
nyatla 91:db8279c869d3 36 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_128_BUF;x++){
nyatla 68:f7def7eb5504 37 if(_mem_addr->buf_128[x].h.is_lock || _mem_addr->buf_128[x].h.ref>0){
nyatla 68:f7def7eb5504 38 r4++;
nyatla 68:f7def7eb5504 39 continue;
nyatla 68:f7def7eb5504 40 }
nyatla 68:f7def7eb5504 41 }
nyatla 91:db8279c869d3 42 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_64_BUF;x++){
nyatla 69:8c5f220441f5 43 if(_mem_addr->buf_64[x].h.is_lock || _mem_addr->buf_64[x].h.ref>0){
nyatla 69:8c5f220441f5 44 r5++;
nyatla 69:8c5f220441f5 45 continue;
nyatla 69:8c5f220441f5 46 }
nyatla 69:8c5f220441f5 47 }
nyatla 69:8c5f220441f5 48 return r1+r2+r3+r4+r5;
nyatla 68:f7def7eb5504 49 }
nyatla 68:f7def7eb5504 50
nyatla 68:f7def7eb5504 51
nyatla 68:f7def7eb5504 52 void NyLPC_cEthernetMM_initialize(void* i_memblock_addr)
nyatla 68:f7def7eb5504 53 {
nyatla 68:f7def7eb5504 54 int x;
nyatla 68:f7def7eb5504 55 _mem_addr=i_memblock_addr;
nyatla 68:f7def7eb5504 56 //TXバッファを初期化
nyatla 91:db8279c869d3 57 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_MAX_BUF;x++){
nyatla 68:f7def7eb5504 58 _mem_addr->buf_max[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 59 _mem_addr->buf_max[x].h.ref=0;
nyatla 68:f7def7eb5504 60 }
nyatla 91:db8279c869d3 61 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_512_BUF;x++){
nyatla 68:f7def7eb5504 62 _mem_addr->buf_512[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 63 _mem_addr->buf_512[x].h.ref=0;
nyatla 68:f7def7eb5504 64 }
nyatla 91:db8279c869d3 65 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_256_BUF;x++){
nyatla 68:f7def7eb5504 66 _mem_addr->buf_256[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 67 _mem_addr->buf_256[x].h.ref=0;
nyatla 68:f7def7eb5504 68 }
nyatla 91:db8279c869d3 69 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_128_BUF;x++){
nyatla 68:f7def7eb5504 70 _mem_addr->buf_128[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 68:f7def7eb5504 71 _mem_addr->buf_128[x].h.ref=0;
nyatla 68:f7def7eb5504 72 }
nyatla 91:db8279c869d3 73 for(x=0;x<NyLPC_TcEthernetMM_NUM_OF_64_BUF;x++){
nyatla 69:8c5f220441f5 74 _mem_addr->buf_64[x].h.is_lock=NyLPC_TUInt8_FALSE;
nyatla 69:8c5f220441f5 75 _mem_addr->buf_64[x].h.ref=0;
nyatla 69:8c5f220441f5 76 }
nyatla 68:f7def7eb5504 77 }
nyatla 68:f7def7eb5504 78
nyatla 68:f7def7eb5504 79 /**
nyatla 68:f7def7eb5504 80 * 空のTxバッファのポインタを返します。
nyatla 68:f7def7eb5504 81 */
nyatla 91:db8279c869d3 82 void* NyLPC_cEthernetMM_alloc(NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_size)
nyatla 68:f7def7eb5504 83 {
nyatla 68:f7def7eb5504 84 int i;
nyatla 68:f7def7eb5504 85 //ヒントから、割り当てるメモリブロックを決定
nyatla 69:8c5f220441f5 86
nyatla 69:8c5f220441f5 87 //特殊ブロック
nyatla 69:8c5f220441f5 88 if(i_hint==NyLPC_TcEthernetMM_HINT_CTRL_PACKET){
nyatla 91:db8279c869d3 89 for(i=0;i<NyLPC_TcEthernetMM_NUM_OF_64_BUF;i++){
nyatla 68:f7def7eb5504 90 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 91 if(_mem_addr->buf_64[i].h.ref>0 || _mem_addr->buf_64[i].h.is_lock){
nyatla 68:f7def7eb5504 92 continue;
nyatla 68:f7def7eb5504 93 }
nyatla 69:8c5f220441f5 94 _mem_addr->buf_64[i].h.ref++;
nyatla 69:8c5f220441f5 95 *o_size=64;
nyatla 91:db8279c869d3 96 return _mem_addr->buf_64[i].b;
nyatla 68:f7def7eb5504 97 }
nyatla 69:8c5f220441f5 98 return NULL;
nyatla 69:8c5f220441f5 99 }
nyatla 69:8c5f220441f5 100
nyatla 69:8c5f220441f5 101 //汎用ブロック
nyatla 69:8c5f220441f5 102 if(i_hint<=128){
nyatla 69:8c5f220441f5 103 goto ALLOC_128;
nyatla 69:8c5f220441f5 104 }else if(i_hint<=256){
nyatla 69:8c5f220441f5 105 goto ALLOC_256;
nyatla 69:8c5f220441f5 106 }else if(i_hint<=512){
nyatla 69:8c5f220441f5 107 goto ALLOC_512;
nyatla 69:8c5f220441f5 108 }else{
nyatla 69:8c5f220441f5 109 goto ALLOC_MAX;
nyatla 69:8c5f220441f5 110 }
nyatla 69:8c5f220441f5 111
nyatla 69:8c5f220441f5 112 ALLOC_MAX:
nyatla 91:db8279c869d3 113 for(i=0;i<NyLPC_TcEthernetMM_NUM_OF_MAX_BUF;i++){
nyatla 69:8c5f220441f5 114 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 115 if(_mem_addr->buf_max[i].h.ref>0 || _mem_addr->buf_max[i].h.is_lock){
nyatla 69:8c5f220441f5 116 continue;
nyatla 68:f7def7eb5504 117 }
nyatla 69:8c5f220441f5 118 _mem_addr->buf_max[i].h.ref++;
nyatla 91:db8279c869d3 119 *o_size=NyLPC_TcEthernetMM_MAX_TX_ETHERNET_FRAME_SIZE;
nyatla 91:db8279c869d3 120 return _mem_addr->buf_max[i].b;
nyatla 69:8c5f220441f5 121 }
nyatla 69:8c5f220441f5 122 ALLOC_512:
nyatla 91:db8279c869d3 123 for(i=0;i<NyLPC_TcEthernetMM_NUM_OF_512_BUF;i++){
nyatla 69:8c5f220441f5 124 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 125 if(_mem_addr->buf_512[i].h.ref>0 || _mem_addr->buf_512[i].h.is_lock){
nyatla 69:8c5f220441f5 126 continue;
nyatla 68:f7def7eb5504 127 }
nyatla 69:8c5f220441f5 128 *o_size=512;
nyatla 69:8c5f220441f5 129 _mem_addr->buf_512[i].h.ref++;
nyatla 91:db8279c869d3 130 return _mem_addr->buf_512[i].b;
nyatla 69:8c5f220441f5 131 }
nyatla 69:8c5f220441f5 132 ALLOC_256:
nyatla 91:db8279c869d3 133 for(i=0;i<NyLPC_TcEthernetMM_NUM_OF_256_BUF;i++){
nyatla 69:8c5f220441f5 134 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 135 if(_mem_addr->buf_256[i].h.ref>0 || (_mem_addr->buf_256[i].h.is_lock)){
nyatla 69:8c5f220441f5 136 continue;
nyatla 68:f7def7eb5504 137 }
nyatla 69:8c5f220441f5 138 *o_size=256;
nyatla 69:8c5f220441f5 139 _mem_addr->buf_256[i].h.ref++;
nyatla 91:db8279c869d3 140 return _mem_addr->buf_256[i].b;
nyatla 69:8c5f220441f5 141 }
nyatla 69:8c5f220441f5 142 ALLOC_128:
nyatla 91:db8279c869d3 143 for(i=0;i<NyLPC_TcEthernetMM_NUM_OF_128_BUF;i++){
nyatla 69:8c5f220441f5 144 //未参照かつ送信中でないもの。
nyatla 69:8c5f220441f5 145 if(_mem_addr->buf_128[i].h.ref>0 || (_mem_addr->buf_128[i].h.is_lock)){
nyatla 69:8c5f220441f5 146 continue;
nyatla 69:8c5f220441f5 147 }
nyatla 69:8c5f220441f5 148 *o_size=128;
nyatla 69:8c5f220441f5 149 _mem_addr->buf_128[i].h.ref++;
nyatla 91:db8279c869d3 150 return _mem_addr->buf_128[i].b;
nyatla 68:f7def7eb5504 151 }
nyatla 68:f7def7eb5504 152 return NULL;
nyatla 68:f7def7eb5504 153 }
nyatla 68:f7def7eb5504 154
nyatla 68:f7def7eb5504 155
nyatla 91:db8279c869d3 156 void NyLPC_cEthernetMM_release(void* i_buf)
nyatla 68:f7def7eb5504 157 {
nyatla 91:db8279c869d3 158 struct NyLPC_TTxBufferHeader* h=NyLPC_TTxBufferHeader_getBufferHeaderAddr(i_buf);
nyatla 68:f7def7eb5504 159 //参照カウンタを1減算
nyatla 91:db8279c869d3 160 NyLPC_Assert(h->ref>0);
nyatla 91:db8279c869d3 161 h->ref--;
nyatla 68:f7def7eb5504 162 return;
nyatla 68:f7def7eb5504 163 }
nyatla 68:f7def7eb5504 164