Covia UM-125 User manual

CYBERDYNE 株式会社 御中
User manual
Model: UM-125
Brand: Covia
Manufacture: Amigo Technology Inc.

改版履歴
日付 Date
改版者 Revision
版数 Edition
number
改訂内容 Revised content
2017/01/07
Covia Inc.
0.01 版
初版 First eiditon
2017/02/05
Covia Inc.
0.50 版
記載を追加 Additional records
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 2 / 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
1 はじめに Introduction
本仕様書では、UM-125（CDC-AP）ゲートウェイ装置のソフトウェア仕様について記述する。本仕
様書では、原則として GUI の表示形態、表示方法などについては記述しないものとする。
In this Instruction book, UM-125 introduces a Gateway Device of software specification(CDC-
AP). GUI serves as a general display mode in this instruction book, which includes no records of
the displaying method.
2 前提条件 Precondition
2.1 関連規格 Associated specification
本仕様書に記載する内容は、以下の規格に準拠する。
Content recorded in this instruction book measures up to the following standard.
2.2 関連資料
本仕様書に記載する内容は、以下の資料に準拠する。
Content recorded in this instruction book has the following information.
No.
資料 Information
版数 edition
number
出展元 Publish company
1
CCS Web API Document
1
CYBERDYNE 株式会社（Ltd）
2
CNDP 仕様書（CNDP Specification table）
1
CYBERDYNE 株式会社
3
NDP-PROP 仕様書（NDP-PROP Specification
table）
1
CYBERDYNE 株式会社
4
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 3 / 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書（Software
functional specification table）
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
2.3 凡例 Guide
(1) 本仕様書中の項目名は『』内に示す。
【例】『目的』、『機能概要』
(2) 編記
本仕様書の改版時に、変更・追加、削除などの理由・説明等を特に明記する場合には、【編
記】として記載する。この記述は基本的に、次回改版時には削除される。
（1）Project names mentioned in this instruction book is presented in『』.
Esp. 『目的』、『機能概要』
（2）Edit by symbols
In this instruction book, modification, supplement and amendment, especially for reason and
interpretation, etc. when need to be deleted, use 【編記】 to illustrate. Such description
means that it will be deleted in the next version at that time.
2.4 用語 Term
本仕様書で仕様する用語にうち、製品に固有の述語など、特殊で一般的でないものにつき
下表に記載する。
The product-related technical terms in the instruction book are particularly rare and are
described in the following format.
No.
用語 Term
意味 Meanings
1
2
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 4 / 19

2.5 注意事項 Attentions
本仕様書に定義している動作説明において、メモリ構成、フロー図などを用いて説明してい
る箇所が存在する。これは、文章での記述だけでは困難と判断した場合について記載したも
のであり、具体的な実現手法については本仕様書では特に記載しない。
In this instruction book, the act of the memory configuration is defined by parts of the
flowchart. There’s no record of specific implementation procedure for it’s difficult to
describe or judge merely in this book.
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 5 / 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
3 概要 Outline
クラウドサーバーが提供する Web API を利用する際の通信プロトコルにおける基本事項につ
いて本項に記述する。
Use the Web API to provide the cloud server with the basic knowledge of the communication
protocol described in this section.
3.1 ハードウェア概要 Hardware overview
UM-125 のハードウェアブロック図を以下に示す。
The hardware block diagram of the UM 125 is shown below.
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 6 / 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
3.2 ソフトウェア概要 Software overview
UM-125（CDC-AP）のソフトウェアブロック図を以下に示す。
A software block diagram of UM 125 (CDC-AP) is shown below.
No
区分
名称
説明
1
HTML/CSS/JS
WebGUI 部である。Web 経由のログイン画面、各種設定
機能などが含まれる。
This is a part of WebGUI which includes login
screen, settings through the internet, etc.
2
Web Server
独自の軽量 Web サーバー、アプリケーション・サーバー
である。HTTP 通信のみしかサポートしない。
It’s an original lightweight web server of
application. It supports only HTTP communication.
3
Application
Web API Module
WebAPI として公開する機能を提供するモジュールであ
る。
Web API as a module that provides a function to
publish.
システム管理（状態管理・制御）と CDC-AP（マスタ・ス
4
System Manager
レーブ）制御を行うシステムとしてのコアなモジュールと
なる。同時に CNDP（マスタ・スレーブ）にもなる部分で
CNDP Coordinator
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 7 / 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
BT/BLE
CNDP Coordinator と連携して、制御する BT/BLE デバイ
5
スを判断し、CC2564/CC2541 Driver Application を利用
Coordinator
して、デバイスインスタンスの制御を行うモジュールであ
Application
る。
Cooperate with CNDP
Coordinator to control the BT /
BLE device
Use CC2564 / CC2541 Driver
Application to confirm the scan.
It is a module that controls the
device instance.
6
CCS2
CCS2 サーバーとの通信を行い、通信内容により、System
Communicator
Manager に状況をレポートするモジュールである。
CCS2 communicates with the server, communication
content, and system communication.
This is a module that reflects the management situation.
7
FW Updator
UM-125（CDC-AP）のファームウェアを更新するモジュー
である。
UM-125（CDC-AP）is a module
for firmware update.
8
CURL
HTTP/HTTPS 通信用のライブラリ・コマンドを提供する
オープンソースソフトウェアである。
Provide library commands for HTTP /
HTTPS communication
It’s a open source software.
9
OpenSSL
SSL/TLS プロトコル、および暗号化ライブラリを提供す
るオープンソースソフトウェアである。
SSL / TLS protocol, and encryption library.
It is open source software.
10
Python
Python 言語（スクリプト）の実行エンジン機能を提供す
るオープンソースソフトウェアである。
This is an open source software for running
the Python language running engine
functionality (script).
11
Open
JSON Parsor
JSON 構造のデータをデコードするためのライブラリ機能
を提供するオープンソースソフトウェアである。
This is an open source software for providing decoding
library for data of JSON structure.
Source
12
MTD Utils
フラッシュメモリに対する Write/Read/Erase 機能コマン
ドを提供するオープンソースソフトウェアである。
This is a software that provides flash / read / erase
function commands.
13
Wireless Tools
Wi-Fi 関連の機能コマンドを提供するオープンソースソフ
トウェアである。
Open source software that
provides Wi-Fi related function
commands.
14
DHCP
DHCP サーバー、クライアント機能を提供するオープンソ
ースソフトウェアである。
This is an open source to
provide DHCP server and
client-side scanning software.
14
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 8 / 19

4 機能仕様 Functional specification
クラウドサーバーが提供する Web API を利用する際の通信プロトコルにおける基本事項につ
いて本項に記述する。
Basic items in the communication protocol when using the Web API provided by the cloud
server are described in this section.
4.1 機能一覧 Function overview
UM-125（CDC-AP）にて提供する機能を下表に示す。
The functions provided by UM 125 (CDC-AP) are shown in the table below.
ネットワーク機能 Network function
無線 LAN 機能（2.4/5GHz 同時利用可能）Wireless LAN function (2.4 / 5GHz simultaneous possible for use)
無線方式 Wireless mode
5GHz
IEEE802.11a/n/ac
2.4GHz
IEEE802.11b/g/n
暗号化方式 Cipher mode
WEP（64/128bit）、WPA2-PSK（AES）, WPA/WPA2-PSK（AES/TKIP）
SSID 機能 SSID function
マルチ SSID、ステルス SSID Multi SSID, Stealth SSID
その他 Others
UM120 機能に準拠 Conform to UM120 function.
ルータ機能 Router function
フィルタリング機能
Filtering function
IP フィルタリング、MAC フィルタリング、URL フィルタリング
IP filtering, MAC filtering, URL filtering
その他 Others
ルーティング、ポートマッピング、DNS ルーティング、DDNS、DoS、DMZ、
など、他 UM120 機能に準拠
Routing, port mapping, DNS routing, DDNS, DoS, DMZ,
For example, follow other UM120 functions.
設定機能 Setting function
各種設定 Web 画面
Various setting Web
screens
WebAPI
※Basic 認証にて WebAPI 経由で設定変更可能
Settings can be changed via WebAPI with basic authentication
CDC-AP（CYBERDYNE Data Communication Access Point）機能 Function
CDNP エージェント機能 CDNP agent
function
CNDP クライアント機能（デバイスに対して 1 つのインスタンス起
動）
CNDP client function (one instance activation for device)
Bluetooth（BT）アグリゲータ機能 Bluetooth (BT) aggregator function
聚合函数 Aggregate function
CNDP-AP 機能設定機能 CNDP-AP function setting function
WebGUI/WebAPI 認証機能
WebGUI / WebAPI
authentication function
スクリプトを実行する際に実行権限を分けるための認証機能
Authorized certification function will be executed when executing script.
CNDP エージェント設定
CNDP agent setting
CNDP エージェント機能の有効／無効設定
Enable / disable CNDP agent function
Bluetooth 機能設定
Bluetooth Function
setting
Bluetooth 機能の有効／無効設定
Enable / disable Bluetooth function
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 9 / 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
CCS2 サーバー設定
CCS2 server setting
CCS2 サーバーアドレスおよびユーザーアカウント認証設定
CCS2 server address and user account authentication settings
FW アップデータ設定
FW update settings
FW アップデートの自動／手動設定
Automatic / manual setting of FW
update
デバイス設定
Device
settings
処理対象のデバイスを判断するためのホワイトリスト・ブラックリ
ストの設定
White list / black list setting for judging
the processing target device
スクリプト設定
Script settings
スクリプトの登録および実行
Register and execute script
通信帯域設定
Communicatio
n band setting
CNDP プロトコル通信の帯域制御設定
Bandwidth control setting for CNDP
protocol communication
設定機能 Setting
function
T.B.D
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 10/ 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
UM 125 (CDC-AP) Software Function Specification
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
4.2 機能一覧 Function overview
4.2.1 UM-125（CDC-AP）デバイス入出力インターフェイス
UM 125 (CDC-AP) device input / output connector
4.2.1.1 ボタン・スイッチ仕様 Button Switch Specifications
UM-125（CDC-AP）に搭載されるボタンおよびスイッチの動作仕様について下表に示す。
Operating specifications of buttons and switches mounted on UM 125 (CDC-AP) are
shown in the table below.
No
区分
名称
操作
制御条件 System conditions
OFF から ON
OFF to ON
動作モードをマスタモードからスレーブモ
1
スイッチ
switch
モードスイッチ
Mode switch
押下
Press down
WPS 設定モードへの移行または工場出荷リ
2
ボタン
button
WPS
セット待機モードへ突入
Move to WPS setting mode or enter factory
reset wait mode.
3 秒間長押し
Long press for 3
seconds
Wi-Fi 機能有効時、WPS 設定モードに移行
する（Wi-Fi 機能無効時は無動作）
When Wi-Fi function is enabled, switch to WPS
setting mode.
(No operation when the Wi-Fi function is
disabled)
押下
Press down
工場出荷リセット待機モード時に押下され
3
ボタン
button
リセットボタン
Reset button
た場合、工場出荷リセットを実行する。
Factory shipment reset when pressed in
standby mode.
3 秒間長押し
Long press for 3
seconds
システムを再起動する。
Reboot the system.
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 11 / 19

4.2.1.2 LED 仕様 LED specification
UM-125（CDC-AP）に搭載される LED（Mode、Wi-Fi、BT/BLE）の制御仕様に
ついて下表に示す。
The control specifications of the LED (Mode, Wi-Fi, BT / BLE) mounted on the UM 125
(CDC-AP) are shown in the table below.
No
LED 区分
LED 種
LED 状態
制御条件 System conditions
1
BLINK
CDC-AP がスレーブモードの場合かつ上流との通信を行
っている場合（通信量により Blinking 間隔を調整）
When the CDC-AP is in communicating with the upstream
(the blinking interval is adjusted according to communication
volume)
2
RED
OFF
成功稼働時
when operation is successful
3
BLINK
DC 駆動時の電圧低下時（T.B.D）
When voltage drops during DC drive
（T.B.D）
4
LED2
ORANGE
OFF
ネットワークに接続されている場合または Wi-Fi 無効時
When connected to the wrong network or when Wi-Fi is
disabled
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 12/ 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
10
(Wi-Fi)
ON
Wi-Fi 接続をしている・されている場合
When connected with WIFI
11
OFF
Wi-Fi 接続をされていない・していない場合または Wi-Fi
GREEN
無効時
No WIFI connection or
WIFI is disabled
12
ON
Wi-Fi 接続をしている・されている場合
When connected with WIFI
13
BLINK
Wi-Fi 通信中の場合
When communicating with
WIFI
14
RED
OFF
Wi-Fi 正常稼働中または Wi-Fi 無効時
When Wi-Fi is operating normally or Wi-Fi is
disabled
15
ON
Wi-Fi で何かしらのエラーが発生して機能していない場
合
When some error occurs
on Wi-Fi and it is not
functioning
16
OFF
BT/BLE 通信および接続がある場合または BT/BLE 無効
ORANGE
時
When there is BT / BLE
communication connection or
when BT / BLE is invalid
17
ON
BT/BLE 通信および接続がない場合
When there is no BT / BLE communication
and connection
18
OFF
BT/BLE 通信および接続がない場合または BT/BLE 無効
LED3
GREEN
時
When there is no BT /
BLE communication
connection, or when BT /
BLE is invalid
19
ON
BT/BLE 通信および接続がある場合
When there is no BT / BLE
communication and connection
(BT/BLE)
20
BLINK
BT/BLE 通信および接続がある場合かつ通信中の場合
When there is BT / BLE communication connection
21
OFF
BT/BLE が正常に稼働している場合または BT/BLE 無効
RED
時
When BT / BLE is
operating normally, or
when BT / BLE is invalid
22
BLINK
BT/BLE エラー事象により BT/BLE 機能が機能しない場
合
When BT / BLE function
does not function due to
BT / BLE error event
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 13 / 19

4.2.1.3 USB 端子 USB terminal
UM-125（CDC-AP）においては USB 端子を利用した機能は提供しない。（将来拡張用）
UM 125 (CDC-AP) does not provide the function using the USB terminal. (for future expansion)
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 14/ 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
4.2.2 ネットワーク機能（T.B.D）Network function（T.B.D）
UM-125（CDC-AP）は、UM120 と基本的に同等のネットワーク機能を提供する。（T.B.D
メッシュ機能）
UM 125 (CDC-AP) provides basically the same network function as UM 120. (TB D mesh function)
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 15/ 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
4.2.3 CDC-AP（CYBERDYNE Data Communication Access Point）機能
CDC-AP (CYBERDYNE Data Communication Access Point) Function
4.2.3.1 CDC-AP 機能概要 CDC-AP function overview
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 16 / 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
4.2.3.2.1 基本機能 Basic function
4.2.3.2.1.1 動作モード制御機能 Operation mode control function
動作モードの切り替えは、UM-125（CDC-AP）機器のモードスイッチの ON/OFF にて切り替え
を行う。モードの切り替えは再起動を伴わずに動的に変更することが可能である。
Switching of the operation mode is performed by turning on / off the mode switch of UM 125
(CDC-AP) equipment. Switching of modes can be dynamically changed without rebooting.
4.2.3.2.1.2 CNDP プロトコル制御 CNDP protocol control
UM-125 には、「CNDP 仕様書」に準拠したプロトコル層が搭載され、デバイスに関連した通信
は全て CNDP プロトコルに従い、送受信される。それぞれの UM-125（CDC-AP）には、CNDP
Host Agen が１つ、CNDP Client を監視対象デバイス分のインスタンスを起動する。機能の内
容について、「CNDP 仕様書」に記載される機能が漏れなく提供する。
The UM 125 is equipped with a protocol layer conforming to the "CNDP Specification", and
all communication related to the device is transmitted and received according to the CNDP
protocol. In each UM 125 (CDC-AP), one CNDP Host Agen is launched, and an instance of the
monitoring target device is started for CNDP Client. For the content of the function, the
functions described in the "CNDP Specification" is provided without omission.
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 17/ 19

Confidential
UM-125（CDC-AP）ソフトウェア機能仕様書
版数
改版日
作成者
0.01 版
2016.01.07
Covia Inc.
4.2.3.2.3 BT/BLE デバイス制御機能 BT / BLE device control function
4.2.3.2.3.1 BT/BLE デバイス探索機能 BT / BLE device search function
UM-125（CDC-AP）デバイスは、BT/BLE 機能を有効に設定された場合、BT/BLE デバイスの
スキャンを定期的（周期は T.B.D）に実行して、その内容を漏れなく、「マスタ」の
When the BT / BLE function is enabled, the UM 125 (CDC-AP) device executes the scan of
the BT / BLE device regularly (period is TBD), and without missing the content
4.2.3.2.3.3 BT/BLE デバイスモニタ機能 BT / BLE device monitor function
BT/BLE デバイスによりその構造や仕様が異なる。よって、この構造を内部的に JSON 形式にて
記述し、その情報を元に BT/BLE デバイスよりデータ収集やイベント検知を行う。データの収集周
期については、監視するセンサーが多い場合、設定周期にて収集出来ない可能性ため、処理可
能な状態（BT/BLE 通信が当該デバイスに対して可能な状態）になった、かつ収集周期を超えてい
た場合に実施するものとする。
It’s structure and specification are different depending on the BT / BLE device. Therefore, we
describe this structure internally in JSON format and perform data collection and event
detection from the BT / BLE device based on this information. As for the collection period of
data, if there are many sensors to be monitored, it is possible that it can not be collected at the
setting cycle, so it can be processed (BT / BLE communication is possible for the device) It shall
be carried out when it exceeds the period.
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 18/ 19

FCC Caution.
This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not
cause harmful interference, and (2) this device must accept any interference received, including interference that may cause
undesired operation.
Any Changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to
operate the equipment.
Note: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the
FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation.
This equipment generates uses and can radiate radio frequency energy and, if not installed and used in accordance with the
instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not
occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be
determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the
following measures:
-Reorient or relocate the receiving antenna.
-Increase the separation between the equipment and receiver.
-Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
-Consult the dealer or an experienced radio/TV technician for help.
This equipment complies with FCC radiation exposure limits set forth for an uncontrolled environment. This equipment should be
installed and operated with minimum distance 20cm between the radiator & your body.
Indoor use only
© Covia Inc. reserves all rights, including rights of disposal such as copying and passing on to third parties.
Created on Jan-6-2017
UM-125_system_requirement_v001.docx
Page 19/ 19