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

cpp/NetConfig.h@13:a71705c5e6fd, 2013-04-21 (annotated)

Committer:
nyatla
Date:
Sun Apr 21 01:21:41 2013 +0000
Revision:
13:a71705c5e6fd
Parent:
11:c82a7b2899b0
Child:
14:4618692ec239
a lot changes.; add format text reader. ;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 3:0a94993be1f6 1 #pragma once
nyatla 3:0a94993be1f6 2 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 3 // NetConfig.h
nyatla 3:0a94993be1f6 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 5
nyatla 3:0a94993be1f6 6 #include "NyLPC_net.h"
nyatla 3:0a94993be1f6 7
nyatla 3:0a94993be1f6 8 namespace MiMic
nyatla 3:0a94993be1f6 9 {
nyatla 3:0a94993be1f6 10 /**
nyatla 3:0a94993be1f6 11 * Network configulation class.
nyatla 11:c82a7b2899b0 12 * The class is used for argument of NetConfig constructor.
nyatla 3:0a94993be1f6 13 */
nyatla 3:0a94993be1f6 14 class NetConfig
nyatla 3:0a94993be1f6 15 {
nyatla 3:0a94993be1f6 16 public:
nyatla 3:0a94993be1f6 17 NyLPC_TcNetConfig_t _inst;
nyatla 3:0a94993be1f6 18 public:
nyatla 3:0a94993be1f6 19 /**
nyatla 3:0a94993be1f6 20 * The constructor.
nyatla 3:0a94993be1f6 21 * This function initializes instance by onchip configulation data.
nyatla 3:0a94993be1f6 22 * @param i_is_factory_default
nyatla 11:c82a7b2899b0 23 * Factory default flag.
nyatla 3:0a94993be1f6 24 * <ul>
nyatla 3:0a94993be1f6 25 * <li>true - The function sets factory default setting.
nyatla 3:0a94993be1f6 26 * <li>false -The function sets onchip memory configulation (default)
nyatla 3:0a94993be1f6 27 * </ul>
nyatla 3:0a94993be1f6 28 */
nyatla 3:0a94993be1f6 29 NetConfig(bool i_is_factory_default=false);
nyatla 3:0a94993be1f6 30 virtual ~NetConfig();
nyatla 11:c82a7b2899b0 31 /**
nyatla 11:c82a7b2899b0 32 * Set IPv4 ip address to instance.
nyatla 11:c82a7b2899b0 33 */
nyatla 11:c82a7b2899b0 34 void setIpAddr(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 35 /**
nyatla 11:c82a7b2899b0 36 * Set IPv4 network mask value to instance.
nyatla 11:c82a7b2899b0 37 */
nyatla 11:c82a7b2899b0 38 void setNetMask(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 39
nyatla 11:c82a7b2899b0 40 /**
nyatla 11:c82a7b2899b0 41 * Set IPv4 default gateway address to instance.
nyatla 11:c82a7b2899b0 42 */
nyatla 11:c82a7b2899b0 43 void setGateway(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 44 /**
nyatla 11:c82a7b2899b0 45 * Set ethernet mac address to instance.
nyatla 11:c82a7b2899b0 46 */
nyatla 11:c82a7b2899b0 47 void setEmac(unsigned char ip6,unsigned char ip5,unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 13:a71705c5e6fd 48 /**
nyatla 13:a71705c5e6fd 49 * Load configulation from text file.
nyatla 13:a71705c5e6fd 50 * <p>File format example
nyatla 13:a71705c5e6fd 51 * <pre>
nyatla 13:a71705c5e6fd 52 * macaddr=00:00:00:00:00:00
nyatla 13:a71705c5e6fd 53 * ipaddr=192.168.0.1
nyatla 13:a71705c5e6fd 54 * netmask=255.255.255.0
nyatla 13:a71705c5e6fd 55 * gateway=192.168.0.254
nyatla 13:a71705c5e6fd 56 * </pre>
nyatla 13:a71705c5e6fd 57 * <p>Keys
nyatla 13:a71705c5e6fd 58 * <ul>
nyatla 13:a71705c5e6fd 59 * <li>macaddr=[:macaddr:] - 48bit ethernet mac address that are separated by ':'</li>
nyatla 13:a71705c5e6fd 60 * <li>ipaddr=[:ip:] - 32 bit IP address</li>
nyatla 13:a71705c5e6fd 61 * <li>netmask=[:ip:]- 32 bit network mask value.</li>
nyatla 13:a71705c5e6fd 62 * <li>gateway=[:ip:] - 32 bit default gateway address.</li>
nyatla 13:a71705c5e6fd 63 * </ul>
nyatla 13:a71705c5e6fd 64 * </p>
nyatla 13:a71705c5e6fd 65 * Maximum line length is 31.
nyatla 13:a71705c5e6fd 66 * Specified values are override on-chip setting value.
nyatla 13:a71705c5e6fd 67 * If the same value appeared, then the last one is enabled.
nyatla 13:a71705c5e6fd 68 * </p>
nyatla 13:a71705c5e6fd 69 * @return
nyatla 13:a71705c5e6fd 70 * true if file read. false is not read.
nyatla 13:a71705c5e6fd 71 */
nyatla 13:a71705c5e6fd 72 bool NetConfig::loadFromFile(const char* i_file);
nyatla 13:a71705c5e6fd 73 };
nyatla 13:a71705c5e6fd 74 }