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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

チュートリアル

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.

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Tutorial

core/http/NyLPC_cHttpBodyWriter.c

Committer:
nyatla
Date:
2016-06-04
Revision:
114:f6aef16d4e60
Parent:
57:bc4330dfa62f

File content as of revision 114:f6aef16d4e60:

/*********************************************************************************
 * 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>
 *
 *********************************************************************************/


#include <stdlib.h>
#include "NyLPC_utils.h"
#include "NyLPC_cHttpBodyWriter.h"






/**
 * PrintHandler
 */
static NyLPC_TBool printHandler(void* i_inst,const void* i_buf,NyLPC_TUInt32 i_len)
{
    //エラー状態ならFALSE
    if(((NyLPC_TcHttpBodyWriter_t*)i_inst)->_is_error){
        return NyLPC_TBool_FALSE;
    }
    ((NyLPC_TcHttpBodyWriter_t*)i_inst)->_size_of_sent+=i_len;
    if(!NyLPC_iHttpPtrStream_write(((NyLPC_TcHttpBodyWriter_t*)i_inst)->_ref_stream,i_buf,i_len)){
        ((NyLPC_TcHttpBodyWriter_t*)i_inst)->_is_error=NyLPC_TUInt8_TRUE;
        return NyLPC_TBool_FALSE;
    }
    return NyLPC_TBool_TRUE;
}



void NyLPC_cHttpBodyWriter_initialize(NyLPC_TcHttpBodyWriter_t* i_inst,NyLPC_TcHttpStream_t* i_stream)
{
    i_inst->_ref_stream=&(i_stream->super);
    i_inst->_is_chunked=NyLPC_TUInt8_FALSE;
    i_inst->_is_error=NyLPC_TUInt8_FALSE;
    i_inst->_size_of_sent=0;
    i_inst->_content_length=0;
    NyLPC_iHttpPtrStream_setWriteEncoding(i_inst->_ref_stream,NyLPC_TiHttpPtrStream_ET_NONE);
}

void NyLPC_cHttpBodyWriter_setChunked(NyLPC_TcHttpBodyWriter_t* i_inst)
{
    i_inst->_is_chunked=NyLPC_TUInt8_TRUE;
    NyLPC_iHttpPtrStream_setWriteEncoding(i_inst->_ref_stream,NyLPC_TiHttpPtrStream_ET_CHUNKED);
}
void NyLPC_cHttpBodyWriter_setContentLength(NyLPC_TcHttpBodyWriter_t* i_inst,NyLPC_TUInt32 i_content_length)
{
    i_inst->_is_chunked=NyLPC_TUInt8_FALSE;
    i_inst->_content_length=i_content_length;
    NyLPC_iHttpPtrStream_setWriteEncoding(i_inst->_ref_stream,NyLPC_TiHttpPtrStream_ET_NONE);
}


/**
 * HttpBodyを書き込みます。
 * @return
 * 偽を返した場合は、コネクションを切断してください。
 */
NyLPC_TBool NyLPC_cHttpBodyWriter_write(NyLPC_TcHttpBodyWriter_t* i_inst,const void* i_buf,NyLPC_TUInt32 i_len)
{
    return printHandler(i_inst,i_buf,i_len);
}

/**
 * HttpBodyの書き込みを完了します。
 * @return
 */
NyLPC_TBool NyLPC_cHttpBodyWriter_close(NyLPC_TcHttpBodyWriter_t* i_inst)
{
    //エラー状態ならFALSE
    if(i_inst->_is_error){
        return NyLPC_TBool_FALSE;
    }
    //chunkedの場合、フッタを書き込む
    if(i_inst->_is_chunked){
        //エンコーディングを戻す。
        NyLPC_iHttpPtrStream_setWriteEncoding(i_inst->_ref_stream,NyLPC_TiHttpPtrStream_ET_NONE);
        //フッタを書き込む。
        if(!NyLPC_iHttpPtrStream_write(i_inst->_ref_stream,"0\r\n\r\n",5)){
            i_inst->_is_error=NyLPC_TUInt8_TRUE;
            return NyLPC_TBool_FALSE;
        }
    }
    //エラーでないときはストリームをフラッシュ
    NyLPC_iHttpPtrStream_flush(i_inst->_ref_stream);
    //クローズのステータスで状態を変える。
    return NyLPC_TBool_TRUE;
}

/**
 * printfライクな書式出力を提供します。
 * @i_fmt
 * 書式文字列です。%d,%x,%s,%c,%%をサポートします。
 */
NyLPC_TBool NyLPC_cHttpBodyWriter_format(NyLPC_TcHttpBodyWriter_t* i_inst,const NyLPC_TChar* i_fmt,...)
{
    NyLPC_TBool ret;
    va_list a;
    //エラー状態ならFALSE
    if(i_inst->_is_error){
        return NyLPC_TBool_FALSE;
    }
    va_start(a,i_fmt);
    ret=   NyLPC_cFormatWriter_print(printHandler,i_inst,i_fmt,a);
    va_end(a);
    return ret;
}

NyLPC_TBool NyLPC_cHttpBodyWriter_formatV(NyLPC_TcHttpBodyWriter_t* i_inst,const NyLPC_TChar* i_fmt,va_list i_args)
{
    NyLPC_TBool ret;
    //エラー状態ならFALSE
    if(i_inst->_is_error){
        return NyLPC_TBool_FALSE;
    }
    ret=NyLPC_cFormatWriter_print(printHandler,i_inst,i_fmt,i_args);
    return ret;
}

/**
 * テスト用のコード。
 */
#define TEST
#ifndef TEST
//テスト
#include "NyLPC_cHttpHeaderWriter.h"

const char* TP1=
        "HTTP/0.9 200 OK\r\n"
        "HOST: 127.0.0.0.0.0.1\r\n"
        "CONTENt-LENGTH: 1285\r\n"
        "CONNECTION: CloSe\r\n"
        "ETAG: nyatla.jp\r\n"
        "ETAG: nyatla.jp\r\n"
        "Transfer-Encoding:chunked\r\n"
        "\r\n";
const char* TP2=
        "GET /nyanyanya!/nyoronnnnnnnnnnnn?m,fpeofjregnoegnr HTTP/1.1\r\n"
        "HOST: 127.0.0.0.0.0.1\r\n"
        "CONTENt-LENGTH: 1285\r\n"
        "CONNECTION: Keep\r\n"
        "ETAG: nyatla.jp\r\n"
        "ETAG: nyatla.jp\r\n"
        "\r\n";
const char* DT="0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789";






void main()
{
    NyLPC_TcHttpStream_t st;
    NyLPC_TcHttpBasicHeaderParser_t hp;
    struct NyLPC_THttpBasicHeader reqheader;
    NyLPC_TcHttpHeaderWriter_t hw;
    NyLPC_TcHttpBodyWriter_t bw;
    NyLPC_TcTcpSocket_t ts;
    int body_len;
    NyLPC_cTcpSocket_initialized(NULL,TP2,strlen(TP2));

    //TCPのオープン
    if(!NyLPC_cHttpStream_initialize(&st,&ts)){
        //エラー
    }
    for(;;){
        //ヘッダ解析
        NyLPC_cHttpBasicHeaderParser_initialize(&hp);
        if(!NyLPC_cHttpShortRequestHeaderParser_parse(&hp,&st,&reqheader)){
            //エラー
            puts("Error");
        }
        //ヘッダの内容確認
        if(reqheader.type!=NyLPC_THttpHeaderType_REQUEST){
            //BadRequest
            puts("Error");
        }
        if(reqheader.startline.req.method!=NyLPC_THttpMethodType_GET){
            //リクエストサポートしてない
            puts("Error");
        }
        //
        NyLPC_cHttpHeaderWriter_initialize(&hw,&st,&reqheader);
//      NyLPC_cHttpResponseWriter_setClose(&hw);
        body_len=100;
        NyLPC_cHttpHeaderWriter_setContentLength(&hw,body_len);
        NyLPC_cHttpHeaderWriter_writeResponseHeader(&hw,500);
        NyLPC_cHttpHeaderWriter_close(&hw);

        NyLPC_cHttpBodyWriter_initialize(&bw,&st);
        NyLPC_cHttpBodyWriter_setChunked(&bw);
        NyLPC_cHttpBodyWriter_write(&bw,"TEST",4);
        NyLPC_cHttpBodyWriter_printf(&bw,"TEST");
        NyLPC_cHttpBodyWriter_printf(&bw,"TEST[%s][%d][%c],%%,[%x]","abcde",123,'s',0xff0011);
        NyLPC_cHttpBodyWriter_close(&bw);
        NyLPC_cHttpHttpWriter_finalize(&hw);
    }
    NyLPC_cHttpStream_finalize(&st);
    //TCPのクローズ
    return;
}
#endif