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)

/*
 * cConfiglationStorage.h
 *
 *  Created on: 2011/10/18
 *      Author: nyatla
 */

#include "NyLPC_stdlib.h"
#include "NyLPC_net.h"
#ifndef NYLPC_CCONFIGLATIONSTORAGE_H_
#define NYLPC_CCONFIGLATIONSTORAGE_H_

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


/**
 * IPアドレスはネットワークオーダーで格納する。
 * 構造体は8バイトアライメントであること。
 */
struct NyLPC_TMiMicConfigulation{
    /** ROM焼検出用。0xFFFFFFFFを書く　*/
    NyLPC_TUInt32   fast_boot;
    /** ホスト名*/
    NyLPC_TChar     hostname[NyLPC_TcNetConfig_HOSTNAME_LEN];
    /** MACアドレスの下位4bit*/
    NyLPC_TUInt32   mac_00_01_02_03;
    /** MACアドレスの上位2bit*/
    NyLPC_TUInt32   mac_04_05_xx_xx;    //12+NyLPC_TcNetConfig_HOSTNAME_LEN
    /*
     * IPv4設定
     */

    /**
     * 0-1bit 起動モード
     *  0:default,1:DHCP,2:AUTOIP,3:APIPA
     */
    NyLPC_TUInt32   ipv4_flags;
    /** IPV4アドレス*/
    NyLPC_TUInt32   ipv4_addr_net;
    NyLPC_TUInt32   ipv4_mask_net;
    NyLPC_TUInt32   ipv4_drut_net;      //16

    /*
     * Service setting
     */

    /**
     * Service flags
     * 0:mdns ON/OFF
     */
    NyLPC_TUInt32   srv_flags;
    /** HTTPポート番号*/
    NyLPC_TUInt16   http_port;          //6
                                        //total=(34=(12+16+6)+NyLPC_TcNetConfig_HOSTNAME_LEN)
    NyLPC_TUInt16   padding32;
    NyLPC_TUInt32   padding64;          //total=40+NyLPC_TcNetConfig_HOSTNAME_LEN
};

/**
 * ユーザー定義コンフィギュレーションを持つ場合にtrue
 * falseなら初期設定と捉えることも出来ます。
 */
NyLPC_TBool NyLPC_cMiMicConfiglation_hasUserConfigulation(void);

/**
 * ユーザコンフィギュレーションを更新する。
 * この関数は、RTOSが停止中に実行すること。
 * この関数は384バイト程度のスタックが必要です。
 */
NyLPC_TBool NyLPC_cMiMicConfiglation_updateConfigulation(const struct NyLPC_TMiMicConfigulation* i_congfiglation);
/**
 * コンフィギュレーション値を返す。
 * この関数は、RTOSが停止中に実行すること。
 */
const struct NyLPC_TMiMicConfigulation* NyLPC_cMiMicConfiglation_loadFromFlash(void);
const struct NyLPC_TMiMicConfigulation* NyLPC_cMiMicConfiglation_loadFactoryDefault(void);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* CCONFIGLATIONSTORAGE_H_ */