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

core/net/mdns/NyLPC_cMDnsServer.h@109:18f12ac01097, 2014-11-19 (annotated)

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 37:fc4b4fd6a649 1 /*********************************************************************************
nyatla 37:fc4b4fd6a649 2 * PROJECT: MiMic
nyatla 37:fc4b4fd6a649 3 * --------------------------------------------------------------------------------
nyatla 37:fc4b4fd6a649 4 *
nyatla 37:fc4b4fd6a649 5 * This file is part of MiMic
nyatla 37:fc4b4fd6a649 6 * Copyright (C)2011 Ryo Iizuka
nyatla 37:fc4b4fd6a649 7 *
nyatla 37:fc4b4fd6a649 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 37:fc4b4fd6a649 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 37:fc4b4fd6a649 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 37:fc4b4fd6a649 11 * (at your option) any later version.
nyatla 37:fc4b4fd6a649 12 *
nyatla 37:fc4b4fd6a649 13 * This program is distributed in the hope that it will be useful,
nyatla 37:fc4b4fd6a649 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 37:fc4b4fd6a649 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 37:fc4b4fd6a649 16 * GNU General Public License for more details.
nyatla 37:fc4b4fd6a649 17 *
nyatla 37:fc4b4fd6a649 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 37:fc4b4fd6a649 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 37:fc4b4fd6a649 20 *
nyatla 37:fc4b4fd6a649 21 * For further information please contact.
nyatla 37:fc4b4fd6a649 22 * http://nyatla.jp/
nyatla 37:fc4b4fd6a649 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 37:fc4b4fd6a649 24 *
nyatla 37:fc4b4fd6a649 25 *********************************************************************************/
nyatla 37:fc4b4fd6a649 26 #ifndef NYLPC_CMDNSSERVER_H_
nyatla 37:fc4b4fd6a649 27 #define NYLPC_CMDNSSERVER_H_
nyatla 109:18f12ac01097 28 #include "NyLPC_netif.h"
nyatla 37:fc4b4fd6a649 29
nyatla 37:fc4b4fd6a649 30 #ifdef __cplusplus
nyatla 37:fc4b4fd6a649 31 extern "C" {
nyatla 37:fc4b4fd6a649 32 #endif /* __cplusplus */
nyatla 37:fc4b4fd6a649 33
nyatla 37:fc4b4fd6a649 34
nyatla 37:fc4b4fd6a649 35 /**
nyatla 37:fc4b4fd6a649 36 * NyLPC_TDnsRecordで使用するサービスレコード
nyatla 37:fc4b4fd6a649 37 */
nyatla 37:fc4b4fd6a649 38 struct NyLPC_TMDnsServiceRecord
nyatla 37:fc4b4fd6a649 39 {
nyatla 37:fc4b4fd6a649 40 const char* protocol;
nyatla 37:fc4b4fd6a649 41 NyLPC_TUInt16 port;
nyatla 37:fc4b4fd6a649 42 };
nyatla 37:fc4b4fd6a649 43 /**
nyatla 37:fc4b4fd6a649 44 * DNSレコード
nyatla 37:fc4b4fd6a649 45 */
nyatla 37:fc4b4fd6a649 46 struct NyLPC_TDnsRecord
nyatla 37:fc4b4fd6a649 47 {
nyatla 37:fc4b4fd6a649 48 /** Service name*/
nyatla 37:fc4b4fd6a649 49 const NyLPC_TChar* name;
nyatla 37:fc4b4fd6a649 50 /** Host name recommended name[:emac:]*/
nyatla 37:fc4b4fd6a649 51 const NyLPC_TChar* a;
nyatla 37:fc4b4fd6a649 52 /**
nyatla 37:fc4b4fd6a649 53 * 配列の数
nyatla 37:fc4b4fd6a649 54 */
nyatla 37:fc4b4fd6a649 55 NyLPC_TUInt16 num_of_srv;
nyatla 37:fc4b4fd6a649 56 const struct NyLPC_TMDnsServiceRecord* srv;
nyatla 37:fc4b4fd6a649 57 };
nyatla 37:fc4b4fd6a649 58
nyatla 37:fc4b4fd6a649 59
nyatla 37:fc4b4fd6a649 60
nyatla 37:fc4b4fd6a649 61 /**
nyatla 37:fc4b4fd6a649 62 * MDNSサーバクラス
nyatla 37:fc4b4fd6a649 63 */
nyatla 37:fc4b4fd6a649 64 typedef struct NyLPC_TcMDnsServer NyLPC_TcMDnsServer_t;
nyatla 37:fc4b4fd6a649 65
nyatla 37:fc4b4fd6a649 66
nyatla 37:fc4b4fd6a649 67
nyatla 37:fc4b4fd6a649 68 struct NyLPC_TcMDnsServer
nyatla 37:fc4b4fd6a649 69 {
nyatla 37:fc4b4fd6a649 70 /** マルチキャストのUDPソケット*/
nyatla 109:18f12ac01097 71 NyLPC_TiUdpSocket_t* _socket;
nyatla 37:fc4b4fd6a649 72 /**周期実行タイマ*/
nyatla 37:fc4b4fd6a649 73 NyLPC_TcStopwatch_t _periodic_sw;
nyatla 107:d4b14febb863 74 /** 動作モード(private)*/
nyatla 107:d4b14febb863 75 NyLPC_TUInt8 _state;
nyatla 107:d4b14febb863 76 NyLPC_TUInt8 _state_val;
nyatla 107:d4b14febb863 77 NyLPC_TUInt8 _padding[2];
nyatla 37:fc4b4fd6a649 78 /** DNSレコードの参照情報*/
nyatla 37:fc4b4fd6a649 79 const struct NyLPC_TDnsRecord* _ref_record;
nyatla 37:fc4b4fd6a649 80 };
nyatla 37:fc4b4fd6a649 81
nyatla 37:fc4b4fd6a649 82 /**
nyatla 37:fc4b4fd6a649 83 * スケッチシステムの場合、この関数はsetup時に実行してください。
nyatla 37:fc4b4fd6a649 84 * @param i_ref_record
nyatla 37:fc4b4fd6a649 85 * DNSレコードの参照値。インスタンス
nyatla 37:fc4b4fd6a649 86 */
nyatla 37:fc4b4fd6a649 87 NyLPC_TBool NyLPC_cMDnsServer_initialize(
nyatla 48:00d211aac2ec 88 NyLPC_TcMDnsServer_t* i_inst,const struct NyLPC_TDnsRecord* i_ref_record);
nyatla 37:fc4b4fd6a649 89
nyatla 37:fc4b4fd6a649 90 void NyLPC_cMDnsServer_finalize(
nyatla 37:fc4b4fd6a649 91 NyLPC_TcMDnsServer_t* i_inst);
nyatla 37:fc4b4fd6a649 92
nyatla 37:fc4b4fd6a649 93 void NyLPC_cMDnsServer_periodicRecvProc(NyLPC_TcMDnsServer_t* i_inst);
nyatla 37:fc4b4fd6a649 94 /**
nyatla 37:fc4b4fd6a649 95 * mDNSサービスを開始します。
nyatla 37:fc4b4fd6a649 96 * 関数はstop関数をコールするまでの間ブロックします。
nyatla 37:fc4b4fd6a649 97 */
nyatla 37:fc4b4fd6a649 98 void NyLPC_cMDnsServer_start(NyLPC_TcMDnsServer_t* i_inst);
nyatla 37:fc4b4fd6a649 99 /**
nyatla 37:fc4b4fd6a649 100 * mDNSサービスを停止します。
nyatla 37:fc4b4fd6a649 101 * 関数はサービスが停止するまでブロックします。
nyatla 37:fc4b4fd6a649 102 */
nyatla 37:fc4b4fd6a649 103 void NyLPC_cMDnsServer_stop(NyLPC_TcMDnsServer_t* i_inst);
nyatla 37:fc4b4fd6a649 104
nyatla 37:fc4b4fd6a649 105
nyatla 37:fc4b4fd6a649 106 #ifdef __cplusplus
nyatla 37:fc4b4fd6a649 107 }
nyatla 37:fc4b4fd6a649 108 #endif /* __cplusplus */
nyatla 37:fc4b4fd6a649 109
nyatla 37:fc4b4fd6a649 110 #endif