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が準備されています。
※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.
チュートリアル
- HTTPD解説
- UPnPデバイスの作り方
- MiMicRemoteMCUの紹介(pdf)
- MiMicRemoteMCUのマニュアル(pdf)
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.
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
- HTTPD hello world.
- How to make own UPnP device.
- MiMicRemoteMCUの紹介(pdf)
- MiMicRemoteMCUのマニュアル(pdf)
NyLPC_cFifoBuffer.h@0:142ee8b12fef, 2013-01-30 (annotated)
- Committer:
- nyatla
- Date:
- Wed Jan 30 03:46:05 2013 +0000
- Revision:
- 0:142ee8b12fef
ported core classes
Who changed what in which revision?
User | Revision | Line number | New 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_cFifoBufferクラスを定義します。 |
nyatla | 0:142ee8b12fef | 29 | */ |
nyatla | 0:142ee8b12fef | 30 | #ifndef NyLPC_TcFifoBuffer_H |
nyatla | 0:142ee8b12fef | 31 | #define NyLPC_TcFifoBuffer_H |
nyatla | 0:142ee8b12fef | 32 | |
nyatla | 0:142ee8b12fef | 33 | #include "NyLPC_stdlib.h" |
nyatla | 0:142ee8b12fef | 34 | |
nyatla | 0:142ee8b12fef | 35 | #ifdef __cplusplus |
nyatla | 0:142ee8b12fef | 36 | extern "C" { |
nyatla | 0:142ee8b12fef | 37 | #endif /* __cplusplus */ |
nyatla | 0:142ee8b12fef | 38 | |
nyatla | 0:142ee8b12fef | 39 | /** |
nyatla | 0:142ee8b12fef | 40 | * クラス型を定義します。 |
nyatla | 0:142ee8b12fef | 41 | * NyLPC_cFifoBufferクラスは、固定長のメモリを、最大bit長のFIFOメモリーとして扱うためのラップクラスです。 |
nyatla | 0:142ee8b12fef | 42 | */ |
nyatla | 0:142ee8b12fef | 43 | typedef struct NyLPC_TcFifoBuffer NyLPC_TcFifoBuffer_t; |
nyatla | 0:142ee8b12fef | 44 | |
nyatla | 0:142ee8b12fef | 45 | /** |
nyatla | 0:142ee8b12fef | 46 | * NyLPC_TcFifoBufferクラスの構造体です。 |
nyatla | 0:142ee8b12fef | 47 | */ |
nyatla | 0:142ee8b12fef | 48 | struct NyLPC_TcFifoBuffer |
nyatla | 0:142ee8b12fef | 49 | { |
nyatla | 0:142ee8b12fef | 50 | /** 配列の最大サイズ*/ |
nyatla | 0:142ee8b12fef | 51 | NyLPC_TUInt16 size; |
nyatla | 0:142ee8b12fef | 52 | /** 配列の現在の長さ*/ |
nyatla | 0:142ee8b12fef | 53 | NyLPC_TUInt16 len; |
nyatla | 0:142ee8b12fef | 54 | /** バッファ領域*/ |
nyatla | 0:142ee8b12fef | 55 | void* buf; |
nyatla | 0:142ee8b12fef | 56 | }; |
nyatla | 0:142ee8b12fef | 57 | |
nyatla | 0:142ee8b12fef | 58 | /** |
nyatla | 0:142ee8b12fef | 59 | * コンストラクタです。 |
nyatla | 0:142ee8b12fef | 60 | * i_instを、i_bufをラップするインスタンスとして初期化します。 |
nyatla | 0:142ee8b12fef | 61 | * i_bufは、finalizeを呼び出すまで、クラスが参照します。 |
nyatla | 0:142ee8b12fef | 62 | * インスタンスを削除するまでの間、維持してください。 |
nyatla | 0:142ee8b12fef | 63 | * @param i_inst |
nyatla | 0:142ee8b12fef | 64 | * 初期化するメモリブロックのアドレス。 |
nyatla | 0:142ee8b12fef | 65 | * @param i_buf |
nyatla | 0:142ee8b12fef | 66 | * ラップするメモリブロックのアドレス |
nyatla | 0:142ee8b12fef | 67 | * @param i_buf_size |
nyatla | 0:142ee8b12fef | 68 | * i_bufのサイズ。 |
nyatla | 0:142ee8b12fef | 69 | */ |
nyatla | 0:142ee8b12fef | 70 | void NyLPC_cFifoBuffer_initialize(NyLPC_TcFifoBuffer_t* i_inst,void* i_buf,NyLPC_TUInt16 i_buf_size); |
nyatla | 0:142ee8b12fef | 71 | |
nyatla | 0:142ee8b12fef | 72 | /** |
nyatla | 0:142ee8b12fef | 73 | * デストラクタです。 |
nyatla | 0:142ee8b12fef | 74 | * インスタンスの確保しているリソースを開放します。 |
nyatla | 0:142ee8b12fef | 75 | * @param i_inst |
nyatla | 0:142ee8b12fef | 76 | * 開放するインスタンスのポインタ |
nyatla | 0:142ee8b12fef | 77 | */ |
nyatla | 0:142ee8b12fef | 78 | #define NyLPC_cFifoBuffer_finalize(i_inst) |
nyatla | 0:142ee8b12fef | 79 | |
nyatla | 0:142ee8b12fef | 80 | /** |
nyatla | 0:142ee8b12fef | 81 | * この関数は、FIFOバッファの有効データ長を0にしてリセットします。 |
nyatla | 0:142ee8b12fef | 82 | * @param i_inst |
nyatla | 0:142ee8b12fef | 83 | * 操作するインスタンスのポインタ |
nyatla | 0:142ee8b12fef | 84 | */ |
nyatla | 0:142ee8b12fef | 85 | #define NyLPC_cFifoBuffer_clear(i_inst) (i_inst)->len=0; |
nyatla | 0:142ee8b12fef | 86 | |
nyatla | 0:142ee8b12fef | 87 | /** |
nyatla | 0:142ee8b12fef | 88 | * この関数は、バッファの後方にデータをコピーして追記します。 |
nyatla | 0:142ee8b12fef | 89 | * 十分なサイズがない場合、ASSERTします。 |
nyatla | 0:142ee8b12fef | 90 | * 書込み可能な最大サイズは、getSpace関数で得ることが出来ます。 |
nyatla | 0:142ee8b12fef | 91 | * @param i_inst |
nyatla | 0:142ee8b12fef | 92 | * 操作するインスタンスのポインタ |
nyatla | 0:142ee8b12fef | 93 | * @param i_data |
nyatla | 0:142ee8b12fef | 94 | * 追記するデータ。 |
nyatla | 0:142ee8b12fef | 95 | * @param i_data_len |
nyatla | 0:142ee8b12fef | 96 | * 追記するデータのサイズ |
nyatla | 0:142ee8b12fef | 97 | * |
nyatla | 0:142ee8b12fef | 98 | */ |
nyatla | 0:142ee8b12fef | 99 | void NyLPC_cFifoBuffer_push(NyLPC_TcFifoBuffer_t* i_inst,const void* i_data,NyLPC_TUInt16 i_data_len); |
nyatla | 0:142ee8b12fef | 100 | |
nyatla | 0:142ee8b12fef | 101 | /** |
nyatla | 0:142ee8b12fef | 102 | * この関数は、バッファの先頭からデータを削除します。 |
nyatla | 0:142ee8b12fef | 103 | * 十分なデータがない場合、ASSERTします。 |
nyatla | 0:142ee8b12fef | 104 | * この関数は、戻り値を返しません。getPtrで得たポインタからデータを読み込んだ後に、読み込んだデータをバッファから削除するために使います。 |
nyatla | 0:142ee8b12fef | 105 | * @param i_inst |
nyatla | 0:142ee8b12fef | 106 | * 操作するインスタンスのポインタ |
nyatla | 0:142ee8b12fef | 107 | * @param i_data |
nyatla | 0:142ee8b12fef | 108 | * 削除するデータのサイズ。getLengthの戻り値以下である必要があります。 |
nyatla | 0:142ee8b12fef | 109 | */ |
nyatla | 0:142ee8b12fef | 110 | void NyLPC_cFifoBuffer_pop(NyLPC_TcFifoBuffer_t* i_inst,NyLPC_TUInt16 i_len); |
nyatla | 0:142ee8b12fef | 111 | |
nyatla | 0:142ee8b12fef | 112 | /** |
nyatla | 0:142ee8b12fef | 113 | * バッファの先頭ポインタを得ます。 |
nyatla | 0:142ee8b12fef | 114 | * @param i_inst |
nyatla | 0:142ee8b12fef | 115 | * 操作するインスタンスのポインタ |
nyatla | 0:142ee8b12fef | 116 | * @return |
nyatla | 0:142ee8b12fef | 117 | * バッファの先頭ポインタを返します。値は、次回にpush/popをするまでの間有効です。 |
nyatla | 0:142ee8b12fef | 118 | */ |
nyatla | 0:142ee8b12fef | 119 | void* NyLPC_cFifoBuffer_getPtr(const NyLPC_TcFifoBuffer_t* i_inst); |
nyatla | 0:142ee8b12fef | 120 | |
nyatla | 0:142ee8b12fef | 121 | /** |
nyatla | 0:142ee8b12fef | 122 | * 格納しているデータの長さを返します。 |
nyatla | 0:142ee8b12fef | 123 | * getPtrで得たポインタから読み出せるデータのサイズに相当します。 |
nyatla | 0:142ee8b12fef | 124 | * @param i_inst |
nyatla | 0:142ee8b12fef | 125 | * 操作するインスタンスのポインタ |
nyatla | 0:142ee8b12fef | 126 | * @return |
nyatla | 0:142ee8b12fef | 127 | * 読み出せるデータの長さです。 |
nyatla | 0:142ee8b12fef | 128 | */ |
nyatla | 0:142ee8b12fef | 129 | NyLPC_TUInt16 NyLPC_cFifoBuffer_getLength(const NyLPC_TcFifoBuffer_t* i_inst); |
nyatla | 0:142ee8b12fef | 130 | |
nyatla | 0:142ee8b12fef | 131 | /** |
nyatla | 0:142ee8b12fef | 132 | * バッファの残量を計算して返します。 |
nyatla | 0:142ee8b12fef | 133 | * この値は、push関数で追記できるデータサイズと同じです。 |
nyatla | 0:142ee8b12fef | 134 | * @param i_inst |
nyatla | 0:142ee8b12fef | 135 | * 操作するインスタンスのポインタ |
nyatla | 0:142ee8b12fef | 136 | * @return |
nyatla | 0:142ee8b12fef | 137 | * バッファの空き領域のサイズです。 |
nyatla | 0:142ee8b12fef | 138 | */ |
nyatla | 0:142ee8b12fef | 139 | NyLPC_TUInt16 NyLPC_cFifoBuffer_getSpace(const NyLPC_TcFifoBuffer_t* i_inst); |
nyatla | 0:142ee8b12fef | 140 | |
nyatla | 0:142ee8b12fef | 141 | #ifdef __cplusplus |
nyatla | 0:142ee8b12fef | 142 | } |
nyatla | 0:142ee8b12fef | 143 | #endif /* __cplusplus */ |
nyatla | 0:142ee8b12fef | 144 | |
nyatla | 0:142ee8b12fef | 145 | #endif |