bowen liu / Mbed OS mbed-os-example-blinky

ex

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

dumi_doc-master/doc/directives/Alerts.md@44:c1d8923072ba, 2017-07-18 (annotated)

Committer:
TMBOY
Date:
Tue Jul 18 16:27:22 2017 +0800
Revision:
44:c1d8923072ba
?

Who changed what in which revision?

UserRevisionLine numberNew contents of line
TMBOY 44:c1d8923072ba 1 ## Alerts数据结构
TMBOY 44:c1d8923072ba 2 ### <span id="alert_struct">AlertsStruct</span>
TMBOY 44:c1d8923072ba 3 ```javascript
TMBOY 44:c1d8923072ba 4 AlertsStruct = {
TMBOY 44:c1d8923072ba 5 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 6 "type": string,// Alert类型 TIMER|ALARM
TMBOY 44:c1d8923072ba 7 "scheduled_time": string,// Alert触发时间，秒级时间戳
TMBOY 44:c1d8923072ba 8 "content": string, // Alert事件名称
TMBOY 44:c1d8923072ba 9
TMBOY 44:c1d8923072ba 10 // ####### 接入完整能力不要关注此字段#########
TMBOY 44:c1d8923072ba 11 "extensions": ExtensionsStruct json, // 可选，额外信息，qu能力级别输出携带，例如接入完整能力的A音箱则没有该字段，接入qu能力的B手机助手则有该字段|mateapp携带
TMBOY 44:c1d8923072ba 12 }
TMBOY 44:c1d8923072ba 13 ```
TMBOY 44:c1d8923072ba 14 ```javascript
TMBOY 44:c1d8923072ba 15 ExtensionsStruct = {
TMBOY 44:c1d8923072ba 16 "start_time": int, // 开始时间
TMBOY 44:c1d8923072ba 17 "content": string, // 事件名称
TMBOY 44:c1d8923072ba 18 "duration": int, // timer时长
TMBOY 44:c1d8923072ba 19 "repeat_type": string, // 重复类型 day|week|month|year
TMBOY 44:c1d8923072ba 20 "repeat_week": int, // 可选，重复星期 从低位到高位表示星期一到星期日
TMBOY 44:c1d8923072ba 21 "repeat_month": int, // 可选，重复月 从低位到高位表示1~12月
TMBOY 44:c1d8923072ba 22 "repeat_year": string, // 可选， 重复年 12-1，8-2
TMBOY 44:c1d8923072ba 23 "special_calender": string, // 农历，lunar
TMBOY 44:c1d8923072ba 24 "special_day": string, // 工作日, weekday
TMBOY 44:c1d8923072ba 25 }
TMBOY 44:c1d8923072ba 26 ```
TMBOY 44:c1d8923072ba 27
TMBOY 44:c1d8923072ba 28
TMBOY 44:c1d8923072ba 29 ### SetAlert Directive
TMBOY 44:c1d8923072ba 30 1、客户端通过语音创建alarm、timer
TMBOY 44:c1d8923072ba 31 2、mateapp重新开启已经创建的alarm、timer
TMBOY 44:c1d8923072ba 32 3、mateapp更新已经创建的alarm、timer
TMBOY 44:c1d8923072ba 33
TMBOY 44:c1d8923072ba 34 ```javascript
TMBOY 44:c1d8923072ba 35 {
TMBOY 44:c1d8923072ba 36 "header": {
TMBOY 44:c1d8923072ba 37 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 38 "name": "SetAlert",
TMBOY 44:c1d8923072ba 39 "message_id": string,
TMBOY 44:c1d8923072ba 40 },
TMBOY 44:c1d8923072ba 41 "payload": AlertsStruct,// 见Alerts数据结构
TMBOY 44:c1d8923072ba 42 }
TMBOY 44:c1d8923072ba 43 ```
TMBOY 44:c1d8923072ba 44
TMBOY 44:c1d8923072ba 45 ### SetAlertSucceeded Event
TMBOY 44:c1d8923072ba 46 客户端在收到SetAlert Directive后成功创建Alert必须向DCS上报SetAlertSucceeded Event
TMBOY 44:c1d8923072ba 47 ```javascript
TMBOY 44:c1d8923072ba 48 {
TMBOY 44:c1d8923072ba 49 "header": {
TMBOY 44:c1d8923072ba 50 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 51 "name": "SetAlertSucceeded"
TMBOY 44:c1d8923072ba 52 },
TMBOY 44:c1d8923072ba 53 "payload": {
TMBOY 44:c1d8923072ba 54 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 55 }
TMBOY 44:c1d8923072ba 56 }
TMBOY 44:c1d8923072ba 57 ```
TMBOY 44:c1d8923072ba 58
TMBOY 44:c1d8923072ba 59 ### SetAlertFailed Event
TMBOY 44:c1d8923072ba 60 客户端在收到SetAlert Directive后未成功创建Alert必须向DCS上报SetAlertFailed Event
TMBOY 44:c1d8923072ba 61 ```javascript
TMBOY 44:c1d8923072ba 62 {
TMBOY 44:c1d8923072ba 63 "header": {
TMBOY 44:c1d8923072ba 64 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 65 "name": "SetAlertFailed"
TMBOY 44:c1d8923072ba 66 },
TMBOY 44:c1d8923072ba 67 "payload": {
TMBOY 44:c1d8923072ba 68 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 69 }
TMBOY 44:c1d8923072ba 70 }
TMBOY 44:c1d8923072ba 71 ```
TMBOY 44:c1d8923072ba 72
TMBOY 44:c1d8923072ba 73 ### DeleteAlert Directive
TMBOY 44:c1d8923072ba 74 DCS下发DeleteAlert Directive场景：
TMBOY 44:c1d8923072ba 75 1、客户端通过语音删除alarm、timer
TMBOY 44:c1d8923072ba 76 2、客户端通过语音停止响铃的alarm、timer
TMBOY 44:c1d8923072ba 77 2、mateapp删除alarm、timer
TMBOY 44:c1d8923072ba 78 3、mateapp暂停已经创建的alarm
TMBOY 44:c1d8923072ba 79
TMBOY 44:c1d8923072ba 80 ```javascript
TMBOY 44:c1d8923072ba 81 {
TMBOY 44:c1d8923072ba 82 "header": {
TMBOY 44:c1d8923072ba 83 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 84 "name": "DeleteAlert",
TMBOY 44:c1d8923072ba 85 "message_id": string,
TMBOY 44:c1d8923072ba 86 },
TMBOY 44:c1d8923072ba 87 "payload":{
TMBOY 44:c1d8923072ba 88 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 89 }
TMBOY 44:c1d8923072ba 90 }
TMBOY 44:c1d8923072ba 91 ```
TMBOY 44:c1d8923072ba 92
TMBOY 44:c1d8923072ba 93 ### DeleteAlertSucceeded Event
TMBOY 44:c1d8923072ba 94 客户端在收到DeleteAlert Directive后成功删除Alert必须向DCS上报DeleteAlertSucceeded Event
TMBOY 44:c1d8923072ba 95 ```javascript
TMBOY 44:c1d8923072ba 96 {
TMBOY 44:c1d8923072ba 97 "header": {
TMBOY 44:c1d8923072ba 98 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 99 "name": "DeleteAlertSucceeded"
TMBOY 44:c1d8923072ba 100 },
TMBOY 44:c1d8923072ba 101 "payload": {
TMBOY 44:c1d8923072ba 102 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 103 }
TMBOY 44:c1d8923072ba 104 }
TMBOY 44:c1d8923072ba 105 ```
TMBOY 44:c1d8923072ba 106
TMBOY 44:c1d8923072ba 107 ### DeleteAlertFailed Event
TMBOY 44:c1d8923072ba 108 客户端在收到DeleteAlert Directive后未成功删除Alert必须向DCS上报DeleteAlertfailed Event
TMBOY 44:c1d8923072ba 109 ```javascript
TMBOY 44:c1d8923072ba 110 {
TMBOY 44:c1d8923072ba 111 "header": {
TMBOY 44:c1d8923072ba 112 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 113 "name": "DeleteAlertFailed"
TMBOY 44:c1d8923072ba 114 },
TMBOY 44:c1d8923072ba 115 "payload": {
TMBOY 44:c1d8923072ba 116 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 117 }
TMBOY 44:c1d8923072ba 118 }
TMBOY 44:c1d8923072ba 119 ```
TMBOY 44:c1d8923072ba 120
TMBOY 44:c1d8923072ba 121 ### AlertStarted Event
TMBOY 44:c1d8923072ba 122 Alert到触发时间响铃必须向DCS上报AlertStarted Event
TMBOY 44:c1d8923072ba 123 ```javascript
TMBOY 44:c1d8923072ba 124 {
TMBOY 44:c1d8923072ba 125 "header": {
TMBOY 44:c1d8923072ba 126 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 127 "name": "AlertStarted"
TMBOY 44:c1d8923072ba 128 },
TMBOY 44:c1d8923072ba 129 "payload": {
TMBOY 44:c1d8923072ba 130 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 131 }
TMBOY 44:c1d8923072ba 132 }
TMBOY 44:c1d8923072ba 133 ```
TMBOY 44:c1d8923072ba 134 ### AlertStopped Event
TMBOY 44:c1d8923072ba 135 Alert停止正在响铃的Alert必须向DCS上报AlertStopped Event
TMBOY 44:c1d8923072ba 136 ```javascript
TMBOY 44:c1d8923072ba 137 {
TMBOY 44:c1d8923072ba 138 "header": {
TMBOY 44:c1d8923072ba 139 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 140 "name": "AlertStoped"
TMBOY 44:c1d8923072ba 141 },
TMBOY 44:c1d8923072ba 142 "payload": {
TMBOY 44:c1d8923072ba 143 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 144 }
TMBOY 44:c1d8923072ba 145 }
TMBOY 44:c1d8923072ba 146 ```
TMBOY 44:c1d8923072ba 147
TMBOY 44:c1d8923072ba 148
TMBOY 44:c1d8923072ba 149 ## 前后台切换
TMBOY 44:c1d8923072ba 150 ### AlertEnteredForeground Event
TMBOY 44:c1d8923072ba 151 ```javascript
TMBOY 44:c1d8923072ba 152 {
TMBOY 44:c1d8923072ba 153 "header": {
TMBOY 44:c1d8923072ba 154 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 155 "name": "AlertEnteredForeground"
TMBOY 44:c1d8923072ba 156 },
TMBOY 44:c1d8923072ba 157 "payload": {
TMBOY 44:c1d8923072ba 158 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 159 }
TMBOY 44:c1d8923072ba 160 }
TMBOY 44:c1d8923072ba 161 ```
TMBOY 44:c1d8923072ba 162
TMBOY 44:c1d8923072ba 163 ### AlertEnteredBackground Event
TMBOY 44:c1d8923072ba 164 ```javascript
TMBOY 44:c1d8923072ba 165 {
TMBOY 44:c1d8923072ba 166 "header": {
TMBOY 44:c1d8923072ba 167 "namespace": "Alerts",
TMBOY 44:c1d8923072ba 168 "name": "AlertEnteredBackground"
TMBOY 44:c1d8923072ba 169 },
TMBOY 44:c1d8923072ba 170 "payload": {
TMBOY 44:c1d8923072ba 171 "token": string,// 唯一标识
TMBOY 44:c1d8923072ba 172 }
TMBOY 44:c1d8923072ba 173 }
TMBOY 44:c1d8923072ba 174 ```