智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本...

40
1 TL Proprietary 目錄 1. 簡介 ................................................................................................................................................................................... 3 1.1. 名詞......................................................................................................................................................................... 3 1.2. TaiSEIA 用詞 ....................................................................................................................................................... 3 1.3. 資料格式............................................................................................................................................................... 3 1.4. 文件版本............................................................................................................................................................... 4 2. MQTT 格式.................................................................................................................................................................... 4 2.1 App 即時訂閱家電回覆狀態 ........................................................................................................................ 4 2.2 App 訂閱接收成功控制回覆訊息............................................................................................................... 6 2.3 App 訂閱控制回覆成功與否訊息............................................................................................................... 7 2.3.1 錯誤代碼 fault_code.................................................................................................................................... 8 2.4 App 訂閱系統控制回覆訊息 ........................................................................................................................ 8 2.5 App 回覆接收訊息完成 Ack ...................................................................................................................... 11 2.6 App 接收 Dongle 系統變更訊息 .............................................................................................................. 12 2.7 App 查詢 Dongle 連線狀況........................................................................................................................ 14 3. RESTful 家電控制..................................................................................................................................................... 15 3.1 App 下達控制命令......................................................................................................................................... 15 3.2 App 下達接收 ack 完成 ............................................................................................................................... 16 3.3 取得家電註冊回報訊息.......................................................................................................................... 16 3.4 取得家電當前狀態 ................................................................................................................................... 17 3.5 取得 Dongle 設定資訊 ............................................................................................................................ 19 4. RESTful 系統相關查測及維運............................................................................................................................. 20 4.1 韌體更新....................................................................................................................................................... 20 4.2 重新啟動....................................................................................................................................................... 21 4.3 重新網路校時 ............................................................................................................................................. 22 4.4 查詢 Dongle wifi 連線訊號強度.......................................................................................................... 23

Transcript of 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本...

Page 1: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

1 TL Proprietary

目錄

1. 簡介 ................................................................................................................................................................................... 3

1.1. 名詞 ......................................................................................................................................................................... 3

1.2. TaiSEIA用詞 ....................................................................................................................................................... 3

1.3. 資料格式 ............................................................................................................................................................... 3

1.4. 文件版本 ............................................................................................................................................................... 4

2. MQTT 格式 .................................................................................................................................................................... 4

2.1 App即時訂閱家電回覆狀態 ........................................................................................................................ 4

2.2 App訂閱接收成功控制回覆訊息 ............................................................................................................... 6

2.3 App訂閱控制回覆成功與否訊息 ............................................................................................................... 7

2.3.1 錯誤代碼 fault_code .................................................................................................................................... 8

2.4 App訂閱系統控制回覆訊息 ........................................................................................................................ 8

2.5 App回覆接收訊息完成 Ack ...................................................................................................................... 11

2.6 App接收 Dongle系統變更訊息 .............................................................................................................. 12

2.7 App查詢 Dongle連線狀況 ........................................................................................................................ 14

3. RESTful家電控制 ..................................................................................................................................................... 15

3.1 App下達控制命令 ......................................................................................................................................... 15

3.2 App下達接收 ack完成 ............................................................................................................................... 16

3.3 取得家電註冊回報訊息 .......................................................................................................................... 16

3.4 取得家電當前狀態 ................................................................................................................................... 17

3.5 取得 Dongle設定資訊 ............................................................................................................................ 19

4. RESTful系統相關查測及維運 ............................................................................................................................. 20

4.1 韌體更新 ....................................................................................................................................................... 20

4.2 重新啟動 ....................................................................................................................................................... 21

4.3 重新網路校時 ............................................................................................................................................. 22

4.4 查詢 Dongle wifi連線訊號強度 .......................................................................................................... 23

Page 2: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

2 TL Proprietary

4.5 Dongle啟用命令 ............................................................................................................................................ 24

4.6 家電重新註冊訊息 ................................................................................................................................... 25

4.7 設定 Timer Polling週期 ........................................................................................................................ 26

4.8 設定 AES加密啟用與否 ......................................................................................................................... 27

4.9 App查詢 Dongle連線狀況 ........................................................................................................................ 28

4.10 設定家電控制器使用者名稱 ................................................................................................................ 28

5. IOT平台註冊流程 ........................................................................................................................................................... 30

5.1 流程圖 .................................................................................................................................................................... 30

5.2 掃描 QR code ....................................................................................................................................................... 30

5.3 APP測試連線,確認客戶輸入密碼正確 .............................................................................................. 31

5.4 APP改連至 CHT控制器............................................................................................................................... 31

5.5 傳送Wifi ap 帳號密碼至 CHT控制器 ................................................................................................... 31

5.6 APP開通 IOT平台 ......................................................................................................................................... 32

6. 附錄-TaiSEIA協定 ................................................................................................................................................... 33

6.1 智慧家電類別碼 type_id ............................................................................................................................ 33

6.2 智慧家電功能表 service_id ....................................................................................................................... 33

6.2.1 冷氣機 0x01 ................................................................................................................................................ 33

6.2.2 電扇 0x0F ..................................................................................................................................................... 34

6.3 註冊資訊 ............................................................................................................................................................ 35

Page 3: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

3 TL Proprietary

1. 簡介

1.1. 名詞

TaiSEIA 由台灣智慧能源產業協會所訂定之智慧家庭物聯網主從通訊架構標準。

Dongle MTK Linkit 7688開發板,嵌入式 Linux系統,用以介接家電設備。

APP 供使用者手機上操作使用之應用程式,可為 Android或 iOS系統。

1.2. TaiSEIA用詞

type_id 智慧家電類別碼,例如冷氣機 0x01、除溼機 0x04、電扇 0x0F等。

service_id 家電的狀態或是控制功能,例如冷氣機有電源控制功能 0x00與室內溫

度顯示功能 0x04。

詳細 type_id與 service_id列表,請參考附錄-TAISEIA協定

1.3. 資料格式 由於 TaiSEIA協定中皆使用固定長度之 binary格式,為了能夠對應 RESTful API與 MQTT

中的 JSON格式都能正確表示,因此採以十六進位之固定長度字串表示,並且字母部分為小寫。

type_id service_id value

長度 2 2 4

例值 "01" "03" "001b"

Page 4: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

4 TL Proprietary

1.4. 文件版本

日期 更改內容

2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

2016-1013 TaiSEIA 102協定, 包含網路控制間一問一答, Dongle系統存取(重開機,wifi訊

號等)

2016-1130 通訊封包內容改為 Json格式

2. MQTT 格式

2.1 App即時訂閱家電回覆狀態

Topic /v1/device/${device_id}/sensor/Reply/rawdata

帳號 ${API_KEY}

密碼 ${API_KEY}

TLS port : 8883

說明 Dongle定時更新裝置狀態至 IOT平台

發佈者 Dongle

訂閱者 App

範例 以回應平台為例:

內容

(冷氣

為例)

{

"id":"Reply",

"deviceId":"828405796",

"time":"2016-09-26T11:01:42Z",

"value":

[

"{

"type":"01",

"service_number":"15",

"service_00":"0001",

Page 5: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

5 TL Proprietary

"service_01":"0000",

"service_02":"0002",

"service_03":"0017",

"service_04":"001c",

"service_06":"0000",

"service_0b":"0000",

"service_0c":"0000",

"service_0e":"0000",

"service_11":"0003",

"service_14":"0033",

"service_17":"0000",

"service_1d":"0000",

"service_1e":"0000",

"service_1f":"0000",

"service_20":"0000",

"service_21":"00d3",

"service_24":"0002",

"service_29":"0000",

"service_50":"0000",

"service_51":"0000"

}"

]

}

※type請參考 3.1智慧家電類別碼 type_id

※service_00請參考 3.1.1智慧家電功能表 service_id

※service_number為回報 total service數目

Page 6: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

6 TL Proprietary

2.2 App訂閱接收成功控制回覆訊息

Topic /v1/device/${device_id}/sensor/ControlReceive/rawdata

說明 當平台下達控制命令後, Dongle回覆接收到控制訊息

帳號 ${API_KEY}

密碼 ${API_KEY}

TLS port : 8883

發佈者 Dongle

訂閱者 App

範例 以回應平台為例:

內容 1 {

"id": "ControlReply",

"deviceId": "857480979",

"time": "2016-12-08T10:48:22Z",

"value": [

{

"type":"01",

"service":"00",

"value":"0000",

"user":"AABBCC",

"Receive":"OK"

}

]

}

Page 7: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

7 TL Proprietary

2.3 App訂閱控制回覆成功與否訊息

Topic /v1/device/${device_id}/sensor/ControlReply/rawdata

說明 當平台下達控制命令後, Dongle回報控制狀況

帳號 ${API_KEY}

密碼 ${API_KEY}

TLS port : 8883

發佈者 Dongle

訂閱者 App

範例 以回應平台為例:

內容 1 {

"id": "ControlReply",

"deviceId": "857480979",

"time": "2016-12-08T10:48:22Z",

"value": [

{

"type":"01",

"service":"00",

"value":"0000",

"user":"AABBCC",

"faultcode":"00000"

}

]

}

※fault_code請參考 2.4.2錯誤代碼 fault_code

※type為家電類別

※service為接收到之控制服務

※user為接收到之使用者編號, 使用者編號目前最多可放入 20碼

Page 8: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

8 TL Proprietary

2.3.1 錯誤代碼 fault_code

錯誤代碼 說明

00000 成功。

90001 逾時。家電超過一定時間無回應。

90100 type_id有錯,不支援此 type_id或是該 dongle不是介接這種家電。

90200 service_id有錯,這項家電無此 service_id或是目前尚未實作。

90300 value有錯,格式不符或是值超出可控制範圍。

99999 其他尚未定義的錯誤。

2.4 App訂閱系統控制回覆訊息

Topic /v1/device/${device_id}/sensor/SystemControl/rawdata

說明 當平台下達系統控制命令後, Dongle回報系統狀況

帳號 ${API_KEY}

密碼 ${API_KEY}

TLS port : 8883

發佈者 Dongle

訂閱者 App

範例 以回應平台為例:

內容 1 {

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":[${Message},${Message2}]

}

內容

(Reboot完成為

例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["Reboot-OK","0"]

}

內容

(已接收 Reboot

{

"id":"SystemControl",

Page 9: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

9 TL Proprietary

訊息為例) "deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["Reboot-Receive","0"]

}

內容

(韌體更新完成

為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["OAD-OK","0"]

}

內容

(已接收韌體更

新訊息為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["OAD-Receive","0"]

}

內容

(Clock更新完成

為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["Clock-OK","0"]

}

內容

(已接收 Clock

訊息為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["Clock-Receive","0"]

}

內容

(RSSI回傳為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["RSSI","-66"]

}

內容

(已接收 RSSI訊

息為例)

{

"id":"SystemControl",

"deviceId":"828405796",

Page 10: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

10 TL Proprietary

"time":"2016-09-26T10:34:41Z",

"value":["RSSI-Receive","0"]

}

內容

(Register回傳

為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":[" Register–OK","0"]

}

內容

(已接收 RSSI訊

息為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":[" Register-Receive","0"]

}

內容

(已接收

Program Enable

訊息為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":[" ProgramEnable-Receive","0"]

}

內容

(Program

Enable回傳為

例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":[" ProgramEnable-OK","0"]

}

內容

(已接收 AES啟

用訊息為例)

{

"id":"SystemControl",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":[" AESflag-Receive","0"]

}

Page 11: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

11 TL Proprietary

※Message2為預留用途, 在 RSSI裡面 Message2做為回傳 wifi訊號強度

2.5 App回覆接收訊息完成 Ack

Topic /v1/device/${device_id}/sensor/CloudAck/rawdata

說明 當 App接收到 Reply更新與 ControlReply 回報後, 發送 Ack通知 Dongle

帳號 ${API_KEY}

密碼 ${API_KEY}

TLS port : 8883

發佈者 App

訂閱者 Dongle

範例 以回應平台為例:

內容 1 {

"id":"CloudAck",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":[${message},"OK"]

}

內容

(冷氣接收到

狀態變更為

例)

{

"id":"CloudAck",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["Reply","OK"]

}

內容

(冷氣接收到

控制完成為

例)

{

"id":"CloudAck",

"deviceId":"828405796",

"time":"2016-09-26T10:34:41Z",

"value":["Control","OK"]

}

Page 12: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

12 TL Proprietary

2.6 App接收 Dongle系統變更訊息

Topic /v1/device/${device_id}/sensor/SysInfo/rawdata

說明 當 App下達 dongle啟用命令後, Dongle發送啟用成功通知 App

帳號 ${API_KEY}

密碼 ${API_KEY}

TLS port : 8883

發佈者 Dongle

訂閱者 App

範例 以回應平台為例:

內容 1 {

"id": "SysInfo",

"deviceId": "852180758",

"time": "2016-11-30T13:06:35Z",

"value":

[ {

"SN":"TaiSEIA001",

"Dongle_MAC":"852180758",

"MQTT_TLS":"1.2",

"IP_Address":"192.168.2.109",

"AES":"null",

"AES_key":"null",

"Enable":"01",

"TimePolling":"0a",

"message":"NULL"

}

]

}

內容

(冷氣接收到

狀態變更為

例)

{

"id": "SysInfo",

"deviceId": "852180758",

"time": "2016-11-30T13:06:35Z",

"value":

["{\"SN\":\"TaiSEIA001\",\"Dongle_MAC\":\"852180758\"

,\"IP_Address\":\"192.168.2.109\",\"MQTT_TLS\":\"1.2\

Page 13: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

13 TL Proprietary

",\"AES\":\"null\",\"AES_key\":\"null\",\"Enable\":\"

01\",\"TimePolling\":\"0a\",\"message\":\"NULL\"}"

]

}

※ SN : Dongle 出貨流水號

※ Dongle_MAC : Dongle 網卡 MAC

※ IP_Address : 被分配到的 IP

※ MQTT_TLS : TLS加密版本

※ AES : AES版本

※ AES_key : AES金鑰

※ Enable : Dongle 是否開始 Polling

※ TimePolling : Polling週期 (秒)

※ message: 其他訊息

Page 14: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

14 TL Proprietary

2.7 App查詢 Dongle連線狀況

Topic /v1/device/${device_id}/heartbeat

說明 當 type狀況變化時,App接收到訊息時,查看 type欄位可得知設備狀況

帳號 ${API_KEY}

密碼 ${API_KEY}

TLS port : 8883

發佈者 App

訂閱者 Dongle

範例 以回應平台為例:

內容 1 {

"pulse": "1000",

"from": "223.140.31.51",

"last": "2016-03-30T08:28:47.532Z",

"time": "2016-03-30T09:28:47.532Z",

"type": "Lost",

"deviceId": "857480979"

}

1.pulse 設備發送訊息間隔時間(ms)

2.from 設備最後一次發送訊息 IP

3.last 設備最後一次發送訊息時間

4.time 目前時間

5.type 設備狀態

Live: 設備第一次連上 IOT平台並開始傳送 HeartBeat時。

Lost: 沒有在時間內收到通知。

ReLive: 設備中斷 HeartBeat後,重新連回 IOT平台時。

LastInfo: 設備最後一次 HeartBeat的資訊

6.project key 為專案的專屬金鑰,可以從專案管理 > 權限資料查詢得知

7.device key 為設備專屬的金鑰,可以從設備管理查詢得知

Page 15: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

15 TL Proprietary

3. RESTful家電控制

3.1 App下達控制命令

功能 控制 dongle

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "Control",

"time": "2014-12-11T10:43:58",

"value":

["typeID","serviceID","value","userid"]

}

]

內容

[

{

"id": "Control",

"time": "2014-12-11T10:43:58",

"value": ["01","00","0001","AABBCC"]

}

]

內容

(冷氣

為例)

回覆 成功: 200 OK

※詳細請參考 IOT平台操作手冊”儲存原始資料”

※userid目前最多可放入 20碼

Page 16: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

16 TL Proprietary

3.2 App下達接收 ack完成

功能 控制 dongle

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "CloudACK",

"time": "2014-12-11T10:43:58",

"value": ["OK"]

}

]

內容

回覆 成功: 200 OK

3.3 取得家電註冊回報訊息

功能 APP取得當前 dongle設備可控範圍

URL [HOST]/v1/device/${device_id}/sensor/Register/rawdata

method HTTP GET

Headers 參數名 數值

CK ${API_KEY}

回傳 成功: 200 OK

例值 說明

[

{

"id": " Register",

"time": "2014-12-11T10:43:58",

"value": [

"89","0","0","4","0","3","0","1","72","73","84","65",

"67","72","73","0","82","65","83","45","50","50","78",

"66","0","128","0","3","129","0","31","130","0",

"31","131","16","32","4","0","40","134",

內容 1

Page 17: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

17 TL Proprietary

"5","160","139","5","160","140","5","160",

"142","0","3","145","0","63",

"20","30","90","151","0","3","157","0",

"63","158","0","3","159","0","15","160","0","7","33",

"233","40","36","1","244","41","0","85","208","16","32",

"209","16","32","240"]

}

]

※詳細請參考 6.3 TaiSEIA附錄文件(此註冊將 TaiSEIA註冊訊息全部上傳)

3.4 取得家電當前狀態

功能 APP取得當前 dongle設備可控範圍

URL [HOST]/v1/device/${device_id}/sensor/Reply/rawdata

method HTTP GET

Headers 參數名 數值

CK ${API_KEY}

回傳 成功: 200 OK

例值 說明

{

"id": "Reply",

"deviceId": "857480979",

"time": "2016-11-25T15:01:52Z",

"value": [

"{

"type":"01",

"service_number":"1b",

"service_00":"0000",

"service_01":"0000",

"service_02":"0001",

"service_03":"0018",

"service_04":"0019",

"service_05":"0000",

"service_08":"0000",

"service_0b":"0000",

內容 1

Page 18: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

18 TL Proprietary

"service_0c":"ffff",

"service_0f":"0000",

"service_11":"0000",

"service_12":"0000",

"service_15":"2494",

"service_16":"0000",

"service_17":"0000",

"service_18":"0000",

"service_1a":"0000",

"service_1b":"ffff",

"service_1e":"0001",

"service_21":"0000",

"service_22":"0029",

"service_23":"0029",

"service_24":"0000",

"service_27":"0000",

"service_28":"0000",

"service_29":"480b",

"service_60":"0001"

}"

]

}

Page 19: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

19 TL Proprietary

3.5 取得 Dongle設定資訊

功能 APP取得 dongle SN, MQTT_TLS版本, AES使用, AES_key, 系統

狀態

URL [HOST]/v1/device/${device_id}/sensor/SysInfo/rawdata

method HTTP GET

Headers 參數名 數值

CK ${API_KEY}

回傳 成功: 200 OK

例值 說明

{

"id": "SysInfo",

"deviceId": "852180758",

"time": "2016-11-30T13:06:35Z",

"value":

[ {

"SN":"TaiSEIA001",

"Dongle_MAC":"852180758",

"MQTT_TLS":"1.2",

"IP_Address":"192.168.2.109",

"AES":"null",

"AES_key":"null",

"Enable":"01",

"TimePolling":"0a",

"message":"NULL"

}

]

}

內容 1

Page 20: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

20 TL Proprietary

4. RESTful系統相關查測及維運

4.1 韌體更新

功能 Dongle韌體更新

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value":

["OAD",${download_http},${file_name}]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["OAD","

https://iot.cht.com.tw/iot/quickstart/device/

scapp","scapp.exe"]

}

]

內容

(冷氣

為例)

回覆 成功: 200 OK

Page 21: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

21 TL Proprietary

4.2 重新啟動

功能 Dongle Reboot

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["Reboot"]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["Reboot"]

}

]

內容

(冷氣

為例)

回覆 成功: 200 OK

Page 22: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

22 TL Proprietary

4.3 重新網路校時

功能 Dongle 網路校時

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["Clock",${HttpAddress}]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["Clock","time.stdtime.gov.tw"]

}

]

內容

(冷氣

為例)

回覆 成功: 200 OK

Page 23: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

23 TL Proprietary

4.4 查詢 Dongle wifi連線訊號強度

功能 Dongle 網路校時

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["RSSI"]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["RSSI"]

}

]

內容

(冷氣

為例)

回覆 成功: 200 OK

Page 24: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

24 TL Proprietary

4.5 Dongle啟用命令

功能 Dongle 啟用命令

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["ProgramEnable",${Enable}]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["ProgramEnable","1"]

}

]

內容

(啟用

dongl

e為

例)

回覆 成功: 200 OK

※ Enable = 1 -> Timer Polling Start

※ Enable = 0 -> Timer Polling Stop

Page 25: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

25 TL Proprietary

4.6 家電重新註冊訊息

功能 Dongle 重新發送家電註冊訊息

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["Register"]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["Register"]

}

]

內容

(冷氣

為例)

回覆 成功: 200 OK

Page 26: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

26 TL Proprietary

4.7 設定 Timer Polling週期

功能 設定 Dongle Timer Polling週期

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["PollingTime", ${second}]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["PollingTime", "05"]

}

]

內容

(設定

5秒為

例)

回覆 成功: 200 OK

※ second = 秒

Page 27: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

27 TL Proprietary

4.8 設定 AES加密啟用與否

功能 設定 AES加密啟用與否

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["AESflag", ${flag}]

}

]

內容

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["AESflag", "01"]

}

]

內容

(啟用

AES為

例)

回覆 成功: 200 OK

※ flag = 01 啟用

※ flag = 00 停用

Page 28: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

28 TL Proprietary

4.9 App查詢 Dongle連線狀況

功能 App查詢 Dongle連線狀況

URL [HOST]/v1/device/${device_id}/heartbeat

method HTTP Get

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

{

"last": "2017-01-16T06:55:19.611Z",

"pulse": "5000",

"from": "172.18.0.15",

}

內容

回覆 成功: 200 OK

1.last 設備最後一次發送訊息時間

2.pulse 設備發送訊息間隔時間

3.from 設備最後一次發送訊息 IP

4.10 設定家電控制器使用者名稱

功能 Dongle Reboot

URL [HOST]/v1/device/${device_id}/rawdata

method HTTP Post

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

[

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value":

["UserID","GatewayID","DongleID"]

}

]

內容

[ 內容

Page 29: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

29 TL Proprietary

{

"id": "SystemControl",

"time": "2014-12-11T10:43:58",

"value": ["ABCD","EFGH","IJKL"]

}

]

(冷氣

為例)

回覆 成功: 200 OK

※ 每個 ID最多 20個字元

Page 30: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

30 TL Proprietary

5. IOT平台註冊流程

5.1 流程圖

5.2 掃描 QR code

掃描 QR code 後可得到流水號與簽章, 本次使用下列 QR code 為範例, 此流水號為

TaiSEIA03

Page 31: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

31 TL Proprietary

5.3 APP測試連線,確認客戶輸入密碼正確

功能 測試手機 app經由Wifi AP是否可連線到 IOT平台

URL [HOST]/v1/device/387321615/sensor/Reply/rawdata

method HTTP GET

Headers 參數名 數值

CK ${API_KEY}

回傳 成功: 200 OK

例值 說明

{

"id": "Reply",

"deviceId": "387321615",

"time": "2016-09-29T08:06:01.679Z",

"value": [

"OK"

]

}

內容

5.4 APP改連至 CHT控制器

出廠時每組 CHT控制器擁有獨立的流水號

SSID = 流水號_chttl

Password = 流水號_taiseia

EX. 流水號 = TaiSEIA03

SSID = TaiSEIA03_chttl

Password = TaiSEIA02_taiseia

5.5 傳送Wifi ap 帳號密碼至 CHT控制器

功能 當連上手機 app使用 wifi連上 CHT控制器後, 傳送Wifi AP訊息

IP 192.168.100.1

Port 8888

連線方式 Socket

傳送 例值 說明

Page 32: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

32 TL Proprietary

{‘A’}{SSID}{+}{Password}{+}

內容

回覆 例值 說明

OK 內容

5.6 APP開通 IOT平台

功能 當 APP比對 LED閃爍頻率, 使用此功能讓 CHT控制器註冊至 IOT平台

URL [HOST]/v1/registry/${流水號}

method HTTP POST

Headers 參數名 數值

CK ${API_KEY}

傳送 例值 說明

{

"op": "Reconfigure",

"digest": "流水號"

}

內容

回覆 成功: 200 OK

例值 說明

{

"op": "Reconfigure",

"digest": "流水號",

"deviceId": ${device_id},

"authority": "device"

}

內容

Page 33: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

33 TL Proprietary

6. 附錄-TaiSEIA協定 以下簡要條列目前 Dongle支援的 TaiSEIA設備,以及其可讀寫功能(service_id),僅供開

發階段快速對照用,詳細協定資訊應以 TaiSEIA官方相關文件為主。

6.1 智慧家電類別碼 type_id TaiSEIA家電類別碼 資料表示方式

中文名稱

0x01 "01" 冷氣機

0x04 "04" 除溼機

0x0F "0f" 電扇

6.2 智慧家電功能表 service_id

6.2.1 冷氣機 0x01

service

_id

Service Name Attri

bute

Data Type Min Max Unit Description

00 電源控制功能 R/W BOOL 0 1 - 0:關閉電源,

1:開啟電源

01 運轉模式設定功能 R/W UINT16 0 4 -

0:冷氣, 1:除溼, 2:

送風, 3:自動, 4:暖

02 風速設定功能 R/W UINT16 0 15 -

0:自動,

n: n段風速

(1~15段數越高風

速越強)

03 溫度設定功能 R/W Unsigned

char 18 30 ℃

設定溫度值

04 室內溫度顯示功能 R char -128 127 ℃ 目前室內溫度值

Page 34: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

34 TL Proprietary

6.2.2 電扇 0x0F

service

_id

Service Name Attri

bute

Data Type Min Max Unit Description

00 電源控制功能 R/W BOOL 0 1 - 0:關閉電源,

1:開啟電源

01 運轉模式設定功能 R/W UINT16 0 4 - n: 模式 n

02 風速設定功能 R/W UINT16 0 15 -

0:自動,

n: n段風速

(1~15段數越高風

速越強)

Page 35: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

35 TL Proprietary

6.3 註冊資訊

Page 36: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

36 TL Proprietary

Page 37: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

37 TL Proprietary

註冊資訊範例

Page 38: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

38 TL Proprietary

Page 39: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

39 TL Proprietary

Page 40: 智慧家電 TaiSeia 簡易文件 - CHT IoT SMART PLATFORM · 4 TL Proprietary 1.4. 文件版本 日期 更改內容 2016-0926 TaiSEIA 101協定, 包含家電註冊,控制,IOT平台連線回傳機制

40 TL Proprietary