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 Aug 07 13:53:02 2013 +0000
Revision:
48:00d211aac2ec
Parent:
1:9f6a78395432
Child:
109:18f12ac01097
backup

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 1:9f6a78395432 1 /*********************************************************************************
nyatla 1:9f6a78395432 2 * PROJECT: MiMic
nyatla 1:9f6a78395432 3 * --------------------------------------------------------------------------------
nyatla 1:9f6a78395432 4 *
nyatla 1:9f6a78395432 5 * This file is part of MiMic
nyatla 1:9f6a78395432 6 * Copyright (C)2011 Ryo Iizuka
nyatla 1:9f6a78395432 7 *
nyatla 1:9f6a78395432 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 1:9f6a78395432 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 1:9f6a78395432 10 * by the Free Software Foundation, either version 3 of the License, or
nyatla 1:9f6a78395432 11 * (at your option) any later version.
nyatla 1:9f6a78395432 12 *
nyatla 1:9f6a78395432 13 * This program is distributed in the hope that it will be useful,
nyatla 1:9f6a78395432 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 1:9f6a78395432 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 1:9f6a78395432 16 * GNU General Public License for more details.
nyatla 1:9f6a78395432 17 *
nyatla 1:9f6a78395432 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 1:9f6a78395432 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 1:9f6a78395432 20 *
nyatla 1:9f6a78395432 21 * For further information please contact.
nyatla 1:9f6a78395432 22 * http://nyatla.jp/
nyatla 1:9f6a78395432 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 1:9f6a78395432 24 *
nyatla 1:9f6a78395432 25 *********************************************************************************/
nyatla 1:9f6a78395432 26 #ifndef NyLPC_TcHttpStream_h
nyatla 1:9f6a78395432 27 #define NyLPC_TcHttpStream_h
nyatla 1:9f6a78395432 28
nyatla 1:9f6a78395432 29 #include "NyLPC_config.h"
nyatla 1:9f6a78395432 30 #include "NyLPC_iHttpPtrStream.h"
nyatla 1:9f6a78395432 31
nyatla 1:9f6a78395432 32
nyatla 1:9f6a78395432 33
nyatla 1:9f6a78395432 34 #if NyLPC_CONFIG_cHttpStream_DEBUG == 1
nyatla 1:9f6a78395432 35 #ifdef __cplusplus
nyatla 1:9f6a78395432 36 extern "C" {
nyatla 1:9f6a78395432 37 #endif /* __cplusplus */
nyatla 1:9f6a78395432 38
nyatla 1:9f6a78395432 39 typedef int NyLPC_TcTcpSocket_t;
nyatla 1:9f6a78395432 40 void NyLPC_cTcpSocket_initialized(void* inst,const char* rb,int l);
nyatla 1:9f6a78395432 41 void* NyLPC_cTcpSocket_allocSendBuf(void* inst,NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_len,NyLPC_TUInt32 i_to);
nyatla 1:9f6a78395432 42 NyLPC_TBool NyLPC_cTcpSocket_psend(void* inst,void* i_buf,NyLPC_TUInt16 i_len,NyLPC_TUInt32 i_to);
nyatla 1:9f6a78395432 43 NyLPC_TInt32 NyLPC_cTcpSocket_precv(void* i_inst,const void** o_buf_ptr,NyLPC_TUInt32 i_wait_msec);
nyatla 1:9f6a78395432 44 void NyLPC_cTcpSocket_pseek(void* i_inst,NyLPC_TUInt16 i_seek);
nyatla 1:9f6a78395432 45
nyatla 1:9f6a78395432 46 #ifdef __cplusplus
nyatla 1:9f6a78395432 47 }
nyatla 1:9f6a78395432 48 #endif /* __cplusplus */
nyatla 1:9f6a78395432 49
nyatla 1:9f6a78395432 50 #else
nyatla 1:9f6a78395432 51 #include "../uip/NyLPC_cTcpSocket.h"
nyatla 1:9f6a78395432 52 #endif
nyatla 1:9f6a78395432 53
nyatla 1:9f6a78395432 54 #ifdef __cplusplus
nyatla 1:9f6a78395432 55 extern "C" {
nyatla 1:9f6a78395432 56 #endif /* __cplusplus */
nyatla 1:9f6a78395432 57
nyatla 1:9f6a78395432 58 /**
nyatla 1:9f6a78395432 59 * HttpStreamを供給するためのクラスです。このクラスは、NyLPC_TiHttpPtrStream_TInterfaceインタフェイスを実装します。
nyatla 1:9f6a78395432 60 */
nyatla 1:9f6a78395432 61 typedef struct NyLPC_TcHttpStream NyLPC_TcHttpStream_t;
nyatla 1:9f6a78395432 62
nyatla 1:9f6a78395432 63
nyatla 1:9f6a78395432 64
nyatla 1:9f6a78395432 65 struct NyLPC_TcHttpStream
nyatla 1:9f6a78395432 66 {
nyatla 48:00d211aac2ec 67 NyLPC_TiHttpPtrStream_t super;
nyatla 1:9f6a78395432 68 NyLPC_TcTcpSocket_t* _ref_sock;
nyatla 1:9f6a78395432 69 NyLPC_TUInt8* txb;//送信バッファ
nyatla 1:9f6a78395432 70 NyLPC_TUInt16 txb_size;//送信バッファサイズ
nyatla 1:9f6a78395432 71 NyLPC_TUInt16 tx_len; //送信サイズ
nyatla 1:9f6a78395432 72 NyLPC_TiHttpPtrStream_ET re_type;
nyatla 1:9f6a78395432 73 NyLPC_TiHttpPtrStream_ET we_type;
nyatla 1:9f6a78395432 74 };
nyatla 1:9f6a78395432 75
nyatla 1:9f6a78395432 76
nyatla 1:9f6a78395432 77
nyatla 1:9f6a78395432 78 /**
nyatla 1:9f6a78395432 79 * 接続済のソケットをストリームに抽象化します。
nyatla 1:9f6a78395432 80 * このインスタンスは、NyLPC_TiHttpPtrStream_TInterfaceインタフェイスを提供します。
nyatla 1:9f6a78395432 81 * @
nyatla 1:9f6a78395432 82 */
nyatla 1:9f6a78395432 83 NyLPC_TBool NyLPC_cHttpStream_initialize(NyLPC_TcHttpStream_t* i_inst,NyLPC_TcTcpSocket_t* i_ref_sock);
nyatla 1:9f6a78395432 84
nyatla 1:9f6a78395432 85 void NyLPC_cHttpStream_finalize(NyLPC_TcHttpStream_t* i_inst);
nyatla 1:9f6a78395432 86
nyatla 1:9f6a78395432 87 #ifdef __cplusplus
nyatla 1:9f6a78395432 88 }
nyatla 1:9f6a78395432 89 #endif /* __cplusplus */
nyatla 1:9f6a78395432 90
nyatla 1:9f6a78395432 91 #endif