tuya Довідка щодо API хмарних служб керування пристроями
Інформація про продукт
Продукт Device Control надає набір API та інструкцій для віддаленого керування пристроями. Користувачі можуть надсилати інструкції на пристрій за допомогою наданих кінцевих точок API.
Технічні характеристики:
- Контроль пристрою
- Версія: 20240124
- Онлайн-версія
Інструкція з використання продукту
- Отримайте набір інструкцій за категоріями:
Користувачі можуть отримати набір інструкцій за категоріями за допомогою таких кінцевих точок API:- Опис API
- Адреса API
- Параметр запиту
- Повернутий параметр
- Запит Прample
- SDK Example
- Відповідь Впрample
- Код помилки
- Отримати набір інструкцій для пристрою:
Щоб отримати інструкції, встановлені пристроєм, користувачі можуть використовувати надані кінцеві точки API для певних пристроїв. Це включає такі деталі, як адреса API, параметри запиту, параметри повернення тощоampлес. - Отримати набір інструкцій за пристроями:
Ця функція дозволяє користувачам отримувати доступ до набору інструкцій для кількох пристроїв. Користувачі можуть робити запити, використовуючи надану адресу API та параметри. - Отримайте технічні характеристики та властивості пристрою:
Ця кінцева точка API надає детальні специфікації та властивості пристрою, включаючи набір інструкцій і набір статусів. Користувачі можуть запитувати цю інформацію разом із напрampописано, як використовувати SDK. - Надіслати інструкції на пристрій:
Користувачі можуть надсилати певні інструкції на пристрій за допомогою наданого API. Це включає такі деталі, як параметри запиту, параметри повернення та напрampопис того, як ефективно надсилати інструкції.
FAQ:
- З: Як я можу вирішити проблему, якщо під час надсилання інструкцій виникають помилки?
Відповідь: якщо під час надсилання інструкцій виникають помилки, зверніться до розділу з кодом помилки в документації API, щоб визначити та усунути проблему. - З: Чи можу я керувати кількома пристроями одночасно?
A: Так, ви можете керувати декількома пристроями одночасно, використовуючи інструкції, встановлені функцією пристрою, і надсилаючи відповідні запити для кожного пристрою.
У цьому розділі описано API, пов’язані з керуванням пристроєм, зокрема отримання наборів інструкцій, специфікацій, властивостей, останніх статусів і надсилання інструкцій.
Отримайте набір інструкцій за категоріями
Опис API
Запитайте набір інструкцій за категорією. Цей набір інструкцій містить найбільшу кількість інструкцій у категорії універсальних програм, які можуть використовуватися розробниками. Якщо ви розробник платформи, ви можете розробляти програми відповідно до цього набору інструкцій.
адреса API
- GET /v1.0/ functions /{ category}
Параметр запиту
Параметр повернення
- Опис результату
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | категорія| Рядок | Категорія товару |
- | функції| Список | Набір інструкцій |
- Опис функцій
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | код | Рядок | Інструкція | | типу | Рядок | Тип інструкції |
- | значення | Рядок | Діапазон значень вхідних параметрів |
- | назва | Рядок | Назва інструкції |
- | спад | Рядок | Опис |
Запит напрample
- GET /v1.0/ функції/кг
SDK example
Відповідь прample
Код помилки
Нижче наведено типові винятки служби для цього інтерфейсу. Додаткові помилки винятків див Код помилки.
Отримати інструкції, встановлені пристроєм
Опис API
Запитуйте функції, які підтримує пристрій. За отриманими інструкціями ви можете відправити контроль.
адреса API
- Функції GET /v1.0/ devices /{ device_id }/
Параметр запиту
Параметр повернення
- Опис результату
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | категорія| Рядок | Категорія товару |
- | функції| Список | Набір інструкцій |
- Опис функцій
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | код | Рядок | Інструкція |
- | типу | Рядок | Тип інструкції |
- | значення | Рядок | Діапазон значень вхідних параметрів |
- | назва | Рядок | Назва інструкції |
- | спад | Рядок | Опис |
Запит напрample
- GET /v1.0/ devices/vdevo155XXXX83954683/functions
SDK example
- TuyaClient client = new TuyaClient(clientId , secret , RegionEnum.CN);
- categoryFunctions = client.getFunctionsByDevId(DEV_ID);
- System.out.println(“Отримати список функцій за ідентифікатором пристрою: “);
- System.out.println(JSONObject.toJSONString(функції категорії));
Відповідь прample
Код помилки
Нижче наведено типові винятки служби для цього інтерфейсу. Додаткові помилки винятків див Код помилки.
Отримати інструкції, набір пристроїв
Опис API
Запитайте функції, які підтримує список пристроїв. За отриманими інструкціями ви можете відправити контроль. підтримка до 20 пристроїв
адреса API
- GET /v1.0/ пристрої/функції
Параметр запиту
Параметр повернення
- Опис результату
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | категорія| Рядок | Категорія товару |
- | функції| Список | Набір інструкцій |
- | пристрої | Список | список ідентифікаторів пристроїв |
- Опис функцій
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | код | Рядок | Інструкція |
- | типу | Рядок | Тип інструкції |
- | значення | Рядок | Діапазон значень вхідних параметрів |
- | назва | Рядок | Назва інструкції |
- | спад | Рядок | Опис |
Запит напрample
- ОТРИМАЙТЕ /v1.0/ devices/functions?device_ids =06200286 dc4f22c8418c ,6c8b eb2f
- a517fbc901dtln
SDK example
- TuyaClient client = new TuyaClient(clientId , secret , RegionEnum.CN);
- categoryFunctions = client.getFunctionsByDevsList(DEV_ID);
- System.out.println(“Отримати список функцій за списком пристроїв: “);
- System.out.println(JSONObject.toJSONString(функції категорії));
Відповідь прample
Код помилки
Нижче наведено типові винятки служби для цього інтерфейсу. Додаткові помилки винятків див Код помилки.
Технічні характеристики та властивості пристрою
Отримайте специфікації та властивості пристрою, включаючи набір інструкцій і набір стану
Опис API
Цей інтерфейс використовується для отримання набору інструкцій і набору статусів, які підтримуються пристроєм, відповідно до ідентифікатора пристрою.
адреса API
- ОТРИМАЙТЕ специфікації /v1.0/ devices /{ device_id }/
Параметр запиту
Параметр повернення
- Опис результату
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | категорія | Рядок | Категорія товару |
- | функції | Список | Набір інструкцій |
- | статус | Список | Набір статусів |
- Опис функцій
- | Назва параметра | Категорія | Опис |
- | :—- | :—- | :—|
- | код | Рядок | команда |
- | типу | Рядок | Тип |
- | значення | Рядок | Діапазон значень параметрів |
- Опис статусу
- | Назва параметра | Категорія | Опис |
- | :—| :—| :—|
- | код | Рядок | код статусу |
- | типу | Рядок | Тип |
- | значення | Рядок | Діапазон значень параметрів |
Запит напрample
- ОТРИМАЙТЕ /v1.0/ devices/vdevoXXXXXXXXXXXXXXX/specifications
SDK example
N/A
Параметр повернення
Надішліть інструкції на пристрій
Опис API
Цей інтерфейс використовується для надсилання одного або кількох отриманих наборів інструкцій. Чи можна надсилати набори інструкцій одночасно, залежить від продукту.
адреса API
- Команди POST /v1.0/ devices /{ device_id }/
Параметр запиту
Параметр повернення
Запит напрample
- POST /v1.0/ devices/vdevo1552XXXX3954683/commands
SDK example
Відповідь прample
Код помилки
Нижче наведено типові винятки служби для цього інтерфейсу. Додаткові помилки винятків див Код помилки.
Отримати останній стан пристрою
Опис API
Отримайте останній статус пристрою за ідентифікатором пристрою
адреса API
- GET /v1.0/ пристрої /{ device_id }/ статус
Параметр запиту
Параметр повернення
Запит напрample
- GET /v1.0/ пристрої /{ device_id }/ статус
SDK example
Відповідь прample
Код помилки
Нижче наведено типові винятки служби для цього інтерфейсу. Додаткові помилки винятків див Код помилки.
Документи / Ресурси
 |
tuya Довідка щодо API хмарних служб керування пристроями [pdfПосібник користувача Довідник щодо API хмарних служб керування пристроями, Довідник API хмарних служб, Довідник API |
