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/Httpd.h@45:63d6aa80e26d, 2013-07-11 (annotated)

Committer:
nyatla
Date:
Thu Jul 11 03:52:33 2013 +0000
Revision:
45:63d6aa80e26d
Parent:
19:33b9ba0859ee 
add Httpd::loopTask function;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 3:0a94993be1f6 1 #pragma once
nyatla 3:0a94993be1f6 2 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 3 // Httpd.h
nyatla 3:0a94993be1f6 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 5
nyatla 3:0a94993be1f6 6 #include "NyLPC_net.h"
nyatla 3:0a94993be1f6 7
nyatla 3:0a94993be1f6 8 namespace MiMic
nyatla 3:0a94993be1f6 9 {
nyatla 3:0a94993be1f6 10 class HttpdConnection;
nyatla 3:0a94993be1f6 11 class Httpd
nyatla 3:0a94993be1f6 12 {
nyatla 3:0a94993be1f6 13 private:
nyatla 3:0a94993be1f6 14 struct Httpd2{
nyatla 3:0a94993be1f6 15 NyLPC_TcHttpd_t super;
nyatla 3:0a94993be1f6 16 Httpd* _parent;
nyatla 3:0a94993be1f6 17 }_inst;
nyatla 3:0a94993be1f6 18 static void onRequestHandler(NyLPC_TcHttpdConnection_t* i_connection);
nyatla 45:63d6aa80e26d 19 static int taskHandler(void* i_param);
nyatla 3:0a94993be1f6 20 public:
nyatla 45:63d6aa80e26d 21 /**
nyatla 45:63d6aa80e26d 22 * This function create an instance with service port number.
nyatla 45:63d6aa80e26d 23 * @param i_port_number
nyatla 45:63d6aa80e26d 24 * HTTP service port number.
nyatla 45:63d6aa80e26d 25 */
nyatla 3:0a94993be1f6 26 Httpd(int i_port_number);
nyatla 3:0a94993be1f6 27 virtual ~Httpd();
nyatla 45:63d6aa80e26d 28 /**
nyatla 45:63d6aa80e26d 29 * This function starts HTTP listen loop on current task.
nyatla 45:63d6aa80e26d 30 * The function never return.
nyatla 45:63d6aa80e26d 31 * Must not use after called loopTask function.
nyatla 45:63d6aa80e26d 32 */
nyatla 3:0a94993be1f6 33 void loop();
nyatla 45:63d6aa80e26d 34 /**
nyatla 45:63d6aa80e26d 35 * This function starts HTTP listen loop on a new task.
nyatla 45:63d6aa80e26d 36 */
nyatla 45:63d6aa80e26d 37 void loopTask();
nyatla 45:63d6aa80e26d 38 /**
nyatla 45:63d6aa80e26d 39 * This function gets a lock.
nyatla 45:63d6aa80e26d 40 * This function is used for exclusive process in request handler or other task.
nyatla 45:63d6aa80e26d 41 */
nyatla 45:63d6aa80e26d 42 void lock();
nyatla 45:63d6aa80e26d 43 /**
nyatla 45:63d6aa80e26d 44 * This function releases a lock.
nyatla 45:63d6aa80e26d 45 */
nyatla 45:63d6aa80e26d 46 void unlock();
nyatla 45:63d6aa80e26d 47 /**
nyatla 45:63d6aa80e26d 48 * The handler function for HTTP request.
nyatla 45:63d6aa80e26d 49 * Must implement the function in extended class.
nyatla 45:63d6aa80e26d 50 * This is called when HTTPD received HTTP request.
nyatla 45:63d6aa80e26d 51 * The function may be call in multiple.
nyatla 45:63d6aa80e26d 52 * @param i_connection
nyatla 45:63d6aa80e26d 53 * HTTP connection object that contain "prefetched" HTTP stream.
nyatla 45:63d6aa80e26d 54 */
nyatla 3:0a94993be1f6 55 virtual void onRequest(HttpdConnection& i_connection)=0;
nyatla 19:33b9ba0859ee 56 public:
nyatla 19:33b9ba0859ee 57 const static int SIZE_OF_HTTP_BUF=512;
nyatla 19:33b9ba0859ee 58 /**
nyatla 45:63d6aa80e26d 59 * This buffer is a shared buffer for HTTPD modules.
nyatla 45:63d6aa80e26d 60 * It will be use for temporary buffer or work memory.
nyatla 45:63d6aa80e26d 61 * Must lock before using.
nyatla 19:33b9ba0859ee 62 */
nyatla 19:33b9ba0859ee 63 static char _shared_buf[SIZE_OF_HTTP_BUF];
nyatla 3:0a94993be1f6 64 };
nyatla 3:0a94993be1f6 65 }