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:
Wed Nov 19 14:45:17 2014 +0000
Revision:
109:18f12ac01097
Child:
110:257739f9b31e
new MiMicIP API;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 109:18f12ac01097 1 /*********************************************************************************
nyatla 109:18f12ac01097 2 * PROJECT: MiMic
nyatla 109:18f12ac01097 3 * --------------------------------------------------------------------------------
nyatla 109:18f12ac01097 4 *
nyatla 109:18f12ac01097 5 * This file is part of MiMic
nyatla 109:18f12ac01097 6 * Copyright (C)2011 Ryo Iizuka
nyatla 109:18f12ac01097 7 *
nyatla 109:18f12ac01097 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 109:18f12ac01097 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 109:18f12ac01097 10 * by the Free Software Foundation, either version 3 of the License, or
nyatla 109:18f12ac01097 11 * (at your option) any later version.
nyatla 109:18f12ac01097 12 *
nyatla 109:18f12ac01097 13 * This program is distributed in the hope that it will be useful,
nyatla 109:18f12ac01097 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 109:18f12ac01097 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 109:18f12ac01097 16 * GNU General Public License for more details.
nyatla 109:18f12ac01097 17 *
nyatla 109:18f12ac01097 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 109:18f12ac01097 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 109:18f12ac01097 20 *
nyatla 109:18f12ac01097 21 * For further information please contact.
nyatla 109:18f12ac01097 22 * http://nyatla.jp/
nyatla 109:18f12ac01097 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 109:18f12ac01097 24 *
nyatla 109:18f12ac01097 25 *
nyatla 109:18f12ac01097 26 * Parts of this file were leveraged from uIP:
nyatla 109:18f12ac01097 27 *
nyatla 109:18f12ac01097 28 * Copyright (c) 2001-2003, Adam Dunkels.
nyatla 109:18f12ac01097 29 * All rights reserved.
nyatla 109:18f12ac01097 30 *
nyatla 109:18f12ac01097 31 * Redistribution and use in source and binary forms, with or without
nyatla 109:18f12ac01097 32 * modification, are permitted provided that the following conditions
nyatla 109:18f12ac01097 33 * are met:
nyatla 109:18f12ac01097 34 * 1. Redistributions of source code must retain the above copyright
nyatla 109:18f12ac01097 35 * notice, this list of conditions and the following disclaimer.
nyatla 109:18f12ac01097 36 * 2. Redistributions in binary form must reproduce the above copyright
nyatla 109:18f12ac01097 37 * notice, this list of conditions and the following disclaimer in the
nyatla 109:18f12ac01097 38 * documentation and/or other materials provided with the distribution.
nyatla 109:18f12ac01097 39 * 3. The name of the author may not be used to endorse or promote
nyatla 109:18f12ac01097 40 * products derived from this software without specific prior
nyatla 109:18f12ac01097 41 * written permission.
nyatla 109:18f12ac01097 42 *
nyatla 109:18f12ac01097 43 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
nyatla 109:18f12ac01097 44 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
nyatla 109:18f12ac01097 45 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
nyatla 109:18f12ac01097 46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
nyatla 109:18f12ac01097 47 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
nyatla 109:18f12ac01097 48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
nyatla 109:18f12ac01097 49 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
nyatla 109:18f12ac01097 50 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
nyatla 109:18f12ac01097 51 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
nyatla 109:18f12ac01097 52 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
nyatla 109:18f12ac01097 53 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nyatla 109:18f12ac01097 54 */
nyatla 109:18f12ac01097 55 #ifndef NyLPC_TcMiMicIpNetIf_H_
nyatla 109:18f12ac01097 56 #define NyLPC_TcMiMicIpNetIf_H_
nyatla 109:18f12ac01097 57 #include "NyLPC_config.h"
nyatla 109:18f12ac01097 58 #include "NyLPC_stdlib.h"
nyatla 109:18f12ac01097 59 #include "../NyLPC_iNetInterface.h"
nyatla 109:18f12ac01097 60 #include "../NyLPC_cIPv4Config.h"
nyatla 109:18f12ac01097 61 /**********************************************************************
nyatla 109:18f12ac01097 62 * Heder files
nyatla 109:18f12ac01097 63 **********************************************************************/
nyatla 109:18f12ac01097 64
nyatla 109:18f12ac01097 65 #ifdef __cplusplus
nyatla 109:18f12ac01097 66 extern "C" {
nyatla 109:18f12ac01097 67 #endif /* __cplusplus */
nyatla 109:18f12ac01097 68
nyatla 109:18f12ac01097 69 /**********************************************************************
nyatla 109:18f12ac01097 70 *
nyatla 109:18f12ac01097 71 * NyLPC_TcUipService class
nyatla 109:18f12ac01097 72 *
nyatla 109:18f12ac01097 73 **********************************************************************/
nyatla 109:18f12ac01097 74 /**
nyatla 109:18f12ac01097 75 * uipタスクを管理する、サービスクラスです。
nyatla 109:18f12ac01097 76 */
nyatla 109:18f12ac01097 77 typedef struct NyLPC_TcMiMicIpNetIf NyLPC_TcMiMicIpNetIf_t;
nyatla 109:18f12ac01097 78
nyatla 109:18f12ac01097 79
nyatla 109:18f12ac01097 80 /** サービスタスクスタックサイズ
nyatla 109:18f12ac01097 81 * mdns 256+96(MIN)
nyatla 109:18f12ac01097 82 * upnp 256+160(MIN)
nyatla 109:18f12ac01097 83 * mbedのExportしたのをLPCXpressoでコンパイルするときは+192しないと落ちる。
nyatla 109:18f12ac01097 84 */
nyatla 109:18f12ac01097 85 #ifndef NyLPC_cMiMicIpNetIf_config_STACK_SIZE
nyatla 109:18f12ac01097 86 # define NyLPC_cMiMicIpNetIf_config_STACK_SIZE (256+192+192)
nyatla 109:18f12ac01097 87 #endif
nyatla 109:18f12ac01097 88
nyatla 109:18f12ac01097 89 /**
nyatla 109:18f12ac01097 90 * SOCKETリソースの最大数とRXメモリサイズ
nyatla 109:18f12ac01097 91 */
nyatla 109:18f12ac01097 92
nyatla 109:18f12ac01097 93 #ifndef NyLPC_cMiMicIpNetIf_config_TCPLISTENER_MAX
nyatla 109:18f12ac01097 94 # define NyLPC_cMiMicIpNetIf_config_TCPLISTENER_MAX 2
nyatla 109:18f12ac01097 95 #endif
nyatla 109:18f12ac01097 96 #ifndef NyLPC_cMiMicIpNetIf_config_TCPSOCKET_MAX
nyatla 109:18f12ac01097 97 # define NyLPC_cMiMicIpNetIf_config_TCPSOCKET_MAX 3
nyatla 109:18f12ac01097 98 #endif
nyatla 109:18f12ac01097 99 #ifndef NyLPC_cMiMicIpNetIf_config_UDPSOCKET_MAX
nyatla 109:18f12ac01097 100 # define NyLPC_cMiMicIpNetIf_config_UDPSOCKET_MAX 1
nyatla 109:18f12ac01097 101 #endif
nyatla 109:18f12ac01097 102 #ifndef NyLPC_cMiMicIpNetIf_config_NB_UDPSOCKET_MAX
nyatla 109:18f12ac01097 103 # define NyLPC_cMiMicIpNetIf_config_NB_UDPSOCKET_MAX 2
nyatla 109:18f12ac01097 104 #endif
nyatla 109:18f12ac01097 105 #ifndef NyLPC_cMiMicIpNetIf_config_TCPSOCKET_RX_BUFFER_SIZE
nyatla 109:18f12ac01097 106 # define NyLPC_cMiMicIpNetIf_config_TCPSOCKET_RX_BUFFER_SIZE 512
nyatla 109:18f12ac01097 107 #endif
nyatla 109:18f12ac01097 108 #ifndef NyLPC_cMiMicIpNetIf_config_UDPSOCKET_RX_BUFFER_SIZE
nyatla 109:18f12ac01097 109 # define NyLPC_cMiMicIpNetIf_config_UDPSOCKET_RX_BUFFER_SIZE 512
nyatla 109:18f12ac01097 110 #endif
nyatla 109:18f12ac01097 111
nyatla 109:18f12ac01097 112
nyatla 109:18f12ac01097 113 /**
nyatla 109:18f12ac01097 114 * @param i_mac_addr
nyatla 109:18f12ac01097 115 * システムで唯一のUIPサービスを初期化します。1度だけ実行できます。
nyatla 109:18f12ac01097 116 */
nyatla 109:18f12ac01097 117 NyLPC_TBool NyLPC_cMiMicIpNetIf_initialize(NyLPC_TcMiMicIpNetIf_t* i_inst);
nyatla 109:18f12ac01097 118
nyatla 109:18f12ac01097 119
nyatla 109:18f12ac01097 120
nyatla 109:18f12ac01097 121
nyatla 109:18f12ac01097 122 //const NyLPC_TcIPv4Config_t* NyLPC_cUipService_refCurrentConfig(void);
nyatla 109:18f12ac01097 123 const struct NyLPC_TiNetInterface_Interface* NyLPC_cMiMicIpNetIf_getNetInterface(void);
nyatla 109:18f12ac01097 124
nyatla 109:18f12ac01097 125
nyatla 109:18f12ac01097 126
nyatla 109:18f12ac01097 127 #ifdef __cplusplus
nyatla 109:18f12ac01097 128 }
nyatla 109:18f12ac01097 129 #endif /* __cplusplus */
nyatla 109:18f12ac01097 130
nyatla 109:18f12ac01097 131 #endif
nyatla 109:18f12ac01097 132