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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 5:6d67db3875cb 1 #pragma once
nyatla 5:6d67db3875cb 2 ////////////////////////////////////////////////////////////////////////////////
nyatla 5:6d67db3875cb 3 // ModRomFiles.h
nyatla 5:6d67db3875cb 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 5:6d67db3875cb 5
nyatla 5:6d67db3875cb 6 #include "NyLPC_net.h"
nyatla 5:6d67db3875cb 7
nyatla 5:6d67db3875cb 8
nyatla 5:6d67db3875cb 9 namespace MiMic
nyatla 5:6d67db3875cb 10 {
nyatla 5:6d67db3875cb 11 class HttpdConnection;
nyatla 5:6d67db3875cb 12 /**
nyatla 5:6d67db3875cb 13 * This class is a module for Httpd.
nyatla 5:6d67db3875cb 14 * The class parses a request path to buffer from connection.
nyatla 5:6d67db3875cb 15 */
nyatla 5:6d67db3875cb 16 class ModUrl
nyatla 5:6d67db3875cb 17 {
nyatla 5:6d67db3875cb 18 private:
nyatla 5:6d67db3875cb 19 int _method_type;
nyatla 5:6d67db3875cb 20 public:
nyatla 5:6d67db3875cb 21 const static int METHOD_GET =NyLPC_THttpMethodType_GET;
nyatla 5:6d67db3875cb 22 const static int METHOD_HEAD=NyLPC_THttpMethodType_HEAD;
nyatla 5:6d67db3875cb 23 const static int METHOD_POST=NyLPC_THttpMethodType_POST;
nyatla 5:6d67db3875cb 24 public:
nyatla 5:6d67db3875cb 25 /**
nyatla 5:6d67db3875cb 26 * Constructor.
nyatla 5:6d67db3875cb 27 */
nyatla 5:6d67db3875cb 28 ModUrl();
nyatla 5:6d67db3875cb 29 virtual ~ModUrl();
nyatla 5:6d67db3875cb 30
nyatla 5:6d67db3875cb 31 /**
nyatla 5:6d67db3875cb 32 * This function processes a request.
nyatla 5:6d67db3875cb 33 * @param i_connection
nyatla 5:6d67db3875cb 34 * @param o_url_buf
nyatla 5:6d67db3875cb 35 * Output parametor.
nyatla 5:6d67db3875cb 36 * Address of buffer which accept URL string.
nyatla 5:6d67db3875cb 37 * The string will be "" (zero text) if URL too long or parsing failed.
nyatla 5:6d67db3875cb 38 * @param i_buf_len
nyatla 5:6d67db3875cb 39 * Size of o_url buffer in byte.
nyatla 5:6d67db3875cb 40 * @param o_method_type
nyatla 5:6d67db3875cb 41 * Address of variable which accept HTTP-Method type.
nyatla 5:6d67db3875cb 42 * Can be omitted.
nyatla 5:6d67db3875cb 43 * @return
nyatla 5:6d67db3875cb 44 * TRUE if request was processed. otherwise FALSE.
nyatla 5:6d67db3875cb 45 * The value describes processing status. It is not parsing error status.
nyatla 5:6d67db3875cb 46 */
nyatla 5:6d67db3875cb 47 bool execute(HttpdConnection& i_connection,char* o_url_buf,int i_buf_len,int* o_method_type=NULL);
nyatla 5:6d67db3875cb 48 };
nyatla 5:6d67db3875cb 49
nyatla 5:6d67db3875cb 50 }