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

mbed/UdpSocket.cpp@114:f6aef16d4e60, 2016-06-04 (annotated)

Committer:
nyatla
Date:
Sat Jun 04 06:51:04 2016 +0000
Revision:
114:f6aef16d4e60
Parent:
110:257739f9b31e 
include????????; ???????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 58:03b89038b21a 1 ////////////////////////////////////////////////////////////////////////////////
nyatla 58:03b89038b21a 2 // UdpSocket.cpp
nyatla 58:03b89038b21a 3 ////////////////////////////////////////////////////////////////////////////////
nyatla 58:03b89038b21a 4
nyatla 58:03b89038b21a 5 #include "UdpSocket.h"
nyatla 109:18f12ac01097 6 #include "mbed.h"
nyatla 58:03b89038b21a 7
nyatla 58:03b89038b21a 8
nyatla 58:03b89038b21a 9
nyatla 58:03b89038b21a 10 namespace MiMic
nyatla 58:03b89038b21a 11 {
nyatla 58:03b89038b21a 12 #define TIMEOUT_IN_MSEC (2*1000)
nyatla 58:03b89038b21a 13
nyatla 109:18f12ac01097 14 void UdpSocket::rxhandler(NyLPC_TiUdpSocket_t* i_inst,const void* i_buf,const struct NyLPC_TIPv4RxInfo* i_info)
nyatla 58:03b89038b21a 15 {
nyatla 109:18f12ac01097 16 UdpSocket* sock=(UdpSocket*)i_inst->_tag;
nyatla 109:18f12ac01097 17 sock->onRxHandler(i_buf,i_info);
nyatla 58:03b89038b21a 18 }
nyatla 58:03b89038b21a 19
nyatla 109:18f12ac01097 20 UdpSocket::UdpSocket(unsigned short i_port,bool i_nobuffer)
nyatla 58:03b89038b21a 21 {
nyatla 109:18f12ac01097 22 if(i_nobuffer){
nyatla 110:257739f9b31e 23 this->_inst=NyLPC_cNet_createUdpSocketEx(i_port,NyLPC_TSocketType_UDP_NOBUF);
nyatla 109:18f12ac01097 24 }else{
nyatla 110:257739f9b31e 25 this->_inst=NyLPC_cNet_createUdpSocketEx(i_port,NyLPC_TSocketType_UDP_NORMAL);
nyatla 109:18f12ac01097 26 }
nyatla 109:18f12ac01097 27 if(this->_inst==NULL){
nyatla 109:18f12ac01097 28 mbed_die();
nyatla 109:18f12ac01097 29 }
nyatla 58:03b89038b21a 30 }
nyatla 58:03b89038b21a 31 UdpSocket::~UdpSocket()
nyatla 58:03b89038b21a 32 {
nyatla 109:18f12ac01097 33 NyLPC_iUdpSocket_finalize(this->_inst);
nyatla 58:03b89038b21a 34 }
nyatla 60:803de2088243 35 bool UdpSocket::canRecv()
nyatla 60:803de2088243 36 {
nyatla 60:803de2088243 37 const void* rx;
nyatla 60:803de2088243 38 const struct NyLPC_TIPv4RxInfo* info;
nyatla 109:18f12ac01097 39 return NyLPC_iUdpSocket_precv(this->_inst,&rx,&info,TIMEOUT_IN_MSEC)>0;
nyatla 60:803de2088243 40 }
nyatla 58:03b89038b21a 41
nyatla 64:258e84040262 42 int UdpSocket::precvFrom(const void* &i_rx,IpAddr* i_peer_host,unsigned short* i_port)
nyatla 58:03b89038b21a 43 {
nyatla 58:03b89038b21a 44 const struct NyLPC_TIPv4RxInfo* info;
nyatla 109:18f12ac01097 45 int rs=NyLPC_iUdpSocket_precv(this->_inst,&i_rx,&info,TIMEOUT_IN_MSEC);
nyatla 58:03b89038b21a 46 if(rs>1){
nyatla 58:03b89038b21a 47 if(i_peer_host!=NULL){
nyatla 58:03b89038b21a 48 i_peer_host->setIPv4(info->peer_ip);
nyatla 58:03b89038b21a 49 }
nyatla 58:03b89038b21a 50 if(i_port!=NULL){
nyatla 58:03b89038b21a 51 *i_port=info->peer_port;
nyatla 58:03b89038b21a 52 }
nyatla 58:03b89038b21a 53 }
nyatla 58:03b89038b21a 54 return rs;
nyatla 58:03b89038b21a 55 }
nyatla 64:258e84040262 56 int UdpSocket::precvFrom(const char* &i_rx,IpAddr* i_peer_host,unsigned short* i_port)
nyatla 60:803de2088243 57 {
nyatla 60:803de2088243 58 const struct NyLPC_TIPv4RxInfo* info;
nyatla 109:18f12ac01097 59 int rs=NyLPC_iUdpSocket_precv(this->_inst,(const void**)&i_rx,&info,TIMEOUT_IN_MSEC);
nyatla 60:803de2088243 60 if(rs>1){
nyatla 60:803de2088243 61 if(i_peer_host!=NULL){
nyatla 60:803de2088243 62 i_peer_host->setIPv4(info->peer_ip);
nyatla 60:803de2088243 63 }
nyatla 60:803de2088243 64 if(i_port!=NULL){
nyatla 60:803de2088243 65 *i_port=info->peer_port;
nyatla 60:803de2088243 66 }
nyatla 60:803de2088243 67 }
nyatla 60:803de2088243 68 return rs;
nyatla 60:803de2088243 69 }
nyatla 58:03b89038b21a 70
nyatla 64:258e84040262 71 void UdpSocket::precvNext(void)
nyatla 58:03b89038b21a 72 {
nyatla 109:18f12ac01097 73 NyLPC_iUdpSocket_pseek(this->_inst);
nyatla 58:03b89038b21a 74 }
nyatla 58:03b89038b21a 75
nyatla 58:03b89038b21a 76 bool UdpSocket::sendTo(const IpAddr& i_host,unsigned short i_port,const void* i_tx,unsigned short i_tx_size)
nyatla 58:03b89038b21a 77 {
nyatla 109:18f12ac01097 78 int r=NyLPC_iUdpSocket_send(this->_inst,&i_host.addr.v4,i_port,i_tx,i_tx_size,TIMEOUT_IN_MSEC);
nyatla 60:803de2088243 79 return (r==i_tx_size);
nyatla 58:03b89038b21a 80
nyatla 58:03b89038b21a 81 }
nyatla 58:03b89038b21a 82
nyatla 58:03b89038b21a 83 void UdpSocket::joinMulticast(const IpAddr& i_host)
nyatla 58:03b89038b21a 84 {
nyatla 109:18f12ac01097 85 NyLPC_iUdpSocket_joinMulticast(this->_inst,&i_host.addr.v4);
nyatla 58:03b89038b21a 86 }
nyatla 58:03b89038b21a 87 void UdpSocket::setBroadcast(void)
nyatla 58:03b89038b21a 88 {
nyatla 109:18f12ac01097 89 NyLPC_iUdpSocket_setBroadcast(this->_inst);
nyatla 58:03b89038b21a 90
nyatla 58:03b89038b21a 91 }
nyatla 109:18f12ac01097 92 }