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/driver/flash/k64f/K64F_IAP.h@92:4f77028cce64, 2014-10-01 (annotated)

Committer:
nyatla
Date:
Wed Oct 01 13:58:53 2014 +0000
Revision:
92:4f77028cce64
?????????????????; K64F??????????????; LPC?????????????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 92:4f77028cce64 1 /**
nyatla 92:4f77028cce64 2 * Copyright 2014 MiMicProject
nyatla 92:4f77028cce64 3 * Licensed under the Apache License, Version 2.0 (the "License");
nyatla 92:4f77028cce64 4 * you may not use this file except in compliance with the License.
nyatla 92:4f77028cce64 5 * You may obtain a copy of the License at
nyatla 92:4f77028cce64 6 *
nyatla 92:4f77028cce64 7 * http://www.apache.org/licenses/LICENSE-2.0
nyatla 92:4f77028cce64 8 *
nyatla 92:4f77028cce64 9 * Unless required by applicable law or agreed to in writing, software
nyatla 92:4f77028cce64 10 * distributed under the License is distributed on an "AS IS" BASIS,
nyatla 92:4f77028cce64 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
nyatla 92:4f77028cce64 12 * See the License for the specific language governing permissions and
nyatla 92:4f77028cce64 13 * limitations under the License.
nyatla 92:4f77028cce64 14 */
nyatla 92:4f77028cce64 15 /**
nyatla 92:4f77028cce64 16 * This file based on https://mbed.org/users/Sissors/code/FreescaleIAP/
nyatla 92:4f77028cce64 17 */
nyatla 92:4f77028cce64 18 #ifndef K64F_IAP_h
nyatla 92:4f77028cce64 19 #define K64F_IAP_h
nyatla 92:4f77028cce64 20 #include "NyLPC_config.h"
nyatla 92:4f77028cce64 21 #if NyLPC_MCU==NyLPC_MCU_K64F
nyatla 92:4f77028cce64 22 #ifdef __cplusplus
nyatla 92:4f77028cce64 23 extern "C" {
nyatla 92:4f77028cce64 24 #endif /* __cplusplus */
nyatla 92:4f77028cce64 25 #define K64F_IAP_SECTOR_SIZE 4096
nyatla 92:4f77028cce64 26
nyatla 92:4f77028cce64 27 typedef int K64F_IAP_TIAPCode;
nyatla 92:4f77028cce64 28
nyatla 92:4f77028cce64 29 #define K64F_IAP_TIAPCode_BoundaryError -99 //Commands may not span several sectors
nyatla 92:4f77028cce64 30 #define K64F_IAP_TIAPCode_AlignError -98 //Data must be aligned on longword (two LSBs zero)
nyatla 92:4f77028cce64 31 #define K64F_IAP_TIAPCode_ProtectionError -97 //Flash sector is protected
nyatla 92:4f77028cce64 32 #define K64F_IAP_TIAPCode_AccessError -96 //Something went wrong
nyatla 92:4f77028cce64 33 #define K64F_IAP_TIAPCode_CollisionError -95 //During writing something tried to flash which was written to
nyatla 92:4f77028cce64 34 #define K64F_IAP_TIAPCode_LengthError -94 //The length must be multiples of 4
nyatla 92:4f77028cce64 35 #define K64F_IAP_TIAPCode_RuntimeError -93
nyatla 92:4f77028cce64 36 #define K64F_IAP_TIAPCode_EraseError -92 //The flash was not erased before writing to it
nyatla 92:4f77028cce64 37 #define K64F_IAP_TIAPCode_Success 0
nyatla 92:4f77028cce64 38
nyatla 92:4f77028cce64 39
nyatla 92:4f77028cce64 40 /** Erase a flash sector
nyatla 92:4f77028cce64 41 *
nyatla 92:4f77028cce64 42 * The size erased depends on the used device
nyatla 92:4f77028cce64 43 *
nyatla 92:4f77028cce64 44 * @param address address in the sector which needs to be erased
nyatla 92:4f77028cce64 45 * @param return Success if no errors were encountered, otherwise one of the error states
nyatla 92:4f77028cce64 46 */
nyatla 92:4f77028cce64 47 K64F_IAP_TIAPCode K64F_IAP_erase_sector(int address);
nyatla 92:4f77028cce64 48
nyatla 92:4f77028cce64 49 /** Program flash
nyatla 92:4f77028cce64 50 *
nyatla 92:4f77028cce64 51 * Before programming the used area needs to be erased. The erase state is checked
nyatla 92:4f77028cce64 52 * before programming, and will return an error if not erased.
nyatla 92:4f77028cce64 53 *
nyatla 92:4f77028cce64 54 * @param address starting address where the data needs to be programmed (must be longword alligned: two LSBs must be zero)
nyatla 92:4f77028cce64 55 * @param data pointer to array with the data to program
nyatla 92:4f77028cce64 56 * @param length number of bytes to program (must be a multiple of 4. must be a multiple of 8 when K64F)
nyatla 92:4f77028cce64 57 * @param return Success if no errors were encountered, otherwise one of the error states
nyatla 92:4f77028cce64 58 */
nyatla 92:4f77028cce64 59 K64F_IAP_TIAPCode K64F_IAP_program_flash(int address, char *data, unsigned int length);
nyatla 92:4f77028cce64 60
nyatla 92:4f77028cce64 61 /**
nyatla 92:4f77028cce64 62 * Returns size of flash memory
nyatla 92:4f77028cce64 63 *
nyatla 92:4f77028cce64 64 * This is the first address which is not flash
nyatla 92:4f77028cce64 65 *
nyatla 92:4f77028cce64 66 * @param return length of flash memory in bytes
nyatla 92:4f77028cce64 67 */
nyatla 92:4f77028cce64 68 unsigned int K64F_IAP_flash_size(void);
nyatla 92:4f77028cce64 69 #ifdef __cplusplus
nyatla 92:4f77028cce64 70 }
nyatla 92:4f77028cce64 71 #endif /* __cplusplus */
nyatla 92:4f77028cce64 72 #endif
nyatla 92:4f77028cce64 73 #endif