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)
core/netif/mimicip/NyLPC_cIPv4.h
- Committer:
- nyatla
- Date:
- 2016-06-04
- Revision:
- 114:f6aef16d4e60
- Parent:
- 110:257739f9b31e
File content as of revision 114:f6aef16d4e60:
/********************************************************************************* * PROJECT: MiMic * -------------------------------------------------------------------------------- * * This file is part of MiMic * Copyright (C)2011 Ryo Iizuka * * MiMic is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * * For further information please contact. * http://nyatla.jp/ * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp> * * * Parts of this file were leveraged from uIP: * * Copyright (c) 2001-2003, Adam Dunkels. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote * products derived from this software without specific prior * written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /** * @file * このファイルは、NyLPC_cIPv4IPv4クラスを定義します。 */ #ifndef NYLPC_CIPV4TCP_H_ #define NYLPC_CIPV4TCP_H_ #include "NyLPC_os.h" #include "../NyLPC_NetIf_ip_types.h" #include "../NyLPC_cIPv4Config.h" #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /********************************************************************** * * Closs reference * **********************************************************************/ typedef struct NyLPC_TcMiMicIpBaseSocket NyLPC_TcMiMicIpBaseSocket_t; /********************************************************************** * * class NyLPC_TcIPv4 * **********************************************************************/ typedef struct NyLPC_TcIPv4 NyLPC_TcIPv4_t; /** * Socketの最大生成数 * この値は、NyLPC_cTcpSocketクラス,NyLPC_cTcpListener,NyLPC_cUdpの最大生成数になります。 */ #define NyLPC_cIPv4_MAX_SOCKET 10 /** * NyLPC_TcIPv4クラスの構造体です。 */ struct NyLPC_TcIPv4 { /** 参照しているIPスタックの環境値です。この値は、start関数が設定します。*/ const NyLPC_TcIPv4Config_t* _ref_config; /** ソケットリソースの保護用。コールバック関数から呼び出されるソケット内部のリソース保護に使用する共通MUTEX*/ NyLPC_TcMutex_t _sock_mutex; /** リスナリソースの保護用。コールバック関数から呼び出されるソケット内部のリソース保護に使用する共通MUTEX*/ NyLPC_TcMutex_t _listener_mutex; /** 0-0xfffまでを巡回するカウンタ*/ NyLPC_TUInt16 tcp_port_counter; }; /** * コンストラクタです。インスタンスを初期化します。 * @param i_inst * 初期化するインスタンス */ void NyLPC_cIPv4_initialize( NyLPC_TcIPv4_t* i_inst); /** * デストラクタです。インスタンスを破棄して、確保している動的リソースを元に戻します。 * @param i_inst * 破棄するインスタンス * initializeが成功したインスタンスだけが指定できます。 */ void NyLPC_cIPv4_finalize( NyLPC_TcIPv4_t* i_inst); /** * この関数は、インスタンスにTCP/IP処理の準備をするように伝えます。 * @param i_inst * 操作するインスタンス * @param i_ref_configlation * IPの環境値をセットしたオブジェクトを指定します。 * この値は、stop関数を実行するまでの間、維持してください。 */ void NyLPC_cIPv4_start( NyLPC_TcIPv4_t* i_inst, const NyLPC_TcIPv4Config_t* i_ref_configlation); /** * この関数はTCP/IP処理を停止することを伝えます。 * @param i_inst * 操作するインスタンス。 * startで開始済みで無ければなりません。 * @note * 現在、接続中の接続に対する保障は未実装です。安全に使用することが出来ません。 */ void NyLPC_cIPv4_stop( NyLPC_TcIPv4_t* i_inst); /** * この関数は、RxIPパケットを処理して、管理下のインスタンスに処理を依頼します。 * 現在の関数は、i_rxに最大64バイトの応答パケットのイメージを格納することがあります。 * 応答パケットは、RXに対するACKパケットです。 * 格納の有無は戻り値を確認することで判ります。 * この関数はstart-stopの間だけコールすることが出来ます。start,stopと非同期に実行しないでください。 * @param i_inst * 操作するインスタンスです。 * @param i_rx * RXパケットを格納したメモリアドレスです。 * 最低でも、64バイト以上のサイズが必要です。 * @param i_rx_size * i_rxに格納したデータのサイズです。 * @return * 応答パケットを格納したメモリです。 */ void* NyLPC_cIPv4_rx(NyLPC_TcIPv4_t* i_inst,const void* i_rx,NyLPC_TUInt16 i_rx_size); /** * この関数は、定期的にインスタンスへ実行機会を与える関数です。 * TCPの再送、無通信タイムアウトなどを処理します。 * 約1秒おきに呼び出してください。 * @param i_inst * 操作するインスタンスです。 */ void NyLPC_cIPv4_periodec(NyLPC_TcIPv4_t* i_inst); /** * ソケットリソースとコールバックの排他処理に使う共通MUTEXを返します。 * このMutexはソケット同士の干渉が起こらない処理にだけ使ってください。 */ #define NyLPC_cIPv4_getSockMutex(i_inst) (&((i_inst)->_sock_mutex)) /** * リスナーリソースとコールバックの排他処理に使う共通MUTEXを返します。 */ #define NyLPC_cIPv4_getListenerMutex(i_inst) (&((i_inst)->_listener_mutex)) /** * ポート0で使用するポート番号を返します。 * @return * 49152 - (49152+0x0ffff)番までのポートのうち、使用中でないポート番号を返します。 * エラー時は0です。 */ NyLPC_TUInt16 NyLPC_cIPv4_getNewPortNumber(NyLPC_TcIPv4_t* i_inst); #ifdef __cplusplus } #endif /* __cplusplus */ #endif