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

Committer:
nyatla
Date:
Sat Jun 04 06:51:04 2016 +0000
Revision:
114:f6aef16d4e60
Parent:
62:8be8c5924c3e 
include????????; ???????????

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 // HttpClient.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 class HttpClient
nyatla 58:03b89038b21a 12 {
nyatla 58:03b89038b21a 13 private:
nyatla 58:03b89038b21a 14 void* _private_tcp_rx_buf;
nyatla 58:03b89038b21a 15 protected:
nyatla 58:03b89038b21a 16 NyLPC_TcHttpClient_t _inst;
nyatla 58:03b89038b21a 17 public:
nyatla 58:03b89038b21a 18 const static NyLPC_THttpMethodType HTTP_GET=NyLPC_THttpMethodType_GET;
nyatla 58:03b89038b21a 19 const static NyLPC_THttpMethodType HTTP_POST=NyLPC_THttpMethodType_POST;
nyatla 58:03b89038b21a 20 const static NyLPC_THttpMethodType HTTP_HEAD=NyLPC_THttpMethodType_HEAD;
nyatla 58:03b89038b21a 21 const static unsigned int CONTENT_CHUNKED=NyLPC_cHttpHeaderWriter_CONTENT_LENGTH_UNLIMITED;
nyatla 58:03b89038b21a 22
nyatla 58:03b89038b21a 23 public:
nyatla 58:03b89038b21a 24 HttpClient();
nyatla 58:03b89038b21a 25 virtual ~HttpClient();
nyatla 58:03b89038b21a 26 public:
nyatla 58:03b89038b21a 27 bool connect(const IpAddr& i_host,unsigned short i_port);
nyatla 58:03b89038b21a 28 /**
nyatla 58:03b89038b21a 29 * This function sends a request to server and prevent to accept status code.
nyatla 58:03b89038b21a 30 * Must call getStatus after successful.
nyatla 58:03b89038b21a 31 * If request has content body(i_content_length!=0), call writeX function to send request body in before to call getStatus
nyatla 58:03b89038b21a 32 * @param i_content_length
nyatla 58:03b89038b21a 33 * size of request body.
nyatla 58:03b89038b21a 34 * Specify CONTENT_CHUNKED if the size is unknown.
nyatla 58:03b89038b21a 35 * @return
nyatla 58:03b89038b21a 36 * true if successful,
nyatla 58:03b89038b21a 37 * otherwise error. Connection is closed.
nyatla 58:03b89038b21a 38 * @example
nyatla 58:03b89038b21a 39 * <code>
nyatla 58:03b89038b21a 40 * //GET
nyatla 58:03b89038b21a 41 * </code>
nyatla 58:03b89038b21a 42 * <code>
nyatla 58:03b89038b21a 43 * //POST
nyatla 58:03b89038b21a 44 *
nyatla 58:03b89038b21a 45 * </code>
nyatla 58:03b89038b21a 46 */
nyatla 58:03b89038b21a 47 bool sendMethod(NyLPC_THttpMethodType i_method,const char* i_path,int i_content_length=0,const char* i_mimetype=NULL,const char* i_additional_header=NULL);
nyatla 58:03b89038b21a 48 /**
nyatla 58:03b89038b21a 49 * This function returns status code.
nyatla 58:03b89038b21a 50 * Must call after the sendMethod was successful.
nyatla 58:03b89038b21a 51 * @return
nyatla 58:03b89038b21a 52 * Error:0,otherwise HTTP status code.
nyatla 58:03b89038b21a 53 */
nyatla 58:03b89038b21a 54 int getStatus();
nyatla 58:03b89038b21a 55 /**
nyatla 58:03b89038b21a 56 * Close current connection.
nyatla 58:03b89038b21a 57 */
nyatla 58:03b89038b21a 58 void close();
nyatla 58:03b89038b21a 59 /**
nyatla 58:03b89038b21a 60 * Read request body from http stream.
nyatla 58:03b89038b21a 61 * This function must be call repeatedly until the end of the stream or an error.
nyatla 58:03b89038b21a 62 * @param i_rx_buf
nyatla 58:03b89038b21a 63 * A buffer which accepts received data.
nyatla 58:03b89038b21a 64 * @param i_rx_buf_len
nyatla 58:03b89038b21a 65 * size of i_rx_buf in byte.
nyatla 58:03b89038b21a 66 * @param i_read_len
nyatla 58:03b89038b21a 67 * pointer to variable which accept received data size in byte.
nyatla 58:03b89038b21a 68 * It is enabled in retrurn true.
nyatla 58:03b89038b21a 69 * n>0 is datasize. n==0 is end of stream.
nyatla 58:03b89038b21a 70 * @return
nyatla 58:03b89038b21a 71 * true if successful,otherwise false
nyatla 58:03b89038b21a 72 */
nyatla 62:8be8c5924c3e 73 bool read(void* i_rx_buf,int i_rx_buf_len,short &i_read_len);
nyatla 58:03b89038b21a 74 /**
nyatla 58:03b89038b21a 75 * Write request body to connected http stream.
nyatla 58:03b89038b21a 76 * This function must be call repeatedly until the end of the request content or an error.
nyatla 58:03b89038b21a 77 * Transmission of the request body is completed by to call the AAA in the case of chunked transfer.
nyatla 58:03b89038b21a 78 * @param i_tx_buf
nyatla 58:03b89038b21a 79 * @param i_tx_len
nyatla 58:03b89038b21a 80 * @return
nyatla 58:03b89038b21a 81 * true if successful.
nyatla 58:03b89038b21a 82 */
nyatla 58:03b89038b21a 83 bool write(const void* i_tx_buf,int i_tx_len);
nyatla 58:03b89038b21a 84 };
nyatla 58:03b89038b21a 85 }