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/ModLocalFileSystem.h@111:f525c6e5e27b, 2015-03-16 (annotated)

Committer:
nyatla
Date:
Mon Mar 16 14:19:16 2015 +0000
Revision:
111:f525c6e5e27b
Parent:
48:00d211aac2ec 
ModLocalfilesystem; ; Add virtual directory option.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 7:2b33a8d84eb3 1 #pragma once
nyatla 7:2b33a8d84eb3 2 ////////////////////////////////////////////////////////////////////////////////
nyatla 7:2b33a8d84eb3 3 // ModRomFiles.h
nyatla 7:2b33a8d84eb3 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 7:2b33a8d84eb3 5
nyatla 7:2b33a8d84eb3 6 #include "NyLPC_net.h"
nyatla 7:2b33a8d84eb3 7 #include "ModBaseClass.h"
nyatla 7:2b33a8d84eb3 8
nyatla 7:2b33a8d84eb3 9
nyatla 7:2b33a8d84eb3 10 namespace MiMic
nyatla 7:2b33a8d84eb3 11 {
nyatla 7:2b33a8d84eb3 12 class HttpdConnection;
nyatla 7:2b33a8d84eb3 13
nyatla 7:2b33a8d84eb3 14 /**
nyatla 7:2b33a8d84eb3 15 * This class is httpd module.
nyatla 7:2b33a8d84eb3 16 * The class provide files on mbed LocalFile System.
nyatla 14:4618692ec239 17 * The class provide 2 services.
nyatla 14:4618692ec239 18 * <ul>
nyatla 14:4618692ec239 19 * <li>lfile content provider.</li>
nyatla 14:4618692ec239 20 * This is response of local file path. for example "/local/file.txt". full content of file.
nyatla 14:4618692ec239 21 * <li>file list provider</li>
nyatla 14:4618692ec239 22 * This is array of json response. for example, "/local/"
nyatla 14:4618692ec239 23 * [{name:"name",size:"size",type:"type"}]
nyatla 14:4618692ec239 24 * </ul>
nyatla 7:2b33a8d84eb3 25 */
nyatla 7:2b33a8d84eb3 26 class ModLocalFileSystem:ModBaseClass
nyatla 7:2b33a8d84eb3 27 {
nyatla 48:00d211aac2ec 28 private:
nyatla 48:00d211aac2ec 29 /** file system type*/
nyatla 48:00d211aac2ec 30 unsigned char _fs_type;
nyatla 111:f525c6e5e27b 31 /** ルートディレクトリのプレフィクス "/pathname/" 表記*/
nyatla 111:f525c6e5e27b 32 const char* _root_alias;
nyatla 111:f525c6e5e27b 33 private:
nyatla 111:f525c6e5e27b 34 void retFile(char* i_buf,HttpdConnection& i_connection);
nyatla 111:f525c6e5e27b 35 void retDirHtml(const char* i_buf,HttpdConnection& i_connection,unsigned char i_fs_type);
nyatla 111:f525c6e5e27b 36 void retDirJson(const char* buf,HttpdConnection& i_connection,unsigned char i_fs_type);
nyatla 111:f525c6e5e27b 37
nyatla 7:2b33a8d84eb3 38 public:
nyatla 48:00d211aac2ec 39 const static unsigned char FST_DEFAULT=0x00;
nyatla 48:00d211aac2ec 40 const static unsigned char FST_SDFATFS=0x01;
nyatla 48:00d211aac2ec 41 public:
nyatla 48:00d211aac2ec 42 /**
nyatla 111:f525c6e5e27b 43 * Create filesistem responder.
nyatla 48:00d211aac2ec 44 * @param i_fs_type
nyatla 48:00d211aac2ec 45 * Filesystem type.
nyatla 48:00d211aac2ec 46 * This value should match the file system type of mount point.
nyatla 48:00d211aac2ec 47 * <ul>
nyatla 48:00d211aac2ec 48 * <li>FST_DEFAULT - default filesystem(eg. mbed local.)</li>
nyatla 48:00d211aac2ec 49 * <li>FST_SDFATFS - for SD filesystem</li>
nyatla 48:00d211aac2ec 50 * </ul>
nyatla 48:00d211aac2ec 51 */
nyatla 48:00d211aac2ec 52 ModLocalFileSystem(const char* i_path,unsigned char i_fs_type=FST_DEFAULT);
nyatla 111:f525c6e5e27b 53 /**
nyatla 111:f525c6e5e27b 54 * 2nd constructor.
nyatla 111:f525c6e5e27b 55 * @param i_root_alias
nyatla 111:f525c6e5e27b 56 * Root path string. Handler replaces the accepted URL prefix in the root path.
nyatla 111:f525c6e5e27b 57 * ex. '/' or '/virtual_path/',
nyatla 111:f525c6e5e27b 58 */
nyatla 111:f525c6e5e27b 59 ModLocalFileSystem(const char* i_path,const char* i_root_alias,unsigned char i_fs_type=FST_DEFAULT);
nyatla 111:f525c6e5e27b 60 /**
nyatla 111:f525c6e5e27b 61 * 3rd donstructor.
nyatla 111:f525c6e5e27b 62 * Must be call setParam method before call execute.
nyatla 111:f525c6e5e27b 63 */
nyatla 7:2b33a8d84eb3 64 ModLocalFileSystem();
nyatla 7:2b33a8d84eb3 65 virtual ~ModLocalFileSystem();
nyatla 48:00d211aac2ec 66 void setParam(const char* i_path,unsigned char i_fs_type=FST_DEFAULT);
nyatla 111:f525c6e5e27b 67 void setParam(const char* i_path,const char* i_root_alias,unsigned char i_fs_type=FST_DEFAULT);
nyatla 111:f525c6e5e27b 68 virtual bool canHandle(HttpdConnection& i_connection);
nyatla 111:f525c6e5e27b 69
nyatla 7:2b33a8d84eb3 70 bool execute(HttpdConnection& i_connection);
nyatla 7:2b33a8d84eb3 71 };
nyatla 7:2b33a8d84eb3 72
nyatla 7:2b33a8d84eb3 73 }