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)

/*********************************************************************************
 * 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_TcRingBuffer_h
#define NyLPC_TcRingBuffer_h



#include "NyLPC_stdlib.h"

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

/**********************************************************************
 *
 * NyLPC_TcRingBuffer class
 *
 **********************************************************************/
typedef struct NyLPC_TcRingBuffer NyLPC_TcRingBuffer_t;


struct NyLPC_TcRingBuffer
{
    void* buf;          //バッファ
    NyLPC_TUInt16 bl;   //バッファ長さ
    NyLPC_TUInt16 wo;   //バッファ書込み位置オフセット
    NyLPC_TUInt16 ro;   //バッファ読み込み位置オフセット
};


#if NyLPC_ARCH==NyLPC_ARCH_FREERTOS
#elif NyLPC_ARCH==NyLPC_ARCH_WIN32
/**
 * リングバッファをダンプします。
 */
void NyLPC_cRingBuffer_dump(NyLPC_TcRingBuffer_t* i_inst);
#else
#endif


/**
 * i_bufをラップするリングバッファを作成します。
 */
void NyLPC_cRingBuffer_initialize(NyLPC_TcRingBuffer_t* i_inst,void* i_buf,NyLPC_TUInt16 sizeof_buf);

/**
 * この関数は、読出し可能なサイズを計算して返します。
 * @return
 * 読み出し可能なバイト数を返します。
 * 0以外の場合、もう一度読み出せる可能性があります。
 */
NyLPC_TInt16 NyLPC_cRingBuffer_getReadableSize(NyLPC_TcRingBuffer_t* i_inst);

/**
 * この関数は、書き込み可能なサイズを計算して返します。
 * @return
 * 書き込み可能なバイト数です。
 * この数値は、バッファ全体に対する空き領域と同じです。
 */
NyLPC_TInt16 NyLPC_cRingBuffer_getWritableSize(const NyLPC_TcRingBuffer_t* i_inst);

/**
 * リングバッファにデータを書き込みます。
 * @return
 * 書きこめたサイズ。
 */
int NyLPC_cRingBuffer_write(NyLPC_TcRingBuffer_t* i_inst,NyLPC_TUInt8* i_data,const int i_len);

/**
 * この関数は、リングバッファを初期化します。
 */
void NyLPC_cRingBuffer_reset(NyLPC_TcRingBuffer_t* i_inst);

/**
 * リングバッファの読出しポイントと読出し可能サイズを返します。
 */
NyLPC_TUInt8* NyLPC_cRingBuffer_pread(NyLPC_TcRingBuffer_t* i_inst,NyLPC_TUInt16* len);

/**
 * この関数は、リングバッファの読み取り点を前方にシークします。
 * @i_seek
 * シークするバイト数。NyLPC_cRingBuffer_getReadableSize,又はNyLPC_cRingBuffer_preadのlen以下のサイズである必要があります。
 */
void NyLPC_cRingBuffer_preadSeek(NyLPC_TcRingBuffer_t* i_inst,NyLPC_TUInt16 i_seek);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif