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:
Thu May 22 12:59:50 2014 +0000
Revision:
68:f7def7eb5504
Child:
69:8c5f220441f5
MiMic-core ?344???;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 68:f7def7eb5504 1 /*********************************************************************************
nyatla 68:f7def7eb5504 2 * PROJECT: MiMic
nyatla 68:f7def7eb5504 3 * --------------------------------------------------------------------------------
nyatla 68:f7def7eb5504 4 *
nyatla 68:f7def7eb5504 5 * This file is part of MiMic
nyatla 68:f7def7eb5504 6 * Copyright (C)2011 Ryo Iizuka
nyatla 68:f7def7eb5504 7 *
nyatla 68:f7def7eb5504 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 68:f7def7eb5504 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 68:f7def7eb5504 10 * by the Free Software Foundation, either version 3 of the License, or
nyatla 68:f7def7eb5504 11 * (at your option) any later version.
nyatla 68:f7def7eb5504 12 *
nyatla 68:f7def7eb5504 13 * This program is distributed in the hope that it will be useful,
nyatla 68:f7def7eb5504 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 68:f7def7eb5504 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 68:f7def7eb5504 16 * GNU General Public License for more details.
nyatla 68:f7def7eb5504 17 *
nyatla 68:f7def7eb5504 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 68:f7def7eb5504 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 68:f7def7eb5504 20 *
nyatla 68:f7def7eb5504 21 * For further information please contact.
nyatla 68:f7def7eb5504 22 * http://nyatla.jp/
nyatla 68:f7def7eb5504 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 68:f7def7eb5504 24 *
nyatla 68:f7def7eb5504 25 *********************************************************************************/
nyatla 68:f7def7eb5504 26
nyatla 68:f7def7eb5504 27 #ifndef NyLPC_cEthernetMM_protected_h
nyatla 68:f7def7eb5504 28 #define NyLPC_cEthernetMM_protected_h
nyatla 68:f7def7eb5504 29
nyatla 68:f7def7eb5504 30 #include "NyLPC_stdlib.h"
nyatla 68:f7def7eb5504 31 #include "NyLPC_IEthernetDevice.h"
nyatla 68:f7def7eb5504 32
nyatla 68:f7def7eb5504 33 #ifdef __cplusplus
nyatla 68:f7def7eb5504 34 extern "C" {
nyatla 68:f7def7eb5504 35 #endif /* __cplusplus */
nyatla 68:f7def7eb5504 36
nyatla 68:f7def7eb5504 37 /**
nyatla 68:f7def7eb5504 38 * @file
nyatla 68:f7def7eb5504 39 * このファイルは、イーサネットメモリマネージャクラスを定義します。
nyatla 68:f7def7eb5504 40 */
nyatla 68:f7def7eb5504 41
nyatla 68:f7def7eb5504 42 int NyLPC_cEthernetMM_dbg_getNumofUsedTx(void);
nyatla 68:f7def7eb5504 43
nyatla 68:f7def7eb5504 44 /**
nyatla 68:f7def7eb5504 45 * メモリブロックを初期化してメモリマネージャを構築します。
nyatla 68:f7def7eb5504 46 * メモリサイズはsizeof(struct TTxMemoryBlock)以上である必要があります。
nyatla 68:f7def7eb5504 47 */
nyatla 68:f7def7eb5504 48 void NyLPC_cEthernetMM_initialize(void* i_memblock_addr);
nyatla 68:f7def7eb5504 49 #define NyLPC_cEthernetMM_finalize(i)
nyatla 68:f7def7eb5504 50 /**
nyatla 68:f7def7eb5504 51 * メモリを割り当てます。
nyatla 68:f7def7eb5504 52 * @return
nyatla 68:f7def7eb5504 53 * 割り当て不能な場合はNULLが帰ります。
nyatla 68:f7def7eb5504 54 * @bug
nyatla 68:f7def7eb5504 55 * 戻り値、メモリブロックヘッダ不要では?
nyatla 68:f7def7eb5504 56 */
nyatla 68:f7def7eb5504 57 struct NyLPC_TTxBufferHeader* NyLPC_cEthernetMM_alloc(NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_size);
nyatla 68:f7def7eb5504 58 /**
nyatla 68:f7def7eb5504 59 * NyLPC_EthernetMM_allocで得たメモリを解放します。
nyatla 68:f7def7eb5504 60 */
nyatla 68:f7def7eb5504 61 void NyLPC_cEthernetMM_release(struct NyLPC_TTxBufferHeader* i_buf);
nyatla 68:f7def7eb5504 62
nyatla 68:f7def7eb5504 63 #ifdef __cplusplus
nyatla 68:f7def7eb5504 64 }
nyatla 68:f7def7eb5504 65 #endif /* __cplusplus */
nyatla 68:f7def7eb5504 66
nyatla 68:f7def7eb5504 67 #endif
nyatla 68:f7def7eb5504 68