Підключення до I3 REST-Bridge

В систему i3 Engineering REST Bridge підключається по CANЩоб надсилати HTTP-запити до i3 REST Bridge, він має бути підключений до мережі з IP-адресою (динамічною або статичною). Для звернення можна використовувати:
IP-адресу напряму: http://<bridge_ip>
mDNS-адресу: http://Atom_<серійний_номер>.local

Адресація пристроїв

Усі пристрої i3Engineering мають унікальні ідентифікатори — unit ID, які мають формат 4-символьного HEX-рядка (наприклад: 1234, BEEF, C0FE).
Кожен пристрій містить стейти (states) — логічні елементи, що можуть бути кнопками, датчиками, світлодіодами тощо. Кожен стейт має:● state_type — тип стейту (наприклад: out — вихід, temp — температура)● state_id — ID стейту (наприклад, порт або абстрактна ідентифікація)
Щоб звернутися до стейту, потрібно вказати:php-templateКопіюватиРедагувати<unit_id>/<state_type>/<state_id>/<subvalue>

Всі стейти мають основний канал з даними та допоміжні (Subvalues)

Кожен стейт має набір допоміжних значень — це окремі значення або властивості. Наприклад:● main — основне значення (обов'язкове)● CURRENT, VOLTAGE, POWER — додаткові дані для енергометра● HSV, RGB — кольорові значення для LED
Деякі значення доступні лише за специфічної конфігурації.

Формат URL запитів

https://<bridge_ip>/api/v1/<unit_id>/<state_type>/<state_id>/<subvalue>/

Авторизація

У кожен запит потрібно включити API ключ у тілі запиту.

Методи HTTP-запитів

Приклади запитів

Отримання значення (GET):
URL:
https://192.168.1.21/api/v1/000A/out/9/main/

Тіло:
json
{
"api_key": "your_api_key_here"
}

Відповідь:
json
{
"value": 0
}

Увімкнення виходу (POST):

URL:
https://192.168.1.21/api/v1/B0B0/out/2/main/

Тіло:
{
"api_key": "your_api_key_here",
"value": 1
}

Відповідь:● Порожнє тіло● Код: 200 OK

Встановлення кольору RGB:

URL:
https://192.168.1.21/api/v1/B0B0/rgb/2/main/

Тіло:
{
"api_key": "your_api_key_here",
"value": "#FFAA00"
}
Відповідь:● Порожнє тіло

Запуск сценарію:

URL:https://192.168.1.21/api/v1/B0B0/scenario_ctrl/1/main
Тіло:{ "api_key": "1453fc9406736afdeceb35470a1809a790d025f222f11a985fc705d627db7a7f", "value": 77}
Відповідь:● Порожнє тіло

Зупинити виконання сценарію:

URL:
https://192.168.1.21/api/v1/B0B0/scenario_ctrl/1/main

Тіло:
{
"api_key": "1453fc9406736afdeceb35470a1809a790d025f222f11a985fc705d627db7a7f",
"value": -77
}
Відповідь:● Порожнє тіло

Примітки

● Параметри значень і типів можна знайти за посиланням https://i3engineering.com/knowledge-base-blockly-ua/blockly-states● Для вашого проекту дані про стейти можна знайти в додатку натиснувши головне меню - менеджер пристроїв - вибрати потрібний юніти - таблиця налаштувань портів