tuya-Logo

Referència de l'API de serveis al núvol de control de dispositius tuya

tuya-Device-Control-Cloud-Services-API-Reference-product

Informació del producte

El producte Device Control proporciona un conjunt d'API i instruccions per controlar els dispositius de forma remota. Els usuaris poden enviar instruccions al dispositiu mitjançant els punts finals de l'API proporcionats.

Especificacions:

  • Control del dispositiu
  • Versió: 20240124
  • Versió en línia

Instruccions d'ús del producte

  1. Obteniu el conjunt d'instruccions per categoria:
    Els usuaris poden recuperar el conjunt d'instruccions per categoria mitjançant els punts finals de l'API següents:
    • Descripció de l'API
    • Adreça de l'API
    • Paràmetre de sol·licitud
    • Paràmetre de retorn
    • Sol·licitud Example
    • SDK Example
    • Resposta Example
    • Codi d'error
  2. Obteniu el conjunt d'instruccions per dispositiu:
    Per obtenir les instruccions establertes pel dispositiu, els usuaris poden utilitzar els punts finals de l'API proporcionats per a dispositius específics. Això inclou detalls com ara l'adreça de l'API, els paràmetres de sol·licitud, els paràmetres de retorn i, per exemple,amples.
  3. Obteniu el conjunt d'instruccions per dispositius:
    Aquesta característica permet als usuaris accedir al conjunt d'instruccions per a diversos dispositius. Els usuaris poden fer sol·licituds mitjançant l'adreça de l'API i els paràmetres proporcionats.
  4. Obteniu les especificacions i propietats del dispositiu:
    Aquest punt final de l'API proporciona especificacions i propietats detallades del dispositiu, inclòs el conjunt d'instruccions i el conjunt d'estats. Els usuaris poden sol·licitar aquesta informació juntament amb exampfitxers de com utilitzar l'SDK.
  5. Envieu instruccions al dispositiu:
    Els usuaris poden enviar instruccions específiques al dispositiu mitjançant l'API proporcionada. Això inclou detalls com ara els paràmetres de sol·licitud, els paràmetres de retorn i, pampfitxers de com enviar instruccions de manera eficaç.

Preguntes freqüents:

  • P: Com puc solucionar problemes si trobo errors en enviar instruccions?
    R: Si trobeu errors en enviar instruccions, consulteu la secció del codi d'error de la documentació de l'API per identificar i resoldre el problema.
  • P: Puc controlar diversos dispositius simultàniament?
    R: Sí, podeu controlar diversos dispositius simultàniament utilitzant les instruccions establertes per la funció del dispositiu i fent sol·licituds per a cada dispositiu en conseqüència.

Aquest tema descriu les API relacionades amb el control del dispositiu, com ara l'obtenció de conjunts d'instruccions, especificacions, propietats, estats més recents i enviament d'instruccions.

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (1)

Obteniu les instruccions establertes per categoria

Descripció de l'API
Consulta la instrucció establerta per categoria. Aquest conjunt d'instruccions té la major quantitat d'instruccions de la categoria d'aplicacions tot en un, que els desenvolupadors poden utilitzar i fer referència. Si sou un desenvolupador de plataformes, podeu desenvolupar aplicacions segons aquest conjunt d'instruccions.

Adreça de l'API

  1. GET /v1.0/ funcions /{ categoria}

Paràmetre de sol·licitud

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (2)

Paràmetre de retorn

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (3)tuya-Device-Control-Cloud-Services-API-Reference-Fig- (5)

  • Descripció del resultat
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | categoria| Cadena | Categoria de producte |
    • | funcions| Llista | Conjunt d'instruccions |
  • Descripció de les funcions
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | codi | Cadena | Instrucció | | tipus | Cadena | Tipus d'instrucció |
    • | valors | Cadena | L'interval de valors dels paràmetres d'entrada |
    • | nom | Cadena | Nom de la instrucció |
    • | desc | Cadena | Descripció |

Sol·licitud example

  1. GET /v1.0/funcions/kg

SDK example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (6)

Resposta example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (7) tuya-Device-Control-Cloud-Services-API-Reference-Fig- (8) tuya-Device-Control-Cloud-Services-API-Reference-Fig- (9)

Codi d'error
Les següents són excepcions de servei habituals per a aquesta interfície. Per obtenir més errors d'excepció, vegeu Codi d'error.

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (10)

Obteniu les instruccions establertes per dispositiu

Descripció de l'API
Consulta les funcions suportades pel dispositiu. Podeu enviar el control mitjançant les instruccions obtingudes.

Adreça de l'API

  1. GET /v1.0/ dispositius /{ device_id }/ funcions

Paràmetre de sol·licitud

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (11)

Paràmetre de retorn

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (12)tuya-Device-Control-Cloud-Services-API-Reference-Fig- (13)

  • Descripció del resultat
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | categoria| Cadena | Categoria de producte |
    • | funcions| Llista | Conjunt d'instruccions |
  • Descripció de les funcions
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | codi | Cadena | Instrucció |
    • | tipus | Cadena | Tipus d'instrucció |
    • | valors | Cadena | L'interval de valors dels paràmetres d'entrada |
    • | nom | Cadena | Nom de la instrucció |
    • | desc | Cadena | Descripció |

Sol·licitud example

  1. GET /v1.0/ devices/vdevo155XXXX83954683/functions

SDK example

  1. TuyaClient client = nou TuyaClient(clientId , secret , RegionEnum.CN);
  2. categoryFunctions = client.getFunctionsByDevId(DEV_ID);
  3. System.out.println(“Obtén la llista de funcions per ID del dispositiu:”);
  4. System.out.println(JSONObject.toJSONString(categoria Funcions));

Resposta example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (14)

Codi d'error
Les següents són excepcions de servei habituals per a aquesta interfície. Per obtenir més errors d'excepció, vegeu Codi d'error.

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (15)

Obteniu les instruccions establertes pels dispositius

Descripció de l'API
Consulta les funcions suportades per la llista de dispositius. Podeu enviar el control mitjançant les instruccions obtingudes. suporta fins a 20 dispositius

Adreça de l'API

  1. GET /v1.0/dispositius/funcions

Paràmetre de sol·licitud

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (16)

Paràmetre de retorn

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (17)tuya-Device-Control-Cloud-Services-API-Reference-Fig- (18)

  • Descripció del resultat
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | categoria| Cadena | Categoria de producte |
    • | funcions| Llista | Conjunt d'instruccions |
    • | dispositius | Llista | Llista d'identificacions del dispositiu |
  • Descripció de les funcions
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | codi | Cadena | Instrucció |
    • | tipus | Cadena | Tipus d'instrucció |
    • | valors | Cadena | L'interval de valors dels paràmetres d'entrada |
    • | nom | Cadena | Nom de la instrucció |
    • | desc | Cadena | Descripció |

Sol·licitud example

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

SDK example

  1. TuyaClient client = nou TuyaClient(clientId , secret , RegionEnum.CN);
  2. categories Funcions = client.getFunctionsByDevsList(DEV_ID);
  3. System.out.println("Obtén la llista de funcions per llista de dispositius: ");
  4. System.out.println(JSONObject.toJSONString(categoria Funcions));

Resposta example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (19)

Codi d'error
Les següents són excepcions de servei habituals per a aquesta interfície. Per obtenir més errors d'excepció, vegeu Codi d'error.

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (20)

Especificacions i propietats del dispositiu

Obteniu les especificacions i propietats del dispositiu, inclòs el conjunt d'instruccions i el conjunt d'estats

Descripció de l'API
Aquesta interfície s'utilitza per obtenir el conjunt d'instruccions i el conjunt d'estats compatibles amb el dispositiu segons l'ID del dispositiu.

Adreça de l'API

  1. GET /v1.0/ dispositius /{ device_id }/ especificacions

Paràmetre de sol·licitud

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (21)

Paràmetre de retorn

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (22)tuya-Device-Control-Cloud-Services-API-Reference-Fig- (23)

  • Descripció del resultat
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | categoria | Cadena | Categoria de producte |
    • | funcions | Llista | Conjunt d'instruccions |
    • | estat | Llista | Estat establert |
  • Descripció de les funcions
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—- | :—- | :—|
    • | codi | Cadena | comanda |
    • | tipus | Cadena | Tipus |
    • | valors | Cadena | L'interval de valors dels paràmetres |
  • Descripció de l'estat
    • | Nom del paràmetre | Categoria | Descripció |
    • | :—| :—| :—|
    • | codi | Cadena | codi d'estat |
    • | tipus | Cadena | Tipus |
    • | valors | Cadena | L'interval de valors dels paràmetres |

Sol·licitud example

  • GET /v1.0/ devices/vdevoXXXXXXXXXXXXXXX/specifications

SDK example
N/A

Paràmetre de retorn

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (24) tuya-Device-Control-Cloud-Services-API-Reference-Fig- (25)

Envieu instruccions al dispositiu

Descripció de l'API
Aquesta interfície s'utilitza per enviar un o més conjunts d'instruccions obtinguts. Si es poden enviar conjunts d'instruccions simultàniament depèn del producte.

Adreça de l'API

  1. POST /v1.0/ devices /{ device_id }/ ordres

Paràmetre de sol·licitud

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (26)

Paràmetre de retorn

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (27)tuya-Device-Control-Cloud-Services-API-Reference-Fig- (28)

Sol·licitud example

  1. POST /v1.0/dispositius/vdevo1552XXXX3954683/commands

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (29)

SDK example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (30)

Resposta example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (31)

Codi d'error
Les següents són excepcions de servei habituals per a aquesta interfície. Per obtenir més errors d'excepció, vegeu Codi d'error.

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (32)

Obteniu l'últim estat del dispositiu

Descripció de l'API
Obteniu l'últim estat del dispositiu mitjançant l'ID del dispositiu

Adreça de l'API

  1. GET /v1.0/ dispositius /{ device_id }/ estat

Paràmetre de sol·licitud

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (33)

Paràmetre de retorn

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (34)tuya-Device-Control-Cloud-Services-API-Reference-Fig- (35)

Sol·licitud example

  1. GET /v1.0/ dispositius /{ device_id }/ estat

SDK example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (36)

Resposta example

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (37)tuya-Device-Control-Cloud-Services-API-Reference-Fig- (39)

Codi d'error
Les següents són excepcions de servei habituals per a aquesta interfície. Per obtenir més errors d'excepció, vegeu Codi d'error.

tuya-Device-Control-Cloud-Services-API-Reference-Fig- (38)

Documents/Recursos

Referència de l'API de serveis al núvol de control de dispositius tuya [pdfGuia de l'usuari
Device Control Cloud Services API Reference, Cloud Services API Reference, Cloud Services API Reference

Referències

Deixa un comentari

La teva adreça de correu electrònic no es publicarà. Els camps obligatoris estan marcats *