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

Diff: core/mimicvm/NyLPC_cMiMicVM_protected.h

Revision:
2:b96c1e90d120
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/mimicvm/NyLPC_cMiMicVM_protected.h	Wed Mar 27 12:07:47 2013 +0000
@@ -0,0 +1,163 @@
+/*********************************************************************************
+ * PROJECT: MiMic
+ * --------------------------------------------------------------------------------
+ *
+ * This file is part of MiMic
+ * Copyright (C)2011 Ryo Iizuka
+ *
+ * MiMic is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by　the Free Software Foundation, either version 3 of the　License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * For further information please contact.
+ *  http://nyatla.jp/
+ *  <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
+ *
+ *********************************************************************************/
+#ifndef NYLPC_CMIMICVM_PROTECTED_H_
+#define NYLPC_CMIMICVM_PROTECTED_H_
+#include "NyLPC_cMiMicVM.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+//----------------------------------------------------------------------
+//MiMicOpCodeのタイプ値
+//----------------------------------------------------------------------
+
+#define NyLPC_TcMiMicVM_OP_TYPE_AND    0x11
+#define NyLPC_TcMiMicVM_OP_TYPE_OR     0x12
+#define NyLPC_TcMiMicVM_OP_TYPE_XOR    0x13
+#define NyLPC_TcMiMicVM_OP_TYPE_NOT    0x14
+
+#define NyLPC_TcMiMicVM_OP_TYPE_SHL    0x21
+#define NyLPC_TcMiMicVM_OP_TYPE_SHR    0x22
+
+#define NyLPC_TcMiMicVM_OP_TYPE_ADD    0x31
+#define NyLPC_TcMiMicVM_OP_TYPE_SUB    0x32
+#define NyLPC_TcMiMicVM_OP_TYPE_MUL    0x33
+
+#define NyLPC_TcMiMicVM_OP_TYPE_MGET    0x41
+#define NyLPC_TcMiMicVM_OP_TYPE_MPUT    0x42
+
+#define NyLPC_TcMiMicVM_OP_TYPE_SGET    0x51
+#define NyLPC_TcMiMicVM_OP_TYPE_SPUT    0x52
+
+#define NyLPC_TcMiMicVM_OP_TYPE_NOP     0x61
+#define NyLPC_TcMiMicVM_OP_TYPE_EXIT    0x62
+#define NyLPC_TcMiMicVM_OP_TYPE_CALL    0x63
+
+#define NyLPC_TcMiMicVM_OP_TYPE_LD      0x71
+
+
+#define NyLPC_TcMiMicVM_CP_TYPE_END    0x01
+/*
+#define NyLPC_TcMiMicVM_OP_TYPE_V_END  0x1001
+#define NyLPC_TcMiMicVM_OP_TYPE_V_DB8  0x1011
+#define NyLPC_TcMiMicVM_OP_TYPE_V_DB16 0x1012
+#define NyLPC_TcMiMicVM_OP_TYPE_V_DB32 0x1013
+*/
+
+//----------------------------------------------------------------------
+//MiMicOprandのタイプ値
+//----------------------------------------------------------------------
+
+#define NyLPC_TcMiMicVM_OPR_TYPE_NONE    0x01
+#define NyLPC_TcMiMicVM_OPR_TYPE_WM_WM   0x11
+#define NyLPC_TcMiMicVM_OPR_TYPE_WM_H08  0x12
+#define NyLPC_TcMiMicVM_OPR_TYPE_WM_H16  0x13
+#define NyLPC_TcMiMicVM_OPR_TYPE_WM_H32  0x14
+#define NyLPC_TcMiMicVM_OPR_TYPE_WM      0x21
+#define NyLPC_TcMiMicVM_OPR_TYPE_H08     0x22
+#define NyLPC_TcMiMicVM_OPR_TYPE_H16     0x23
+#define NyLPC_TcMiMicVM_OPR_TYPE_H32     0x24
+
+
+
+
+
+/**
+ * インストラクションセットのバイナリデータ型。
+ * MiMicVMで実行するインストラクションをバッファから参照するために使います。
+ * キャスト元のバッファは、32bitのunsigned intを想定しています。境界は32bit単位です。
+ *
+ * 構造体は、
+ *
+ */
+union NyLPC_TcMiMicVM_TInstruction{
+    /**
+     * オペコード情報のみを格納します
+     */
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+    }op;
+    //32ビットコード
+
+    /**
+     * WM[8],WM[8]オペランドの命令を格納します。
+     */
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8 wm1;
+        NyLPC_TUInt8 wm2;
+    }wmwm_32;
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8 wm;
+        NyLPC_TUInt8 h8;
+    }wmh08_32;
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8  wm;
+    }wm_32;
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8  h8;
+    }h8_32;
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8  h16;
+    }h16_32;
+    //64bit命令
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8  wm;
+        NyLPC_TUInt8  _padding;
+        NyLPC_TUInt16 h16;
+    }wmh16_64;
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8  wm;
+        NyLPC_TUInt8  _padding;
+        NyLPC_TUInt32 h32;
+    }wmh32_64;
+    struct{
+        NyLPC_TcMiMicVM_OP_TYPE opc;
+        NyLPC_TUInt8 oprtype;
+        NyLPC_TUInt8  _padding[2];
+        NyLPC_TUInt32 h32;
+    }h32_64;
+};
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* NYLPC_CMIMICVM_PROTECTED_H_ */