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 Jul 11 01:44:20 2014 +0000
Revision:
86:a042fb18911b
Parent:
84:a5f5973591d8
Child:
91:db8279c869d3
HTTP????????????1024+512???

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全体に関わる、コンフィギュレーション定数を宣言します。
nyatla 0:142ee8b12fef 29 */
nyatla 0:142ee8b12fef 30 #ifndef NyLPC_config_h
nyatla 0:142ee8b12fef 31 #define NyLPC_config_h
nyatla 0:142ee8b12fef 32
nyatla 0:142ee8b12fef 33 #ifdef __cplusplus
nyatla 0:142ee8b12fef 34 extern "C" {
nyatla 0:142ee8b12fef 35 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 36
nyatla 68:f7def7eb5504 37 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 68:f7def7eb5504 38 // ENDIAN
nyatla 68:f7def7eb5504 39 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 68:f7def7eb5504 40
nyatla 68:f7def7eb5504 41
nyatla 0:142ee8b12fef 42 /**
nyatla 0:142ee8b12fef 43 * 定義値です。LITTLE ENDIANを表します。
nyatla 0:142ee8b12fef 44 */
nyatla 0:142ee8b12fef 45 #define NyLPC_ENDIAN_LITTLE 0
nyatla 0:142ee8b12fef 46 /**
nyatla 0:142ee8b12fef 47 * 定義値です。BIG ENDIANを表します。
nyatla 0:142ee8b12fef 48 */
nyatla 0:142ee8b12fef 49 #define NyLPC_ENDIAN_BIG 1
nyatla 0:142ee8b12fef 50
nyatla 0:142ee8b12fef 51 /**
nyatla 0:142ee8b12fef 52 * 定義値です。CPUのエンディアンを定義します。
nyatla 0:142ee8b12fef 53 * この値は、NyLPClibに影響を及ぼします。
nyatla 0:142ee8b12fef 54 */
nyatla 0:142ee8b12fef 55 #define NyLPC_ENDIAN NyLPC_ENDIAN_LITTLE
nyatla 68:f7def7eb5504 56 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 68:f7def7eb5504 57 // MCU
nyatla 68:f7def7eb5504 58 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 68:f7def7eb5504 59 #define NyLPC_MCU_UNKNOWN 1
nyatla 68:f7def7eb5504 60 #define NyLPC_MCU_LPC17xx 2
nyatla 68:f7def7eb5504 61 #define NyLPC_MCU_LPC4088 3
nyatla 68:f7def7eb5504 62
nyatla 68:f7def7eb5504 63 #define NyLPC_MCU NyLPC_MCU_LPC17xx
nyatla 68:f7def7eb5504 64
nyatla 0:142ee8b12fef 65
nyatla 0:142ee8b12fef 66 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 68:f7def7eb5504 67 // OS
nyatla 0:142ee8b12fef 68 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 0:142ee8b12fef 69
nyatla 0:142ee8b12fef 70 /**
nyatla 0:142ee8b12fef 71 * 環境定数です。WIN32環境でコンパイルすることを示します。
nyatla 0:142ee8b12fef 72 */
nyatla 0:142ee8b12fef 73 #define NyLPC_ARCH_WIN32 1
nyatla 0:142ee8b12fef 74 /**
nyatla 0:142ee8b12fef 75 * 環境定数です。FREERTOS環境でコンパイルすることを示します。
nyatla 0:142ee8b12fef 76 */
nyatla 0:142ee8b12fef 77 #define NyLPC_ARCH_FREERTOS 2
nyatla 0:142ee8b12fef 78 /**
nyatla 0:142ee8b12fef 79 * 環境定数です。MbedRTOR環境でコンパイルすることを示します。
nyatla 0:142ee8b12fef 80 */
nyatla 0:142ee8b12fef 81 #define NyLPC_ARCH_MBEDRTOS 3
nyatla 0:142ee8b12fef 82
nyatla 0:142ee8b12fef 83 /**
nyatla 0:142ee8b12fef 84 * 環境定数です。アーキテクチャを選択します。NyLPC_ARCH_WIN32は、デバック用の定数です。
nyatla 0:142ee8b12fef 85 * 通常は、NyLPC_ARCH_FREERTOSを使用します。
nyatla 0:142ee8b12fef 86 */
nyatla 41:2389bd6b6f74 87 #ifdef WIN_DEBUG
nyatla 41:2389bd6b6f74 88 #define NyLPC_ARCH NyLPC_ARCH_WIN32
nyatla 41:2389bd6b6f74 89 #else
nyatla 68:f7def7eb5504 90 #define NyLPC_ARCH NyLPC_ARCH_FREERTOS
nyatla 41:2389bd6b6f74 91 #endif
nyatla 41:2389bd6b6f74 92
nyatla 41:2389bd6b6f74 93
nyatla 41:2389bd6b6f74 94 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 41:2389bd6b6f74 95 //予約定義値の修正
nyatla 41:2389bd6b6f74 96 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 41:2389bd6b6f74 97
nyatla 41:2389bd6b6f74 98 #if NyLPC_ARCH==NyLPC_ARCH_WIN32
nyatla 68:f7def7eb5504 99 //PACKED STRUCTの無効化
nyatla 41:2389bd6b6f74 100 #define PACK_STRUCT_END
nyatla 68:f7def7eb5504 101 //OSタイプによりMCUを修正
nyatla 83:d46aa580722a 102 # undef NyLPC_MCU
nyatla 83:d46aa580722a 103 # define NyLPC_MCU NyLPC_MCU_UNKNOWN
nyatla 41:2389bd6b6f74 104 #endif
nyatla 0:142ee8b12fef 105
nyatla 0:142ee8b12fef 106
nyatla 68:f7def7eb5504 107
nyatla 0:142ee8b12fef 108 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 0:142ee8b12fef 109 //デバック情報
nyatla 0:142ee8b12fef 110 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 0:142ee8b12fef 111
nyatla 0:142ee8b12fef 112 /**
nyatla 0:142ee8b12fef 113 * デバック用の宣言。
nyatla 0:142ee8b12fef 114 * 定数が1の場合、メモリブロックをソースにして、TCPSocketをエミュレートします。
nyatla 0:142ee8b12fef 115 * ソケットを使わずにデバックをしたいときに使います。
nyatla 0:142ee8b12fef 116 */
nyatla 0:142ee8b12fef 117 #define NyLPC_CONFIG_cHttpStream_DEBUG 0
nyatla 0:142ee8b12fef 118
nyatla 68:f7def7eb5504 119 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 68:f7def7eb5504 120 //デバック情報
nyatla 68:f7def7eb5504 121 ////////////////////////////////////////////////////////////////////////////////////////////////
nyatla 68:f7def7eb5504 122
nyatla 86:a042fb18911b 123 #define NyLPC_cHttpdThread_SIZE_OF_THREAD_STACK (1024+512)
nyatla 84:a5f5973591d8 124 #define NyLPC_cHttpd_MAX_PERSISTENT_CONNECTION 1
nyatla 81:e5e4f2264d24 125
nyatla 68:f7def7eb5504 126 /*固有プラットフォーム設定はここに記述します。*/
nyatla 68:f7def7eb5504 127 #undef NyLPC_ARCH
nyatla 68:f7def7eb5504 128 #define NyLPC_ARCH NyLPC_ARCH_MBEDRTOS
nyatla 68:f7def7eb5504 129
nyatla 69:8c5f220441f5 130 #ifdef TARGET_LPC4088
nyatla 69:8c5f220441f5 131 #undef NyLPC_MCU
nyatla 69:8c5f220441f5 132 #define NyLPC_MCU NyLPC_MCU_LPC4088
nyatla 69:8c5f220441f5 133 #endif
nyatla 69:8c5f220441f5 134
nyatla 0:142ee8b12fef 135 #ifdef __cplusplus
nyatla 0:142ee8b12fef 136 }
nyatla 0:142ee8b12fef 137 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 138
nyatla 0:142ee8b12fef 139 #endif