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

Revision:
109:18f12ac01097
Parent:
108:8dae2a2682e7
Child:
110:257739f9b31e
--- a/core/uip/NyLPC_cUdpSocket.h	Thu Nov 13 14:06:19 2014 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,159 +0,0 @@
-/*
- * NyLPC_cUdpSocket.h
- *
- *  Created on: 2013/05/20
- *      Author: nyatla
- */
-
-#ifndef NYLPC_CUDPSOCKET_H_
-#define NYLPC_CUDPSOCKET_H_
-#include "NyLPC_uip.h"
-#include "NyLPC_os.h"
-#include "NyLPC_cBaseSocket.h"
-
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
-
-typedef struct NyLPC_TcUdpSocket NyLPC_TcUdpSocket_t;
-/**
- * 受信情報を格納する構造体
- */
-struct NyLPC_TIPv4RxInfo
-{
-    NyLPC_TUInt16 size;//パケットサイズ
-    NyLPC_TUInt16 port;//受信ポート
-    NyLPC_TUInt16 peer_port;//PEERポート
-    struct NyLPC_TIPv4Addr ip;//受信IP
-    struct NyLPC_TIPv4Addr peer_ip;//PEERIP
-};
-
-/**
- * Representation of a uIP UDP connection.
- */
-struct uip_udp_conn{
-    struct NyLPC_TIPv4Addr lipaddr;   /**< The IP address of the remote peer. */
-    /** マルチキャスとアドレス(ZEROで無効)*/
-    struct NyLPC_TIPv4Addr mcastaddr;
-    NyLPC_TUInt16 lport;        /**< The local port number in network byte order. */
-    NyLPC_TUInt8  flags;        /**フラグ*/
-    NyLPC_TUInt8  padding;      /***/
-};
-
-/**
- * 受信時に非同期にコールされるハンドラ
- * UIPサービスタスクが実行する。
- * @return
- * TRUEならパケットを受信キューへ追加する。FALSEならパケットを受信キューへ追加しない。
- */
-typedef NyLPC_TBool (*NyLPC_TcUdpSocket_onRxHandler)(NyLPC_TcUdpSocket_t* i_inst,const void* i_buf,const struct NyLPC_TIPv4RxInfo* i_info);
-/**
- * 非同期にコールされるハンドラ。
- * UIPサービスタスクが実行する。
- */
-typedef void (*NyLPC_TcUdpSocket_onPeriodic)(NyLPC_TcUdpSocket_t* i_inst);
-
-struct NyLPC_TcUdpSocket
-{
-    NyLPC_TcBaseSocket_t _super;
-    //この変数は、uipタスクの実行する関数のみが変更する。
-    struct uip_udp_conn uip_udp_conn;
-    NyLPC_TcFifoBuffer_t rxbuf;
-    NyLPC_TcMutex_t* _smutex;
-    struct{
-        /** 受信ハンドラ。サービス実装に使用する。*/
-        NyLPC_TcUdpSocket_onRxHandler rx;
-        /** 定期実行ハンドラ。サービス実装に使用する。最低保障周期は1s*/
-        NyLPC_TcUdpSocket_onPeriodic periodic;
-    }as_handler;
-};
-
-
-
-
-
-/**
- * @param i_rbuf
- * 受信バッファアアドレス。サイズは、(最大受信サイズ-4バイト)*キュー数で計算します。
- * @param i_rbuf_len
- * 受信バッファのサイズ。
- */
-NyLPC_TBool NyLPC_cUdpSocket_initialize(NyLPC_TcUdpSocket_t* i_inst,NyLPC_TUInt16 i_port,void* i_rbuf,NyLPC_TUInt16 i_rbuf_len);
-void NyLPC_cUdpSocket_finalize(NyLPC_TcUdpSocket_t* i_inst);
-
-/**
- * マルチキャストアドレスに参加する。
- * @param i_addr
- * 参加するマルチキャストグループを指定する。
- * 同じマルチキャスとグループに参加できるのは、システムの中で1つに限られます。
- * 0を指定した場合、マルチキャスとグループから離脱します。
- */
-void NyLPC_cUdpSocket_joinMulticast(NyLPC_TcUdpSocket_t* i_inst,const struct NyLPC_TIPv4Addr* i_addr);
-
-/**
- * ブロードキャストに参加する。
- */
-void NyLPC_cUdpSocket_setBroadcast(NyLPC_TcUdpSocket_t* i_inst);
-
-
-/**
- * この関数は、ソケットの受信バッファの読み取り位置と、読み出せるデータサイズを返却します。
- * 関数はポインターを返却するだけで、バッファの読み取り位置をシークしません。
- * シークするにはNyLPC_cTcpSocket_pseekを使います。
- */
-NyLPC_TInt32 NyLPC_cUdpSocket_precv(NyLPC_TcUdpSocket_t* i_inst,const void** o_buf_ptr,const struct NyLPC_TIPv4RxInfo** o_info,NyLPC_TUInt32 i_wait_msec);
-/**
- * 受信バッファを次のバッファまでシークします。
- */
-void NyLPC_cUdpSocket_pseek(NyLPC_TcUdpSocket_t* i_inst);
-
-/**
- * 送信バッファを割り当てて返します。
- * 割り当てたメモリは、releaseSendBuf関数か、psend関数を成功させて開放する必要があります。
- * @param i_hint
- * 取得したいメモリサイズをセットします。
- * 関数は要求サイズより小さいメモリを返すことがあります。
- */
-void* NyLPC_cUdpSocket_allocSendBuf(NyLPC_TcUdpSocket_t* i_inst,NyLPC_TUInt16 i_hint,NyLPC_TUInt16* o_buf_size,NyLPC_TUInt32 i_wait_in_msec);
-
-void NyLPC_cUdpSocket_releaseSendBuf(NyLPC_TcUdpSocket_t* i_inst,void* i_buf_ptr);
-
-/**
- * 事前にAllocしたTxパケットを送信します。
- * このAPIはゼロコピー送信をサポートするためのものです。
- * @param i_buf_ptr
- * allocSendBufで取得したメモリを指定します。
- * @return
- * 関数が失敗した場合、i_buf_ptrは「開放されません。」
- */
-NyLPC_TBool NyLPC_cUdpSocket_psend(NyLPC_TcUdpSocket_t* i_inst,const struct NyLPC_TIPv4Addr* i_addr,NyLPC_TUInt16 i_port,void* i_buf_ptr,int i_len);
-
-/**
- * 最大送信サイズは1200バイトです。
- */
-NyLPC_TInt32 NyLPC_cUdpSocket_send(NyLPC_TcUdpSocket_t* i_inst,const struct NyLPC_TIPv4Addr* i_addr,NyLPC_TUInt16 i_port,const void* i_buf_ptr,NyLPC_TInt32 i_len,NyLPC_TUInt32 i_wait_in_msec);
-
-/**
- * 非同期パケットハンドラを設定する。
- */
-#define NyLPC_cUdpSocket_setOnRxHandler(i_inst,i_handler) (i_inst)->as_handler.rx=i_handler;
-
-/**
- * 非同期タイマ呼び出しハンドラを設定する。
- */
-#define NyLPC_cUdpSocket_setOnPeriodicHandler(i_inst,i_handler) (i_inst)->as_handler.periodic=i_handler;
-
-/**
- * ソケットのローカルIPのアドレスを返す。
- * 値はuipが動作中のみ有効。
- */
-#define NyLPC_cUdpSocket_getSockIP(i_inst) (&(i_inst)->uip_udp_conn.lipaddr)
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
-
-#endif /* NYLPC_CUDPSOCKET_H_ */