Twin API Guide. How to use Twin

Transcription

1 Twin API Guide How to use Twin 1

2 目錄 一 Cycle Job P3 二 Twin Action Table P4-5 三 QQN P5 四 Command P5-9 2

3 一 Cycle Job 人 * 動作名稱 *Action command 裝置名稱 新增工單回復工單 *Ticket ID 移除工單 終止工單 指令 1 指令 1 和指令 2 的間隔時間 指令 2 工單期限 工單開始日期 工單截止日期 於每月幾號運作 工單運行周期立即運作上班日月底運作一週一次 明日每日運作假期運作每三個月一次年底運作每一季底一年一次一週一次當幾點幾分幾秒開始運作從幾點開始到幾點結束, 這段期間內每多少時間重複執行一次 是否收取通知 於信箱收取通知 於 telegram 收取通知 若勾選則管理者也看的到 馬上試作 上層主管簽名 由誰下這張單子, 系統會自動顯示 * 1. Ticket ID: 可從信箱或 Telegram 的通知中得知 2. Subject: 當要 remove 此單時必須填入 Ticket ID 而非原本的 subject 3

4 3. ACMD: 已預設好動作的代碼, 填入代碼即可完成單子 二 Twin Action Table IOT control A1010 mqtt:sonoff/(u Stand on on did)/power A1011 mqtt:sonoff/(u Stand off off did)/power A1012 mqtt:sonoff/(u Neo LED Toggle toggle did)/power A1020 Device name Smartscreen on A1021 Device name Smartscreen off A1030 Device name Speaker on A1031 Device name Speaker off Media A2110 Device name Drop youtube video Drop e) A2210 Device name Drop radio A2220 Device name Drop spotify Drop spotify:track:(visbncode) A2310 Device name Drop photo drop [(url) (mpath)] (duration) (frame) (animate) (animate duration)(play mode) A2410 Device name Text ( ) when (QQN) text (text) (duration) (color) (size) (background color) (text alignment) (frame) (animate) (animate duration) A25xx Device name Drop emoji people A3010 tg/user/(uid) reminder 文字 4

5 Machine A4010 Device name Data backup A4020 Device name Capture when (QQN) A4030 Device name snapshot/ ( ) min IOC A5010 IOC Check system A5020 IOC Status report A5030 IOC 除錯 A5040 IOC Check yesterday s cctv A5050 IOC 監測 smartscreen 是否有正常運作 三 QQN QQN 1 Open the door 2 Passing by 3 Touch Description 四 Command Command Format 1. Command line command, type is string. 2. { cmd : drop, } Command Brief 1. Drop 2. Notify 3. Toast 4. Marquee 5. Text 6. App 7. Frame 5

6 8. Touch 9. Status 10. Mote 11. Emoji Drop command 1. drop [(url) (mpath)] (duration) (frame) (animate) (animate duration) (play mode) 1. {"cmd":"drop","type":"url","src":["[(url1) (mpath1)]","[(url2) (mpath2)]"],"dura tion":"(duration)","frame":"(frame)","animate":"(animate)","aniduration":"(ani mate duration)","bgcolor":"(background color)","pmode":"(play mode)"} 1. drop 30 main 2. drop 30 main fade 2 loop 3. {"cmd":"drop","type":"url","src":[" mp4"],"duration":"0","frame":"t2","animate":"fade","aniduration":"2","bgcolor ":"white","pmode":"loop"} 1. duration: unit is second, 0 means play to end 2. frame: can be main, t1, t2, t3, or t4 3. CLI use "," to separate multiple URLs. 4. animate: can be delay, fade, slide, left, right 5. animate duration: unit is second. 6. pmode: can be loop or random Notify command 1. notify (message) (duration) (color) (size) 1. {"cmd":"notify","msg":"(message)","duration":"(duration)","color":"(color)","siz e":"(size)"} 6

7 1. notify HelloWorld! 30 black 3 2. notify "Hello World!" {"cmd":"notify","msg":"helloworld!","duration":"30","color":"lime","size":"4"} 1. For CLI, if has space in message, use "" to enclose the message string. Message keyword 1. (%time): current time. 2. (%time#yyyy/mm/dd hh:nn:ss): current time with format Toast command 1. toast (message) (heading) (icon) (transition) 1. {"cmd":"toast","msg":"(message)","heading":"(heading)","icon":"(icon)","transit ion":"(transition)"} 1. toast HelloWorld! Wellcome info plain 2. {"cmd":"toast","msg":"helloworld!","heading":"wellcome","icon":"info","transi tion":"plain"} 1. For CLI, if has space in message, use "" to enclose the message string. 2. Icon: can be info, waring, error and success 3. Transition: can be plain, fade and slide Marquee command 1. marquee (message) (duration) (color) (size) 1. {"cmd":"marquee","msg":"(message)","duration":"(duration)","color":"(color)", 7

8 "size":"(size)","bgcolor","(background color)"} 1. marquee HelloWorld! 30 black 3 2. marquee "Hello World!" {"cmd":"marquee","msg":"helloworld!","duration":"30","color":"lime","size":"4 ","bgcolor":"lime"} 1. For CLI, if has space in message, use "" to enclose the message string. Text command 1. text (text) (duration) (color) (size) (background color) (text alignment) (frame) (animate) (animate duration) 1. {"cmd":"text","msg":"(text)","duration":"(duration)","color":"(color)","size":"(siz e)","bgcolor":"(backgroundcolor)","align":"(textalignment)","frame":"(frame)"," animate":"(animate)","aniduration":"(animate duration),"bgcolor","(background color)"} 1. text HelloWorld! 30 black 3 white left text 2. text "Hello World!" 30 lime 4 yellow center main 3. {"cmd":"text","msg":"helloworld!","duration":"30","color":"lime","size":"4","bg color":"white","align":"left","frame":"main","animate":"slide","aniduration":"1","bgcolor":"red"} 4. animate: can be delay, fade, slide, left, right 5. animate duration: unit is second. 1. For CLI, if has space in message, use "" to enclose the message string. 2. Align can be center, left or right 3. Frame can be text, main, t1, t2, t3, or t4. 4. duration: unit is second, 0 means play to end 8

9 App command 1. app (url) (duration) (frame) 1. {"cmd":"app","url":"(url1)","duration":"(duration)","frame":"(frame)"} 1. app 30 main 2. {"cmd":"app","url":" 1. duration: unit is second, 0 means play to end 2. frame can be main, t1, t2, t3, or t4. 9