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:
Sun Mar 15 09:33:38 2015 +0000
Revision:
110:257739f9b31e
51d1c88c8a56d6295311cfd20aa197a9cd650b2d; ????; NetworkInterface???????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 110:257739f9b31e 1 #ifndef NYLPC_CNET_H_
nyatla 110:257739f9b31e 2 #define NYLPC_CNET_H_
nyatla 110:257739f9b31e 3 #include "NyLPC_stdlib.h"
nyatla 110:257739f9b31e 4 #include "NyLPC_cIPv4Config.h"
nyatla 110:257739f9b31e 5 #include "NyLPC_iTcpListener.h"
nyatla 110:257739f9b31e 6 #include "NyLPC_iTcpSocket.h"
nyatla 110:257739f9b31e 7 #include "NyLPC_iUdpSocket.h"
nyatla 110:257739f9b31e 8 #include "NyLPC_iNetInterface.h"
nyatla 110:257739f9b31e 9 #include "NyLPC_NetIf_ip_types.h"
nyatla 110:257739f9b31e 10
nyatla 110:257739f9b31e 11 #ifdef __cplusplus
nyatla 110:257739f9b31e 12 extern "C" {
nyatla 110:257739f9b31e 13 #endif /* __cplusplus */
nyatla 110:257739f9b31e 14
nyatla 110:257739f9b31e 15 typedef struct NyLPC_TcNet NyLPC_TcNet_t;
nyatla 110:257739f9b31e 16
nyatla 110:257739f9b31e 17 void NyLPC_cNet_initialize(const struct NyLPC_TiNetInterface_Interface* i_netif);
nyatla 110:257739f9b31e 18 #define NyLPC_cNet_finalize()
nyatla 110:257739f9b31e 19
nyatla 110:257739f9b31e 20 NyLPC_TiTcpSocket_t* NyLPC_cNet_createTcpSocketEx(NyLPC_TSocketType i_socktype);
nyatla 110:257739f9b31e 21 NyLPC_TiUdpSocket_t* NyLPC_cNet_createUdpSocketEx(NyLPC_TUInt16 i_port,NyLPC_TSocketType i_socktype);
nyatla 110:257739f9b31e 22 NyLPC_TiTcpListener_t* NyLPC_cNet_createTcpListenerEx(NyLPC_TUInt16 i_port);
nyatla 110:257739f9b31e 23
nyatla 110:257739f9b31e 24 /**
nyatla 110:257739f9b31e 25 * 指定したIPアドレスを要求するARPリクエストを発行します。
nyatla 110:257739f9b31e 26 */
nyatla 110:257739f9b31e 27 void NyLPC_cNet_sendArpRequest(const struct NyLPC_TIPv4Addr* i_addr);
nyatla 110:257739f9b31e 28
nyatla 110:257739f9b31e 29 /**
nyatla 110:257739f9b31e 30 * ARPテーブルに指定したIPがあるかを返します。
nyatla 110:257739f9b31e 31 */
nyatla 110:257739f9b31e 32 NyLPC_TBool NyLPC_cNet_hasArpInfo(const struct NyLPC_TIPv4Addr* i_addr);
nyatla 110:257739f9b31e 33
nyatla 110:257739f9b31e 34 void NyLPC_cNet_start(const NyLPC_TcIPv4Config_t* i_ref_config);
nyatla 110:257739f9b31e 35 void NyLPC_cNet_stop(void);
nyatla 110:257739f9b31e 36 NyLPC_TBool NyLPC_cNet_isInitService(void);
nyatla 110:257739f9b31e 37
nyatla 110:257739f9b31e 38 /**
nyatla 110:257739f9b31e 39 * NyLPC_TcIPv4Config_tをDHCPで更新します。
nyatla 110:257739f9b31e 40 * この関数をコールする時は、サービスは停止中でなければなりません。
nyatla 110:257739f9b31e 41 * @param i_cfg
nyatla 110:257739f9b31e 42 * 更新するi_cfg構造体。
nyatla 110:257739f9b31e 43 * emac,default_mssは設定済である必要があります。他のフィールド値は不定で構いません。
nyatla 110:257739f9b31e 44 * 更新されるフィールドは、ip,netmast,default_rootの3つです。
nyatla 110:257739f9b31e 45 * @return
nyatla 110:257739f9b31e 46 * 更新に成功した場合TRUE
nyatla 110:257739f9b31e 47 */
nyatla 110:257739f9b31e 48 NyLPC_TBool NyLPC_cNet_requestAddrDhcp(NyLPC_TcIPv4Config_t* i_cfg,NyLPC_TInt16 i_repeat);
nyatla 110:257739f9b31e 49 /**
nyatla 110:257739f9b31e 50 * NyLPC_TcIPv4Config_tをAPIPAで更新します。
nyatla 110:257739f9b31e 51 * この関数をコールする時は、サービスは停止中でなければなりません。
nyatla 110:257739f9b31e 52 * @param i_cfg
nyatla 110:257739f9b31e 53 * 更新するi_cfg構造体。
nyatla 110:257739f9b31e 54 * emac,default_mssは設定済である必要があります。他のフィールド値は不定で構いません。
nyatla 110:257739f9b31e 55 * 更新されるフィールドは、ip,netmast,default_rootの3つです。
nyatla 110:257739f9b31e 56 * @return
nyatla 110:257739f9b31e 57 * 更新に成功した場合TRUE
nyatla 110:257739f9b31e 58 */
nyatla 110:257739f9b31e 59 NyLPC_TBool NyLPC_cNet_requestAddrApipa(NyLPC_TcIPv4Config_t* i_cfg,NyLPC_TInt16 i_repeat);
nyatla 110:257739f9b31e 60
nyatla 110:257739f9b31e 61 const struct NyLPC_TNetInterfaceInfo* NyLPC_cNet_getInterfaceInfo(void);
nyatla 110:257739f9b31e 62
nyatla 110:257739f9b31e 63 #ifdef __cplusplus
nyatla 110:257739f9b31e 64 }
nyatla 110:257739f9b31e 65 #endif /* __cplusplus */
nyatla 110:257739f9b31e 66
nyatla 110:257739f9b31e 67 #endif
nyatla 110:257739f9b31e 68
nyatla 110:257739f9b31e 69