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/uip/NyLPC_cUipService_protected.h@48:00d211aac2ec, 2013-08-07 (annotated)

Committer:
nyatla
Date:
Wed Aug 07 13:53:02 2013 +0000
Revision:
48:00d211aac2ec
Parent:
37:fc4b4fd6a649
Child:
68:f7def7eb5504
backup

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 0:142ee8b12fef 1 /*********************************************************************************
nyatla 0:142ee8b12fef 2 * PROJECT: MiMic
nyatla 0:142ee8b12fef 3 * --------------------------------------------------------------------------------
nyatla 0:142ee8b12fef 4 *
nyatla 0:142ee8b12fef 5 * This file is part of MiMic
nyatla 0:142ee8b12fef 6 * Copyright (C)2011 Ryo Iizuka
nyatla 0:142ee8b12fef 7 *
nyatla 0:142ee8b12fef 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 0:142ee8b12fef 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 0:142ee8b12fef 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 0:142ee8b12fef 11 * (at your option) any later version.
nyatla 0:142ee8b12fef 12 *
nyatla 0:142ee8b12fef 13 * This program is distributed in the hope that it will be useful,
nyatla 0:142ee8b12fef 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 0:142ee8b12fef 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 0:142ee8b12fef 16 * GNU General Public License for more details.
nyatla 0:142ee8b12fef 17 *
nyatla 0:142ee8b12fef 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 0:142ee8b12fef 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 0:142ee8b12fef 20 *
nyatla 0:142ee8b12fef 21 * For further information please contact.
nyatla 0:142ee8b12fef 22 * http://nyatla.jp/
nyatla 0:142ee8b12fef 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 0:142ee8b12fef 24 *
nyatla 0:142ee8b12fef 25 *********************************************************************************/
nyatla 0:142ee8b12fef 26
nyatla 37:fc4b4fd6a649 27 #ifndef NyLPC_uipService_protected_H
nyatla 37:fc4b4fd6a649 28 #define NyLPC_uipService_protected_H
nyatla 0:142ee8b12fef 29 #include "NyLPC_cUipService.h"
nyatla 0:142ee8b12fef 30 #include "../driver/uip/EthDev.h"
nyatla 0:142ee8b12fef 31 #include "../driver/uip/EthDev_LPC17xx.h"
nyatla 0:142ee8b12fef 32
nyatla 0:142ee8b12fef 33 /**********************************************************************
nyatla 0:142ee8b12fef 34 *
nyatla 0:142ee8b12fef 35 * NyLPC_TcUipService_t
nyatla 0:142ee8b12fef 36 *
nyatla 0:142ee8b12fef 37 **********************************************************************/
nyatla 0:142ee8b12fef 38 #ifdef __cplusplus
nyatla 0:142ee8b12fef 39 extern "C" {
nyatla 0:142ee8b12fef 40 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 41
nyatla 0:142ee8b12fef 42 #define NyLPC_TcUipService_SIZE_OF_REPLY_BUF 128
nyatla 0:142ee8b12fef 43
nyatla 0:142ee8b12fef 44
nyatla 0:142ee8b12fef 45 struct NyLPC_TcUipService
nyatla 0:142ee8b12fef 46 {
nyatla 0:142ee8b12fef 47 const NyLPC_TcIPv4Config_t* _ref_config;
nyatla 48:00d211aac2ec 48 volatile NyLPC_TUInt16 _status; /**< ステータスビット*/
nyatla 0:142ee8b12fef 49 NyLPC_TcSemaphore_t _emac_semapho; /** EMACの制御用セマフォです。*/
nyatla 0:142ee8b12fef 50 NyLPC_TcStopwatch_t _arp_sw; /**<ARP用のストップウォッチ*/
nyatla 0:142ee8b12fef 51 NyLPC_TcStopwatch_t _periodic_sw; /**<周期実行用のストップウォッチ*/
nyatla 0:142ee8b12fef 52 /** ARP処理インスタンス*/
nyatla 0:142ee8b12fef 53 NyLPC_TcIPv4Arp_t _arp;
nyatla 0:142ee8b12fef 54 /** TCPv4処理インスタンス*/
nyatla 0:142ee8b12fef 55 NyLPC_TcIPv4_t _tcpv4;
nyatla 0:142ee8b12fef 56 /** ICOMP処理インスタンス*/
nyatla 0:142ee8b12fef 57 NyLPC_TcIPv4IComp_t _icomp;
nyatla 37:fc4b4fd6a649 58 /** (Ethernetメモリ排他制御用)*/
nyatla 0:142ee8b12fef 59 NyLPC_TcMutex_t _mutex;
nyatla 0:142ee8b12fef 60 const struct TiEthernetDevice* _ethif;
nyatla 0:142ee8b12fef 61 /**　ipタスクが使う小サイズ送信バッファ*/
nyatla 0:142ee8b12fef 62 struct
nyatla 0:142ee8b12fef 63 {
nyatla 0:142ee8b12fef 64 struct NyLPC_TTxBufferHeader h;
nyatla 0:142ee8b12fef 65 NyLPC_TUInt8 buf[NyLPC_TcUipService_SIZE_OF_REPLY_BUF];
nyatla 0:142ee8b12fef 66 }stx;
nyatla 0:142ee8b12fef 67 };
nyatla 0:142ee8b12fef 68
nyatla 0:142ee8b12fef 69
nyatla 0:142ee8b12fef 70 /**　唯一のサービスインスタンス - Single service instance*/
nyatla 0:142ee8b12fef 71 extern NyLPC_TcUipService_t* _NyLPC_TcUipService_inst;
nyatla 0:142ee8b12fef 72
nyatla 0:142ee8b12fef 73 /**
nyatla 0:142ee8b12fef 74 * サービスが初期化済みならtrueです。 - true if service was initialized.
nyatla 0:142ee8b12fef 75 */
nyatla 0:142ee8b12fef 76 #define NyLPC_TcUipService_isInitService() (_NyLPC_TcUipService_inst!=NULL)
nyatla 0:142ee8b12fef 77 /**
nyatla 0:142ee8b12fef 78 * サービスが稼働中か返します。
nyatla 0:142ee8b12fef 79 */
nyatla 48:00d211aac2ec 80 #define NyLPC_cUipService_isRun() NyLPC_TUInt16_isBitOn(_NyLPC_TcUipService_inst->_status,NyLPC_TcUipService_STATUSBIT_IS_RUNNING)
nyatla 0:142ee8b12fef 81
nyatla 0:142ee8b12fef 82
nyatla 0:142ee8b12fef 83 /**********************************************************************
nyatla 0:142ee8b12fef 84 * コントロールビットの定義
nyatla 0:142ee8b12fef 85 **********************************************************************/
nyatla 48:00d211aac2ec 86 //サービスが実行中の場合1
nyatla 48:00d211aac2ec 87 #define NyLPC_TcUipService_STATUSBIT_IS_RUNNING 0
nyatla 48:00d211aac2ec 88 #define NyLPC_TcUipService_ORDER_START 1
nyatla 48:00d211aac2ec 89 #define NyLPC_TcUipService_ORDER_STOP 2
nyatla 0:142ee8b12fef 90
nyatla 0:142ee8b12fef 91
nyatla 0:142ee8b12fef 92
nyatla 0:142ee8b12fef 93 #define INST_TYPE_NyLPC_Unknown 0
nyatla 0:142ee8b12fef 94 #define INST_TYPE_NyLPC_TcTcpListener 1
nyatla 0:142ee8b12fef 95 #define INST_TYPE_NyLPC_TcTcpSocket 2
nyatla 0:142ee8b12fef 96
nyatla 0:142ee8b12fef 97
nyatla 0:142ee8b12fef 98 /**********************************************************************
nyatla 0:142ee8b12fef 99 * cTcpSocketからコールする関数
nyatla 0:142ee8b12fef 100 **********************************************************************/
nyatla 0:142ee8b12fef 101
nyatla 0:142ee8b12fef 102
nyatla 0:142ee8b12fef 103
nyatla 0:142ee8b12fef 104 /**
nyatla 0:142ee8b12fef 105 * IPv4パケットをネットワークに送信します。
nyatla 0:142ee8b12fef 106 * この関数は、リエントラントを許容します。
nyatla 0:142ee8b12fef 107 * @param i_eth_payload
nyatla 0:142ee8b12fef 108 * NyLPC_cUipService_getTxFrame、または、NyLPC_cUipService_recvIPv4Rxで得たバッファに、
nyatla 0:142ee8b12fef 109 * IPv4パケットを書きこんだものを指定してください。
nyatla 0:142ee8b12fef 110 */
nyatla 0:142ee8b12fef 111 void NyLPC_cUipService_sendIPv4Tx(void* i_eth_payload);
nyatla 0:142ee8b12fef 112
nyatla 0:142ee8b12fef 113 /**
nyatla 0:142ee8b12fef 114 * 送信ペイロードメモリを返します。
nyatla 0:142ee8b12fef 115 * この関数は、リエントラントを許容します。
nyatla 0:142ee8b12fef 116 * @param i_hint
nyatla 0:142ee8b12fef 117 * 取得したいメモリサイズを指定します。(このサイズは、イーサネットヘッダのサイズを含みません。)
nyatla 0:142ee8b12fef 118 * このサイズよりも小さなサイズが割り当てられることがあります。
nyatla 37:fc4b4fd6a649 119 * @param o_size
nyatla 37:fc4b4fd6a649 120 * 取得メモリのイーサネットヘッダを除いたペイロード部分の長さ
nyatla 37:fc4b4fd6a649 121 * @return
nyatla 37:fc4b4fd6a649 122 * 成功:IPペイロードのためのメモリブロックを返します。/失敗:NULL
nyatla 37:fc4b4fd6a649 123 * メモリは、[TEthPacket][payload]の構造で返されます。
nyatla 0:142ee8b12fef 124 */
nyatla 0:142ee8b12fef 125 void* NyLPC_cUipService_allocTxBuf(NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_size);
nyatla 0:142ee8b12fef 126
nyatla 0:142ee8b12fef 127 /**
nyatla 0:142ee8b12fef 128 * allocTxbufで確保したメモリを開放します。
nyatla 0:142ee8b12fef 129 */
nyatla 0:142ee8b12fef 130 void* NyLPC_cUipService_releaseTxBuf(void* i_buf);
nyatla 0:142ee8b12fef 131
nyatla 37:fc4b4fd6a649 132 /**
nyatla 37:fc4b4fd6a649 133 * 指定したIPアドレスを要求するARPリクエストを発行します。
nyatla 37:fc4b4fd6a649 134 */
nyatla 37:fc4b4fd6a649 135 void NyLPC_cUipService_sendArpRequest(const struct NyLPC_TIPv4Addr* i_addr);
nyatla 37:fc4b4fd6a649 136
nyatla 37:fc4b4fd6a649 137 /**
nyatla 37:fc4b4fd6a649 138 * ARPテーブルに指定したIPがあるかを返します。
nyatla 37:fc4b4fd6a649 139 */
nyatla 37:fc4b4fd6a649 140 NyLPC_TBool NyLPC_cUipService_hasArpInfo(const struct NyLPC_TIPv4Addr* i_addr);
nyatla 37:fc4b4fd6a649 141
nyatla 37:fc4b4fd6a649 142
nyatla 37:fc4b4fd6a649 143
nyatla 37:fc4b4fd6a649 144
nyatla 37:fc4b4fd6a649 145
nyatla 0:142ee8b12fef 146
nyatla 0:142ee8b12fef 147 #ifdef __cplusplus
nyatla 0:142ee8b12fef 148 }
nyatla 0:142ee8b12fef 149 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 150
nyatla 0:142ee8b12fef 151 #endif