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 Apr 20 05:03:57 2013 +0000
Revision:
12:efe841863fc8
Parent:
11:c82a7b2899b0
Child:
41:2389bd6b6f74
MiMic r218

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 #ifndef NYLPC_CTHREAD_H_
nyatla 0:142ee8b12fef 27 #define NYLPC_CTHREAD_H_
nyatla 0:142ee8b12fef 28
nyatla 0:142ee8b12fef 29 ////////////////////////////////////////////////////////////////////////////////
nyatla 0:142ee8b12fef 30 // Include
nyatla 0:142ee8b12fef 31 ////////////////////////////////////////////////////////////////////////////////
nyatla 0:142ee8b12fef 32 #include "NyLPC_stdlib.h"
nyatla 0:142ee8b12fef 33 #if NyLPC_ARCH==NyLPC_ARCH_FREERTOS
nyatla 0:142ee8b12fef 34 #include "FreeRTOS.h"
nyatla 0:142ee8b12fef 35 #include "task.h"
nyatla 0:142ee8b12fef 36 #elif NyLPC_ARCH==NyLPC_ARCH_MBEDRTOS
nyatla 0:142ee8b12fef 37 #else
nyatla 0:142ee8b12fef 38 #error Bad NyLPC_ARCH!
nyatla 0:142ee8b12fef 39 #endif
nyatla 0:142ee8b12fef 40
nyatla 0:142ee8b12fef 41 /**********************************************************************
nyatla 0:142ee8b12fef 42 *
nyatla 0:142ee8b12fef 43 * NyLPC_TcThread class
nyatla 0:142ee8b12fef 44 *
nyatla 0:142ee8b12fef 45 **********************************************************************/
nyatla 0:142ee8b12fef 46 #ifdef __cplusplus
nyatla 0:142ee8b12fef 47 extern "C" {
nyatla 0:142ee8b12fef 48 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 49
nyatla 0:142ee8b12fef 50 /**
nyatla 0:142ee8b12fef 51 * 関数スレッドを実行します。
nyatla 0:142ee8b12fef 52 */
nyatla 0:142ee8b12fef 53 typedef struct NyLPC_TcThread NyLPC_TcThread_t;
nyatla 0:142ee8b12fef 54
nyatla 0:142ee8b12fef 55 /** スレッドの関数型*/
nyatla 2:b96c1e90d120 56 typedef int (*NyLPC_TcThread_ThreadFunc)(void* i_param);
nyatla 0:142ee8b12fef 57 /** */
nyatla 0:142ee8b12fef 58 #define NyLPC_TcThread_DEFAULT_STACKSIZE configMINIMAL_STACK_SIZE
nyatla 0:142ee8b12fef 59
nyatla 0:142ee8b12fef 60 /** ターミネイトしたときに1*/
nyatla 0:142ee8b12fef 61 #define NyLPC_TcThread_BIT_IS_TERMINATED 0x00000001
nyatla 0:142ee8b12fef 62
nyatla 0:142ee8b12fef 63 /** JOINリクエストがある場合に1*/
nyatla 0:142ee8b12fef 64 #define NyLPC_TcThread_BIT_IS_JOIN_REQ 0x00000002
nyatla 0:142ee8b12fef 65
nyatla 0:142ee8b12fef 66 /**
nyatla 0:142ee8b12fef 67 * Thread priorities
nyatla 0:142ee8b12fef 68 */
nyatla 0:142ee8b12fef 69 #define NyLPC_TcThread_PRIORITY_IDLE 0
nyatla 0:142ee8b12fef 70 #define NyLPC_TcThread_PRIORITY_SERVICE 1
nyatla 0:142ee8b12fef 71
nyatla 0:142ee8b12fef 72 #if NyLPC_ARCH==NyLPC_ARCH_FREERTOS
nyatla 0:142ee8b12fef 73
nyatla 2:b96c1e90d120 74 struct NyLPC_TcThread {
nyatla 0:142ee8b12fef 75 NyLPC_TUInt32 _sbit;
nyatla 0:142ee8b12fef 76 xTaskHandle _taskid;
nyatla 0:142ee8b12fef 77 NyLPC_TcThread_ThreadFunc _func;
nyatla 0:142ee8b12fef 78 void* _param;
nyatla 0:142ee8b12fef 79 };
nyatla 0:142ee8b12fef 80 #elif NyLPC_ARCH==NyLPC_ARCH_MBEDRTOS
nyatla 0:142ee8b12fef 81
nyatla 0:142ee8b12fef 82 struct NyLPC_TcThread
nyatla 0:142ee8b12fef 83 {
nyatla 0:142ee8b12fef 84 NyLPC_TUInt32 _sbit;
nyatla 11:c82a7b2899b0 85 void* _thread; //Thread* type.
nyatla 0:142ee8b12fef 86 NyLPC_TcThread_ThreadFunc _func;
nyatla 0:142ee8b12fef 87 void* _arg;
nyatla 0:142ee8b12fef 88 };
nyatla 0:142ee8b12fef 89
nyatla 0:142ee8b12fef 90 #else
nyatla 0:142ee8b12fef 91 #error Bad NyLPC_ARCH!
nyatla 0:142ee8b12fef 92 #endif
nyatla 0:142ee8b12fef 93
nyatla 0:142ee8b12fef 94 /**
nyatla 0:142ee8b12fef 95 * 終了要求フラグの値を返します。
nyatla 0:142ee8b12fef 96 * スレッドのループ内で、Join要求の有無を確認するために使います。
nyatla 0:142ee8b12fef 97 * スレッドは定期的にこの関数を実行して、trueの場合は速やかに関数を終了する必要があります。
nyatla 0:142ee8b12fef 98 */
nyatla 0:142ee8b12fef 99 #define NyLPC_cThread_isJoinReqest(i_inst) NyLPC_TUInt32_isBitOn((i_inst)->_sbit,NyLPC_TcThread_BIT_IS_JOIN_REQ)
nyatla 0:142ee8b12fef 100 #define NyLPC_cThread_isTerminated(i_inst) NyLPC_TUInt32_isBitOn((i_inst)->_sbit,NyLPC_TcThread_BIT_IS_TERMINATED)
nyatla 0:142ee8b12fef 101
nyatla 2:b96c1e90d120 102 void NyLPC_cThread_initialize(NyLPC_TcThread_t* i_inst, NyLPC_TInt32 i_stack,NyLPC_TInt32 i_prio);
nyatla 2:b96c1e90d120 103 void NyLPC_cThread_finalize(NyLPC_TcThread_t* i_inst);
nyatla 2:b96c1e90d120 104 void NyLPC_cThread_start(NyLPC_TcThread_t* i_inst,
nyatla 2:b96c1e90d120 105 NyLPC_TcThread_ThreadFunc i_func, void* i_param);
nyatla 0:142ee8b12fef 106 void NyLPC_cThread_join(NyLPC_TcThread_t* i_inst);
nyatla 12:efe841863fc8 107 void NyLPC_cThread_yield(void);
nyatla 0:142ee8b12fef 108 /**
nyatla 0:142ee8b12fef 109 * 一定時間、スレッドをスリープする。
nyatla 0:142ee8b12fef 110 * この関数はstatic関数です。
nyatla 0:142ee8b12fef 111 */
nyatla 0:142ee8b12fef 112 void NyLPC_cThread_sleep(NyLPC_TUInt32 i_time_in_msec);
nyatla 0:142ee8b12fef 113
nyatla 0:142ee8b12fef 114 #ifdef __cplusplus
nyatla 0:142ee8b12fef 115 }
nyatla 0:142ee8b12fef 116 #endif /* __cplusplus */
nyatla 0:142ee8b12fef 117
nyatla 3:0a94993be1f6 118 #endif /* NYLPC_CTHREAD_H_ */