tuya Device Control Cloud Services API Reference User Guide

tuya Device Control Cloud Services API nuoroda

Informacija apie produktą

Įrenginio valdymo produktas pateikia API rinkinį ir instrukcijas, skirtas nuotoliniu būdu valdyti įrenginius. Vartotojai gali siųsti instrukcijas į įrenginį naudodami pateiktus API galinius taškus.

Specifikacijos:

Įrenginio valdymas
Versija: 20240124
Internetinė versija

Produkto naudojimo instrukcijos

Gaukite instrukcijų rinkinį pagal kategorijas:
Vartotojai gali gauti instrukcijų rinkinį pagal kategorijas naudodami šiuos API galutinius taškus:
- API aprašymas
- API adresas
- Užklausos parametras
- Grąžinimo parametras
- Prašyti Example
- SDK pvzample
- Atsakymas Pvzample
- Klaidos kodas
Gaukite instrukcijų rinkinį pagal įrenginį:
Norėdami gauti įrenginio instrukcijų rinkinį, vartotojai gali naudoti pateiktus API galutinius taškus konkretiems įrenginiams. Tai apima tokią informaciją kaip API adresas, užklausos parametrai, grąžinimo parametrai ir pvzamples.
Gaukite įrenginių instrukcijų rinkinį:
Ši funkcija leidžia vartotojams pasiekti kelių įrenginių instrukcijų rinkinį. Vartotojai gali pateikti užklausas naudodami API adresą ir pateiktus parametrus.
Gaukite įrenginio specifikacijas ir savybes:
Šis API galutinis taškas pateikia išsamias įrenginio specifikacijas ir savybes, įskaitant instrukcijų rinkinį ir būsenos rinkinį. Vartotojai gali prašyti šios informacijos kartu su pvzampkaip naudoti SDK.
Nusiųskite instrukcijas į įrenginį:
Vartotojai gali siųsti konkrečias instrukcijas į įrenginį naudodami pateiktą API. Tai apima tokią informaciją kaip užklausos parametrai, grąžinimo parametrai ir pvzampmažiau kaip efektyviai siųsti instrukcijas.

DUK:

Kl.: Kaip šalinti triktis, jei siųsdamas instrukcijas įvyksta klaidų?
A: Jei siųsdami instrukcijas susiduriate su klaidomis, žr. API dokumentacijos klaidos kodo skyrių, kad nustatytumėte ir pašalintumėte problemą.
Kl .: Ar galiu vienu metu valdyti kelis įrenginius?
A: Taip, galite valdyti kelis įrenginius vienu metu, naudodami įrenginio funkcijos nustatytas instrukcijas ir atitinkamai pateikdami užklausas kiekvienam įrenginiui.

Šioje temoje aprašomos su įrenginio valdymu susijusios API, įskaitant instrukcijų rinkinių, specifikacijų, ypatybių gavimą, naujausias būsenas ir instrukcijų siuntimą.

Gaukite instrukcijas pagal kategorijas

API aprašymas
Pateikite užklausą pagal kategorijas nurodymus. Šiame instrukcijų rinkinyje yra daugiausia instrukcijų „viskas viename“ programų kategorijoje, kurias gali naudoti ir nurodyti kūrėjai. Jei esate platformos kūrėjas, galite kurti programas pagal šį instrukcijų rinkinį.

API adresas

GAUTI /v1.0/ funkcijas /{ kategorija}

Prašymo parametras

Grąžinimo parametras

Rezultato aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kategorija| Styga | Prekės kategorija |
- | funkcijos| Sąrašas | Instrukcijų rinkinys |
Funkcijų aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kodas | Styga | Instrukcija | | tipas | Styga | Instrukcijos tipas |
- | vertės | Styga | Įvesties parametrų verčių diapazonas |
- | vardas | Styga | Instrukcijos pavadinimas |
- | desc | Styga | Aprašymas |

Prašyti example

GET /v1.0/ funkcijų/kg

SDK example

Atsakymas pvzample

Klaidos kodas
Toliau pateikiamos bendros šios sąsajos paslaugų išimtys. Daugiau išimčių klaidų žr Klaidos kodas.

Gaukite instrukcijas pagal įrenginį

API aprašymas
Užklausa apie įrenginio palaikomas funkcijas. Galite siųsti valdymą pagal gautas instrukcijas.

API adresas

GET /v1.0/ devices /{ device_id }/ funkcijas

Prašymo parametras

Grąžinimo parametras

Rezultato aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kategorija| Styga | Prekės kategorija |
- | funkcijos| Sąrašas | Instrukcijų rinkinys |
Funkcijų aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kodas | Styga | Instrukcija |
- | tipas | Styga | Instrukcijos tipas |
- | vertės | Styga | Įvesties parametrų verčių diapazonas |
- | vardas | Styga | Instrukcijos pavadinimas |
- | desc | Styga | Aprašymas |

Prašyti example

GET /v1.0/ devices/vdevo155XXXX83954683/functions

SDK example

TuyaClient klientas = naujas TuyaClient(klientoId , secret , RegionEnum.CN);
categoryFunctions = klientas.getFunctionsByDevId(DEV_ID);
System.out.println („Gauti funkcijų sąrašą pagal įrenginio ID:“);
System.out.println(JSONObject.toJSONString(kategorijos funkcijos));

Atsakymas pvzample

Klaidos kodas
Toliau pateikiamos bendros šios sąsajos paslaugų išimtys. Daugiau išimčių klaidų žr Klaidos kodas.

Gaukite įrenginių instrukcijas

API aprašymas
Pateikite užklausą dėl funkcijų, kurias palaiko įrenginių sąrašas. Galite siųsti valdymą pagal gautas instrukcijas. palaiko iki 20 įrenginių

API adresas

GET /v1.0/ įrenginiai/funkcijos

Prašymo parametras

Grąžinimo parametras

Rezultato aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kategorija| Styga | Prekės kategorija |
- | funkcijos| Sąrašas | Instrukcijų rinkinys |
- | prietaisai | Sąrašas | įrenginio ID sąrašas |
Funkcijų aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kodas | Styga | Instrukcija |
- | tipas | Styga | Instrukcijos tipas |
- | vertės | Styga | Įvesties parametrų verčių diapazonas |
- | vardas | Styga | Instrukcijos pavadinimas |
- | desc | Styga | Aprašymas |

Prašyti example

GET /v1.0/ devices/functions?device_ids =06200286 dc4f22c8418c ,6c8b eb2f
a517fbc901dtln

SDK example

TuyaClient klientas = naujas TuyaClient(klientoId , secret , RegionEnum.CN);
categoryFunctions = klientas.getFunctionsByDevsList(DEV_ID);
System.out.println(“Gauti funkcijų sąrašą pagal įrenginius Sąrašas: “);
System.out.println(JSONObject.toJSONString(kategorijos funkcijos));

Atsakymas pvzample

Klaidos kodas
Toliau pateikiamos bendros šios sąsajos paslaugų išimtys. Daugiau išimčių klaidų žr Klaidos kodas.

Prietaiso specifikacijos ir savybės

Gaukite įrenginio specifikacijas ir savybes, įskaitant instrukcijų rinkinį ir būsenos rinkinį

API aprašymas
Ši sąsaja naudojama įrenginio palaikomam instrukcijų rinkiniui ir būsenos rinkiniui gauti pagal įrenginio ID.

API adresas

GAUTI /v1.0/ įrenginius /{ device_id }/ specifikacijas

Prašymo parametras

Grąžinimo parametras

Rezultato aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kategorija | Styga | Prekės kategorija |
- | funkcijos | Sąrašas | Instrukcijų rinkinys |
- | statusas | Sąrašas | Būsena nustatyta |
Funkcijų aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—- | :—- | :—|
- | kodas | Styga | komandą |
- | tipas | Styga | Tipas |
- | vertės | Styga | Parametrų reikšmių diapazonas |
Būsenos aprašymas
- | Parametro pavadinimas | Kategorija | Aprašymas |
- | :—| :—| :—|
- | kodas | Styga | būsenos kodas |
- | tipas | Styga | Tipas |
- | vertės | Styga | Parametrų reikšmių diapazonas |

Prašyti example

GAUTI /v1.0/ devices/vdevoXXXXXXXXXXXXXXX/specifikacijos

SDK example
N/A

Grąžinimo parametras

Nusiųskite instrukcijas į įrenginį

API aprašymas
Ši sąsaja naudojama siųsti vienam ar daugiau gautų instrukcijų rinkinių. Ar instrukcijų rinkinius galima siųsti vienu metu, priklauso nuo gaminio.

API adresas