Ryo Iizuka / libMiMic

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.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

チュートリアル

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.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

Tutorial

core/netif/mimicip/NyLPC_cMiMicIpUdpSocket.h@109:18f12ac01097, 2014-11-19 (annotated)

Committer:
nyatla
Date:
Wed Nov 19 14:45:17 2014 +0000
Revision:
109:18f12ac01097
Child:
110:257739f9b31e
new MiMicIP API;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 109:18f12ac01097 1 /*
nyatla 109:18f12ac01097 2 * NyLPC_cUdpSocket.h
nyatla 109:18f12ac01097 3 *
nyatla 109:18f12ac01097 4 * Created on: 2013/05/20
nyatla 109:18f12ac01097 5 * Author: nyatla
nyatla 109:18f12ac01097 6 */
nyatla 109:18f12ac01097 7
nyatla 109:18f12ac01097 8 #ifndef NYLPC_CMIMICIPUDPSOCKET_H_
nyatla 109:18f12ac01097 9 #define NYLPC_CMIMICIPUDPSOCKET_H_
nyatla 109:18f12ac01097 10
nyatla 109:18f12ac01097 11 #include "NyLPC_os.h"
nyatla 109:18f12ac01097 12 #include "NyLPC_cMiMicIpBaseSocket.h"
nyatla 109:18f12ac01097 13 #include "../NyLPC_iUdpSocket.h"
nyatla 109:18f12ac01097 14
nyatla 109:18f12ac01097 15
nyatla 109:18f12ac01097 16 #ifdef __cplusplus
nyatla 109:18f12ac01097 17 extern "C" {
nyatla 109:18f12ac01097 18 #endif /* __cplusplus */
nyatla 109:18f12ac01097 19
nyatla 109:18f12ac01097 20 #define NyLPC_TcMiMicIpUdpSocket_MAX_UDP_SOCKET 1
nyatla 109:18f12ac01097 21
nyatla 109:18f12ac01097 22 /**
nyatla 109:18f12ac01097 23 * Class struct
nyatla 109:18f12ac01097 24 */
nyatla 109:18f12ac01097 25 typedef struct NyLPC_TcMiMicIpUdpSocket NyLPC_TcMiMicIpUdpSocket_t;
nyatla 109:18f12ac01097 26
nyatla 109:18f12ac01097 27
nyatla 109:18f12ac01097 28 /**
nyatla 109:18f12ac01097 29 * 受信時に非同期にコールされるハンドラ
nyatla 109:18f12ac01097 30 * UIPサービスタスクが実行する。
nyatla 109:18f12ac01097 31 * @return
nyatla 109:18f12ac01097 32 * TRUEならパケットを受信キューへ追加する。FALSEならパケットを受信キューへ追加しない。
nyatla 109:18f12ac01097 33 */
nyatla 109:18f12ac01097 34 typedef NyLPC_TBool (*NyLPC_TcMiMicIpUdpSocket_onRxHandler)(NyLPC_TiUdpSocket_t* i_inst,const void* i_buf,const struct NyLPC_TIPv4RxInfo* i_info);
nyatla 109:18f12ac01097 35
nyatla 109:18f12ac01097 36 /**
nyatla 109:18f12ac01097 37 * 一定周期で非同期にコールされるハンドラ。
nyatla 109:18f12ac01097 38 * UIPサービスタスクが実行する。
nyatla 109:18f12ac01097 39 */
nyatla 109:18f12ac01097 40 typedef void (*NyLPC_TcMiMicIpUdpSocket_onPeriodicHandler)(NyLPC_TiUdpSocket_t* i_inst);
nyatla 109:18f12ac01097 41
nyatla 109:18f12ac01097 42 /**
nyatla 109:18f12ac01097 43 * Representation of a uIP UDP connection.
nyatla 109:18f12ac01097 44 */
nyatla 109:18f12ac01097 45 struct uip_udp_conn{
nyatla 109:18f12ac01097 46 struct NyLPC_TIPv4Addr lipaddr; /**< The IP address of the remote peer. */
nyatla 109:18f12ac01097 47 /** マルチキャスとアドレス(ZEROで無効)*/
nyatla 109:18f12ac01097 48 struct NyLPC_TIPv4Addr mcastaddr;
nyatla 109:18f12ac01097 49 NyLPC_TUInt16 lport; /**< The local port number in network byte order. */
nyatla 109:18f12ac01097 50 NyLPC_TUInt8 flags; /**フラグ*/
nyatla 109:18f12ac01097 51 NyLPC_TUInt8 padding; /***/
nyatla 109:18f12ac01097 52 };
nyatla 109:18f12ac01097 53
nyatla 109:18f12ac01097 54
nyatla 109:18f12ac01097 55
nyatla 109:18f12ac01097 56
nyatla 109:18f12ac01097 57 struct NyLPC_TcMiMicIpUdpSocket
nyatla 109:18f12ac01097 58 {
nyatla 109:18f12ac01097 59 NyLPC_TcMiMicIpBaseSocket_t _super;
nyatla 109:18f12ac01097 60 //この変数は、uipタスクの実行する関数のみが変更する。
nyatla 109:18f12ac01097 61 struct uip_udp_conn uip_udp_conn;
nyatla 109:18f12ac01097 62 NyLPC_TcFifoBuffer_t rxbuf;
nyatla 109:18f12ac01097 63 NyLPC_TcMutex_t* _smutex;
nyatla 109:18f12ac01097 64 struct{
nyatla 109:18f12ac01097 65 /**　受信ハンドラ。サービス実装に使用する。*/
nyatla 109:18f12ac01097 66 NyLPC_TcMiMicIpUdpSocket_onRxHandler rx;
nyatla 109:18f12ac01097 67 /** 定期実行ハンドラ。サービス実装に使用する。最低保障周期は1s*/
nyatla 109:18f12ac01097 68 NyLPC_TcMiMicIpUdpSocket_onPeriodicHandler periodic;
nyatla 109:18f12ac01097 69 }as_handler;
nyatla 109:18f12ac01097 70 };
nyatla 109:18f12ac01097 71
nyatla 109:18f12ac01097 72
nyatla 109:18f12ac01097 73
nyatla 109:18f12ac01097 74
nyatla 109:18f12ac01097 75
nyatla 109:18f12ac01097 76
nyatla 109:18f12ac01097 77 /**
nyatla 109:18f12ac01097 78 * @param i_rbuf
nyatla 109:18f12ac01097 79 * 受信バッファアアドレス。サイズは、(最大受信サイズ-4バイト)*キュー数で計算します。
nyatla 109:18f12ac01097 80 * @param i_rbuf_len
nyatla 109:18f12ac01097 81 * 受信バッファのサイズ。
nyatla 109:18f12ac01097 82 */
nyatla 109:18f12ac01097 83 NyLPC_TBool NyLPC_cMiMicIpUdpSocket_initialize(NyLPC_TcMiMicIpUdpSocket_t* i_inst,NyLPC_TUInt16 i_port,void* i_rbuf,NyLPC_TUInt16 i_rbuf_len);
nyatla 109:18f12ac01097 84 void NyLPC_cMiMicIpUdpSocket_finalize(NyLPC_TcMiMicIpUdpSocket_t* i_inst);
nyatla 109:18f12ac01097 85
nyatla 109:18f12ac01097 86
nyatla 109:18f12ac01097 87 #ifdef __cplusplus
nyatla 109:18f12ac01097 88 }
nyatla 109:18f12ac01097 89 #endif /* __cplusplus */
nyatla 109:18f12ac01097 90
nyatla 109:18f12ac01097 91
nyatla 109:18f12ac01097 92 #endif /* NYLPC_CUDPSOCKET_H_ */
nyatla 109:18f12ac01097 93