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

mbed/UdpSocket.h@64:258e84040262, 2013-10-23 (annotated)

Committer:
nyatla
Date:
Wed Oct 23 04:49:08 2013 +0000
Revision:
64:258e84040262
Parent:
60:803de2088243
Child:
109:18f12ac01097
fix issue; http://mbed.org/users/nyatla/code/libMiMic/issues/1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 58:03b89038b21a 1 #pragma once
nyatla 58:03b89038b21a 2 ////////////////////////////////////////////////////////////////////////////////
nyatla 58:03b89038b21a 3 // UdpSocket.h
nyatla 58:03b89038b21a 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 58:03b89038b21a 5
nyatla 58:03b89038b21a 6 #include "NyLPC_net.h"
nyatla 58:03b89038b21a 7 #include "IpAddr.h"
nyatla 58:03b89038b21a 8
nyatla 58:03b89038b21a 9 namespace MiMic
nyatla 58:03b89038b21a 10 {
nyatla 58:03b89038b21a 11 /**
nyatla 58:03b89038b21a 12 * Udp Socket Class.
nyatla 58:03b89038b21a 13 * The class is used by Net constructor.
nyatla 58:03b89038b21a 14 */
nyatla 58:03b89038b21a 15 class UdpSocket
nyatla 58:03b89038b21a 16 {
nyatla 58:03b89038b21a 17 private:
nyatla 58:03b89038b21a 18 NyLPC_TcUdpSocket_t _inst;
nyatla 58:03b89038b21a 19 void* _private_rx;
nyatla 58:03b89038b21a 20 public:
nyatla 58:03b89038b21a 21 /** wrapped base LPC class.*/
nyatla 58:03b89038b21a 22 NyLPC_TcUdpSocket_t* refBaseInstance(){return &this->_inst;}
nyatla 58:03b89038b21a 23
nyatla 58:03b89038b21a 24 public:
nyatla 60:803de2088243 25 /**
nyatla 60:803de2088243 26 * @param i_port
nyatla 60:803de2088243 27 * port number.
nyatla 60:803de2088243 28 * @param i_rx_buf_size
nyatla 60:803de2088243 29 * Size of the receive memory to allocate on heap
nyatla 60:803de2088243 30 */
nyatla 58:03b89038b21a 31 UdpSocket(unsigned short i_port,unsigned short i_rx_buf_size=(unsigned short)512);
nyatla 60:803de2088243 32 /**
nyatla 60:803de2088243 33 * @param i_port
nyatla 60:803de2088243 34 * port number.
nyatla 60:803de2088243 35 * @param i_rx_buffer
nyatla 60:803de2088243 36 * allocated memory for receiving.
nyatla 60:803de2088243 37 * @param i_rx_buf_size
nyatla 60:803de2088243 38 * Size of the i_rx_buf
nyatla 60:803de2088243 39 */
nyatla 58:03b89038b21a 40 UdpSocket(unsigned short i_port,void* i_rx_buf,unsigned short i_rx_buf_size);
nyatla 58:03b89038b21a 41 /**
nyatla 58:03b89038b21a 42 * This constructor accepts "large" packet by asynchronous handler.
nyatla 58:03b89038b21a 43 * Must be override "onRxHandler" function.
nyatla 58:03b89038b21a 44 */
nyatla 58:03b89038b21a 45 UdpSocket(unsigned short i_port,void* i_rx_handler);
nyatla 58:03b89038b21a 46 virtual ~UdpSocket();
nyatla 58:03b89038b21a 47 /**
nyatla 58:03b89038b21a 48 * This function return recieved data and size.
nyatla 58:03b89038b21a 49 * The function sets the head of the oldest readable buffer.
nyatla 58:03b89038b21a 50 * A position is not changed until precvnext was called.
nyatla 58:03b89038b21a 51 * @param i_host_addr
nyatla 58:03b89038b21a 52 * must be IPv4 address format.
nyatla 58:03b89038b21a 53 */
nyatla 64:258e84040262 54 int precvFrom(const void* &i_rx,IpAddr* i_peer_host=NULL,unsigned short* i_port=NULL);
nyatla 64:258e84040262 55 int precvFrom(const char* &i_rx,IpAddr* i_peer_host=NULL,unsigned short* i_port=NULL);
nyatla 58:03b89038b21a 56 /**
nyatla 58:03b89038b21a 57 * This function moves rx buffer to next packet.
nyatla 58:03b89038b21a 58 */
nyatla 64:258e84040262 59 void precvNext(void);
nyatla 60:803de2088243 60 /**
nyatla 60:803de2088243 61 * true if precv has data.
nyatla 60:803de2088243 62 * This can avoid the block of precv.
nyatla 60:803de2088243 63 */
nyatla 60:803de2088243 64 bool canRecv();
nyatla 60:803de2088243 65
nyatla 58:03b89038b21a 66 bool sendTo(const IpAddr& i_host,unsigned short i_port,const void* i_tx,unsigned short i_tx_size);
nyatla 58:03b89038b21a 67 void joinMulticast(const IpAddr& i_host);
nyatla 58:03b89038b21a 68 void setBroadcast(void);
nyatla 58:03b89038b21a 69 };
nyatla 58:03b89038b21a 70 }
nyatla 58:03b89038b21a 71