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

Committer:
nyatla
Date:
Fri Apr 26 05:26:34 2013 +0000
Revision:
17:f29e1ca90e3d
Child:
18:1970fec78229
update ModLocalFileSystem list API.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 17:f29e1ca90e3d 1 #include "ModLocalFileSystem.h"
nyatla 17:f29e1ca90e3d 2 #include "HttpdConnection.h"
nyatla 17:f29e1ca90e3d 3 #include "NyLPC_net.h"
nyatla 17:f29e1ca90e3d 4 #include "UrlReader.h"
nyatla 17:f29e1ca90e3d 5 #include <stdio.h>
nyatla 17:f29e1ca90e3d 6 #include <stdlib.h>
nyatla 17:f29e1ca90e3d 7 #include <typeinfo>
nyatla 17:f29e1ca90e3d 8 #include "mbed.h"
nyatla 17:f29e1ca90e3d 9 #include "FATDirHandle.h"
nyatla 17:f29e1ca90e3d 10 #define ModLocalFile_SIZE_OF_BUF 256
nyatla 17:f29e1ca90e3d 11 static char buf[ModLocalFile_SIZE_OF_BUF];
nyatla 17:f29e1ca90e3d 12
nyatla 17:f29e1ca90e3d 13
nyatla 17:f29e1ca90e3d 14 namespace MiMic
nyatla 17:f29e1ca90e3d 15 {
nyatla 17:f29e1ca90e3d 16 ModLocalFileSystem::ModLocalFileSystem(const char* i_path):ModBaseClass(i_path)
nyatla 17:f29e1ca90e3d 17 {
nyatla 17:f29e1ca90e3d 18 }
nyatla 17:f29e1ca90e3d 19 ModLocalFileSystem::ModLocalFileSystem():ModBaseClass()
nyatla 17:f29e1ca90e3d 20 {
nyatla 17:f29e1ca90e3d 21 }
nyatla 17:f29e1ca90e3d 22 ModLocalFileSystem::~ModLocalFileSystem()
nyatla 17:f29e1ca90e3d 23 {
nyatla 17:f29e1ca90e3d 24 }
nyatla 17:f29e1ca90e3d 25 void ModLocalFileSystem::setParam(const char* i_path)
nyatla 17:f29e1ca90e3d 26 {
nyatla 17:f29e1ca90e3d 27 ModBaseClass::setParam(i_path);
nyatla 17:f29e1ca90e3d 28 }
nyatla 17:f29e1ca90e3d 29
nyatla 17:f29e1ca90e3d 30
nyatla 17:f29e1ca90e3d 31 bool ModLocalFileSystem::execute(HttpdConnection& i_connection)
nyatla 17:f29e1ca90e3d 32 {
nyatla 17:f29e1ca90e3d 33 //check platform
nyatla 17:f29e1ca90e3d 34 //<write here! />
nyatla 17:f29e1ca90e3d 35
nyatla 17:f29e1ca90e3d 36 //check prefix
nyatla 17:f29e1ca90e3d 37 if(!this->canHandle(i_connection)){
nyatla 17:f29e1ca90e3d 38 return false;
nyatla 17:f29e1ca90e3d 39 }
nyatla 17:f29e1ca90e3d 40 //Httpd lock
nyatla 17:f29e1ca90e3d 41 i_connection.lockHttpd();
nyatla 17:f29e1ca90e3d 42
nyatla 17:f29e1ca90e3d 43 //set file path
nyatla 17:f29e1ca90e3d 44 {
nyatla 17:f29e1ca90e3d 45 //call ModUrl
nyatla 17:f29e1ca90e3d 46 NyLPC_TcModUrl_t mod;
nyatla 17:f29e1ca90e3d 47 NyLPC_cModUrl_initialize(&mod);
nyatla 17:f29e1ca90e3d 48 if(!NyLPC_cModUrl_execute2(&mod,i_connection._ref_inst,buf,ModLocalFile_SIZE_OF_BUF,0)){
nyatla 17:f29e1ca90e3d 49 NyLPC_cModUrl_finalize(&mod);
nyatla 17:f29e1ca90e3d 50 i_connection.releaseHttpd();
nyatla 17:f29e1ca90e3d 51 return true;
nyatla 17:f29e1ca90e3d 52 }
nyatla 17:f29e1ca90e3d 53 NyLPC_cModUrl_finalize(&mod);
nyatla 17:f29e1ca90e3d 54 }
nyatla 17:f29e1ca90e3d 55 // if path has '/?list' query key,return directory information
nyatla 17:f29e1ca90e3d 56 //otherwise FILE.
nyatla 17:f29e1ca90e3d 57 UrlReader url(buf);
nyatla 17:f29e1ca90e3d 58 if(url.hasQueryKey("list")){
nyatla 17:f29e1ca90e3d 59 //directory-list
nyatla 17:f29e1ca90e3d 60 const char* t;
nyatla 17:f29e1ca90e3d 61 int l;
nyatla 17:f29e1ca90e3d 62 url.getPath(t,l);
nyatla 17:f29e1ca90e3d 63 buf[l]='\0';//split path
nyatla 17:f29e1ca90e3d 64 //remove '/'
nyatla 17:f29e1ca90e3d 65 if(buf[l-1]=='/'){
nyatla 17:f29e1ca90e3d 66 buf[l-1]='\0';
nyatla 17:f29e1ca90e3d 67 }
nyatla 17:f29e1ca90e3d 68
nyatla 17:f29e1ca90e3d 69 DIR* d=opendir(buf);
nyatla 17:f29e1ca90e3d 70 if(NyLPC_cHttpdUtils_sendJsonHeader((i_connection._ref_inst))){
nyatla 17:f29e1ca90e3d 71 if ( d != NULL )
nyatla 17:f29e1ca90e3d 72 {
nyatla 17:f29e1ca90e3d 73 bool is_fatfs=(typeid(*d) == typeid(FATDirHandle));
nyatla 17:f29e1ca90e3d 74 struct dirent *p;
nyatla 17:f29e1ca90e3d 75 p = readdir(d);
nyatla 17:f29e1ca90e3d 76 i_connection.sendBodyF("{\"dir\":\"%s\",\"status\":200,\"list\":[",buf);
nyatla 17:f29e1ca90e3d 77 for(;;)
nyatla 17:f29e1ca90e3d 78 {
nyatla 17:f29e1ca90e3d 79 if(is_fatfs){
nyatla 17:f29e1ca90e3d 80 bool isdir=(((struct direntFAT*)(p))->fattrib & AM_DIR)!=0;
nyatla 17:f29e1ca90e3d 81 i_connection.sendBodyF("{\"name\":\"%s\",\"mtype\":\"%s\",\"size\":%u}",
nyatla 17:f29e1ca90e3d 82 p->d_name,isdir?"directory":NyLPC_cMiMeType_getFileName2MimeType(p->d_name),
nyatla 17:f29e1ca90e3d 83 isdir?0:((struct direntFAT*)(p))->fsize);
nyatla 17:f29e1ca90e3d 84 }else{
nyatla 17:f29e1ca90e3d 85 i_connection.sendBodyF("{\"name\":\"%s\",\"mtype\":\"%s\",\"size\":undefined}",
nyatla 17:f29e1ca90e3d 86 p->d_name,NyLPC_cMiMeType_getFileName2MimeType(p->d_name));
nyatla 17:f29e1ca90e3d 87 }
nyatla 17:f29e1ca90e3d 88 p = readdir(d);
nyatla 17:f29e1ca90e3d 89 if(p==NULL){
nyatla 17:f29e1ca90e3d 90 break;
nyatla 17:f29e1ca90e3d 91 }
nyatla 17:f29e1ca90e3d 92 i_connection.sendBodyF(",");
nyatla 17:f29e1ca90e3d 93 }
nyatla 17:f29e1ca90e3d 94 closedir(d);
nyatla 17:f29e1ca90e3d 95 i_connection.sendBodyF("]}");
nyatla 17:f29e1ca90e3d 96 }else{
nyatla 17:f29e1ca90e3d 97 i_connection.sendBodyF("{\"dir\":\"%s\",\"status\":404,\"list\":[]}",buf);
nyatla 17:f29e1ca90e3d 98 }
nyatla 17:f29e1ca90e3d 99 }
nyatla 17:f29e1ca90e3d 100 }else{
nyatla 17:f29e1ca90e3d 101 {//split URL path and query
nyatla 17:f29e1ca90e3d 102 const char* t;
nyatla 17:f29e1ca90e3d 103 int l;
nyatla 17:f29e1ca90e3d 104 url.getPath(t,l);
nyatla 17:f29e1ca90e3d 105 buf[l]='\0';
nyatla 17:f29e1ca90e3d 106 }
nyatla 17:f29e1ca90e3d 107 //return content
nyatla 17:f29e1ca90e3d 108 FILE *fp;
nyatla 17:f29e1ca90e3d 109 size_t sz;
nyatla 17:f29e1ca90e3d 110 //size
nyatla 17:f29e1ca90e3d 111 fp = fopen(buf, "r");
nyatla 17:f29e1ca90e3d 112 if(fp!=NULL){
nyatla 17:f29e1ca90e3d 113 fseek(fp, 0, SEEK_END); // seek to end of file
nyatla 17:f29e1ca90e3d 114 sz = ftell(fp); // get current file pointer
nyatla 17:f29e1ca90e3d 115 fseek(fp, 0, SEEK_SET); // seek back to beginning of file
nyatla 17:f29e1ca90e3d 116 if(i_connection.sendHeader(200,NyLPC_cMiMeType_getFileName2MimeType(buf),NULL,sz)){
nyatla 17:f29e1ca90e3d 117 for(;;){
nyatla 17:f29e1ca90e3d 118 sz=fread(buf,1,ModLocalFile_SIZE_OF_BUF,fp);
nyatla 17:f29e1ca90e3d 119 if(sz<1){
nyatla 17:f29e1ca90e3d 120 break;
nyatla 17:f29e1ca90e3d 121 }
nyatla 17:f29e1ca90e3d 122 if(!i_connection.sendBody(buf,sz)){
nyatla 17:f29e1ca90e3d 123 break;
nyatla 17:f29e1ca90e3d 124 }
nyatla 17:f29e1ca90e3d 125 // //switch transport thread
nyatla 17:f29e1ca90e3d 126 /* i_connection.releaseHttpd();
nyatla 17:f29e1ca90e3d 127 NyLPC_cThread_yield();
nyatla 17:f29e1ca90e3d 128 i_connection.lockHttpd();
nyatla 17:f29e1ca90e3d 129 */ }
nyatla 17:f29e1ca90e3d 130 }
nyatla 17:f29e1ca90e3d 131 fclose(fp);
nyatla 17:f29e1ca90e3d 132 }else{
nyatla 17:f29e1ca90e3d 133 i_connection.sendHeader(404,"text/html",NULL);
nyatla 17:f29e1ca90e3d 134 i_connection.sendBodyF("<html><body>'%s' not found.</body></html>",buf);
nyatla 17:f29e1ca90e3d 135 }
nyatla 17:f29e1ca90e3d 136 }
nyatla 17:f29e1ca90e3d 137 //Httpd unlock
nyatla 17:f29e1ca90e3d 138 i_connection.releaseHttpd();
nyatla 17:f29e1ca90e3d 139 return true;
nyatla 17:f29e1ca90e3d 140
nyatla 17:f29e1ca90e3d 141 }
nyatla 17:f29e1ca90e3d 142 }