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:
57:bc4330dfa62f
include????????; ???????????

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 #include "NyLPC_cPtrStream_protected.h"
nyatla 0:142ee8b12fef 27
nyatla 0:142ee8b12fef 28 /**
nyatla 0:142ee8b12fef 29 * ROMをラップするブロッキングストリーム型です。
nyatla 0:142ee8b12fef 30 * このクラスは、NyLPC_TcBlockingStreamにキャストすることができます。
nyatla 0:142ee8b12fef 31 特性
nyatla 0:142ee8b12fef 32 このクラスは、read onlyです。write動作は永久に失敗します。
nyatla 0:142ee8b12fef 33 また、タイムアウト値は意味を持たず、最終データを読みだした後はカウント0でタイムアウトと同じ挙動を示します。
nyatla 0:142ee8b12fef 34 */
nyatla 0:142ee8b12fef 35 typedef struct NyLPC_TcRomPtrStream NyLPC_TcRomPtrStream_t;
nyatla 0:142ee8b12fef 36
nyatla 0:142ee8b12fef 37 /**********************************************************************
nyatla 0:142ee8b12fef 38 *
nyatla 0:142ee8b12fef 39 * NyLPC_TcRomBlockingStream class
nyatla 0:142ee8b12fef 40 *
nyatla 0:142ee8b12fef 41 **********************************************************************/
nyatla 0:142ee8b12fef 42
nyatla 0:142ee8b12fef 43 struct NyLPC_TcRomPtrStream
nyatla 0:142ee8b12fef 44 {
nyatla 0:142ee8b12fef 45 NyLPC_TcPtrStream_t _super;
nyatla 0:142ee8b12fef 46 NyLPC_TChar* _rom; //ROMアドレス
nyatla 0:142ee8b12fef 47 NyLPC_TInt32 _rom_size; //ROMサイズ
nyatla 0:142ee8b12fef 48 NyLPC_TInt32 _ed; //読出し済みサイズ
nyatla 0:142ee8b12fef 49 NyLPC_TInt16 _packet_size; //一度当たりの読出しサイズ制限
nyatla 0:142ee8b12fef 50 };
nyatla 0:142ee8b12fef 51
nyatla 0:142ee8b12fef 52 NyLPC_TBool NyLPC_TcRomPtrStream_initialize(NyLPC_TcRomPtrStream_t* i_inst,void* i_rom_addr,NyLPC_TInt32 i_length,NyLPC_TInt16 i_packetsize);
nyatla 0:142ee8b12fef 53
nyatla 0:142ee8b12fef 54 #define NyLPC_TcRomPtrStream_finalize(i_inst)
nyatla 0:142ee8b12fef 55
nyatla 0:142ee8b12fef 56 static NyLPC_TInt32 m_pread(NyLPC_TcPtrStream_t* i_inst,const void** o_buf_ptr,NyLPC_TUInt32 i_wait_msec);
nyatla 0:142ee8b12fef 57 static void m_close(NyLPC_TcPtrStream_t* i_inst);
nyatla 0:142ee8b12fef 58 static void m_preadSeek_func(NyLPC_TcPtrStream_t* i_inst,NyLPC_TUInt16 i_seek);
nyatla 0:142ee8b12fef 59
nyatla 0:142ee8b12fef 60 //関数テーブル
nyatla 0:142ee8b12fef 61 static struct NyLPC_TcPtrStream_TInterface NyLPC_TcRomPtrStream_Interface=
nyatla 0:142ee8b12fef 62 {
nyatla 0:142ee8b12fef 63 m_pread,
nyatla 0:142ee8b12fef 64 NyLPC_cPtrStream_write_func,
nyatla 0:142ee8b12fef 65 m_preadSeek_func,
nyatla 0:142ee8b12fef 66 m_close
nyatla 0:142ee8b12fef 67 };
nyatla 0:142ee8b12fef 68
nyatla 0:142ee8b12fef 69
nyatla 0:142ee8b12fef 70
nyatla 0:142ee8b12fef 71 NyLPC_TBool NyLPC_TcRomPtrStream_initialize(NyLPC_TcRomPtrStream_t* i_inst,void* i_rom_addr,NyLPC_TInt32 i_length,NyLPC_TInt16 i_packetsize)
nyatla 0:142ee8b12fef 72 {
nyatla 0:142ee8b12fef 73 NyLPC_ArgAssert(i_inst!=NULL);
nyatla 0:142ee8b12fef 74 NyLPC_ArgAssert(i_rom_addr!=NULL);
nyatla 0:142ee8b12fef 75 NyLPC_ArgAssert(i_length>0);
nyatla 0:142ee8b12fef 76 NyLPC_ArgAssert(i_packetsize>0);
nyatla 0:142ee8b12fef 77 i_inst->_super._interface=&NyLPC_TcRomPtrStream_Interface;
nyatla 0:142ee8b12fef 78 i_inst->_rom=(NyLPC_TChar*)i_rom_addr;
nyatla 0:142ee8b12fef 79 i_inst->_rom_size=i_length;
nyatla 0:142ee8b12fef 80 i_inst->_packet_size=i_packetsize;
nyatla 0:142ee8b12fef 81 return NyLPC_TBool_TRUE;
nyatla 0:142ee8b12fef 82 }
nyatla 0:142ee8b12fef 83
nyatla 0:142ee8b12fef 84 static void m_preadSeek_func(NyLPC_TcPtrStream_t* i_inst,NyLPC_TUInt16 i_seek)
nyatla 0:142ee8b12fef 85 {
nyatla 0:142ee8b12fef 86 (void)i_inst;
nyatla 0:142ee8b12fef 87 NyLPC_TcRomPtrStream_t* inst=(NyLPC_TcRomPtrStream_t*)i_inst;
nyatla 0:142ee8b12fef 88 inst->_rom+=i_seek;
nyatla 0:142ee8b12fef 89 }
nyatla 0:142ee8b12fef 90
nyatla 0:142ee8b12fef 91
nyatla 0:142ee8b12fef 92 /*private*/
nyatla 0:142ee8b12fef 93 static NyLPC_TBool m_pread(NyLPC_TcPtrStream_t* i_inst,const void** o_buf_ptr,NyLPC_TUInt32 i_wait_msec)
nyatla 0:142ee8b12fef 94 {
nyatla 0:142ee8b12fef 95 NyLPC_TInt32 size,psize;
nyatla 0:142ee8b12fef 96 NyLPC_TcRomPtrStream_t* inst=(NyLPC_TcRomPtrStream_t*)i_inst;
nyatla 0:142ee8b12fef 97 //引数
nyatla 0:142ee8b12fef 98 NyLPC_ArgAssert(i_inst!=NULL);
nyatla 0:142ee8b12fef 99 NyLPC_ArgAssert(o_buf_ptr!=NULL);
nyatla 0:142ee8b12fef 100 //クローズしてない?
nyatla 0:142ee8b12fef 101 NyLPC_Assert(inst->_rom!=NULL);
nyatla 0:142ee8b12fef 102
nyatla 0:142ee8b12fef 103 size=inst->_rom_size-inst->_ed; //残り長さ計算
nyatla 57:bc4330dfa62f 104 psize=(size>inst->_packet_size)?inst->_packet_size:size; //パケットサイズ計算
nyatla 0:142ee8b12fef 105 *o_buf_ptr=(inst->_rom+inst->_ed); //現在位置を返す
nyatla 0:142ee8b12fef 106 inst->_ed+=psize;//読出し位置更新
nyatla 0:142ee8b12fef 107 return psize;
nyatla 0:142ee8b12fef 108 }
nyatla 0:142ee8b12fef 109
nyatla 0:142ee8b12fef 110
nyatla 0:142ee8b12fef 111 static void m_close(NyLPC_TcPtrStream_t* i_inst)
nyatla 0:142ee8b12fef 112 {
nyatla 0:142ee8b12fef 113 NyLPC_TcRomPtrStream_t* inst=(NyLPC_TcRomPtrStream_t*)i_inst;
nyatla 0:142ee8b12fef 114 inst->_rom=NULL;
nyatla 0:142ee8b12fef 115 }
nyatla 0:142ee8b12fef 116
nyatla 0:142ee8b12fef 117
nyatla 0:142ee8b12fef 118