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/uip/NyLPC_cUdpSocket_protected.h@69:8c5f220441f5, 2014-05-29 (annotated)

Committer:
nyatla
Date:
Thu May 29 14:29:15 2014 +0000
Revision:
69:8c5f220441f5
Parent:
37:fc4b4fd6a649 
r354????; LPC4088?????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 37:fc4b4fd6a649 1 /*
nyatla 37:fc4b4fd6a649 2 * NyLPC_cUdpSocket.h
nyatla 37:fc4b4fd6a649 3 *
nyatla 37:fc4b4fd6a649 4 * Created on: 2013/05/20
nyatla 37:fc4b4fd6a649 5 * Author: nyatla
nyatla 37:fc4b4fd6a649 6 */
nyatla 37:fc4b4fd6a649 7
nyatla 37:fc4b4fd6a649 8 #ifndef NYLPC_CUDPSOCKET_PROTECTED_H_
nyatla 37:fc4b4fd6a649 9 #define NYLPC_CUDPSOCKET_PROTECTED_H_
nyatla 37:fc4b4fd6a649 10 #include "NyLPC_cUdpSocket.h"
nyatla 37:fc4b4fd6a649 11 #include "NyLPC_cIPv4Payload.h"
nyatla 37:fc4b4fd6a649 12 #include "NyLPC_cIPv4Config.h"
nyatla 37:fc4b4fd6a649 13
nyatla 37:fc4b4fd6a649 14 #ifdef __cplusplus
nyatla 37:fc4b4fd6a649 15 extern "C" {
nyatla 37:fc4b4fd6a649 16 #endif /* __cplusplus */
nyatla 37:fc4b4fd6a649 17
nyatla 37:fc4b4fd6a649 18
nyatla 37:fc4b4fd6a649 19 /**
nyatla 37:fc4b4fd6a649 20 * この関数は、rxパケットを処理して、ソケットの状態を更新します。
nyatla 37:fc4b4fd6a649 21 * uipサービスタスクが実行する関数です。
nyatla 37:fc4b4fd6a649 22 */
nyatla 37:fc4b4fd6a649 23 NyLPC_TBool NyLPC_cUdpSocket_parseRx(
nyatla 37:fc4b4fd6a649 24 NyLPC_TcUdpSocket_t* i_inst,
nyatla 69:8c5f220441f5 25 const NyLPC_TcIPv4Payload_t* i_ipp);
nyatla 37:fc4b4fd6a649 26
nyatla 37:fc4b4fd6a649 27 /**
nyatla 37:fc4b4fd6a649 28 * uipサービスタスクが実行する関数です。
nyatla 37:fc4b4fd6a649 29 * サービスの開始を通知します。
nyatla 37:fc4b4fd6a649 30 * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。
nyatla 37:fc4b4fd6a649 31 */
nyatla 37:fc4b4fd6a649 32 void NyLPC_cUdpSocket_startService(NyLPC_TcUdpSocket_t* i_inst,const NyLPC_TcIPv4Config_t* i_config);
nyatla 37:fc4b4fd6a649 33
nyatla 37:fc4b4fd6a649 34 /**
nyatla 37:fc4b4fd6a649 35 * uipサービスタスクが実行する関数です。
nyatla 37:fc4b4fd6a649 36 * サービスの停止を通知します。
nyatla 37:fc4b4fd6a649 37 * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。
nyatla 37:fc4b4fd6a649 38 */
nyatla 37:fc4b4fd6a649 39 void NyLPC_cUdpSocket_stopService(NyLPC_TcUdpSocket_t* i_inst);
nyatla 37:fc4b4fd6a649 40
nyatla 37:fc4b4fd6a649 41
nyatla 37:fc4b4fd6a649 42 /**
nyatla 37:fc4b4fd6a649 43 * 定期的に実行する関数。最低でも1s単位で実行してください。
nyatla 37:fc4b4fd6a649 44 * uipサービスタスクが実行する関数です。
nyatla 37:fc4b4fd6a649 45 */
nyatla 37:fc4b4fd6a649 46 #define NyLPC_cUdpSocket_periodic(i_inst) if((i_inst)->as_handler.periodic!=NULL){(i_inst)->as_handler.periodic(i_inst);}
nyatla 37:fc4b4fd6a649 47
nyatla 37:fc4b4fd6a649 48 #ifdef __cplusplus
nyatla 37:fc4b4fd6a649 49 }
nyatla 37:fc4b4fd6a649 50 #endif /* __cplusplus */
nyatla 37:fc4b4fd6a649 51
nyatla 37:fc4b4fd6a649 52
nyatla 37:fc4b4fd6a649 53 #endif /* NYLPC_CUDPSOCKET_H_ */