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)

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/net/httpd/mod/NyLPC_cModFileIoBaseClass.h	Sun Jun 30 14:17:42 2013 +0000
@@ -0,0 +1,98 @@
+/*
+ * NyLPC_cModRemoteMcu.h
+ *
+ *  Created on: 2013/03/07
+ *      Author: nyatla
+ */
+
+#ifndef NYLPC_cModFileIoBaseClass_H_
+#define NYLPC_cModFileIoBaseClass_H_
+
+#include "NyLPC_http.h"
+#include "NyLPC_stdlib.h"
+#include "../NyLPC_cHttpdConnection.h"
+#include "NyLPC_cModRomFiles.h"
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/**
+ * ファイルアップロードの為の基本シーケンスを提供する抽象クラスです。
+ * 継承クラスで_abstruct_function以下の関数に実体を設定して使います。
+ */
+typedef struct NyLPC_TcModFileIoBaseClass NyLPC_TcModFileIoBaseClass_t;
+
+/*
+ * Abstruct関数の定義
+ */
+
+/**
+ * i_fnameの内容をi_body_parserの内容で更新します。
+ * この関数はHTTPD_LOCKがかかった状態でコールされます。
+ * 関数にはコネクションにHTTP応答を返却する実装をしてください。
+ * @return
+ * 処理が失敗した場合はFALSEを返します。FALSEを返すとCallerはHTTPセッションを切断します。
+ */
+typedef NyLPC_TBool (*NyLPC_cModFileIoBaseClass_uploadFunction)(NyLPC_TcHttpdConnection_t* i_connection,const NyLPC_TChar* i_fname,NyLPC_TcHttpBodyParser_t* i_body_parser);
+/**
+ * i_fnameのファイルを作成します。
+ * この関数はHTTPD_LOCKがかかった状態でコールされます。
+ * 関数にはコネクションにHTTP応答を返却する実装をしてください。
+ * @return
+ * 処理が失敗した場合はFALSEを返します。FALSEを返すとCallerはHTTPセッションを切断します。
+ */
+typedef NyLPC_TBool (*NyLPC_cModFileIoBaseClass_createFunction)(NyLPC_TcHttpdConnection_t* i_connection,const NyLPC_TChar* i_fname);
+/**
+ * i_fnameのファイルを削除します。
+ * この関数はHTTPD_LOCKがかかった状態でコールされます。
+ * 関数にはコネクションにHTTP応答を返却する実装をしてください。
+ * @return
+ * 処理が失敗した場合はFALSEを返します。FALSEを返すとCallerはHTTPセッションを切断します。
+ */
+typedef NyLPC_TBool (*NyLPC_cModFileIoBaseClass_removeFunction)(NyLPC_TcHttpdConnection_t* i_connection,const NyLPC_TChar* i_fname);
+
+/**
+ * Abstruct関数テーブル
+ */
+struct NyLPC_TcModFileIoBaseClass_AbstructFunction
+{
+    NyLPC_cModFileIoBaseClass_uploadFunction upload;
+    NyLPC_cModFileIoBaseClass_createFunction create;
+    NyLPC_cModFileIoBaseClass_removeFunction remove;
+};
+
+/**
+ * クラス構造体
+ */
+struct NyLPC_TcModFileIoBaseClass
+{
+    NyLPC_TcModRomFiles_t super;
+    /**
+     * 処理関数へのポインタ構造体
+     */
+    struct NyLPC_TcModFileIoBaseClass_AbstructFunction _abstruct_function;
+};
+
+/**
+ * コンストラクタ。
+ */
+void NyLPC_cModFileIoBaseClass_initialize(NyLPC_TcModFileIoBaseClass_t* i_inst,const NyLPC_TChar* i_ref_root_path);
+void NyLPC_cModFileIoBaseClass_finalize(NyLPC_TcModFileIoBaseClass_t* i_inst);
+
+/**
+ * モジュールがコネクションをハンドリングできるかを返します。
+ */
+NyLPC_TBool NyLPC_cModFileIoBaseClass_canHandle(NyLPC_TcModFileIoBaseClass_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
+/**
+ * モジュールを実行します。
+ * この関数は、リクエストを解析して、抽象関数upload,create,deleteの何れかに該当する場合はそれを呼び出します。
+ * @return
+ * 処理に成功したか
+ */
+NyLPC_TBool NyLPC_cModFileIoBaseClass_execute(NyLPC_TcModFileIoBaseClass_t* i_inst,NyLPC_TcHttpdConnection_t* i_connection);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* NYLPC_CMODREMOTEMCU_H_ */