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 Jun 04 06:51:04 2016 +0000
Revision:
114:f6aef16d4e60
Parent:
92:4f77028cce64
include????????; ???????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 68:f7def7eb5504 1 /*********************************************************************************
nyatla 68:f7def7eb5504 2 * PROJECT: MiMic
nyatla 68:f7def7eb5504 3 * --------------------------------------------------------------------------------
nyatla 68:f7def7eb5504 4 *
nyatla 68:f7def7eb5504 5 * This file is part of MiMic
nyatla 68:f7def7eb5504 6 * Copyright (C)2011 Ryo Iizuka
nyatla 68:f7def7eb5504 7 *
nyatla 68:f7def7eb5504 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 68:f7def7eb5504 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 68:f7def7eb5504 10 * by the Free Software Foundation, either version 3 of the License, or
nyatla 68:f7def7eb5504 11 * (at your option) any later version.
nyatla 68:f7def7eb5504 12 *
nyatla 68:f7def7eb5504 13 * This program is distributed in the hope that it will be useful,
nyatla 68:f7def7eb5504 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 68:f7def7eb5504 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 68:f7def7eb5504 16 * GNU General Public License for more details.
nyatla 68:f7def7eb5504 17 *
nyatla 68:f7def7eb5504 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 68:f7def7eb5504 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 68:f7def7eb5504 20 *
nyatla 68:f7def7eb5504 21 * For further information please contact.
nyatla 68:f7def7eb5504 22 * http://nyatla.jp/
nyatla 68:f7def7eb5504 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 68:f7def7eb5504 24 *
nyatla 68:f7def7eb5504 25 *********************************************************************************/
nyatla 91:db8279c869d3 26 /**
nyatla 91:db8279c869d3 27 * @file
nyatla 91:db8279c869d3 28 * このファイルは、イーサネットメモリマネージャクラスを定義します。
nyatla 91:db8279c869d3 29 */
nyatla 68:f7def7eb5504 30 #ifndef NyLPC_cEthernetMM_protected_h
nyatla 68:f7def7eb5504 31 #define NyLPC_cEthernetMM_protected_h
nyatla 68:f7def7eb5504 32
nyatla 68:f7def7eb5504 33 #include "NyLPC_stdlib.h"
nyatla 68:f7def7eb5504 34 #include "NyLPC_IEthernetDevice.h"
nyatla 68:f7def7eb5504 35
nyatla 68:f7def7eb5504 36 #ifdef __cplusplus
nyatla 68:f7def7eb5504 37 extern "C" {
nyatla 68:f7def7eb5504 38 #endif /* __cplusplus */
nyatla 68:f7def7eb5504 39
nyatla 91:db8279c869d3 40 #ifndef PACK_STRUCT_END
nyatla 91:db8279c869d3 41 #define PACK_STRUCT_END __attribute((packed))
nyatla 91:db8279c869d3 42 #endif
nyatla 91:db8279c869d3 43
nyatla 91:db8279c869d3 44 /**
nyatla 91:db8279c869d3 45 * 構造体のアライメントサイズ(4 or 16)
nyatla 91:db8279c869d3 46 */
nyatla 91:db8279c869d3 47 #ifndef NyLPC_TTxBufferHeader_ALIGNMENT
nyatla 91:db8279c869d3 48 # define NyLPC_TTxBufferHeader_ALIGNMENT 4
nyatla 91:db8279c869d3 49 #endif
nyatla 91:db8279c869d3 50
nyatla 91:db8279c869d3 51 /**
nyatla 92:4f77028cce64 52 *バッファメモリのパディングサイズ
nyatla 92:4f77028cce64 53 */
nyatla 92:4f77028cce64 54 #ifndef NyLPC_TcEthernetMM_BUF_PADDING
nyatla 92:4f77028cce64 55 # define NyLPC_TcEthernetMM_BUF_PADDING 0
nyatla 92:4f77028cce64 56 #endif
nyatla 92:4f77028cce64 57
nyatla 92:4f77028cce64 58 /**
nyatla 91:db8279c869d3 59 * 送信バッフメモリのヘッダ。
nyatla 91:db8279c869d3 60 * この構造体は、TXバッファメモリブロックのヘッダーです。
nyatla 91:db8279c869d3 61 * TXバッファメモリブロックは、この構造体の後ろに、sizeに一致したメモリを連結したもので表現します。
nyatla 91:db8279c869d3 62 * <pre>
nyatla 91:db8279c869d3 63 * buffer=[struct NyLPC_TTxBufferHeader][n]
nyatla 91:db8279c869d3 64 * </pre>
nyatla 91:db8279c869d3 65 */
nyatla 91:db8279c869d3 66 struct NyLPC_TTxBufferHeader
nyatla 91:db8279c869d3 67 {
nyatla 91:db8279c869d3 68 //メモリブロックの参照カウンタ。
nyatla 91:db8279c869d3 69 NyLPC_TInt8 ref;
nyatla 91:db8279c869d3 70 //送信用にロックしたかを示すフラグ
nyatla 91:db8279c869d3 71 NyLPC_TUInt8 is_lock;
nyatla 91:db8279c869d3 72 //Nビット境界に合わせるためのパディング。
nyatla 91:db8279c869d3 73 NyLPC_TUInt8 padding[NyLPC_TTxBufferHeader_ALIGNMENT-2];
nyatla 91:db8279c869d3 74 }PACK_STRUCT_END;
nyatla 91:db8279c869d3 75
nyatla 91:db8279c869d3 76 /**
nyatla 91:db8279c869d3 77 * バッファメモリアドレスからメモリヘッダアドレスを復元します。
nyatla 91:db8279c869d3 78 */
nyatla 91:db8279c869d3 79 #define NyLPC_TTxBufferHeader_getBufferHeaderAddr(a) ((struct NyLPC_TTxBufferHeader*)(((NyLPC_TUInt8*)a)-sizeof(struct NyLPC_TTxBufferHeader)))
nyatla 91:db8279c869d3 80
nyatla 91:db8279c869d3 81
nyatla 68:f7def7eb5504 82 /**
nyatla 69:8c5f220441f5 83 * NyLPC_cEthernetMM_allocのヒント値。
nyatla 69:8c5f220441f5 84 * コントロールパケット用のサイズ要求をするときに使用します。
nyatla 69:8c5f220441f5 85 */
nyatla 69:8c5f220441f5 86 #define NyLPC_TcEthernetMM_HINT_CTRL_PACKET 0
nyatla 91:db8279c869d3 87
nyatla 91:db8279c869d3 88
nyatla 69:8c5f220441f5 89 /**
nyatla 91:db8279c869d3 90 * メモリブロック構造体の定数値
nyatla 91:db8279c869d3 91 */
nyatla 91:db8279c869d3 92 #define NyLPC_TcEthernetMM_NUM_OF_MAX_BUF 3
nyatla 91:db8279c869d3 93 #define NyLPC_TcEthernetMM_NUM_OF_512_BUF 3
nyatla 91:db8279c869d3 94 #define NyLPC_TcEthernetMM_NUM_OF_256_BUF 4
nyatla 91:db8279c869d3 95 #define NyLPC_TcEthernetMM_NUM_OF_128_BUF 16
nyatla 91:db8279c869d3 96 #define NyLPC_TcEthernetMM_NUM_OF_64_BUF 4
nyatla 91:db8279c869d3 97
nyatla 91:db8279c869d3 98 /**
nyatla 91:db8279c869d3 99 * FULLサイズのEthernetFrame送信メモリのサイズ。
nyatla 91:db8279c869d3 100 * ここで最大送信サイズを制限します。
nyatla 91:db8279c869d3 101 * 通常は1460+20+20+14=1514バイト
nyatla 91:db8279c869d3 102 * パディングと合計で128bit(16byte)アライメントにしておかないと不幸になる。
nyatla 91:db8279c869d3 103 */
nyatla 91:db8279c869d3 104 #define NyLPC_TcEthernetMM_MAX_TX_ETHERNET_FRAME_SIZE 1514
nyatla 91:db8279c869d3 105 /**
nyatla 91:db8279c869d3 106 * Alignment padding(128bit)
nyatla 91:db8279c869d3 107 */
nyatla 91:db8279c869d3 108 #define NyLPC_TcEthernetMM_MAX_TX_ETHERNET_PADDING 22
nyatla 91:db8279c869d3 109
nyatla 92:4f77028cce64 110
nyatla 91:db8279c869d3 111 /**
nyatla 91:db8279c869d3 112 * TXメモリブロックの定義配列
nyatla 68:f7def7eb5504 113 */
nyatla 91:db8279c869d3 114 struct NyLPC_TcEthernetMM_TxMemoryBlock
nyatla 91:db8279c869d3 115 {
nyatla 91:db8279c869d3 116 struct{
nyatla 91:db8279c869d3 117 struct NyLPC_TTxBufferHeader h;
nyatla 91:db8279c869d3 118 NyLPC_TUInt8 b[NyLPC_TcEthernetMM_MAX_TX_ETHERNET_FRAME_SIZE];
nyatla 92:4f77028cce64 119 NyLPC_TUInt8 _padding[NyLPC_TcEthernetMM_MAX_TX_ETHERNET_PADDING+NyLPC_TcEthernetMM_BUF_PADDING];
nyatla 91:db8279c869d3 120 }buf_max[NyLPC_TcEthernetMM_NUM_OF_MAX_BUF];//(4+MAX_TX_ETHERNET_FRAME_SIZE(1514))*3=? default=4554
nyatla 91:db8279c869d3 121 struct{
nyatla 91:db8279c869d3 122 struct NyLPC_TTxBufferHeader h;
nyatla 92:4f77028cce64 123 NyLPC_TUInt8 b[512+NyLPC_TcEthernetMM_BUF_PADDING];
nyatla 91:db8279c869d3 124 }buf_512[NyLPC_TcEthernetMM_NUM_OF_512_BUF];//(4+512)*3=1548
nyatla 91:db8279c869d3 125 struct{
nyatla 91:db8279c869d3 126 struct NyLPC_TTxBufferHeader h;
nyatla 92:4f77028cce64 127 NyLPC_TUInt8 b[256+NyLPC_TcEthernetMM_BUF_PADDING];
nyatla 91:db8279c869d3 128 }buf_256[NyLPC_TcEthernetMM_NUM_OF_256_BUF];//(4+256)*4=1560
nyatla 91:db8279c869d3 129 struct{
nyatla 91:db8279c869d3 130 struct NyLPC_TTxBufferHeader h;
nyatla 92:4f77028cce64 131 NyLPC_TUInt8 b[128+NyLPC_TcEthernetMM_BUF_PADDING];
nyatla 91:db8279c869d3 132 }buf_128[NyLPC_TcEthernetMM_NUM_OF_128_BUF];//(4+128)*16=1584
nyatla 91:db8279c869d3 133 struct{
nyatla 91:db8279c869d3 134 struct NyLPC_TTxBufferHeader h;
nyatla 92:4f77028cce64 135 NyLPC_TUInt8 b[64+NyLPC_TcEthernetMM_BUF_PADDING];
nyatla 91:db8279c869d3 136 }buf_64[NyLPC_TcEthernetMM_NUM_OF_64_BUF];//(4+64)*4=272
nyatla 91:db8279c869d3 137 }PACK_STRUCT_END;
nyatla 91:db8279c869d3 138
nyatla 91:db8279c869d3 139
nyatla 68:f7def7eb5504 140
nyatla 68:f7def7eb5504 141 int NyLPC_cEthernetMM_dbg_getNumofUsedTx(void);
nyatla 68:f7def7eb5504 142
nyatla 68:f7def7eb5504 143 /**
nyatla 68:f7def7eb5504 144 * メモリブロックを初期化してメモリマネージャを構築します。
nyatla 68:f7def7eb5504 145 * メモリサイズはsizeof(struct TTxMemoryBlock)以上である必要があります。
nyatla 68:f7def7eb5504 146 */
nyatla 68:f7def7eb5504 147 void NyLPC_cEthernetMM_initialize(void* i_memblock_addr);
nyatla 68:f7def7eb5504 148 #define NyLPC_cEthernetMM_finalize(i)
nyatla 68:f7def7eb5504 149 /**
nyatla 68:f7def7eb5504 150 * メモリを割り当てます。
nyatla 69:8c5f220441f5 151 * @param i_hint
nyatla 69:8c5f220441f5 152 * 割り当てるメモリサイズのヒント。
nyatla 69:8c5f220441f5 153 * 数値の場合、128バイト以上のもっともhintに近いメモリを割り当てます。
nyatla 69:8c5f220441f5 154 * 以下の定義値の場合、特別な領域を優先して返します。たぶん。
nyatla 69:8c5f220441f5 155 * <ul>
nyatla 69:8c5f220441f5 156 * <li>NyLPC_TcEthernetMM_HINT_CTRL_PACKET - 64
nyatla 69:8c5f220441f5 157 * </ul>
nyatla 68:f7def7eb5504 158 * @return
nyatla 68:f7def7eb5504 159 * 割り当て不能な場合はNULLが帰ります。
nyatla 68:f7def7eb5504 160 * @bug
nyatla 91:db8279c869d3 161 * パケットバッファの先頭アドレス
nyatla 68:f7def7eb5504 162 */
nyatla 91:db8279c869d3 163 void* NyLPC_cEthernetMM_alloc(NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_size);
nyatla 68:f7def7eb5504 164 /**
nyatla 68:f7def7eb5504 165 * NyLPC_EthernetMM_allocで得たメモリを解放します。
nyatla 68:f7def7eb5504 166 */
nyatla 91:db8279c869d3 167 void NyLPC_cEthernetMM_release(void* i_buf);
nyatla 68:f7def7eb5504 168
nyatla 68:f7def7eb5504 169 #ifdef __cplusplus
nyatla 68:f7def7eb5504 170 }
nyatla 68:f7def7eb5504 171 #endif /* __cplusplus */
nyatla 68:f7def7eb5504 172
nyatla 68:f7def7eb5504 173 #endif