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が準備されています。

※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

プログラム

サンプル

チュートリアル

• HTTPD解説
• UPnPデバイスの作り方
• MiMicRemoteMCUの紹介(pdf)
• MiMicRemoteMCUのマニュアル(pdf)

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.

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

Sample

Tutorial

• HTTPD hello world.
• How to make own UPnP device.
• MiMicRemoteMCUの紹介(pdf)
• MiMicRemoteMCUのマニュアル(pdf)

/*
 * NyLPC_cSsdpSocket.h
 *
 *  Created on: 2013/07/26
 *      Author: nyatla
 */

#ifndef NYLPC_CSSDPSOCKET_H_
#define NYLPC_CSSDPSOCKET_H_
#include "NyLPC_netif.h"
#include "NyLPC_UPnP_types.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**
 * DeviceDescriptionに含まれる最大デバイス数
 */
#define NyLPC_TcSsdpSocket_MAX_DEVICES 5

/**
 * @bug
 * TTLが64(4であるべき)
 */
typedef struct NyLPC_TcSsdpSocket NyLPC_TcSsdpSocket_t;

struct NyLPC_TcSsdpSocket
{
	NyLPC_TiUdpSocket_t* _socket;
	NyLPC_TcStopwatch_t _periodic_sw;
	/**
	 * locationパス
	 */
	const NyLPC_TChar* location_path;
	/**
	 * DeviceDescriptionをホストするサーバアドレス
	 */
	NyLPC_TUInt16 location_port;
	NyLPC_TUInt8 number_of_device;
	/**
	 * bit0:SSDPサービスの開始要求
	 * bit1:SSDPサービスの停止要求
	 * bit2:SSDPサービスの実行状態(1:start,0:stop)
	 */
	 volatile NyLPC_TUInt8 _flags;
	/**
	 * デバイスレコードの配列へのポインタ。
	 * この値は、initialize関数でセットされたrootdeviceを水平展開したものです。
	 * 0番目のレコードはルートデバイスです。
	 */
	const struct NyLPC_TUPnPDevDescDevice* ref_device_record[NyLPC_TcSsdpSocket_MAX_DEVICES];
};

/**
 * DeviceRecordを参照したSSDPソケットインスタンスを生成します。
 * この関数はuipServiceが開始する前に実行してください。
 * @param　i_inst
 * @param i_ref_dev_record
 * 0番目のデバイスがルートデバイス、以降は embeddedデバイスになります。
 * このオブジェクトはインスタンスが破棄されるまでの間維持してください。
 * @param i_number_of_devices
 * @param i_server_port
 * @param i_ref_location_path
 * deviceDescriptionのホストパスを設定します。
 * 例えば"upnp"の場合、locationはhttp://[:ip:]:[:port:]/upnp/ddesc.xmlとなります。
 */
void NyLPC_cSsdpSocket_initialize(
		NyLPC_TcSsdpSocket_t* i_inst,
		const struct NyLPC_TUPnPDevDescDevice* i_ref_dev_record,
		NyLPC_TUInt16 i_server_port,const NyLPC_TChar* i_ref_location_path);

void NyLPC_cSsdpSocket_finalize(NyLPC_TcSsdpSocket_t* i_inst);
/**
 * SSDPサービスを開始します。
 */
void NyLPC_cSsdpSocket_start(NyLPC_TcSsdpSocket_t* i_inst);
/**
 * SSDPサービスを停止します。
 */
void NyLPC_cSsdpSocket_stop(NyLPC_TcSsdpSocket_t* i_inst);


#ifdef __cplusplus
}
#endif /* __cplusplus */













#endif /* NYLPC_CSSDPSOCKET_H_ */