tuya Device Control Cloud Services API Reference User Guide

tuya Device Control Cloud Services API-reference

Produktinformation

Produktet Device Control giver et sæt API'er og instruktioner til fjernstyring af enheder. Brugere kan sende instruktioner til enheden ved hjælp af de medfølgende API-slutpunkter.

Specifikationer:

Enhedskontrol
Version: 20240124
Online Version

Produktbrugsvejledning

Hent instruktionssættet efter kategori:
Brugere kan hente instruktionssættet efter kategori ved hjælp af følgende API-endepunkter:
- API-beskrivelse
- API-adresse
- Anmodningsparameter
- Returparameter
- Anmod eksample
- SDK Eksample
- Svar Eksample
- Fejlkode
Hent instruktionssættet pr. enhed:
For at få den instruktion, der er indstillet af enheden, kan brugere bruge de medfølgende API-endepunkter til specifikke enheder. Dette inkluderer detaljer såsom API-adresse, anmodningsparametre, returparametre og f.eksamples.
Hent instruktionssættet af enheder:
Denne funktion giver brugerne adgang til instruktionssættet for flere enheder. Brugere kan fremsætte anmodninger ved hjælp af den angivne API-adresse og parametre.
Få enhedens specifikationer og egenskaber:
Dette API-endepunkt giver detaljerede specifikationer og egenskaber for enheden, inklusive instruktionssættet og statussættet. Brugere kan anmode om disse oplysninger sammen med f.eksamples om, hvordan man bruger SDK.
Send instruktioner til enheden:
Brugere kan sende specifikke instruktioner til enheden ved hjælp af den medfølgende API. Dette inkluderer detaljer såsom anmodningsparametre, returparametre og f.eksamples om, hvordan man sender instruktioner effektivt.

Ofte stillede spørgsmål:

Sp: Hvordan kan jeg fejlfinde, hvis jeg støder på fejl, når jeg sender instruktioner?
A: Hvis du støder på fejl, når du sender instruktioner, skal du se fejlkodeafsnittet i API-dokumentationen for at identificere og fejlfinde problemet.
Q: Kan jeg styre flere enheder samtidigt?
A: Ja, du kan styre flere enheder samtidigt ved at bruge instruktionerne angivet af enhedsfunktionen og foretage anmodninger til hver enhed i overensstemmelse hermed.

Dette emne beskriver de API'er, der er relateret til enhedskontrol, herunder hentning af instruktionssæt, specifikationer, egenskaber, de seneste statusser og afsendelse af instruktioner.

Få instruktionen sat efter kategori

API beskrivelse
Spørg instruktionen sat efter kategori. Dette instruktionssæt har den største mængde instruktioner i kategorien alt-i-én apps, som kan bruges og henvises til af udviklere. Hvis du er platformudvikler, kan du udvikle applikationer i henhold til dette instruktionssæt.

API-adresse

GET /v1.0/ funktioner /{ kategori}

Anmodningsparameter

Retur parameter

Beskrivelse af resultat
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kategori| String | Produktkategori |
- | funktioner| Liste | Instruktionssæt |
Beskrivelse af funktioner
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kode | String | Instruktion | | type | String | Instruktionstype |
- | værdier | String | Området for inputparameterværdier |
- | navn | String | Instruktionsnavn |
- | beskriv | String | Beskrivelse |

Anmod example

GET /v1.0/ funktioner/kg

SDK example

Svar example

Fejlkode
Følgende er almindelige tjenesteundtagelser for denne grænseflade. For flere undtagelsesfejl, se Fejlkode.

Få instruktionen indstillet af enhed

API beskrivelse
Spørg efter de funktioner, der understøttes af enheden. Du kan sende kontrol ved de indhentede instruktioner.

API-adresse

FÅ /v1.0/-enheder /{ device_id }/-funktioner

Anmodningsparameter

Retur parameter

Beskrivelse af resultat
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kategori| String | Produktkategori |
- | funktioner| Liste | Instruktionssæt |
Beskrivelse af funktioner
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kode | String | Instruktion |
- | type | String | Instruktionstype |
- | værdier | String | Området for inputparameterværdier |
- | navn | String | Instruktionsnavn |
- | beskriv | String | Beskrivelse |

Anmod example

GET /v1.0/ devices/vdevo155XXXX83954683/functions

SDK example

TuyaClient-klient = ny TuyaClient(clientId, secret, RegionEnum.CN);
categoryFunctions = client.getFunctionsByDevId(DEV_ID);
System.out.println(“Hent funktionslisten efter enheds-id: “);
System.out.println(JSONObject.toJSONString(kategorifunktioner));

Svar example

Fejlkode
Følgende er almindelige tjenesteundtagelser for denne grænseflade. For flere undtagelsesfejl, se Fejlkode.

Få instruktionen sat af enheder

API beskrivelse
Spørg efter de funktioner, der understøttes af enhedslisten. Du kan sende kontrol ved de indhentede instruktioner. understøtter op til 20 enheder

API-adresse

GET /v1.0/ enheder/funktioner

Anmodningsparameter

Retur parameter

Beskrivelse af resultat
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kategori| String | Produktkategori |
- | funktioner| Liste | Instruktionssæt |
- | enheder | Liste | enheds-id-liste |
Beskrivelse af funktioner
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kode | String | Instruktion |
- | type | String | Instruktionstype |
- | værdier | String | Området for inputparameterværdier |
- | navn | String | Instruktionsnavn |
- | beskriv | String | Beskrivelse |

Anmod example

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

SDK example

TuyaClient-klient = ny TuyaClient(clientId, secret, RegionEnum.CN);
categoryFunctions = client.getFunctionsByDevsList(DEV_ID);
System.out.println(“Hent funktionslisten efter enhedsliste: “);
System.out.println(JSONObject.toJSONString(kategorifunktioner));

Svar example

Fejlkode
Følgende er almindelige tjenesteundtagelser for denne grænseflade. For flere undtagelsesfejl, se Fejlkode.

Specifikationer og egenskaber for enheden

Få enhedens specifikationer og egenskaber, inklusive instruktionssættet og statussættet

API beskrivelse
Denne grænseflade bruges til at få instruktionssættet og statussættet understøttet af enheden i henhold til enhedens ID.

API-adresse

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

Anmodningsparameter

Retur parameter

Beskrivelse af resultat
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kategori | String | Produktkategori |
- | funktioner | Liste | Instruktionssæt |
- | status | Liste | Status indstillet |
Beskrivelse af funktioner
- | Parameternavn | Kategori | Beskrivelse |
- | :—- | :—- | :—|
- | kode | String | kommando |
- | type | String | Skriv |
- | værdier | String | Området af parameterværdier |
Beskrivelse af status
- | Parameternavn | Kategori | Beskrivelse |
- | :—| :—| :—|
- | kode | String | statuskode |
- | type | String | Skriv |
- | værdier | String | Området af parameterværdier |

Anmod example

FÅ /v1.0/ devices/vdevoXXXXXXXXXXXXXXX/specifications

SDK example
N/A

Retur parameter

Send instruktioner til enheden

API beskrivelse
Denne grænseflade bruges til at sende et eller flere opnåede instruktionssæt. Hvorvidt instruktionssæt kan sendes samtidigt afhænger af produktet.

API-adresse