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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

チュートリアル

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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Tutorial

Committer:
nyatla
Date:
Wed Nov 19 14:45:17 2014 +0000
Revision:
109:18f12ac01097
Parent:
58:03b89038b21a
new MiMicIP API;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 57:bc4330dfa62f 1 /*
nyatla 57:bc4330dfa62f 2 * NyLPC_cHttpClient.h
nyatla 57:bc4330dfa62f 3 *
nyatla 57:bc4330dfa62f 4 * Created on: 2013/08/24
nyatla 57:bc4330dfa62f 5 * Author: nyatla
nyatla 57:bc4330dfa62f 6 */
nyatla 57:bc4330dfa62f 7
nyatla 57:bc4330dfa62f 8 #ifndef NYLPC_CHTTPCLIENT_H_
nyatla 57:bc4330dfa62f 9 #define NYLPC_CHTTPCLIENT_H_
nyatla 57:bc4330dfa62f 10
nyatla 57:bc4330dfa62f 11 #include "NyLPC_stdlib.h"
nyatla 57:bc4330dfa62f 12 #include "NyLPC_net.h"
nyatla 57:bc4330dfa62f 13 #include "NyLPC_http.h"
nyatla 109:18f12ac01097 14 #include "NyLPC_netif.h"
nyatla 57:bc4330dfa62f 15
nyatla 57:bc4330dfa62f 16 #ifdef __cplusplus
nyatla 57:bc4330dfa62f 17 extern "C" {
nyatla 57:bc4330dfa62f 18 #endif /* __cplusplus */
nyatla 57:bc4330dfa62f 19
nyatla 57:bc4330dfa62f 20 typedef struct NyLPC_TcHttpClient NyLPC_TcHttpClient_t;
nyatla 57:bc4330dfa62f 21
nyatla 57:bc4330dfa62f 22 #define NyLPC_cHttpHeaderWriter_CONTENT_LENGTH_UNLIMITED 0xffffffff
nyatla 57:bc4330dfa62f 23 struct NyLPC_TcHttpClient
nyatla 57:bc4330dfa62f 24 {
nyatla 57:bc4330dfa62f 25 NyLPC_TUInt8 _state;
nyatla 57:bc4330dfa62f 26 NyLPC_TUInt8 _padding1;
nyatla 109:18f12ac01097 27 NyLPC_TiTcpSocket_t* _sock;
nyatla 57:bc4330dfa62f 28 NyLPC_TcHttpStream_t _stream;
nyatla 57:bc4330dfa62f 29 union{
nyatla 57:bc4330dfa62f 30 NyLPC_TcHttpHeaderWriter_t head_writer;
nyatla 57:bc4330dfa62f 31 NyLPC_TcHttpBodyWriter_t body_writer;
nyatla 57:bc4330dfa62f 32 NyLPC_TcHttpBasicHeaderParser_t head_parser;
nyatla 57:bc4330dfa62f 33 NyLPC_TcHttpBodyParser_t body_parser;
nyatla 57:bc4330dfa62f 34 }pw;
nyatla 57:bc4330dfa62f 35 };
nyatla 57:bc4330dfa62f 36
nyatla 57:bc4330dfa62f 37
nyatla 109:18f12ac01097 38 NyLPC_TBool NyLPC_cHttpClient_initialize(NyLPC_TcHttpClient_t* i_inst,void* i_rx_buf,NyLPC_TUInt16 i_rx_size);
nyatla 57:bc4330dfa62f 39
nyatla 57:bc4330dfa62f 40 void NyLPC_cHttpClient_finalize(NyLPC_TcHttpClient_t* i_inst);
nyatla 57:bc4330dfa62f 41
nyatla 57:bc4330dfa62f 42 /**
nyatla 57:bc4330dfa62f 43 * サーバとの接続を切断する。
nyatla 57:bc4330dfa62f 44 * ステータスはCLOSEDになる。
nyatla 57:bc4330dfa62f 45 */
nyatla 57:bc4330dfa62f 46 void NyLPC_cHttpClient_close(NyLPC_TcHttpClient_t* i_inst);
nyatla 57:bc4330dfa62f 47
nyatla 57:bc4330dfa62f 48
nyatla 57:bc4330dfa62f 49 /**
nyatla 57:bc4330dfa62f 50 * サーバに接続する。
nyatla 57:bc4330dfa62f 51 * 関数はステータスをIDLEへ遷移する。
nyatla 57:bc4330dfa62f 52 * インスタンスのステータスは何でも構わない。
nyatla 57:bc4330dfa62f 53 * @return
nyatla 57:bc4330dfa62f 54 * TRUE - ステータスはIDLEへ遷移する。
nyatla 57:bc4330dfa62f 55 * FALSE - ステータスはCLOSEDへ遷移する。
nyatla 57:bc4330dfa62f 56 */
nyatla 58:03b89038b21a 57 NyLPC_TBool NyLPC_cHttpClient_connect(NyLPC_TcHttpClient_t* i_inst,const struct NyLPC_TIPv4Addr* i_addr,NyLPC_TUInt16 i_port);
nyatla 57:bc4330dfa62f 58
nyatla 57:bc4330dfa62f 59
nyatla 57:bc4330dfa62f 60
nyatla 57:bc4330dfa62f 61 /**
nyatla 57:bc4330dfa62f 62 * POSTリクエストを送信する。
nyatla 57:bc4330dfa62f 63 * ステータスはIDLEである必要がある。
nyatla 57:bc4330dfa62f 64 * @param i_content_length
nyatla 57:bc4330dfa62f 65 * 送信bodyのサイズ。最大 0xfffffffe
nyatla 57:bc4330dfa62f 66 * NyLPC_cHttpHeaderWriter_CONTENT_LENGTH_UNLIMITEDの場合はChunked転送になる。
nyatla 57:bc4330dfa62f 67 * @return
nyatla 57:bc4330dfa62f 68 * 引き続き処理が可能かを返す。
nyatla 57:bc4330dfa62f 69 * TRUE - 成功。ステータスはSEND_REQ_BODYになる。write/getStatusを呼び出せる。
nyatla 57:bc4330dfa62f 70 * FALSE - 失敗。ステータスはCLOSEDになる。
nyatla 57:bc4330dfa62f 71 */
nyatla 57:bc4330dfa62f 72 NyLPC_TBool NyLPC_cHttpClient_sendMethod(
nyatla 57:bc4330dfa62f 73 NyLPC_TcHttpClient_t* i_inst,
nyatla 57:bc4330dfa62f 74 NyLPC_THttpMethodType i_method,
nyatla 57:bc4330dfa62f 75 const NyLPC_TChar* i_path,
nyatla 57:bc4330dfa62f 76 NyLPC_TUInt32 i_content_length,
nyatla 57:bc4330dfa62f 77 const NyLPC_TChar* i_mime_type,
nyatla 57:bc4330dfa62f 78 const NyLPC_TChar* i_additional_header);
nyatla 57:bc4330dfa62f 79
nyatla 57:bc4330dfa62f 80
nyatla 57:bc4330dfa62f 81 /**
nyatla 57:bc4330dfa62f 82 * POSTリクエストのデータを送信する。
nyatla 57:bc4330dfa62f 83 * ステータスはSEND_REQ_BODYである必要がある。
nyatla 57:bc4330dfa62f 84 * @return
nyatla 57:bc4330dfa62f 85 * TRUE - 成功。
nyatla 57:bc4330dfa62f 86 * FALSE - 失敗。ステータスはCLOSEDになる。
nyatla 57:bc4330dfa62f 87 */
nyatla 58:03b89038b21a 88 NyLPC_TBool NyLPC_cHttpClient_write(NyLPC_TcHttpClient_t* i_inst,const void* i_buf,NyLPC_TUInt32 i_buf_size);
nyatla 57:bc4330dfa62f 89
nyatla 57:bc4330dfa62f 90 /**
nyatla 57:bc4330dfa62f 91 * 書式文字列としてPOSTリクエストのデータを送信する。
nyatla 57:bc4330dfa62f 92 * ステータスはSEND_REQ_BODYである必要がある。
nyatla 57:bc4330dfa62f 93 * @param i_fmt
nyatla 57:bc4330dfa62f 94 * printfライクなフォーマット文字列
nyatla 57:bc4330dfa62f 95 * @return
nyatla 57:bc4330dfa62f 96 * TRUE - 成功。
nyatla 57:bc4330dfa62f 97 * FALSE - 失敗。ステータスはCLOSEDになる。
nyatla 57:bc4330dfa62f 98 */
nyatla 57:bc4330dfa62f 99 NyLPC_TBool NyLPC_cHttpClient_writeFormat(NyLPC_TcHttpClient_t* i_inst,const NyLPC_TChar* i_fmt,...);
nyatla 57:bc4330dfa62f 100 NyLPC_TBool NyLPC_cHttpClient_writeFormatV(NyLPC_TcHttpClient_t* i_inst,const NyLPC_TChar* i_fmt,va_list i_args);
nyatla 57:bc4330dfa62f 101
nyatla 57:bc4330dfa62f 102 /**
nyatla 57:bc4330dfa62f 103 * ステータスコードを返す。
nyatla 57:bc4330dfa62f 104 * ステータスはSEND_REQ_BODYである必要がある。
nyatla 57:bc4330dfa62f 105 * @return
nyatla 57:bc4330dfa62f 106 * 0 - 失敗。ステータスはCLOSEDになる。
nyatla 57:bc4330dfa62f 107 * その他 - ステータスコード。ステータスはRECV_RES_BODYになる。
nyatla 57:bc4330dfa62f 108 */
nyatla 57:bc4330dfa62f 109 NyLPC_TUInt16 NyLPC_cHttpClient_getStatus(NyLPC_TcHttpClient_t* i_inst);
nyatla 57:bc4330dfa62f 110
nyatla 57:bc4330dfa62f 111
nyatla 57:bc4330dfa62f 112 /**
nyatla 57:bc4330dfa62f 113 * GET/POSTリクエストで受信したデータを読み出す。
nyatla 57:bc4330dfa62f 114 * ステータスはRECV_RES_BODYである必要がある。
nyatla 57:bc4330dfa62f 115 * @param o_read_len
nyatla 57:bc4330dfa62f 116 * 戻り値TRUEの場合のみ有効。データ終端に達した場合は0になる。
nyatla 57:bc4330dfa62f 117 * @return
nyatla 57:bc4330dfa62f 118 * TRUE:正常読み出し。o_read_lenの値で終端判定
nyatla 57:bc4330dfa62f 119 * FALSE:失敗。コネクションはクローズされる。
nyatla 57:bc4330dfa62f 120 */
nyatla 57:bc4330dfa62f 121 NyLPC_TBool NyLPC_cHttpClient_read(NyLPC_TcHttpClient_t* i_inst,void* i_buf,NyLPC_TUInt32 i_buf_size,NyLPC_TInt16* o_read_len);
nyatla 57:bc4330dfa62f 122
nyatla 57:bc4330dfa62f 123
nyatla 57:bc4330dfa62f 124
nyatla 57:bc4330dfa62f 125
nyatla 57:bc4330dfa62f 126
nyatla 57:bc4330dfa62f 127
nyatla 57:bc4330dfa62f 128 #ifdef __cplusplus
nyatla 57:bc4330dfa62f 129 }
nyatla 57:bc4330dfa62f 130 #endif /* __cplusplus */
nyatla 57:bc4330dfa62f 131
nyatla 57:bc4330dfa62f 132 #endif /* NYLPC_CHTTPCLIENT_H_ */
nyatla 57:bc4330dfa62f 133