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/HttpdConnection.h@114:f6aef16d4e60, 2016-06-04 (annotated)

Committer:
nyatla
Date:
Sat Jun 04 06:51:04 2016 +0000
Revision:
114:f6aef16d4e60
Parent:
81:e5e4f2264d24 
include????????; ???????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 3:0a94993be1f6 1 #pragma once
nyatla 3:0a94993be1f6 2 ////////////////////////////////////////////////////////////////////////////////
nyatla 4:909dc70956e7 3 // HttpdConnection.h
nyatla 3:0a94993be1f6 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 5
nyatla 3:0a94993be1f6 6 #include "NyLPC_net.h"
nyatla 3:0a94993be1f6 7 namespace MiMic
nyatla 3:0a94993be1f6 8 {
nyatla 3:0a94993be1f6 9 class HttpdConnection
nyatla 3:0a94993be1f6 10 {
nyatla 3:0a94993be1f6 11 public:
nyatla 3:0a94993be1f6 12 NyLPC_TcHttpdConnection* _ref_inst;
nyatla 4:909dc70956e7 13 HttpdConnection(NyLPC_TcHttpdConnection* i_ref_inst);
nyatla 18:1970fec78229 14 /**
nyatla 18:1970fec78229 15 * This function returns HTTP request type.
nyatla 18:1970fec78229 16 * See Http::MT_xxx constant value.
nyatla 18:1970fec78229 17 */
nyatla 18:1970fec78229 18 int getMethodType();
nyatla 18:1970fec78229 19
nyatla 18:1970fec78229 20 /**
nyatla 18:1970fec78229 21 * This function checks Method type if equal with i_method_type.
nyatla 18:1970fec78229 22 */
nyatla 18:1970fec78229 23 bool isMethodType(int i_method_type);
nyatla 4:909dc70956e7 24
nyatla 4:909dc70956e7 25 /**
nyatla 4:909dc70956e7 26 * This function send HTTP response header to connection.
nyatla 4:909dc70956e7 27 * The function is useful for unknown length content.
nyatla 4:909dc70956e7 28 * @param i_additional_header
nyatla 4:909dc70956e7 29 * Additional header text.
nyatla 4:909dc70956e7 30 * The text which was divided in CRLF and closed by CRLF.
nyatla 4:909dc70956e7 31 */
nyatla 4:909dc70956e7 32 bool sendHeader(unsigned short i_status_code,const char* i_content_type,const char* i_additional_header);
nyatla 4:909dc70956e7 33
nyatla 4:909dc70956e7 34 /**
nyatla 4:909dc70956e7 35 * This function send HTTP response header to connection.
nyatla 4:909dc70956e7 36 * The function is useful for known length content.
nyatla 4:909dc70956e7 37 */
nyatla 4:909dc70956e7 38 bool sendHeader(unsigned short i_status_code,const char* i_content_type,const char* i_additional_header,unsigned int i_length);
nyatla 4:909dc70956e7 39 /**
nyatla 43:a182f2b5ff41 40 * This function send HTTP error response with empty body.
nyatla 43:a182f2b5ff41 41 */
nyatla 43:a182f2b5ff41 42 bool sendError(unsigned short i_status_code);
nyatla 43:a182f2b5ff41 43
nyatla 43:a182f2b5ff41 44 /**
nyatla 4:909dc70956e7 45 * This function send formated text to response.
nyatla 4:909dc70956e7 46 * The function can be repeatedly called until the end of contents.
nyatla 4:909dc70956e7 47 */
nyatla 4:909dc70956e7 48 bool sendBody(const void* i_data,NyLPC_TUInt32 i_size);
nyatla 4:909dc70956e7 49
nyatla 4:909dc70956e7 50 /**
nyatla 4:909dc70956e7 51 * The function send formated text to response.
nyatla 4:909dc70956e7 52 * The function can be repeatedly called until the end of contents.
nyatla 4:909dc70956e7 53 * @param i_fmt
nyatla 4:909dc70956e7 54 * printf like string
nyatla 4:909dc70956e7 55 * %% - '%' charactor ,%s - null terminated string ,%d - 32bit signed integer,%x - 32bit intager ,%u - 32bit unsigned integer ,%c - a charactor
nyatla 4:909dc70956e7 56 * @param ...
nyatla 4:909dc70956e7 57 *
nyatla 4:909dc70956e7 58 */
nyatla 7:2b33a8d84eb3 59 bool sendBodyF(const char* i_fmt,...);
nyatla 7:2b33a8d84eb3 60 /**
nyatla 7:2b33a8d84eb3 61 * The function gets httpd lock.
nyatla 7:2b33a8d84eb3 62 * This lock is the only lock in the Httpd.
nyatla 7:2b33a8d84eb3 63 * After call the function, must call unlock function by end of handler.
nyatla 7:2b33a8d84eb3 64 */
nyatla 7:2b33a8d84eb3 65 void lockHttpd();
nyatla 7:2b33a8d84eb3 66 /**
nyatla 7:2b33a8d84eb3 67 * The function releases the httpd lock.
nyatla 7:2b33a8d84eb3 68 */
nyatla 19:33b9ba0859ee 69 void unlockHttpd();
nyatla 81:e5e4f2264d24 70 /**
nyatla 81:e5e4f2264d24 71 * The function breaks the persist connection if it enabled.
nyatla 81:e5e4f2264d24 72 */
nyatla 81:e5e4f2264d24 73 void breakPersistentConnection();
nyatla 81:e5e4f2264d24 74
nyatla 3:0a94993be1f6 75 };
nyatla 3:0a94993be1f6 76 }