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

core/net/httpd/NyLPC_cHttpRequestPrefixParser.c@12:efe841863fc8, 2013-04-20 (annotated)

Committer:
nyatla
Date:
Sat Apr 20 05:03:57 2013 +0000
Revision:
12:efe841863fc8
Parent:
core/net/httpd/NyLPC_cHttpRequestPrefixParser.cpp@2:b96c1e90d120
Child:
48:00d211aac2ec
MiMic r218

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 2:b96c1e90d120 1 /*********************************************************************************
nyatla 2:b96c1e90d120 2 * PROJECT: MiMic
nyatla 2:b96c1e90d120 3 * --------------------------------------------------------------------------------
nyatla 2:b96c1e90d120 4 *
nyatla 2:b96c1e90d120 5 * This file is part of MiMic
nyatla 2:b96c1e90d120 6 * Copyright (C)2011 Ryo Iizuka
nyatla 2:b96c1e90d120 7 *
nyatla 2:b96c1e90d120 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 2:b96c1e90d120 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 2:b96c1e90d120 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 2:b96c1e90d120 11 * (at your option) any later version.
nyatla 2:b96c1e90d120 12 *
nyatla 2:b96c1e90d120 13 * This program is distributed in the hope that it will be useful,
nyatla 2:b96c1e90d120 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 2:b96c1e90d120 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 2:b96c1e90d120 16 * GNU General Public License for more details.
nyatla 2:b96c1e90d120 17 *
nyatla 2:b96c1e90d120 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 2:b96c1e90d120 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 2:b96c1e90d120 20 *
nyatla 2:b96c1e90d120 21 * For further information please contact.
nyatla 2:b96c1e90d120 22 * http://nyatla.jp/
nyatla 2:b96c1e90d120 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 2:b96c1e90d120 24 *
nyatla 2:b96c1e90d120 25 *********************************************************************************/
nyatla 2:b96c1e90d120 26 #include "NyLPC_cHttpRequestPrefixParser.h"
nyatla 2:b96c1e90d120 27 #include "NyLPC_http.h"
nyatla 2:b96c1e90d120 28
nyatla 2:b96c1e90d120 29
nyatla 2:b96c1e90d120 30
nyatla 2:b96c1e90d120 31
nyatla 2:b96c1e90d120 32
nyatla 2:b96c1e90d120 33 struct THttpHeaderPrefix{
nyatla 2:b96c1e90d120 34 struct NyLPC_THttpBasicHeader super;
nyatla 2:b96c1e90d120 35 /** URL蓄積用のオブジェクト*/
nyatla 2:b96c1e90d120 36 NyLPC_TcStr_t surl;
nyatla 2:b96c1e90d120 37 /** コールバック関数の成功/失敗を判定するフラグ*/
nyatla 2:b96c1e90d120 38 NyLPC_TBool status;
nyatla 2:b96c1e90d120 39 };
nyatla 2:b96c1e90d120 40
nyatla 2:b96c1e90d120 41
nyatla 2:b96c1e90d120 42 static NyLPC_TBool message_handler(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_name,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out)
nyatla 2:b96c1e90d120 43 {
nyatla 2:b96c1e90d120 44 //この関数は使用するはずが無い。
nyatla 2:b96c1e90d120 45 (void)i_inst;
nyatla 2:b96c1e90d120 46 (void)i_name;
nyatla 2:b96c1e90d120 47 (void)i_c;
nyatla 2:b96c1e90d120 48 (void)o_out;
nyatla 2:b96c1e90d120 49 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 50 }
nyatla 2:b96c1e90d120 51
nyatla 2:b96c1e90d120 52 const NyLPC_TChar* NyLPC_cHttpRequestPrefixParser_getUrlPrefix(const NyLPC_TcHttpRequestPrefixParser_t* i_inst)
nyatla 2:b96c1e90d120 53 {
nyatla 2:b96c1e90d120 54 return i_inst->_url;
nyatla 2:b96c1e90d120 55 }
nyatla 2:b96c1e90d120 56 /**
nyatla 2:b96c1e90d120 57 * URLハンドラ。
nyatla 2:b96c1e90d120 58 * 規定文字数のPathを入力されるか、Pathが終了するまで文字列を蓄積する。
nyatla 2:b96c1e90d120 59 */
nyatla 2:b96c1e90d120 60 static NyLPC_TBool urlHandler(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out)
nyatla 2:b96c1e90d120 61 {
nyatla 2:b96c1e90d120 62 struct THttpHeaderPrefix* s=(struct THttpHeaderPrefix*)o_out;
nyatla 2:b96c1e90d120 63
nyatla 2:b96c1e90d120 64 //終端なら終わらせる。
nyatla 2:b96c1e90d120 65 if(i_c=='\0'){
nyatla 2:b96c1e90d120 66 s->status=NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 67 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 68 }
nyatla 2:b96c1e90d120 69 //容量がいっぱい->解析を終わらせる。
nyatla 2:b96c1e90d120 70 if(NyLPC_cStr_capacity(&(s->surl))<1)
nyatla 2:b96c1e90d120 71 {
nyatla 2:b96c1e90d120 72 s->status=NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 73 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 74 }
nyatla 2:b96c1e90d120 75 NyLPC_cStr_put(&(s->surl),i_c);
nyatla 2:b96c1e90d120 76 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 77 }
nyatla 2:b96c1e90d120 78 /**
nyatla 2:b96c1e90d120 79 * デフォルトハンドラ
nyatla 2:b96c1e90d120 80 */
nyatla 2:b96c1e90d120 81 static const struct NyLPC_TcHttpBasicHeaderParser_Handler _handler=
nyatla 2:b96c1e90d120 82 {
nyatla 2:b96c1e90d120 83 message_handler,
nyatla 2:b96c1e90d120 84 urlHandler
nyatla 2:b96c1e90d120 85 };
nyatla 2:b96c1e90d120 86 void NyLPC_cHttpRequestPrefixParser_initialize(NyLPC_TcHttpRequestPrefixParser_t* i_inst)
nyatla 2:b96c1e90d120 87 {
nyatla 2:b96c1e90d120 88 return;
nyatla 2:b96c1e90d120 89 }
nyatla 2:b96c1e90d120 90
nyatla 2:b96c1e90d120 91 NyLPC_TBool NyLPC_cHttpRequestPrefixParser_parse(NyLPC_TcHttpRequestPrefixParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream)
nyatla 2:b96c1e90d120 92 {
nyatla 2:b96c1e90d120 93 struct THttpHeaderPrefix hout;
nyatla 2:b96c1e90d120 94 NyLPC_TcHttpBasicHeaderParser_t parser;
nyatla 2:b96c1e90d120 95 NyLPC_cStr_initialize(&hout.surl,i_inst->_url,NyLPC_TcHttpRequestPrefixParser_MAX_URL_LEN);
nyatla 2:b96c1e90d120 96 hout.status=NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 97 NyLPC_cHttpBasicHeaderParser_initialize(&parser,&_handler);
nyatla 2:b96c1e90d120 98 NyLPC_cHttpBasicHeaderParser_parseInit(&parser,&hout.super);
nyatla 2:b96c1e90d120 99 NyLPC_cHttpBasicHeaderParser_parseStream(&parser,i_stream,&hout.super);//どの道エラー
nyatla 2:b96c1e90d120 100 NyLPC_cHttpBasicHeaderParser_parseFinish(&parser,&hout.super);//どの道エラー
nyatla 2:b96c1e90d120 101 if(!hout.status){
nyatla 2:b96c1e90d120 102 NyLPC_OnErrorGoto(Error);
nyatla 2:b96c1e90d120 103 }
nyatla 2:b96c1e90d120 104 //Errorで帰ってくるのでparsefinishは不要
nyatla 2:b96c1e90d120 105 //NyLPC_cHttpBasicHeaderParser_parseFinish(&parser,&hout.super);
nyatla 2:b96c1e90d120 106 i_inst->method=hout.super.startline.req.method;
nyatla 2:b96c1e90d120 107 NyLPC_cHttpBasicHeaderParser_finalize(&parser);
nyatla 2:b96c1e90d120 108 //この時点では、メソッドとURLの一部がパースされているはず。
nyatla 2:b96c1e90d120 109 NyLPC_cStr_finalize(&hout.surl);
nyatla 2:b96c1e90d120 110 //フラグをチェックして返す。
nyatla 2:b96c1e90d120 111 return NyLPC_TBool_TRUE;
nyatla 2:b96c1e90d120 112 Error:
nyatla 2:b96c1e90d120 113 NyLPC_cHttpBasicHeaderParser_finalize(&parser);
nyatla 2:b96c1e90d120 114 NyLPC_cStr_finalize(&hout.surl);
nyatla 2:b96c1e90d120 115 return NyLPC_TBool_FALSE;
nyatla 2:b96c1e90d120 116 }
nyatla 2:b96c1e90d120 117
nyatla 2:b96c1e90d120 118
nyatla 2:b96c1e90d120 119
nyatla 2:b96c1e90d120 120
nyatla 2:b96c1e90d120 121