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:
Fri Sep 13 06:38:16 2013 +0000
Revision:
57:bc4330dfa62f
Parent:
37:fc4b4fd6a649
update mimic core r329;

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 0:142ee8b12fef 27 * @file
nyatla 0:142ee8b12fef 28 * このファイルは、NyLPC_cIPv4Configクラスを定義します。
nyatla 0:142ee8b12fef 29 */
nyatla 0:142ee8b12fef 30 #ifndef NYLPC_CIPV4CONFIG_H_
nyatla 0:142ee8b12fef 31 #define NYLPC_CIPV4CONFIG_H_
nyatla 0:142ee8b12fef 32
nyatla 0:142ee8b12fef 33
nyatla 0:142ee8b12fef 34 #include "NyLPC_uip.h"
nyatla 0:142ee8b12fef 35
nyatla 0:142ee8b12fef 36 /**
nyatla 0:142ee8b12fef 37 * クラス型を定義します。
nyatla 0:142ee8b12fef 38 * NyLPC_cIPv4Configクラスは、IPと、下位のネットワーク層の設定を保持します。
nyatla 0:142ee8b12fef 39 * 関連するオブジェクトが、ネットワーク設定を問い合わせる為に使います。
nyatla 0:142ee8b12fef 40 */
nyatla 0:142ee8b12fef 41 typedef struct NyLPC_TcIPv4Config NyLPC_TcIPv4Config_t;
nyatla 0:142ee8b12fef 42
nyatla 0:142ee8b12fef 43 #ifdef __cplusplus
nyatla 0:142ee8b12fef 44 extern "C" {
nyatla 0:142ee8b12fef 45 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 46 /**********************************************************************
nyatla 0:142ee8b12fef 47 *
nyatla 0:142ee8b12fef 48 * class NyLPC_TcIPv4Config
nyatla 0:142ee8b12fef 49 *
nyatla 0:142ee8b12fef 50 **********************************************************************/
nyatla 0:142ee8b12fef 51
nyatla 0:142ee8b12fef 52
nyatla 0:142ee8b12fef 53
nyatla 0:142ee8b12fef 54
nyatla 0:142ee8b12fef 55 /**
nyatla 0:142ee8b12fef 56 * NyLPC_TcIPv4Configクラスの構造体です。
nyatla 0:142ee8b12fef 57 */
nyatla 0:142ee8b12fef 58 struct NyLPC_TcIPv4Config
nyatla 0:142ee8b12fef 59 {
nyatla 57:bc4330dfa62f 60 /** イーサネットアドレスを格納します。 */
nyatla 0:142ee8b12fef 61 struct NyLPC_TEthAddr eth_mac;
nyatla 57:bc4330dfa62f 62 /** IPアドレスを格納します。Network orderです。 */
nyatla 0:142ee8b12fef 63 struct NyLPC_TIPv4Addr ip_addr;
nyatla 57:bc4330dfa62f 64 /** ネットマスクを格納します。Network orderです。 */
nyatla 0:142ee8b12fef 65 struct NyLPC_TIPv4Addr netmask;
nyatla 57:bc4330dfa62f 66 /** デフォルトゲートウェイアドレスを格納します。Network orderです。 */
nyatla 0:142ee8b12fef 67 struct NyLPC_TIPv4Addr dr_addr;
nyatla 57:bc4330dfa62f 68 /** デフォルトMMSサイズです。送信パケットのMSS値、受信パケットのデフォルトMSS値として使います。 */
nyatla 0:142ee8b12fef 69 NyLPC_TUInt16 default_mss;
nyatla 0:142ee8b12fef 70 };
nyatla 0:142ee8b12fef 71
nyatla 27:eb66b517efe6 72 #define NyLPC_TcIPv4Config_getEtherMac000120203(v)(((v)->eth_mac.addr[0]<<24)|((v)->eth_mac.addr[1]<<16)|((v)->eth_mac.addr[2]<<8)|((v)->eth_mac.addr[3]<<0))
nyatla 27:eb66b517efe6 73 #define NyLPC_TcIPv4Config_getEtherMac0405xxxx(v) (((v)->eth_mac.addr[4]<<24)|((v)->eth_mac.addr[5]<<16))
nyatla 27:eb66b517efe6 74
nyatla 0:142ee8b12fef 75 /**
nyatla 0:142ee8b12fef 76 * コンストラクタです。
nyatla 0:142ee8b12fef 77 * イーサネット用にコンフィギュレーションを初期化します。
nyatla 0:142ee8b12fef 78 * @param i_inst
nyatla 0:142ee8b12fef 79 * 初期化するインスタンスです。
nyatla 0:142ee8b12fef 80 * @param i_ether_frame_len
nyatla 0:142ee8b12fef 81 * イーサネットフレームのサイズ。この数値から、MSSのデフォルト値を計算します。
nyatla 0:142ee8b12fef 82 */
nyatla 0:142ee8b12fef 83 void NyLPC_cIPv4Config_initialzeForEthernet(NyLPC_TcIPv4Config_t* i_inst,const struct NyLPC_TEthAddr* i_ether_addr,NyLPC_TUInt16 i_ether_frame_len);
nyatla 0:142ee8b12fef 84
nyatla 37:fc4b4fd6a649 85 /**
nyatla 37:fc4b4fd6a649 86 * コピーコンストラクタ
nyatla 37:fc4b4fd6a649 87 */
nyatla 37:fc4b4fd6a649 88 void NyLPC_cIPv4Config_initialzeCopy(NyLPC_TcIPv4Config_t* i_inst,const NyLPC_TcIPv4Config_t* i_src);
nyatla 37:fc4b4fd6a649 89
nyatla 13:a71705c5e6fd 90
nyatla 0:142ee8b12fef 91 /**
nyatla 0:142ee8b12fef 92 * デストラクタです。インスタンスを破棄して、確保している動的リソースを元に戻します。
nyatla 0:142ee8b12fef 93 * @param i_inst
nyatla 0:142ee8b12fef 94 * 破棄するインスタンスです。
nyatla 0:142ee8b12fef 95 * initializeに成功したインスタンスだけが指定できます。
nyatla 0:142ee8b12fef 96 */
nyatla 0:142ee8b12fef 97 #define NyLPC_cIPv4Config_finalize(i_inst)
nyatla 0:142ee8b12fef 98
nyatla 0:142ee8b12fef 99 /**
nyatla 0:142ee8b12fef 100 * この関数は、IPのデフォルトゲートウェイを設定します。dr_addrの値を更新します。
nyatla 0:142ee8b12fef 101 * @param i_inst
nyatla 0:142ee8b12fef 102 * 操作するインスタンスです。
nyatla 0:142ee8b12fef 103 * @param i_dr_addr
nyatla 0:142ee8b12fef 104 * 設定するIPアドレスを格納したアドレスです。
nyatla 0:142ee8b12fef 105 */
nyatla 0:142ee8b12fef 106 void NyLPC_cIPv4Config_setDefaultRoute(NyLPC_TcIPv4Config_t* i_inst,const struct NyLPC_TIPv4Addr* i_dr_addr);
nyatla 0:142ee8b12fef 107
nyatla 0:142ee8b12fef 108 /**
nyatla 0:142ee8b12fef 109 * この関数は、ローカルIPアドレスとネットマスクを設定します。
nyatla 0:142ee8b12fef 110 * @param i_inst
nyatla 0:142ee8b12fef 111 * 操作するインスタンスです。
nyatla 0:142ee8b12fef 112 * @param i_ipaddr
nyatla 0:142ee8b12fef 113 * 設定するIPアドレスを格納したアドレスです。
nyatla 0:142ee8b12fef 114 * @param i_netmask
nyatla 0:142ee8b12fef 115 * 設定するネットマスクを格納したアドレスです。
nyatla 0:142ee8b12fef 116 */
nyatla 0:142ee8b12fef 117 void NyLPC_cIPv4Config_setIp(NyLPC_TcIPv4Config_t* i_inst,const struct NyLPC_TIPv4Addr* i_ipaddr,const struct NyLPC_TIPv4Addr* i_netmask);
nyatla 0:142ee8b12fef 118
nyatla 0:142ee8b12fef 119 /**
nyatla 0:142ee8b12fef 120 * この関数は、i_target_ipが、現在のIPアドレスに対するローカルアドレスであるかを返します。
nyatla 0:142ee8b12fef 121 * @param i_inst
nyatla 0:142ee8b12fef 122 * 操作するインスタンスです。
nyatla 0:142ee8b12fef 123 * @param i_target_ip
nyatla 0:142ee8b12fef 124 * 確認するIPアドレスです。
nyatla 0:142ee8b12fef 125 * @return
nyatla 0:142ee8b12fef 126 * i_target_ipがローカルIPアドレスなら、TRUEを返します。
nyatla 0:142ee8b12fef 127 */
nyatla 0:142ee8b12fef 128 NyLPC_TBool NyLPC_cIPv4Config_isLocalIP(const NyLPC_TcIPv4Config_t* i_inst,const struct NyLPC_TIPv4Addr* i_target_ip);
nyatla 0:142ee8b12fef 129
nyatla 0:142ee8b12fef 130 #ifdef __cplusplus
nyatla 0:142ee8b12fef 131 }
nyatla 0:142ee8b12fef 132 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 133
nyatla 0:142ee8b12fef 134 #endif