Dla deweloperów i przewodnik po API

1. Rozpoczęcie użytkowania

1.1 Przygotowanie

Krok 1. Upewnij się, że bramka jest włączona i działa prawidłowo.

Krok 2. Upewnij się, że bramka i komputer są podłączone do tej samej sieci LAN. Następnie wpisz URL CUBE w przeglądarce.

Uwaga: Jeśli masz kilka bramek, możesz uzyskać odpowiedni adres IP, aby uzyskać dostęp do określonej bramki na dwa poniższe sposoby.

1. Zaloguj się do swojego routera bezprzewodowego i sprawdź adres IP bramki w DHCP.

2. CUBE obsługuje lokalne wykrywanie za pomocą mDNS.

1.2 Rozpocznij

• Wywołaj interfejs [Access Token], i otrzymasz odpowiedź o błędzie, z komunikatem wzywającym do kliknięcia <Gotowe>. Zauważ, że po naciśnięciu dostęp do interfejsu jest ważny nie dłużej niż 5 minut.

// Żądanie
curl --location --request GET 'http://<adres ip>/open-api/V2/rest/bridge/access_token' --header 'Content-Type: application/json'

// Odpowiedź
{
  "error": 401,
  "data": {},
  "message": "link button not pressed" 
}

• Kliknij <Gotowe> i ponownie wywołaj interfejs [Access Token]. Odpowiedź jest pomyślna i token zostaje uzyskany.

// Żądanie
curl --location --request GET 'http://<adres ip>/open-api/V2/rest/bridge/access_token' --header 'Content-Type: application/json'

// Odpowiedź
{
  "error": 0,
  "data": {
    "token": "376310da-7adf-4521-b18c-5e0752cfff8d"
  },
  "message": "success"
}

• Zweryfikuj token. Wywołaj interfejs [Get Device List]. Odpowiedź jest pomyślna i lista urządzeń zostaje pobrana.

// Żądanie
curl --location --request GET 'http://<adres ip>/open-api/V2/rest/devices' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 376310da-7adf-4521-b18c-5e0752cfff8d'

// Odpowiedź
{
  "error": 0,
  "data": {
    "device_list":  [
      {
        "serial_number": "ABCDEFGHIJK",
        "name": "nazwa urządzenia",
        "manufacturer": "nazwa producenta",
        "model": "nazwa modelu",
        "firmware_version": "1.1.0",
        "display_category": "switch",
        "capabilities": [
          {
            "capability": "power",
            "permission": "readWrite"
          }
        ],
        "protocal": "zigbee",
        "state": {
          "power": {
            "powerState": "on"
          }
        },
        "tags": {
          "key": "value"
        },
        "online": true
      }
    ]
  }
  "message": "success"
}

• Metoda uzyskania tokena dostępu do CUBE: Po wywołaniu interfejsu [Access Token], na stronie konsoli WWW CUBE pojawi się globalne okno wyskakujące, które wzywa użytkownika do potwierdzenia uzyskania poświadczeń wywołania interfejsu.

• Uwaga: Jeśli otworzysz więcej niż jedną stronę konsoli WWW CUBE, okno potwierdzenia pojawi się na wielu stronach konsoli jednocześnie, a okno wyskakujące na innych stronach zostanie zamknięte po potwierdzeniu na jednej ze stron konsoli.

2. Główna koncepcja

2.1 Adres interfejsu deweloperskiego

Interfejs Web API bramki ma dwa sposoby dostępu (na podstawie IP lub nazwy domeny), zwykle ścieżka główna to /open-api/V2/rest/< specific function module >

// Dostęp przez IP http:///open-api/V2/rest/bridge

// Dostęp przez nazwę domeny http:///open-api/V2/rest/bridge

2.2 Kategoria wyświetlania urządzenia i możliwości

• **Kategoria wyświetlania urządzenia (DisplayCategory).** Kategoria wyświetlania urządzenia służy do identyfikacji określonych kategorii (urządzeń), takich jak switch, plug, light itp. Informacja ta określi efekt wyświetlania UI urządzenia w bramce.

• **Możliwość urządzenia.** Możliwość urządzenia służy do opisu konkretnych podfunkcji urządzenia. Na przykład sterowanie zasilaniem, sterowanie jasnością, sterowanie temperaturą barwową itd. Pojedyncze urządzenie może obsługiwać 1 lub więcej możliwości.

  • zdolność: Opisuje nazwę możliwości, która musi być globalnie unikalna i typu string. Wiele angielskich słów powinno być oddzielonych myślnikami ("-"). Na przykład: "thermostat-target-setpoint".

  • nazwa: Opisuje kategorię pod możliwością, również typu string. Wiele angielskich słów powinno być oddzielonych myślnikami ("-"). Na przykład: "auto-mode", "manual-mode".

  • uprawnienie: Opisuje uprawnienia związane z możliwością. Typ to string, sformatowany w postaci kodu binarnego 8421. Przykłady obejmują:

    • Urządzenie możliwe do sterowania: "1000"

    • Urządzenie możliwe do skonfigurowania: "0010"

    • Urządzenie możliwe do sterowania i konfigurowania: "1010"

    • Urządzenie możliwe do sterowania i raportowania: "1100"

Znaczenie każdego bitu, od prawej do lewej, jest następujące: ⅰ. Bit 0: Pozwala na zapytanie urządzenia ⅱ. Bit 1: Pozwala na konfigurację urządzenia ⅲ. Bit 2: Pozwala urządzeniu na raportowanie danych ⅳ. Bit 3: Pozwala na sterowanie urządzeniem

const permission = {
  "update": "1000",
  "updated": "0100",
  "configure": "0010",
  "query": "0001",  
  "update-updated": "1100",
  "update-query": "1001",
  "update-updated-configure": "1110",
  "updated-configure":"0110",
  "update-updated-query":"1101"
}

ustawienia: Opisuje elementy konfiguracji dla możliwości, które są typu obiekt i zawierają opis każdego elementu konfiguracji. ⅰ. klucz: Opisuje nazwę elementu konfiguracji, która jest typu string. Wiele angielskich słów powinno być wyrażone w camelCase. Na przykład: "temperatureUnit". ⅱ. wartość: Opisuje zawartość elementu konfiguracji. Konkretne specyfikacje są szczegółowo opisane w tabeli poniżej.

Atrybut	Typ	Opcjonalne	Opis
uprawnienie	string	N	Opisuje uprawnienia dla elementu konfiguracji.
Dostępne opcje:

• Pozwól na modyfikację tego elementu konfiguracji: "10"

• Pozwól na przeglądanie tego elementu konfiguracji: "01"

• Pozwól zarówno na modyfikację, jak i przeglądanie tego elementu konfiguracji: "11"

Wyjaśnienie bitów:

1. Bit 0: Pozwala na przeglądanie tego elementu konfiguracji

2. Bit 1: Pozwala na modyfikację tego elementu konfiguracji | | typ | string | N | Opisuje typ danych wartości elementu konfiguracji. Dostępne opcje:

• "enum"

• "numeric"

• "object"

• "boolean"

• "string"

Wytyczne specyficzne dla typów:

1. Kiedy **type = enum**:

   • Z wartość pole (opisujące wartość elementu konfiguracji) jest wymagane jeśli uprawnienie pozwala na modyfikację ("10" lub "11").

   • Z domyślny (opisujący wartość domyślną elementu konfiguracji) oraz wartości (opisujące dostępne wartości dla elementu konfiguracji) pola są opcjonalne.

2. Kiedy **type = numeric**:

   • Z wartość pole jest wymagane jeśli uprawnienie pozwala na modyfikację ("10" lub "11").

   • Następujące pola są opcjonalne:

     • min (opisujące minimalną wartość elementu konfiguracji)

     • max (opisujące maksymalną wartość elementu konfiguracji)

     • krok (opisujące wartość kroku dla elementu konfiguracji)

     • dokładność (opisujące precyzję)

     • jednostka (opisujące jednostkę elementu konfiguracji)

     • domyślny (opisujące wartość domyślną)

3. Kiedy **type = object**:

   • Z wartość pole jest wymagane jeśli uprawnienie pozwala na modyfikację ("10" lub "11").

   • Z domyślny pole jest opcjonalne.

4. Kiedy **type = boolean**:

   • Z wartość pole jest wymagane jeśli uprawnienie pozwala na modyfikację ("10" lub "11").

   • Z domyślny pole jest opcjonalne.

5. Kiedy **type = string**:

   • Z wartość pole jest wymagane jeśli uprawnienie pozwala na modyfikację ("10" lub "11").

   • Z domyślny pole jest opcjonalne. |

// type = enum
{
  "settings":{
    "temperatureUnit": {
      "type": "enum",
      "permission": "11", 
      "values": ["c", "f"], 
      "default": "c",
      "value": "f"
    }
  }
}
// type = numeric
{
  "settings": {
    "setpointRange": {
      "type": "numeric", 
      "permission": "01", 
      "min": 4, 
      "max": 35,
      "default": 20,
      "step": 0.5,
      "precision": 0.01
      "unit": "c"
    }
  }
}

// type = object
{
  "settings":{
    "weeklySchedule":{
      "type": "object",
      "permission": "11", 
      "value": {
        "maxEntryPerDay": 2, 
        "Monday": [
          {
            "startTimeInMinutes": 440, 
            "upperSetpoint": 36.5 
          },
          {
            "startTimeInMinutes": 900,
            "upperSetpoint": 26.5 
          }
        ],
        "Tuesday": [...],
        "Wednesday": [...],
        "Thursday": [...],
        "Friday": [...],
        "Saturday": [...],
        "Sunday": [...],
      }
    }
  }
}

3. Web API

Typ danych

Typ	Opis
string	Typ danych string. Kodowanie UTF8.
number	Typ danych liczbowy. podwójna precyzja 64-bitowy format binarny IEEE 754
int	Typ danych całkowitych.
object	Typ danych obiekt. Obiekt zgodny z JSON
string[]	Tablica stringów
int[]	Tablica liczb całkowitych
object[]	Tablica obiektów
bool	Wartość logiczna
date	Ciąg czasu. Ciąg w formacie ISO (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ. Strefa czasowa jest zawsze UTC (Uniwersalny Czas Koordynowany), oznaczona sufiksem "Z".

Ogólne wyniki odpowiedzi

Atrybut	Typ	Opcjonalne	Opis
error	int	N	Kod błędu:
0: Sukces
400: Błąd parametru
401: Uwierzytelnianie nie powiodło się
500: Wyjątek serwera
data	object	N	Treść danych odpowiedzi
message	string	N	Opis odpowiedzi:
Gdy error jest równy 0, zawartość to success
Gdy error jest różny od 0, jest to niepusty ciąg znaków i zawiera opis błędu.

Przykład odpowiedzi:

{
  "error": 0,
  "data": {
    "token": "376310da-7adf-4521-b18c-5e0752cfff8d"
  },
  "message": "success"
}

{
  "error": 400,
  "data": {},
  "message": "invalid parameters"
}

Lista zasobów

Typ	Opis
Obsługiwane dźwięki	- alert1 (Dźwięk alarmu 1)

• alert2 (Dźwięk alarmu 2)

• alert3 (Dźwięk alarmu 3)

• alert4 (Dźwięk alarmu 4)

• alert5 (Dźwięk alarmu 5)

• doorbell1 (Dźwięk dzwonka 1)

• doorbell2 (Dźwięk dzwonka 2)

• doorbell3 (Dźwięk dzwonka 3)

• doorbell4 (Dźwięk dzwonka 4)

• doorbell5 (Dźwięk dzwonka 5)

• alarm1 (Dźwięk alarmu 1)

• alarm2 (Dźwięk alarmu 2)

• alarm3 (Dźwięk alarmu 3)

• alarm4 (Dźwięk alarmu 4)

• alarm5 (Dźwięk alarmu 5) | | Obsługiwane deep | - bootComplete (Uruchamianie systemu zakończone)

• networkConnected (Sieć połączona)

• networkDisconnected (Sieć rozłączona)

• systemShutdown (Zamknięcie systemu) -deviceDiscovered (Wykryto urządzenie)

• system Armed (System uzbrojony/aktywowany)

• system Disarmed (System rozbrojony/dezaktywowany)

• factoryReset (Reset urządzenia) |

3.1 Funkcja bramki

a. Token dostępu

Pozwól użytkownikom uzyskać token dostępu.

• Uwaga: Token zostanie wyczyszczony po zresetowaniu urządzenia.

• Uwaga: Po uzyskaniu tokena musisz ponownie nacisnąć przycisk, aby pomyślnie uzyskać nowy token.

:::porady

• URL：/open-api/V2/rest/bridge/access_token

• Metoda：GET

• Nagłówek：

  • Content-Type: application/json ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
app_name	string	Y	Opis nazwy aplikacji.

Pomyślna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
token	string	N	Token dostępu do interfejsu. Jest ważny długo, proszę zapisać
app_name	string	Y	Opis nazwy aplikacji.

:::porady Warunek : Użytkownik wyzwala < command key > i uzyskuje dostęp do tego interfejsu w czasie ważności. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {
    "token": "376310da-7adf-4521-b18c-5e0752cfff8d"
  },
  "message": "success"
}

Niepowodzenie odpowiedzi danych：pusty obiekt :::porady Warunki：Użytkownik nie wyzwolił < command key >, lub czas ważności wygasł. **Kod stanu: ** 200 OK ::: Przykład odpowiedzi:

{
  "error": 401,
  "data": {},
  "message": "link button not pressed" 
}

b. Pobierz stan bramki

Pozwól autoryzowanym użytkownikom uzyskać status bramki przez ten interfejs :::porady

• URL：/open-api/V2/rest/bridge/runtime

• Metoda：GET

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania: brak Pomyślna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
ram_used	int	N	Procent użycia pamięci RAM.[0-100]
cpu_used	int	N	Procent użycia CPU. [0-100]
power_up_time	date	N	Ostatni czas włączenia zasilania
cpu_temp	int	N	Temperatura CPU:
Jednostka: Celsjusz
cpu_temp_unit	string	N	Jednostka temperatury CPU:
Opcjonalne
wartości:'c', 'f'
sd_card_used	int	Y	Użycie karty SD (procent):
Zakres:[0-100] z dokładnością do jednego miejsca po przecinku
*Uwaga: Jeśli karta SD nie jest włożona lub nie jest sformatowana, wartość jest pusta.

:::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {
    "ram_used": 40,
    "cpu_used": 30,
    "power_up_time": "2022-10-12T02:58:09.989Z",
    "cpu_temp": 51,
    "cpu_temp_unit": "c",
    "sd_card_used" : "12"
  },
  "message": "success"
}

c. Konfiguracja bramki

Pozwala autoryzowanym użytkownikom ustawić bramkę przez ten interfejs :::porady

• URL：/open-api/V2/rest/bridge/config

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
volume	int	Y	Głośność systemu. [0-100]

Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

d. Pobierz informacje o bramce

Pozwól autoryzowanym użytkownikom uzyskać informacje o bramce przez ten interfejs :::porady

• URL：/open-api/V2/rest/bridge

• Metoda：GET

• Nagłówek：

  • Content-Type: application/json ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
ip	string	N	adres ip
mac	string	N	adres mac
domain	string	Y	Domena usługi bramki
fw_version	string	N	Wersja firmware
name	string	N	Nazwa urządzenia

Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Brak **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {
    "ip": "192.168.31.25",
    "mac": "00:0A:02:0B:03:0C",
    "domain": "ihost.local",
    "fw_version": "1.9.0",
    "name": "iHost"
  },
  "message": "success"
}

e. Wyciszenie bramki

Pozwala autoryzowanym użytkownikom wyciszyć bramkę przez ten interfejs. :::porady

• URL：/open-api/v2/rest/bridge/mute

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: brak Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

f. Wyłączenie wyciszenia bramki

Pozwala autoryzowanym użytkownikom wyłączyć wyciszenie bramki przez ten interfejs. :::porady

• URL：/open-api/v2/rest/bridge/unmute

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: brak Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

g. Anuluj alarm bramki

Pozwala autoryzowanym użytkownikom wyłączyć stan dźwięku alarmu na bramce przez ten interfejs. :::porady

• URL：/open-api/v2/rest/bridge/cancel_alarm

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: brak Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

3.2 Funkcje sprzętowe

a. Restart bramki

Pozwala autoryzowanemu użytkownikowi zrestartować bramkę przez ten interfejs :::porady

• URL：/open-api/V2/rest/hardware/reboot

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania: brak Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK :::

{
  "error": 0,
  "data": {},
  "message": "success"
}

b. Sterowanie głośnikiem

Pozwala autoryzowanym użytkownikom sterować głośnikiem przez ten interfejs :::porady

• URL：/open-api/V2/rest/hardware/speaker

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
type	string	N	Opcjonalne parametry: 1.play_sound (odtwórz dźwięk) 2.play_beep (odtwórz pik)
sound	SoundObject	Y (N jeśli type to play_sound.)	Dźwięk.
beep	BeepObject	Y (N jeśli type to play_beep.)	Pik

SoundObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa dźwięku. Obsługiwane wartości można sprawdzić w [Resource List - Supported sound]
volume	int	N	Głośność dźwięku. [0-100]
countdown	int	N	Czas trwania odtwarzania dźwięku przez głośnik; odtwarzanie zatrzyma się automatycznie po upływie czasu. Jednostka: sekunda. [0,1799]

BeepObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa deep. Obsługiwane wartości można sprawdzić w [Resource List - Supported deep]
volume	int	N	Głośność deep. [0-100]

Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: ** 200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

3.3 Funkcje zarządzania urządzeniami

a. Obsługiwane typy urządzeń

Typ urządzenia	Wartość	Wersja iHost
Gniazdko	plug	≥ 2.1.0
Włącznik	switch	≥ 2.1.0
Światło	light	≥ 2.1.0
Zasłona	curtain	≥ 2.1.0
Czujnik drzwi/okien	contactSensor	≥ 2.1.0
Czujnik ruchu	motionSensor	≥ 2.1.0
Czujnik temperatury	temperatureSensor	≥ 2.1.0
Czujnik wilgotności	humiditySensor	≥ 2.1.0
Czujnik temperatury i wilgotności	temperatureAndHumiditySensor	≥ 2.1.0
Detektor wycieku wody	waterLeakDetector	≥ 2.1.0
Detektor dymu	smokeDetector	≥ 2.1.0
Przycisk bezprzewodowy	button	≥ 2.1.0
Kamera	camera	≥ 2.1.0
Ogólny czujnik	sensor	≥ 2.1.0
Ogólny czujnik	sensor	≥ 2.1.0
Wentylator ze światłem	fanLight	≥ 2.1.0
Klimatyzator	airConditioner	≥ 2.1.0
Wentylator	fan	≥ 2.1.0
Termostat	thermostat	≥ 2.1.0

b. Obsługiwane możliwości urządzeń

Przełącznik zasilania (power):

Przykład deklaracji zdolności:

[
  {
    "capability": "power", // Nazwa zdolności
    "permission": "1100",  // ihost nie obsługuje konfiguracji miękkiego startu/stopu, więc brak pola configure
  }
]

Atrybut stanu:

{
  "powerState": "on", // Pole powerState wskazuje stan zasilania włącz/wyłącz. Wymagane. **Typ:** string. "on" oznacza włączone, "off" oznacza wyłączone, "toggle" oznacza przełączenie.
}

Protokół (zapytanie o status i instrukcje sterowania):

Włącz:

{
  "power": {
    "powerState": "on"
  }
}

Wyłącz:

{
  "power": {
    "powerState": "off"
  }
}

Przełączanie kanału (toggle):

Przykład deklaracji zdolności:

Przykład pojedynczego elementu:

[
  {
    "capability": "toggle", // Nazwa zdolności
    "permission": "1100",  // Uprawnienie
    "name": "1", // Nazwa komponentu, **Typ:** String. Opcjonalne wartości: "1" (Kanał 1), "2" (Kanał 2), "3" (Kanał 3), "4" (Kanał 4) lub inne wartości zawierające wielkie i małe litery oraz cyfry
  }
]

Przykład wielu komponentów:

[
  {
    "capability": "toggle",
    "permission": "1100",
    "name": "1"
  },
  {
    "capability": "toggle",
    "permission": "1100",
    "name": "2"
  }
]

Atrybut stanu:

{
  "toggleState": "on", // Pole toggleState wskazuje stan przełącznika {device_id} o nazwie {name}. Wymagane. **Typ:** String. "on" oznacza włączony, "off" oznacza wyłączony, "toggle" oznacza przełączenie.
}

Protokół (zapytanie o status i instrukcje sterowania):

Format przełączania:

{
  [capability]: {
    [toggle-name]: {
      [toggleState]: [value]
    }
  }
}
Komponent 1 włączony, komponent 2 wyłączony:
{
  "toggle": {
    "1": {
      "toggleState": "on"
    },
    "2": {
      "toggleState": "off"
    }
  }
}

Inching kanału (toggle-inching):

Przykład deklaracji zdolności:

[
  {
    "capability": "toggle-inching", // Nazwa zdolności
    "permission": "0010",  // Uprawnienie
    "settings": {
      "toggleInchingSetting": {
        "permission": "11",
        "type": "object",
        "value": {
          "supported": {
            "1": { // Nazwa komponentu
              "enable": true, // Czy funkcja inching jest włączona. **Typ:** Boolean. Wymagane.
              "inchingSwitch": "off", // Ustawienie przełącznika inching. **Typ:** String. Wymagane. "off" (zasilanie wyłączone), "on" (zasilanie włączone)
              "delay": 1000, // Czas opóźnienia inching w milisekundach. **Typ:** Integer. Wymagane.
              "min_delay": 500, // Minimalny czas opóźnienia
              "max_delay": 100000 // Maksymalny czas opóźnienia
            },
            "2": { // Nazwa komponentu
              "enable": true, // Czy funkcja inching jest włączona. **Typ:** Boolean. Wymagane.
              "inchingSwitch": "off", // Ustawienie przełącznika inching. **Typ:** String. Wymagane. "off" (zasilanie wyłączone), "on" (zasilanie włączone)
              "delay": 1000, // Czas opóźnienia inching w milisekundach. **Typ:** Integer. Wymagane.
              "min_delay": 500, // Minimalny czas opóźnienia
              "max_delay": 100000 // Maksymalny czas opóźnienia
            },
            "3": { // Nazwa komponentu
              "enable": true, // Czy funkcja inching jest włączona. **Typ:** Boolean. Wymagane.
              "inchingSwitch": "off", // Ustawienie przełącznika inching. **Typ:** String. Wymagane. "off" (zasilanie wyłączone), "on" (zasilanie włączone)
              "delay": 1000, // Czas opóźnienia inching w milisekundach. **Typ:** Integer. Wymagane.
              "min_delay": 500, // Minimalny czas opóźnienia
              "max_delay": 100000 // Maksymalny czas opóźnienia
            },
            "4": { // Nazwa komponentu
              "enable": true, // Czy funkcja inching jest włączona. **Typ:** Boolean. Wymagane.
              "inchingSwitch": "off", // Ustawienie przełącznika inching. **Typ:** String. Wymagane. "off" (zasilanie wyłączone), "on" (zasilanie włączone)
              "delay": 1000, // Czas opóźnienia inching w milisekundach. **Typ:** Integer. Wymagane.
              "min_delay": 500, // Minimalny czas opóźnienia
              "max_delay": 100000 // Maksymalny czas opóźnienia
            }
          }
        }
      }
    }
  }
]

Atrybut stanu

Brak

Protokół (zapytanie o status i instrukcje sterowania)

Brak

Regulacja jasności (brightness):

Przykład deklaracji zdolności:

{
  "capability": "brightness", // Nazwa zdolności
  "permission": "1100"  // Uprawnienie
}

Atrybut stanu:

{
  "brightness": 100, // Pole brightness wskazuje procent jasności. Wybierz pomiędzy brightness a brightnessDelta. **Typ:** Number. Zakres: 0-100.
}

Protokół (zapytanie o status i instrukcje sterowania):

Ustaw jasność na 80%. (0 = najciemniej, 100 = najjaśniej.)

json
Kopiuj kod
{
  "brightness": {
    "brightness": 80
  }
}

Regulacja temperatury barwowej (color-temperature):

Przykład deklaracji zdolności:

{
  "capability": "color-temperature", // Nazwa zdolności
  "permission": "1100"  // Uprawnienie
}

Atrybut stanu:

{
  "colorTemperature": 100, // Pole colorTemperature wskazuje procent temperatury barwowej. Wybierz pomiędzy colorTemperature a colorTemperatureDelta. **Typ:** Number. Zakres: 0-100. 0 oznacza ciepłe światło, 50 oznacza neutralne, 100 oznacza zimne światło.
}

Protokół (zapytanie o status i instrukcje sterowania):

Dostosuj temperaturę barwową do 50%:

json
 
{
  "color-temperature": {
    "colorTemperature": 50
  }
}

Regulacja koloru (color-rgb):

Przykład deklaracji zdolności:

{
  "capability": "color-rgb", // Nazwa zdolności
  "permission": "1100"  // Uprawnienie
}

Atrybut stanu:

{
  "red": 255, // Pole red reprezentuje składową czerwoną w przestrzeni kolorów RGB. Wymagane. **Typ:** Number. Zakres: 0-255.
  "green": 0, // Pole green reprezentuje składową zieloną w przestrzeni kolorów RGB. Wymagane. **Typ:** Number. Zakres: 0-255.
  "blue": 255 // Pole blue reprezentuje składową niebieską w przestrzeni kolorów RGB. Wymagane. **Typ:** Number. Zakres: 0-255.
}

Protokół (zapytanie o status i instrukcje sterowania):

Ustaw kolor na purpurowy:

{
  "color-rgb": {
    "red": 255,
    "green": 0,
    "blue": 255
  }
}

Regulacja procentowa (percentage):

Przykład deklaracji zdolności:

{
  "capability": "percentage",
  "permission": "1100",
  "settings": { // Opcjonalne
    "percentageRange": {
      "permission": "01",
      "type": "numeric",
      "min": 0,
      "max": 100,
      "step": 5
    }
  }
}

Atrybut stanu:

{
  "percentage": 100, // Pole percentage wskazuje wartość procentową. Wybierz pomiędzy percentage a percentageDelta. **Typ:** Number. Zakres: 0-100.
}

Protokół (zapytanie o status i instrukcje sterowania):

Dostosuj do 40%:

{
  "percentage": {
    "percentage": 40
  }
}

Sterowanie silnikiem (motor-control):

Przykład deklaracji zdolności:

{
  "capability": "motor-control",
  "permission": "1100"
}

Atrybut stanu:

json
 
{
  "motorControl": "stop", // Pole motorControl wskazuje stan silnika. Wymagane. **Typ:** String. Możliwe wartości: "open" (otwórz), "close" (zamknij), "stop" (stop), "lock" (zablokuj).
}

Protokół (zapytanie o status i instrukcje sterowania):

Otwórz silnik:

{
  "motor-control": {
    "motorControl": "open"
  }
}

Odwrócenie kierunku silnika (motor-reverse):

Przykład deklaracji zdolności:

{
  "capability": "motor-reverse",
  "permission": "1100"
}

Atrybut stanu:

{
  "motorReverse": true, // Pole motorReverse wskazuje ustawienie kierunku silnika. Wymagane. **Typ:** Boolean. true oznacza do przodu, false oznacza wstecz.
}

Protokół (zapytanie o status i instrukcje sterowania):

Ustaw silnik na pracę do przodu:

{
  "motor-reverse": {
    "motorReverse": true
  }
}

Kalibracja silnika (motor-clb)

Przykład deklaracji zdolności:

{
  "capability": "motor-clb",
  "permission": "0100"
}

Atrybuty (stan):

{
  "motorClb": "calibration" // Pole motorClb wskazuje status kalibracji silnika. Wymagane. **Typ:** String. "normal" oznacza tryb normalny (skalibrowany), "calibration" oznacza trwającą kalibrację.
}

Protokół (raportowanie statusu):

Zgłoś, że silnik jest kalibrowany:

{
  "motor-clb": {
    "motorClb": "calibration"
  }
}

Stan włączenia zasilania (startup)

Przykład deklaracji zdolności:

{
  "capability": "startup",
  "permission": "1100"
}

Atrybuty (stan):

{
  "startup": "on" // Stan zasilania przy starcie. **Typ:** String. Wymagane. Opcjonalne wartości: "on" (włączony), "stay" (pozostań w stanie zasilania), "off" (wyłączony), "toggle" (odwróć stan zasilania).
}

Protokół (zapytanie o status i instrukcje sterowania):

Ustaw stan zasilania na zawsze włączony:

{
  "startup": {
    "startup": "on"
  }
}

---

Aktywacja budzenia (identify)

Przykład deklaracji zdolności:

{
  "capability": "identify",
  "permission": "0100"
}

Atrybuty (stan):

{
  "identify": true // Wskazuje, czy urządzenie aktywnie raportuje wyniki rozpoznawania lub jest aktywowane.
}

Protokół (raportowanie statusu i instrukcje sterowania):

Ustaw czas aktywacji budzenia:

{
  "identify": {
    "countdown": 180 // Pole countdown wskazuje czas odliczania. Wymagane. **Typ:** Number. Jednostka: sekundy.
  }
}

Zgłoś status aktywacji:

{
  "identify": {
    "identify": true // Wskazuje, czy urządzenie aktywnie raportuje wyniki rozpoznawania lub jest aktywowane.
  }
}

Przełącznik statystyk zużycia energii w czasie rzeczywistym (power-consumption)

Przykład deklaracji zdolności:

{
  "capability": "power-consumption",
  "permission": "1101",
  "settings": {
    "resolution": {
      "permission": "01",
      "type": "numeric",
      "value": 3600
    },
    "timeZoneOffset": {
      "permission": "01",
      "type": "numeric",
      "min": -12,
      "max": 14,
      "value": 0
    }
  }
}

Atrybuty (stan):

Rozpocznij/Zatrzymaj statystyki w czasie rzeczywistym:

{
  "rlSummarize": true, // Rozpocznij/zatrzymaj statystyki czasu rzeczywistego. **Typ:** Boolean. Wymagane.
  "timeRange": { // Zakres czasu do podsumowania. Wymagane.
    "start": "2020-07-05T08:00:00Z", // Czas początkowy statystyk zużycia energii. **Typ:** String. Wymagane.
    "end": "2020-07-05T09:00:00Z" // Czas końcowy statystyk zużycia energii. **Typ:** String. Wymagane.
  }
}

Zapytaj o zużycie energii w przedziale czasowym:

{
  "type": "summarize", // Typ statystyk. **Typ:** String. Wymagane. Opcjonalne wartości: "rlSummarize" (podsumowanie w czasie rzeczywistym), "summarize" (podsumowanie bieżące).
  "timeRange": { // Zakres czasu do podsumowania. Wymagane, jeśli type = "summarize".
    "start": "2020-07-05T08:00:00Z", // Czas początkowy statystyk zużycia energii. **Typ:** String. Wymagane.
    "end": "2020-07-05T09:00:00Z" // Czas końcowy statystyk zużycia energii. **Typ:** String. Opcjonalne. Jeśli pominięte, oznacza czas bieżący.
  }
}

Odpowiedz wynikiem statystyk w zadanym przedziale czasowym:

json
 
{
  "type": "summarize", // Typ statystyk. **Typ:** String. Wymagane. Opcjonalne wartości: "rlSummarize" (podsumowanie w czasie rzeczywistym), "summarize" (podsumowanie bieżące).
  "rlSummarize": 50.0, // Całkowite zużycie energii. **Typ:** Number. Jednostka: 0.01 kWh. Opcjonalne.
  "electricityIntervals": [ // Wiele rekordów statystyk podzielonych zgodnie z configuration.resolution. Opcjonalne. Nie występuje, gdy type = "rlSummarize".
    {
      "usage": 26.5, // Zużycie energii. **Typ:** Number. Jednostka: 0.01 kWh. Wymagane.
      "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia. **Typ:** Date. Wymagane.
      "end": "2020-07-05T09:00:00Z" // Czas zakończenia. **Typ:** Date. Wymagane. Jeśli odstęp między end a start jest mniejszy niż resolution, wszystkie zgłoszone rekordy są uznawane za nieprawidłowe.
    },
    {
      "usage": 26.5, // Zużycie energii. **Typ:** Number. Jednostka: 0.01 kWh. Wymagane.
      "start": "2020-07-05T09:00:00Z", // Czas rozpoczęcia. **Typ:** Date. Wymagane.
      "end": "2020-07-05T10:00:00Z" // Czas zakończenia. **Typ:** Date. Wymagane. Jeśli odstęp między end a start jest mniejszy niż resolution, wszystkie zgłoszone rekordy są uznawane za nieprawidłowe.
    }
  ]
}

Protokół (raportowanie statusu i instrukcje sterowania):

Rozpocznij statystyki czasu rzeczywistego:

json
 
{
  "power-consumption": {
    "powerConsumption": {
      "rlSummarize": true,
      "timeRange": {
        "start": "2020-07-05T08:00:00Z",
        "end": ""
      }
    }
  }
}

Zatrzymaj statystyki czasu rzeczywistego:

json
 
{
  "power-consumption": {
    "powerConsumption": {
      "rlSummarize": false,
      "timeRange": {
        "start": "2020-07-05T08:00:00Z",
        "end": "2020-07-05T09:00:00Z"
      }
    }
  }
}

Pobierz historyczne zużycie energii:

json
 
{
  "power-consumption": {
    "type": "summarize",
    "timeRange": {
      "start": "2020-07-05T08:00:00Z",
      "end": "2020-07-05T09:00:00Z"
    }
  }
}

Pobierz zużycie energii w czasie rzeczywistym:

json
 
{
  "power-consumption": {
    "powerConsumption": {
      "type": "rlSummarize"
    }
  }
}

Wykrywanie trybu temperatury i wilgotności (thermostat-mode-detect)

Przykład deklaracji zdolności:

{
  "capability": "thermostat-mode-detect",
  "permission": "0110",
  "name": "temperature", // Typ wykrywania kontroli temperatury. **Typ:** String. Wymagane. Opcjonalne wartości: "humidity" (wykrywanie wilgotności), "temperature" (wykrywanie temperatury).
  "settings": {
    "setpointRange": {
      "permission": "11",
      "type": "object",
      "value": {
        "supported": [ // Obsługiwane ustawienia wykrywania. Wymagane.
          {
            "name": "lowerSetpoint", // Wartość wykrywania powinna być powyżej tego punktu nastawy. Wymagane jest co najmniej jedno z lowerSetpoint lub upperSetpoint.
            "value": { // Zakres wykrywania. Opcjonalne. Określ, jeśli istnieją warunki wstępne.
              "value": 68.0, // Wartość temperatury. **Typ:** Number. Wymagane.
              "scale": "f" // Jednostka temperatury. Wymagane gdy name=temperature. Opcjonalne wartości: "c" (Celsjusz), "f" (Fahrenheit).
            }
          },
          {
            "name": "upperSetpoint", // Wartość wykrywania powinna być poniżej tego punktu nastawy. Wymagane jest co najmniej jedno z lowerSetpoint lub upperSetpoint.
            "value": { // Zakres wykrywania. Opcjonalne. Określ, jeśli istnieją warunki wstępne.
              "value": 68.0, // Wartość temperatury. **Typ:** Number. Wymagane.
              "scale": "f" // Jednostka temperatury. Wymagane gdy name=temperature. Opcjonalne wartości: "c" (Celsjusz), "f" (Fahrenheit).
            }
          }
        ]
      }
    },
    "supportedModes": {
      "type": "enum",
      "permission": "01",
      "values": [
        "COMFORT",
        "COLD",
        "HOT"
      ]
    }
  }
}

{
  "capability": "thermostat-mode-detect",
  "permission": "0110",
  "name": "humidity", // Typ wykrywania kontroli temperatury. **Typ:** String. Wymagane. Opcjonalne wartości: "humidity" (wykrywanie wilgotności), "temperature" (wykrywanie temperatury).
  "settings": {
    "setpointRange": {
      "permission": "11",
      "type": "object",
      "value": {
        "supported": [ // Obsługiwane ustawienia wykrywania. Wymagane.
          {
            "name": "lowerSetpoint", // Wartość wykrywania powinna być powyżej tego punktu nastawy. Wymagane jest co najmniej jedno z lowerSetpoint lub upperSetpoint.
            "value": { // Zakres wykrywania. Opcjonalne. Określ, jeśli istnieją warunki wstępne.
              "value": 68.0, // Wartość wilgotności. **Typ:** Number. Wymagane
            }
          },
          {
            "name": "upperSetpoint", // Wartość wykrywania powinna być poniżej tego punktu nastawy. Wymagane jest co najmniej jedno z lowerSetpoint lub upperSetpoint.
            "value": { // Zakres wykrywania. Opcjonalne. Określ, jeśli istnieją warunki wstępne.
              "value": 68.0, // Wartość wilgotności. **Typ:** Number. Wymagane
            }
          }
        ]
      }
    },
    "supportedModes": {
      "type": "enum",
      "permission": "01",
      "values": [
        "COMFORT",
        "COLD",
        "HOT"
      ]
    }
  }
}

Atrybuty (stan):

{
  "mode": "COMFORT" // ID trybu. Opcjonalne. Obsługiwane wartości: "COMFORT" (Tryb komfortu), "COLD" (Tryb chłodny), "HOT" (Tryb gorący), "DRY" (Tryb suchy), "WET" (Tryb wilgotny).
}

Protokół (zapytanie o status i instrukcje sterowania):

Format:

{
    [capability] :{
        [nazwa trybu] :{
            "mode": [value]
        }
    }
}

Przykład:

{
  "thermostat-mode-detect": {
    "humidity": {
      "mode": "COMFORT"
    }
  }
}

Tryb termostatu (thermostat-mode)

Przykład deklaracji zdolności:

{
  "capability": "thermostat",
  "permission": "1100",
  "name": "thermostat-mode",
  "settings": {
    "supportedModes": {
      "type": "enum",
      "permission": "01",
      "values": [
        "MANUAL",
        "AUTO",
        "ECO"
      ]
    }
  }
}

Atrybuty (stan):

{
  "thermostatMode": "MANUAL" // Tryb pracy termostatu. **Typ:** String. Opcjonalne wartości: "MANUAL", "AUTO", "ECO".
}

Protokół (zapytanie o status i instrukcje sterowania):

{
   "thermostat": {
    "thermostat-mode": {
      "thermostatMode": "MANUAL"
    }
  }
}

Status adaptacyjnego odzyskiwania termostatu (thermostat/adaptive-recovery-status)

Przykład deklaracji zdolności:

{
  "capability": "thermostat",
  "permission": "0100",
  "name": "adaptive-recovery-status" // Status adaptacyjnego odzyskiwania termostatu
}

Atrybuty (stan):

{
  "adaptiveRecoveryStatus": "HEATING" // Status adaptacyjnego odzyskiwania termostatu. **Typ:** String. Opcjonalne wartości: "HEATING", "INACTIVE".
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "thermostat": {
    "adaptive-recovery-status": {
      "adaptiveRecoveryStatus": "HEATING"
    }
  }
}

Ustawienie docelowej temperatury trybu termostatu (thermostat-target-setpoint)

Przykład deklaracji zdolności:

[[
  {
    "capability": "thermostat-target-setpoint",
    "name": "manual-mode",
    "permission": "1110",
    "settings": {
      "temperatureUnit":{
        "type": "enum",
        "permission": "11",
        "value": "c",
        "values": [
          "c",
          "f"
        ]
      },
      "temperatureRange":{
        "type": "numeric",
        "permission": "01",
        "min": 4,
        "max": 35,
        "step": 0.5
      }
    }
  },
  {
    "capability": "thermostat-target-setpoint",
    "name": "eco-mode",
    "permission": "1110",
    "settings": {
      "temperatureUnit":{
        "type": "enum",
        "permission": "11",
        "value": "c",
        "values": [
          "c",
          "f"
        ]
      },
      "temperatureRange":{
        "type": "numeric",
        "permission": "01",
        "min": 4,
        "max": 35,
        "step": 0.5
      }
    }
  },
  {
    "capability": "thermostat-target-setpoint",
    "name": "auto-mode",
    "permission": "0110",
    "settings": {
      "temperatureUnit":{
        "type": "enum",
        "permission": "11",
        "value": "c",
        "values": [
          "c",
          "f"
        ]
      },
      "temperatureRange":{
        "type": "numeric",
        "permission": "01",
        "min": 4,
        "max": 35,
        "step": 0.5
      },
      "weeklySchedule":{
        "type": "object",
        "permission": "11",
        "value": {
          "maxEntryPerDay": 2,
          "Monday": [
          {
            "startTimeInMinutes": 440, // Czas rozpoczęcia w minutach. **Typ:** int. Np. 7:20 = 440 minut.
            "upperSetpoint": 36.5, // Maksymalna docelowa temperatura. **Typ:** number.
            "lowerSetpoint": 20 // Minimalna docelowa temperatura. **Typ:** number.
          },
          {
            "startTimeInMinutes": 900, // Czas rozpoczęcia w minutach. Np. 15:00 = 900 minut.
            "upperSetpoint": 26.5, // Maksymalna docelowa temperatura. **Typ:** number.
            "lowerSetpoint": 21 // Minimalna docelowa temperatura. **Typ:** number.
          }
        ],
          "Tuesday": [...
          ],
          "Wednesday": [...
          ],
          "Thursday": [...
          ],
          "Friday": [...
          ],
          "Saturday": [...
          ],
          "Sunday": [...
          ],
        }
      }
    }
  }
]

Atrybuty (stan):

{
  "targetSetpoint": 30 // Docelowa temperatura dla określonego trybu. **Typ:** number, w jednostce określonej przez temperatureUnit.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "thermostat-target-setpoint": {
    "manual-mode": {
        "targetSetpoint": 30 
    },
    "auto-mode": {
        "targetSetpoint": 30 
    }
  }
}

Wykrywanie czujników (detect)

Przykład deklaracji zdolności:

{
  "capability": "detect",
  "permission": "0110",
  "settings": { // Opcjonalne
    "detectInterval": {
      "permission": "11",
      "type": "numeric",
      "value": 300
    },
    "detectSensitivity": {
      "permission": "11",
      "type": "numeric",
      "value": 1000
    }
  }
}

Atrybuty (stan):

{
  "detected": true // Wynik wykrywania. **Typ:** Boolean. `true` oznacza wykrycie, `false` brak wykrycia.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
    "detect": {
        "detected": true
    }
}

Wykrywanie temperatury (temperature)

Przykład deklaracji zdolności:

{
  "capability": "temperature",
  "permission": "0110",
  "settings": { // Opcjonalne
    "temperatureCalibration": { // Opcjonalna kalibracja temperatury
      "type": "numeric",
      "permission": "11",
      "min": -7, // Wartość minimalna
      "max": 7, // Wartość maksymalna
      "step": 0.2, // Krok regulacji temperatury, jednostka taka sama jak temperatureUnit
      "value": 5.2 // Obecna wartość kalibracji temperatury. **Typ:** number.
    },
    "temperatureUnit": { // Opcjonalna jednostka temperatury
      "type": "enum",
      "permission": "11",
      "value": "c",
      "values": [
        "c",
        "f"
      ]
    },
    "temperatureRange": { // Opcjonalny zakres wykrywania temperatury
      "type": "numeric",
      "permission": "01",
      "min": -40,
      "max": 80
    }
  }
}

Atrybuty (stan):

json
Kopiuj kod
{
  "temperature": 26.5 // Bieżąca temperatura. **Typ:** Number, w stopniach Celsjusza.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "temperature": {
    "temperature": 20
  }
}

Wykrywanie wilgotności (humidity)

Przykład deklaracji zdolności:

{
  "capability": "humidity",
  "permission": "0100",
  "settings": { // Opcjonalny zakres wykrywania wilgotności.
    "humidityRange": {
      "type": "numeric",
      "permission": "01",
      "min": 0,
      "max": 100
    }
  }
}

Atrybuty (stan):

{
  "humidity": 50 // Bieżąca względna wilgotność (procent). **Typ:** Number, zakres 0-100.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
    "humidity": {
        "humidity": 20
    }
}

Wykrywanie stanu baterii (battery)

Przykład deklaracji zdolności:

{
  "capability": "battery",
  "permission": "0100"
}

Atrybuty (stan):

{
  "battery": 95 // Pozostały procent baterii. **Typ:** Number, zakres -1 do 100. Uwaga: -1 oznacza nieznany poziom baterii.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "battery": {
    "battery": 40
  }
}

Wykrywanie pojedynczego przycisku (press)

Przykład deklaracji zdolności:

{
  "capability": "press",
  "permission": "1100",
  "settings": { // Opcjonalne
    "actions": { // Akcje przycisku, opcjonalne.
      "type": "enum",
      "permission": "01",
      "values": [ // Opcjonalne akcje przycisku. Domyślne wartości to "singlePress", "doublePress", "longPress". Skonfigurowane akcje zastępują domyślne.
      ]
    }
  }
}

Atrybuty (stan):

{
  "press": "singlePress" // Typ naciśnięcia przycisku. **Typ:** String. Standardowe wartości: "singlePress" (pojedyncze lub krótkie wciśnięcie), "doublePress" (podwójne wciśnięcie), "longPress" (długie wciśnięcie).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "press": {
    "press": "singlePress"
  }
}

Wykrywanie wielokrotnego naciśnięcia (multi-press)

Przykład deklaracji zdolności:

{
  "capability": "multi-press",
  "permission": "0100",
  "name": "1", // Nazwa atrybutu multi-press. **Typ:** String. Dozwolone tylko znaki alfanumeryczne.
  "settings": { // Opcjonalne
    "actions": { // Akcje przycisku, opcjonalne.
      "type": "enum",
      "permission": "01",
      "values": [ // Opcjonalne akcje przycisku. Domyślne wartości to "singlePress", "doublePress", "longPress". Skonfigurowane akcje zastępują domyślne.
      ]
    }
  }
}

Atrybuty (stan):

{
  "press": "singlePress" // Typ naciśnięcia przycisku. **Typ:** String. Standardowe wartości: "singlePress" (pojedyncze lub krótkie wciśnięcie), "doublePress" (podwójne wciśnięcie), "longPress" (długie wciśnięcie).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
    [capability] :{
        [multi-press-name]：{
            press:[value]
        }
    }
}

przykład:
{
  "multi-press": {
    "1": {
      "press": "singlePress"
    },
    "2": {
      "press": "doublePress"
    }
  }
}

Wykrywanie siły sygnału (rssi)

Przykład deklaracji zdolności:

{
  "capability": "rssi",
  "permission": "0100"
}

Atrybuty (stan):

{
  "rssi": -65 // Siła sygnału bezprzewodowego (Received Signal Strength Indicator). **Typ:** Number, jednostka dBm, wartości całkowite ujemne.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "rssi": {
    "rssi": -65
  }
}

Wykrywanie manipulacji (tamper-alert)

Przykład deklaracji zdolności:

{
  "capability": "tamper-alert",
  "permission": "0100"
}

Atrybuty (stan):

{
  "tamper": "clear" // Status manipulacji. **Typ:** String. Możliwe wartości: "clear" (brak manipulacji), "detected" (wykryto manipulację).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "tamper-alert": {
    "tamper": "clear" // Status manipulacji. **Typ:** String. Możliwe wartości: "clear" (brak manipulacji), "detected" (wykryto manipulację).
  }
}

Wykrywanie poziomu oświetlenia (illumination-level)

Przykład deklaracji zdolności:

{
  "capability": "illumination-level",
  "permission": "0100"
}

Atrybuty (stan):

{
  "level": "brighter" // Poziom jasności. **Typ:** String. Możliwe wartości: "brighter" (jaśniej), "darker" (ciemniej).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "illumination-level": {
    "level": "brighter"
  }
}

Wykrywanie napięcia (voltage)

Przykład deklaracji zdolności:

{
  "capability": "voltage",
  "permission": "0100"
}

Atrybuty (stan):

{
  "voltage": 50 // Aktualna wartość napięcia, w jednostkach 0.01V. **Typ:** Number, wartości nieujemne.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "voltage": {
    "voltage": 50
  }
}

Wykrywanie prądu elektrycznego (electric-current)

Przykład deklaracji zdolności:

{
  "capability": "electric-current",
  "permission": "0100"
}

Atrybuty (stan):

{
  "electric-current": 50 // Aktualna wartość prądu, w jednostkach 0.01A. **Typ:** Number, wartości całkowite nieujemne.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "electric-current": {
    "electric-current": 50
  }
}

Wykrywanie mocy elektrycznej (electric-power)

Przykład deklaracji zdolności:

{
  "capability": "electric-power",
  "permission": "0100"
}

Atrybuty (stan):

{
  "electric-power": 50 // Aktualna wartość mocy, w jednostkach 0.01W. **Typ:** Number, wartości całkowite nieujemne.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "electric-power": {
    "electric-power": 50
  }
}

Wykrywanie błędów (fault)

Przykład deklaracji zdolności:

{
  "capability": "fault",
  "permission": "0100"
}

Atrybuty (stan):

{
  "fault": "none" // Status błędu. **Typ:** String. Możliwe wartości: "none" (brak błędu), "detected" (wykryto błąd).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "fault": {
    "fault": "none"
  }
}

Przełącznik progowy (threshold-breaker)

Przykład deklaracji zdolności:

{
  "capability": "threshold-breaker",
  "permission": "0010",
  "settings": {
    "supportedSetting": {
      "type": "object",
      "permission": "11",
      "value": {
        "supported": [
          {
            "name": "lowerPower", // Przełącznik progowy niskiej mocy
            "value": {
              "value": 50, // Wartość wykrywania mocy, w jednostkach 0.01W. **Typ:** Integer. Zakres: >=0.
              "min_range": 10, // Minimalna wartość wykrywania mocy, w jednostkach 0.01W. **Typ:** Integer. Zakres: >=0.
              "max_range": 3500 // Maksymalna wartość wykrywania mocy, w jednostkach 0.01W. **Typ:** Integer. Zakres: >=0.
            }
          },
          {
            "name": "upperPower", // Przełącznik progowy wysokiej mocy
            "value": {
              "value": 50, // Wartość wykrywania mocy, w jednostkach 0.01W. **Typ:** Integer. Zakres: >=0.
              "min_range": 10, // Minimalna wartość wykrywania mocy, w jednostkach 0.01W. **Typ:** Integer. Zakres: >=0.
              "max_range": 3500 // Maksymalna wartość wykrywania mocy, w jednostkach 0.01W. **Typ:** Integer. Zakres: >=0.
            }
          },
          {
            "name": "lowerElectricCurrent", // Przełącznik progowy niskiego prądu
            "value": {
              "value": 50, // Wartość wykrywania prądu, w jednostkach 0.01A. **Typ:** Integer. Zakres: >=0.
              "min_range": 10, // Minimalna wartość wykrywania prądu, w jednostkach 0.01A. **Typ:** Integer. Zakres: >=0.
              "max_range": 1500 // Maksymalna wartość wykrywania prądu, w jednostkach 0.01A. **Typ:** Integer. Zakres: >=0.
            }
          },
          {
            "name": "upperElectricCurrent", // Przełącznik progowy wysokiego prądu
            "value": {
              "value": 50, // Wartość wykrywania prądu, w jednostkach 0.01A. **Typ:** Integer. Zakres: >=0.
              "min_range": 10, // Minimalna wartość wykrywania prądu, w jednostkach 0.01A. **Typ:** Integer. Zakres: >=0.
              "max_range": 1500 // Maksymalna wartość wykrywania prądu, w jednostkach 0.01A. **Typ:** Integer. Zakres: >=0.
            }
          },
          {
            "name": "lowerVoltage", // Przełącznik progowy niskiego napięcia
            "value": {
              "value": 50, // Wartość wykrywania napięcia, w jednostkach 0.01V. **Typ:** Integer. Zakres: >=0.
              "min_range": 10, // Minimalna wartość wykrywania napięcia, w jednostkach 0.01V. **Typ:** Integer. Zakres: >=0.
              "max_range": 24000 // Maksymalna wartość wykrywania napięcia, w jednostkach 0.01V. **Typ:** Integer. Zakres: >=0.
            }
          },
          {
            "name": "upperVoltage", // Przełącznik progowy wysokiego napięcia
            "value": {
              "value": 50, // Wartość wykrywania napięcia, w jednostkach 0.01V. **Typ:** Integer. Zakres: >=0.
              "min_range": 10, // Minimalna wartość wykrywania napięcia, w jednostkach 0.01V. **Typ:** Integer. Zakres: >=0.
              "max_range": 24000 // Maksymalna wartość wykrywania napięcia, w jednostkach 0.01V. **Typ:** Integer. Zakres: >=0.
            }
          }
        ]
      }
    }
  }
}

Atrybuty (stan)

• Brak

Protokół (zapytanie o status i instrukcje sterowania)

• Brak

Funkcja inch (inching)

Przykład deklaracji zdolności:

{
  "capability": "inching",
  "permission": "0010",
  "settings": {
    "inchingEnable": { // Ustawienie włączenia funkcji inch
      "permission": "11",
      "type": "boolean",
      "value": false
    },
    "inchingSwitch": { // Ustawienie akcji inch
      "type": "enum",
      "permission": "11",
      "value": "on",
      "values": ["on", "off"]
    },
    "inchingDelay": { // Ustawienie czasu inch
      "type": "numeric",
      "permission": "11",
      "min": 500,
      "max": 100000,
      "value": 1000,
      "unit": "ms"
    }
  }
}

Atrybuty (stan):

• Brak

Protokół (zapytanie o status i instrukcje sterowania):

• Brak

Strumień kamery (camera-stream)

Przykład deklaracji zdolności:

{
  "capability": "camera-stream",
  "permission": "0010",
  "settings": {
    "streamSetting": {
      "type": "object",
      "permission": "11",
      "value": {
        "username": "String", // Konto dostępu. **Typ:** String. Wymagane.
        "password": "String", // Hasło dostępu. **Typ:** String. Wymagane.
        "streamUrl": "rtsp://<username>:<password>@<hostname>:<port>/streaming/channel01", // URL strumienia. **Typ:** String. Wymagane.
        "videoCodec": "", // Kodek wideo. **Typ:** String. Wymagane. Parametry opcjonalne do zdefiniowania.
        "resolution": { // Rozdzielczość wideo. Wymagane.
          "width": 1080, // Szerokość. **Typ:** Number. Wymagane.
          "height": 720 // Wysokość. **Typ:** Number. Wymagane.
        },
        "keyFrameInterval": 5, // Interwał klatki kluczowej. **Typ:** String. Wymagane.
        "audioCodec": "G711", // Kodek audio. **Typ:** String. Wymagane. Parametry opcjonalne do zdefiniowania.
        "samplingRate": 50, // Częstotliwość próbkowania audio, w Hz. **Typ:** Number. Wymagane. Parametry opcjonalne do zdefiniowania.
        "dataRate": 50 // Przepływność. **Typ:** Number. Wymagane. Jednostka: kb/s.
      }
    }
  }
}

Atrybuty (stan):

• Brak

Protokół (zapytanie o status i instrukcje sterowania):

• Brak

Sterowanie trybem (mode)

Przykład deklaracji zdolności:

[
  {
    "capability": "mode",
    "name": "fanLevel",
    "permission": "1100",
    "settings": {
      "supportedValues": {
        "type": "enum",
        "permission": "01",
        "values": ["low", "medium", "high"] // Własne wartości trybów. Skonfigurowane wartości zastępują domyślne.
      }
    }
  },
  {
    "capability": "mode",
    "name": "thermostatMode",
    "permission": "1100",
    "settings": {
      "supportedValues": {
        "type": "enum",
        "permission": "01",
        "values": ["auto", "manual"] // Własne wartości trybów. Skonfigurowane wartości zastępują domyślne.
      }
    }
  },
  {
    "capability": "mode",
    "name": "airConditionerMode",
    "permission": "1100",
    "settings": {
      "supportedValues": {
        "type": "enum",
        "permission": "01",
        "values": ["cool", "heat", "auto", "fan", "dry"] // Własne wartości trybów. Skonfigurowane wartości zastępują domyślne.
      }
    }
  },
  {
    "capability": "mode",
    "name": "fanMode",
    "permission": "1100",
    "settings": {
      "supportedValues": {
        "type": "enum",
        "permission": "01",
        "values": ["normal", "sleep", "child"] // Własne wartości trybów. Skonfigurowane wartości zastępują domyślne.
      }
    }
  },
  {
    "capability": "mode",
    "name": "horizontalAngle",
    "permission": "1100",
    "settings": {
      "supportedValues": {
        "type": "enum",
        "permission": "01",
        "values": ["30", "60", "90", "120", "180", "360"] // Własne wartości trybów. Skonfigurowane wartości zastępują domyślne.
      }
    }
  },
  {
    "capability": "mode",
    "name": "verticalAngle",
    "permission": "1100",
    "settings": {
      "supportedValues": {
        "type": "enum",
        "permission": "01",
        "values": ["30", "60", "90", "120", "180", "360"] // Własne wartości trybów. Skonfigurowane wartości zastępują domyślne.
      }
    }
  }
]

Atrybuty (stan):

{
  "modeValue": "low" // Wartość trybu. **Typ:** String. Wymagane. Odnieś się do obsługiwanych ustawień wstępnych trybów.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "mode": {
    "fanLevel": {
      "modeValue": "low"
    }
  }
}

Wykrywanie dwutlenku węgla (co2)

Przykład deklaracji zdolności:

{
  "capability": "co2",
  "permission": "0100",
  "settings": {
    "co2Range": {
      "type": "numeric",
      "permission": "01",
      "min": 400,
      "max": 10000
    }
  }
}

Atrybuty (stan):

{
  "co2": 111 // Stężenie dwutlenku węgla. **Typ:** Integer. Jednostka: ppm.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "co2": {
    "co2": 500
  }
}

Wykrywanie oświetlenia (illumination)

Przykład deklaracji zdolności:

{
  "capability": "illumination",
  "permission": "0100",
  "settings": {
    "illuminationRange": {
      "type": "numeric",
      "permission": "01",
      "min": 0,
      "max": 160000
    }
  }
}

Atrybuty (stan):

{
  "illumination": 11 // Poziom oświetlenia. **Typ:** Integer. Jednostka: luks (lux).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "illumination": {
    "illumination": 50
  }
}

Wykrywanie dymu (smoke)

Przykład deklaracji zdolności:

{
  "capability": "smoke",
  "permission": "0100"
}

Atrybuty (stan):

{
  "smoke": true // Wynik wykrywania. **Typ:** Boolean. `true` oznacza wykrycie, `false` brak wykrycia.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "smoke": {
    "smoke": true
  }
}

Wykrywanie otwarcia/zamknięcia magnetycznego drzwi (contact)

Przykład deklaracji zdolności:

{
  "capability": "contact",
  "permission": "0100"
}

Atrybuty (stan):

{
  "contact": true // Wynik wykrywania. **Typ:** Boolean. `true` oznacza wykrycie, `false` oznacza brak wykrycia.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "contact": {
    "contact": true
  }
}

Wykrywanie ruchu (motion)

Przykład deklaracji zdolności:

{
  "capability": "motion",
  "permission": "0110",
  "settings": {
    "motionInterval": {
      "type": "numeric",
      "permission": "11",
      "value": 300
    },
    "motionSensitivity": {
      "type": "numeric",
      "permission": "11",
      "value": 1000
    }
  }
}

Atrybuty (stan):

{
  "motion": true // Wynik wykrywania. **Typ:** Boolean. `true` oznacza wykrycie, `false` oznacza brak wykrycia.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "motion": {
    "motion": true
  }
}

Wykrywanie wycieku wody (water-leak)

Przykład deklaracji zdolności:

{
  "capability": "water-leak",
  "permission": "0100"
}

Atrybuty (stan):

{
  "waterLeak": true // Pole `waterLeak` wskazuje aktualny wynik wykrywania. **Typ:** Boolean. `true` oznacza wykrycie, `false` oznacza brak wykrycia.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "water-leak": {
    "waterLeak": true
  }
}

Przełącznik wykrywania okna (window-detection)

Przykład deklaracji zdolności:

{
  "capability": "window-detection",
  "permission": "1100"
}

Atrybuty (stan):

{
  "powerState": "on" // Pole `powerState` wskazuje stan zasilania. **Typ:** String. `on` oznacza włączone zasilanie, `off` oznacza wyłączone zasilanie.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "window-detection": {
    "powerState": "on"
  }
}

Blokada dziecięca (child-lock)

Przykład deklaracji zdolności:

{
  "capability": "child-lock",
  "permission": "1100"
}

Atrybuty (stan):

{
  "powerState": "on" // Pole `powerState` wskazuje stan zasilania. **Typ:** String. `on` oznacza włączone zasilanie, `off` oznacza wyłączone zasilanie.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "child-lock": {
    "powerState": "on"
  }
}

Przełącznik przeciwdziałający bezpośredniemu nadmuchowi (anti-direct-blow)

Przykład deklaracji zdolności:

{
  "capability": "anti-direct-blow",
  "permission": "1100"
}

Atrybuty (stan):

{
  "powerState": "on" // Pole `powerState` wskazuje stan zasilania. **Typ:** String. `on` oznacza włączone zasilanie, `off` oznacza wyłączone zasilanie.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "anti-direct-blow": {
    "powerState": "on"
  }
}

Poziome wychylenie (horizontal-swing)

Przykład deklaracji zdolności:

{
  "capability": "horizontal-swing",
  "permission": "1100"
}

Atrybuty (stan):

{
  "powerState": "on" // Pole `powerState` wskazuje stan zasilania. **Typ:** String. `on` oznacza włączone zasilanie, `off` oznacza wyłączone zasilanie.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "horizontal-swing": {
    "powerState": "on"
  }
}

Pionowe wychylenie (vertical-swing)

Przykład deklaracji zdolności:

{
  "capability": "vertical-swing",
  "permission": "1100"
}

Atrybuty (stan):

{
  "powerState": "on" // Pole `powerState` wskazuje stan zasilania. **Typ:** String. `on` oznacza włączone zasilanie, `off` oznacza wyłączone zasilanie.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "vertical-swing": {
    "powerState": "on"
  }
}

Tryb ECO (eco)

Przykład deklaracji zdolności:

{
  "capability": "eco",
  "permission": "1100"
}

Atrybuty (stan):

{
  "powerState": "on" // Pole `powerState` wskazuje stan zasilania. **Typ:** String. `on` oznacza włączone zasilanie, `off` oznacza wyłączone zasilanie.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "eco": {
    "powerState": "on"
  }
}

Przełącznik stanu uruchamiania (toggle-startup)

Przykład deklaracji zdolności:

{
  "capability": "toggle-startup",
  "permission": "1100",
  "name": "1" // Pole `name` określa nazwę atrybutu dla `toggle-startup`. **Typ:** String. Dozwolone tylko litery i cyfry.
}

Atrybuty (stan):

{
  "startup": "on" // **Typ:** String. Opcje: `on` (włączenie zasilania), `stay` (utrzymanie zasilania), `off` (wyłączenie zasilania).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "toggle-startup": {
    "1": {
      "startup": "on"
    },
    "2": {
      "startup": "off"
    }
  }
}

Wykrywanie zatrzymania (detect-hold)

Przykład deklaracji zdolności:

{
  "capability": "detect-hold",
  "permission": "0100",
  "settings": {
    "detectHoldEnable": { // Ustawienie włączenia wykrywania zatrzymania
      "permission": "01",
      "type": "boolean",
      "value": false
    },
    "detectHoldSwitch": { // Ustawienie działania wykrywania zatrzymania
      "type": "enum",
      "permission": "01",
      "value": "on",
      "values": ["on", "off"]
    },
    "detectHoldTime": { // Ustawienie czasu wykrywania zatrzymania
      "type": "numeric",
      "permission": "01",
      "min": 1,
      "max": 359,
      "value": 5,
      "unit": "minute"
    }
  }
}

Atrybuty (stan):

{
  "detectHold": "on" // Pole `detectHold` wskazuje stan zatrzymania wykrywania. **Typ:** String. `on` oznacza aktywne zatrzymanie wykrywania, `off` oznacza nieaktywne.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "detect-hold": {
    "detectHold": "on"
  }
}

Przełącznik identyfikacji/aktywacji (toggle-identify)

Przykład deklaracji zdolności:

{
  "capability": "toggle-identify",
  "permission": "1100", // Uwaga: Ta funkcja nie jest używana do raportowania w bieżącej wersji (V1.13.7) na ihost.
  "name": "1" // Nazwa komponentu. **Typ:** String. Opcjonalne wartości: "1" (Kanał 1), "2" (Kanał 2), "3" (Kanał 3), "4" (Kanał 4).
}

Atrybuty (stan):

{
  "identify": true, // Wskazuje, że urządzenie aktywnie zgłosiło identyfikację lub aktywację.
  "countdown": 180 // Pole `countdown` wskazuje czas aktywacji. **Typ:** Number. Jednostka: sekundy.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "toggle-identify": {
    "1": {
      "countdown": 180 // Aktywuj urządzenie na 180 sekund.
    }
  }
}

// Urządzenie zgłasza samodzielną aktywację
{
  "toggle-identify": {
    "1": {
      "identify": true
    }
  }
}

Wykrywanie napięcia (toggle-voltage)

Przykład deklaracji zdolności:

{
  "capability": "toggle-voltage",
  "permission": "1100"
}

Atrybuty (stan):

{
  "voltage": 230 // Pole `voltage` wskazuje wykryte napięcie. **Typ:** Number. Jednostka: Volty.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "toggle-voltage": {
    "voltage": 230
  }
}

Wykrywanie prądu elektrycznego w podkomponencie (toggle-electric-current)

Przykład deklaracji zdolności:

[
  {
    "capability": "toggle-electric-current",
    "permission": "0100",
    "name": "1" // Nazwa komponentu. **Typ:** String. Opcjonalne wartości: "1" (Kanał 1), "2" (Kanał 2), "3" (Kanał 3), "4" (Kanał 4).
  }
]

Atrybuty (stan):

{
  "electricCurrent": 50 // Pole `electricCurrent` przedstawia wartość prądu. **Jednostka:** 0.01 A. **Typ:** Integer. Wartość musi być większa lub równa 0.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "toggle-electric-current": {
    "1": {
      "electricCurrent": 50
    }
  }
}

Wykrywanie mocy w podkomponencie (toggle-electric-power)

Przykład deklaracji zdolności:

[
  {
    "capability": "toggle-electric-power",
    "permission": "0100",
    "name": "1" // Nazwa komponentu. **Typ:** String. Opcjonalne wartości: "1" (Kanał 1), "2" (Kanał 2), "3" (Kanał 3), "4" (Kanał 4).
  }
]

Atrybuty (stan):

{
  "electricPower": 50, // Pole `electricPower` przedstawia aktualną wartość mocy. **Jednostka:** 0.01 W. **Typ:** Integer. Wartość musi być większa lub równa 0.
  "reactivePower": 50, // Pole `reactivePower` przedstawia aktualną wartość mocy biernej. **Jednostka:** 0.01 W. **Typ:** Integer. Opcjonalne.
  "activePower": 50, // Pole `activePower` przedstawia aktualną wartość mocy czynnej. **Jednostka:** 0.01 W. **Typ:** Integer. Opcjonalne.
  "apparentPower": 50 // Pole `apparentPower` przedstawia aktualną wartość mocy pozornej. **Jednostka:** 0.01 W. **Typ:** Integer. Opcjonalne.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "toggle-electric-power": {
    "1": {
      "electricPower": 50,
      "reactivePower": 50,
      "activePower": 50,
      "apparentPower": 50
    }
  }
}

Statystyka zużycia energii w podkomponencie (toggle-power-consumption)

Przykład deklaracji zdolności:

[
  {
    "capability": "toggle-power-consumption",
    "permission": "1101",
    "name": "1", // Nazwa komponentu. **Typ:** String. Opcjonalne wartości: "1" (Kanał 1), "2" (Kanał 2), "3" (Kanał 3), "4" (Kanał 4).
    "settings": {
      "resolution": {
        "permission": "01",
        "type": "numeric",
        "value": 3600
      },
      "timeZoneOffset": {
        "permission": "01",
        "type": "numeric",
        "min": -12,
        "max": 14,
        "value": 0
      }
    }
  }
]

Atrybuty (stan):

Rozpocznij/Zatrzymaj statystyki w czasie rzeczywistym:

{
  "rlSummarize": true, // Rozpocznij lub zatrzymaj statystyki czasu rzeczywistego. **Typ:** Boolean. Wymagane.
  "timeRange": { // Zakres czasu do podsumowania. Wymagane.
    "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia zużycia energii. **Typ:** String. Wymagane.
    "end": "2020-07-05T09:00:00Z" // Czas zakończenia zużycia energii. **Typ:** String. Wymagane.
  }
}

Zapytaj o zużycie energii w przedziale czasowym:

{
  "type": "summarize", // Typ podsumowania. **Typ:** String. Wymagane. Opcje: "rlSummarize" (Podsumowanie w czasie rzeczywistym), "summarize" (Podsumowanie bieżące).
  "timeRange": { // Zakres czasu do podsumowania, wymagany gdy type jest "summarize".
    "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia zużycia energii. **Typ:** String. Wymagane.
    "end": "2020-07-05T09:00:00Z" // Czas zakończenia zużycia energii. **Typ:** String. Opcjonalne. Jeśli nie podano, domyślnie używany jest bieżący czas.
  }
}

Odpowiedź dla zużycia energii w obrębie zakresu czasu:

{
  "type": "summarize", // Typ podsumowania. **Typ:** String. Wymagane.
  "rlSummarize": 50.0, // Całkowite zużycie energii. **Jednostka:** 0.01 kWh. **Typ:** Number. Opcjonalne.
  "electricityIntervals": [ // Podzielone przez `configuration.resolution` na wiele rekordów. Opcjonalne. Nieobecne gdy type jest "rlSummarize".
    {
      "usage": 26.5, // Zużycie energii. **Jednostka:** 0.01 kWh. **Typ:** Number. Wymagane.
      "start": "2020-07-05T08:00:00Z", // Czas początkowy. **Typ:** String. Wymagane.
      "end": "2020-07-05T09:00:00Z" // Czas końcowy. **Typ:** String. Wymagane. Rekordy o przedziałach krótszych niż rozdzielczość są uznawane za nieprawidłowe.
    },
    {
      "usage": 26.5, // Zużycie energii. **Jednostka:** 0.01 kWh. **Typ:** Number. Wymagane.
      "start": "2020-07-05T09:00:00Z", // Czas początkowy. **Typ:** String. Wymagane.
      "end": "2020-07-05T10:00:00Z" // Czas końcowy. **Typ:** String. Wymagane. Rekordy o przedziałach krótszych niż rozdzielczość są uznawane za nieprawidłowe.
    }
  ]
}

Protokół (zapytanie o status i instrukcje sterowania):

Rozpocznij statystyki czasu rzeczywistego:

{
  "toggle-power-consumption": {
    "1": {
      "rlSummarize": true,
      "timeRange": {
        "start": "2020-07-05T08:00:00Z",
        "end": ""
      }
    }
  }
}

Zatrzymaj statystyki czasu rzeczywistego:

{
  "toggle-power-consumption": {
    "1": {
      "rlSummarize": false,
      "timeRange": {
        "start": "2020-07-05T08:00:00Z",
        "end": "2020-07-05T09:00:00Z"
      }
    }
  }
}

Pobierz historyczne zużycie energii:

{
  "toggle-power-consumption": {
    "1": {
      "type": "summarize",
      "timeRange": {
        "start": "2020-07-05T08:00:00Z",
        "end": "2020-07-05T09:00:00Z"
      }
    }
  }
}

Pobierz zużycie energii w czasie rzeczywistym:

{
  "toggle-power-consumption": {
    "1": {
      "type": "rlSummarize"
    }
  }
}

Wskaźnik jakości łącza (lqi)

Przykład deklaracji zdolności:

{
  "capability": "lqi",
  "permission": "0100"
}

Atrybuty (stan):

{
  "lqi": 60 // Pole `lqi` przedstawia wskaźnik jakości łącza. **Typ:** Number. Zakres wartości: 0 do 255.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "lqi": {
    "lqi": 60
  }
}

Konfiguracja funkcjonalna (configuration)

Przykład deklaracji zdolności:

[
  {
    "capability": "configuration",
    "permission": "1100"
  }
]

Atrybuty (stan):

{
  "deviceConfiguration": { // Konfiguracja funkcji związanych z urządzeniem
    "defaultResolution": 300, // Domyślna rozdzielczość do odczytu danych nasycenia wilgoci. **Typ:** Integer. **Jednostka:** Sekundy. Wymagane.
    "maxResolution": 86400, // Maksymalna rozdzielczość do odczytu danych nasycenia wilgoci. **Typ:** Integer. **Jednostka:** Sekundy. Wymagane.
    "minResolution": 60 // Minimalna rozdzielczość do odczytu danych nasycenia wilgoci. **Typ:** Integer. **Jednostka:** Sekundy. Wymagane.
  }
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "configuration": {
    "deviceConfiguration": { // Konfiguracja funkcji związanych z urządzeniem
      "defaultResolution": 300, // Domyślna rozdzielczość do odczytu danych nasycenia wilgoci. **Typ:** Integer. **Jednostka:** Sekundy. Wymagane.
      "maxResolution": 86400, // Maksymalna rozdzielczość do odczytu danych nasycenia wilgoci. **Typ:** Integer. **Jednostka:** Sekundy. Wymagane.
      "minResolution": 60 // Minimalna rozdzielczość do odczytu danych nasycenia wilgoci. **Typ:** Integer. **Jednostka:** Sekundy. Wymagane.
    }
  }
}

System (system)

Przykład deklaracji zdolności:

[
  {
    "capability": "system",
    "permission": "1000"
  }
]

Atrybuty (stan):

{
  "restart": true // Polecenie restartu urządzenia. **Typ:** Boolean. Wymagane. Wartość musi być `true`.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "system": { // Konfiguracja związana z możliwością. Opcjonalne.
    "restart": true
  }
}

Wilgotność (moisture)

Przykład deklaracji zdolności:

[
  {
    "capability": "moisture",
    "permission": "0100"
  }
]

Atrybuty (stan):

{
  "moisture": 55.5 // Pole `moisture` przedstawia procent nasycenia wilgocią. **Typ:** Number. Wymagane. Zakres: 0 do 100.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "moisture": {
    "moisture": 55.5
  }
}

Ciśnienie barometryczne (barometric-pressure)

Przykład deklaracji zdolności:

[
  {
    "capability": "barometric-pressure",
    "permission": "0100",
    "settings": {
      "barometricPressureRange": {
        "type": "numeric",
        "permission": "01",
        "min": 540, // Wartość minimalna. **Typ:** Integer. Wymagane. Musi być mniejsze niż `max`.
        "max": 1100 // Wartość maksymalna. **Typ:** Integer. Wymagane. Musi być większa niż `min`.
      }
    }
  }
]

Atrybuty (stan):

{
  "barometricPressure": 50 // Wartość ciśnienia barometrycznego. **Typ:** Integer. Wymagane. **Jednostka:** hPa.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "barometric-pressure": {
    "barometricPressure": 50
  }
}

Prędkość wiatru (wind-speed)

Przykład deklaracji zdolności:

[
  {
    "capability": "wind-speed",
    "permission": "0100",
    "settings": {
      "windSpeedRange": {
        "type": "numeric",
        "permission": "01",
        "min": 0, // Wartość minimalna. **Typ:** Number. Wymagane. Musi być mniejsza niż `max`.
        "max": 50 // Wartość maksymalna. **Typ:** Number. Wymagane. Musi być większa niż `min`.
      }
    }
  }
]

Atrybuty (stan):

{
  "windSpeed": 50 // Wartość prędkości wiatru. **Typ:** Number. Wymagane. **Jednostka:** m/s (metry na sekundę).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "wind-speed": {
    "windSpeed": 50
  }
}

Kierunek wiatru (wind-direction)

Przykład deklaracji zdolności:

[
  {
    "capability": "wind-direction",
    "permission": "0100"
  }
]

Atrybuty (stan):

{
  "windDirection": 10 // Kierunek wiatru. **Typ:** Integer. Wymagane. **Jednostka:** Stopnie. Zakres: 0 do 360 stopni (kierunek zgodny z ruchem wskazówek zegara).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "wind-direction": {
    "windDirection": 10
  }
}

Opad (rainfall)

Przykład deklaracji zdolności:

[
  {
    "capability": "rainfall",
    "permission": "0100",
    "settings": {
      "rainfallRange": {
        "type": "numeric",
        "permission": "01",
        "min": 0, // Wartość minimalna. **Typ:** Number. Wymagane. Musi być mniejsza niż `max`.
        "max": 450 // Wartość maksymalna. **Typ:** Number. Wymagane. Musi być większa niż `min`.
      }
    }
  }
]

Atrybuty (stan):

{
  "rainfall": 11.11 // Wartość opadu. **Typ:** Number. Wymagane. **Jednostka:** mm/h (milimetry na godzinę).
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "rainfall": {
    "rainfall": 11.11
  }
}

Indeks ultrafioletu (ultraviolet-index)

Przykład deklaracji zdolności:

[
  {
    "capability": "ultraviolet-index",
    "permission": "0100",
    "settings": {
      "ultravioletIndexRange": {
        "type": "numeric",
        "permission": "01",
        "min": 0, // Wartość minimalna. **Typ:** Number. Wymagane. Musi być mniejsza niż `max`.
        "max": 16 // Wartość maksymalna. **Typ:** Number. Wymagane. Musi być większa niż `min`.
      }
    }
  }
]

Atrybuty (stan):

{
  "ultravioletIndex": 11.1 // Indeks ultrafioletu. **Typ:** Number. Wymagane.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "ultraviolet-index": {
    "ultravioletIndex": 11.1
  }
}

Przewodność elektryczna (electrical-conductivity)

Przykład deklaracji zdolności:

[
  {
    "capability": "electrical-conductivity",
    "permission": "0100",
    "settings": {
      "electricalConductivityRange": {
        "type": "numeric",
        "permission": "01",
        "min": 0, // Wartość minimalna. **Typ:** Number. Wymagane. Musi być mniejsza niż `max`.
        "max": 23 // Wartość maksymalna. **Typ:** Number. Wymagane. Musi być większa niż `min`.
      }
    }
  }
]

Atrybuty (stan):

{
  "electricalConductivity": 11.11 // Wartość przewodności elektrycznej. **Typ:** Number. Wymagane. **Jednostka:** dS/m.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "electrical-conductivity": {
    "electricalConductivity": 11.11
  }
}

Moc nadawcza (transmit-power)

Przykład deklaracji zdolności:

[
  {
    "capability": "transmit-power",
    "permission": "1100"
  }
]

Atrybuty (stan):

{
  "transmitPower": 9 // Wartość mocy nadawczej urządzenia. **Typ:** Integer. Wymagane. **Jednostka:** dBm.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "transmit-power": {
    "transmitPower": 9
  }
}

Wykrywanie PM2.5 (pm25)

Przykład deklaracji zdolności:

[
  {
    "capability": "pm25",
    "permission": "0100"
  }
]

Atrybuty (stan):

{
  "pm25": 10 // Stężenie PM2.5 w powietrzu. **Typ:** Number. Wymagane. **Jednostka:** µg/m³.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "pm25": {
    "pm25": 10
  }
}

Indeks VOC (voc-index)

Przykład deklaracji zdolności:

{
  "capability": "voc-index",
  "permission": "0100"
}

Atrybuty (stan):

{
  "vocIndex": 10 // Indeks VOC odzwierciedlający poziom zanieczyszczenia gazami szkodliwymi. **Typ:** Number. Wymagane. **Jednostka:** µg/m³.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "voc-index": {
    "vocIndex": 10
  }
}

Wykrywanie gazu ziemnego (gas)

Przykład deklaracji zdolności:

{
  "capability": "gas",
  "permission": "0100"
}

Atrybuty (stan):

{
  "gas": true // Wskazuje, czy wykryto wyciek gazu ziemnego. **Typ:** Boolean. Wymagane.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "gas": {
    "gas": true
  }
}

Status pracy nawadniania (irrigation/work-status)

Przykład deklaracji zdolności:

[
  {
    "capability": "irrigation",
    "permission": "0101",
    "name": "work-status",
    "settings": {
      "volumeUnit": {
        "type": "enum",
        "permission": "01",
        "values": ["L"],
        "value": "L"
      }
    }
  }
]

Atrybuty (stan):

{
  "realTimeVolume": 20, // Rzeczywista objętość nawadniania. **Typ:** Number. Opcjonalne. **Jednostka:** L.
  "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia nawadniania. **Typ:** Date. Opcjonalne.
  "end": "2020-07-05T09:00:00Z", // Czas zakończenia nawadniania. **Typ:** Date. Opcjonalne.
  "dailyVolume": 20 // Dzienne zużycie nawadniania. **Typ:** Number. Opcjonalne. **Jednostka:** L.
}

Protokół (zapytanie o status i instrukcje sterowania):

Raportowanie statusu pracy:

{
  "irrigation": {
    "work-status": {
      "realTimeVolume": 20,
      "start": "2020-07-05T08:00:00Z",
      "end": "2020-07-05T09:00:00Z",
      "dailyVolume": 20
    }  
  }
}

Zapytanie o status pracy:

{
  "irrigation": {
    "type": "oneDay", // Typ agregacji. **Typ:** String. Wymagane. Opcje: "oneDay", "30Days", "180Days".
    "timeRange": { // Zakres czasu do agregacji. **Typ:** Object. Wymagane.
      "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia agregacji danych nawadniania. **Typ:** String. Wymagane.
      "end": "2020-07-05T09:00:00Z" // Czas zakończenia agregacji danych nawadniania. **Typ:** String. Opcjonalne. Jeśli pominięte, używany jest bieżący czas.
    }
  }
}

Wynik zapytania o status pracy:

{
  "irrigation": {
    "type": "oneDay", // Typ agregacji. **Typ:** String. Wymagane.
    "irrigationIntervals": [
      {
        "volume": 6500, // Objętość nawadniania. **Typ:** Number. Wymagane. **Jednostka:** L.
        "duration": 30, // Czas trwania nawadniania. **Typ:** Number. Wymagane. **Jednostka:** minuty.
        "start": "2020-07-05T08:00:00Z", // Czas początkowy. **Typ:** String. Wymagane.
        "end": "2020-07-05T09:00:00Z" // Czas zakończenia. **Typ:** String. Wymagane.
      },
      {
        "volume": 6500, // Objętość nawadniania. **Typ:** Number. Wymagane. **Jednostka:** L.
        "duration": 30, // Czas trwania nawadniania. **Typ:** Number. Wymagane. **Jednostka:** minuty.
        "start": "2020-07-05T08:00:00Z", // Czas początkowy. **Typ:** String. Wymagane.
        "end": "2020-07-05T09:00:00Z" // Czas zakończenia. **Typ:** String. Wymagane.
      }
    ]
  }
}

Tryb pracy nawadniania (irrigation/work-mode)

Przykład deklaracji zdolności:

[
  {
    "capability": "irrigation",
    "permission": "0100",
    "name": "work-mode",
    "settings": {
      "supportedModes": {
        "type": "enum",
        "permission": "01",
        "values": [
          "MANUAL", // Tryb ręczny
          "TIMER", // Jednorazowe harmonogramowanie
          "CYCLE-TIMER", // Powtarzalne harmonogramowanie
          "VOLUME", // Jednorazowa objętość
          "CYCLE-VOLUME" // Powtarzalna objętość
        ]
      }
    }
  }
]

Atrybuty (stan):

{
  "workMode": "MANUAL" // Tryb pracy nawadniania. **Typ:** String. Opcjonalne. Wartości powinny pochodzić z `settings.supportedModes`.
}

Protokół (zapytanie o status i instrukcje sterowania):

{
  "irrigation": {
    "work-mode": "MANUAL"
  }
}

Automatyczny sterownik nawadniania (irrigation/auto-controller)

Przykład deklaracji zdolności:

[
  {
    "capability": "irrigation",
    "permission": "1100",
    "name": "auto-controller",
    "settings": {
      "volumeRange": { // Zakres objętości
        "type": "enum",
        "permission": "01",
        "min": 0,
        "max": 6500,
        "unit": "L"
      },
      "timeRange": { // Zakres czasu
        "type": "enum",
        "permission": "01",
        "min": 1,
        "max": 86400,
        "unit": "second"
      },
      "cycleCountRange": { // Zakres liczby cykli
        "type": "enum",
        "permission": "01",
        "min": 1,
        "max": 100,
        "step": 1
      }
    }
  }
]

Atrybuty (stan):

Jednorazowe lub powtarzalne harmonogramowanie:

{
  "type": "time", // Tryb nawadniania. **Typ:** String. Wymagane. Opcje: "volume", "time".
  "action": {
    "perDuration": 60, // Czas trwania pojedynczego cyklu nawadniania. **Typ:** Number. Wymagane.
    "intervalDuration": 20, // Przerwa między cyklami nawadniania. **Typ:** Number. Wymagane.
    "count": 3 // Liczba cykli nawadniania. **Typ:** Number. Wymagane.
  }
}

Jednorazowa lub powtarzalna objętość:

{
  "type": "volume", // Tryb nawadniania. **Typ:** String. Wymagane. Opcje: "volume", "time".
  "action": {
    "perConsumedVolume": 60, // Objętość zużywana na cykl nawadniania. **Typ:** Number. Wymagane.
    "intervalDuration": 20, // Przerwa między cyklami nawadniania. **Typ:** Number. Wymagane.
    "count": 3 // Liczba cykli nawadniania. **Typ:** Number. Wymagane.
  }
}

Protokół (zapytanie o status i instrukcje sterowania):

Jednorazowe lub powtarzalne harmonogramowanie:

{
  "irrigation": {
    "auto-controller": {
      "type": "time", // Tryb nawadniania. **Typ:** String. Wymagane.
      "action": {
        "perDuration": 60, // Czas trwania pojedynczego cyklu nawadniania. **Typ:** Number. Wymagane.
        "intervalDuration": 20, // Przerwa między cyklami. **Typ:** Number. Wymagane.
        "count": 3 // Liczba cykli. **Typ:** Number. Wymagane.
      }
    }
  }
}

Jednorazowa lub powtarzalna objętość:

{
  "irrigation": {
    "auto-controller": {
      "type": "volume", // Tryb nawadniania. **Typ:** String. Wymagane.
      "action": {
        "perConsumedVolume": 60, // Objętość zużywana na cykl. **Typ:** Number. Wymagane.
        "intervalDuration": 20, // Przerwa między cyklami. **Typ:** Number. Wymagane.
        "count": 3 // Liczba cykli. **Typ:** Number. Wymagane.
      }
    }
  }
}

Obsługiwane tryby wstępne

**Nazwy trybów **	**Wartości opcjonalne **
poziomWentylatora (fan Level)	"low"
"medium"
"high"
trybTermostatu (Thermostat Mode)	"auto"
"manual"
trybKlimatyzatora >= 1.11.0 (airConditioner Mode)	"cool"
"heat"
"auto"
"fan"
"dry"
trybWentylatora >= 1.11.0 (Fan Mode)	"normal"
"sleep"
"child"
kątPoziomy >= 1.11.0 (Horizontal Angle)	"30"
"60"
"90"
"120"
"180"
"360"
kątPionowy >= 1.11.0 (Vertical Angle)	"30"
"60"
"90"
"120"
"180"
"360"

c. Opis tagów

• Specjalny klucz toggle służy do ustawienia nazwy podkomponentu toggle.

{
    "toggle": {
        '1': 'Chanel1',
        '2': 'Chanel2',
        '3': 'Chanel3',
        '4': 'Chanel4',
    },
}

• Specjalny klucz temperature_unit służy do ustawienia jednostki temperatury.

{
    "temperature_unit":'c' // c-Celsius; f-Fahrenheit
}

d. Specjalne kody błędów i opis

Kod błędu	Opis	Wersja iHost
110000	Pod-urządzenie/grupa odpowiadająca id nie istnieje	≥2.1.0
110001	Brama jest w stanie wyszukiwania urządzeń zigbee	≥2.1.0
110002	Urządzenia w grupie nie mają wspólnej funkcjonalności	≥2.1.0
110003	Nieprawidłowa liczba urządzeń	≥2.1.0
110004	Nieprawidłowa liczba grup	≥2.1.0
110005	Urządzenie offline	≥2.1.0
110006	Nie udało się zaktualizować statusu urządzenia	≥2.1.0
110007	Nie udało się zaktualizować statusu grupy	≥2.1.0
110008	Osiągnięto maksymalną liczbę grup. Utwórz do 50 grup	≥2.1.0
110009	Adres IP urządzenia kamery jest nieprawidłowy	≥2.1.0
110010	Błąd autoryzacji dostępu do urządzenia kamery	≥2.1.0
110011	Błąd adresu strumienia urządzenia kamery	≥2.1.0
110012	Kodowanie wideo urządzenia kamery nie jest obsługiwane	≥2.1.0
110013	Urządzenie już istnieje	≥2.1.0
110014	Kamera nie obsługuje działania w trybie offline	≥2.1.0
110015	Hasło konta nie jest zgodne z hasłem konta w adresie strumienia RTSP	≥2.1.0
110016	Brama jest w stanie wyszukiwania kamer onvif	≥2.1.0
110017	Przekroczono maksymalną liczbę dodanych kamer	≥2.1.0
110018	Ścieżka kamery ESP jest błędna	≥2.1.0
110019	Nie udało się uzyskać dostępu do adresu usługi urządzenia zewnętrznego	≥2.1.0

e. Wyszukiwanie pod-urządzenia

Pozwól autoryzowanym użytkownikom włączyć lub wyłączyć wyszukiwanie pod-urządzeń przez bramę za pośrednictwem tego interfejsu

• 💡Uwaga: Obecnie obsługiwane jest tylko wyszukiwanie pod-urządzeń Zigbee.

• 💡Uwaga: Pod-urządzenia Zigbee zostaną dodane automatycznie po wyszukiwaniu. Nie trzeba używać interfejsu "Ręcznie dodaj pod-urządzenia" :::tips

• URL：/open-api/V2/rest/devices/discovery

• Metoda: PUT

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
enable	boolean	N	true (Rozpocznij parowanie); false (Wstrzymaj parowanie)
type	string	N	Typ wyszukiwania: Zigbee

Pomyślna odpowiedź z danymi: pusty obiekt {} :::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: ** 200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

f. Ręczne dodawanie pod-urządzenia

Pozwól autoryzowanym użytkownikom dodać pojedyncze pod-urządzenie przez ten interfejs.

• Uwaga: Obecnie obsługiwane są tylko kamery RTSP i ESP32-CAM :::tips

• URL：/open-api/V2/rest/devices

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa pod-urządzenia
display_category	string	N	Typ urządzenia. Obsługiwane tylko kamery.
capabilities	CapabilityObject[]	N	Lista możliwości. Gdy display_category = camera, capabilities obejmują tylko możliwości camera-stream.
protocal	string	N	Protokół urządzenia. RTSP; ESP32-CAM
manufacturer	string	N	Producent.
model	string	N	Model urządzenia
firmware_version	string	N	Wersja oprogramowania urządzenia

CapabilityObject

Atrybut	Typ	Opcjonalne	Opis
capability	string	N	Nazwa możliwości. Obsługiwane tylko "camera-stream"
uprawnienie	string	N	Uprawnienie urządzenia. Obsługuje tylko odczyt.
configuration	CameraStreamConfigurationObject	Y	Konfiguracja strumienia kamery.

SettingsObject

Atrybut	Typ	Opcjonalne	Opis
streamSetting	StreamSettingObject	N	Konfiguracja usługi strumieniowej

StreamSettingObject

Atrybut	Typ	Opcjonalne	Opis
type	string	N	Konfiguracja usługi strumieniowej
uprawnienie	string	N	Uprawnienie do możliwości. Obsługuje tylko "11" (możliwe do modyfikacji).
wartość	StreamSettingValueObject	N	Konkretne wartości konfiguracji

StreamSettingValueObject

Atrybut	Typ	Opcjonalne	Opis
stream_url	string	N	Format URL strumienia
Format:<schema>://<hostname>:<port>/<username>:<password>@<service_path>
Przykład:rtsp://admin:[email protected]:554/streaming/channel01
Opcje schematu:
rtsp (Protokół strumieniowania w czasie rzeczywistym)
http (Protokół transferu hipertekstu) — Dla urządzeń ESP32-CAM
*Uwaga: Niektóre kamery mogą nie wymagać nazwy użytkownika ani hasła. W takich przypadkach można pominąć <username> oraz <password> pola z URL.

Pomyślna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia

:::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {
    "serial_number": "serial_number"
  },
  "message": "success"
}

Odpowiedź danych o niepowodzeniu: pusty obiekt :::tips Warunek：

1. Błąd dostępu do adresu strumienia kamery (błąd formatu, błąd autoryzacji, wyjątek sieciowy itp.)

2. Urządzenie już istnieje

3. Jeśli dodanie pojedynczego urządzenia się nie powiedzie, zwracane jest, że wszystkie urządzenia nie zostały dodane.

Kod statusu: 200 OK Kod błędu： ● 110009 Błąd adresu IP kamery ● 110010 Błąd autoryzacji dostępu do kamery ● 110011 Błąd adresu strumienia kamery ● 110012 Kodowanie wideo kamery nie jest obsługiwane ● 110013 Urządzenie już istnieje ::: Przykład odpowiedzi:

{
  "error": 110009,
  "data": {},
  "message": "błąd dostępu do ip kamery" 
}

g. Pobierz listę pod-urządzeń

Pozwól autoryzowanym użytkownikom uzyskać listę pod-urządzeń bramy za pośrednictwem tego interfejsu. :::tips

• URL：/open-api/V2/rest/devices

• Metoda: GET

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania: brak Pomyślna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
device_list	ResponseDeviceObject[]	N	Lista urządzeń

ResponseDeviceObject

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	"N" gdy podłączone jest urządzenie zewnętrzne, w przeciwnym razie "Y"	Unikalny numer seryjny urządzenia zewnętrznego
service_address	string	"N" gdy podłączone jest urządzenie zewnętrzne, w przeciwnym razie "Y"	Adres usługi urządzenia zewnętrznego
name	string	N	Nazwa urządzenia; jeśli nie została zmieniona, zostanie wyświetlona przez interfejs zgodnie z domyślnymi regułami wyświetlania.
manufacturer	string	N	Producent
model	string	N	Model urządzenia
firmware_version	string	N	Wersja oprogramowania. Może być pustym ciągiem znaków.
hostname	string	Y	Nazwa hosta urządzenia
mac_address	string	Y	Adres MAC urządzenia
app_name	string	Y	Nazwa aplikacji, do której należy. Jeśli app_name zostanie wypełnione podczas uzyskiwania certyfikatu interfejsu otwartego, to wszystkie późniejsze urządzenia podłączone przez ten certyfikat będą wpisywane w to pole.
display_category	string	N	Kategoria urządzenia
capabilities	CapabilityObject[]	N	Możliwości urządzenia
protocol	string	"N" gdy podłączone jest urządzenie zewnętrzne, w przeciwnym razie "Y"	Protokół urządzenia: zigbee, onvif, rtsp, esp32-cam
state	object	Y	Obiekt stanu urządzenia. Aby zobaczyć przykłady stanów dla różnych możliwości, sprawdź 【Support Device Capabilities】
tags	object	Y	Format JSON klucz-wartość, niestandardowe informacje o urządzeniu. Funkcja jest następująca: - Służy do przechowywania kanałów urządzenia - Służy do przechowywania jednostek temperatury - Niestandardowe informacje dla innych urządzeń stron trzecich
online	boolean	N	Status online: True oznacza online False oznacza offline
podsiec	boolean	Y	Czy znajduje się w tej samej podsieci co bramka

CapabilityObject 💡Uwaga: Proszę sprawdzić Przykłady Obsługiwanych Funkcji Urządzeń w [Supported Device Capabilities].

Atrybut	Typ	Opcjonalne	Opis
capability	string	N	Nazwa możliwości. Szczegóły sprawdź w [Supported Device Capabilities]
uprawnienie	string	N	Uprawnienie możliwości. Możliwe wartości to "read" (do odczytu), "write" (zapis), "readWrite" (odczyt i zapis).
configuration	object	Y	Informacje konfiguracyjne możliwości. Obecnie używane jest camera-stream, sprawdź [Supported Device Capabilities]
name	string	Y	Pole name w toggle. Numer podkanału używany do identyfikacji urządzeń wielokanałowych. Na przykład, jeśli name to 1, oznacza to kanał 1.

:::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data":{
    "device_list":  [
      {
        "serial_number": "ABCDEFGHIJK",
        "name": "Moje urządzenie",
        "manufacturer": "SONOFF",
        "model": "BASICZBR3",
        "firmware_version": "1.1.0",
        "display_category": "switch",
        "capabilities": [
          {
            "capability": "power",
            "permission": "readWrite"
          },
          {
            "capability": "rssi",
            "permission": "read"
          }
        ],
        "protocal": "zigbee",
        "state": {
          "power": {
            "powerState": "on"
          }
        },
        "tags": {
          "key": "value"
        },
        "online": true
      }
    ],
  }
  "message": "success"
}

h. Aktualizuj określone informacje lub stan urządzenia

Pozwól uprawnionym użytkownikom modyfikować podstawowe informacje o pod-urządzeniu oraz wydawać polecenia sterujące przez to API. :::tips

• URL：/open-api/V2/rest/devices/{serial_number}

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
name	string	Y	Nazwa urządzenia
tags	object	Y	Format JSON klucz-wartość, niestandardowe informacje o urządzeniu.
state	object	Y	Obiekt stanu urządzenia. Przykłady stanów dla różnych możliwości sprawdź w [Support Device Capabilities]
configuration	object	Y	Informacje konfiguracyjne możliwości, obecnie tylko capability camera_stream obsługuje modyfikację.

Pomyślna odpowiedź z danymi: :::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika została pomyślnie zakończona. **Kod statusu: **200 OK Kod błędu:

• 110000 Pod-urządzenie/grupa odpowiadająca id nie istnieje ::: Przykład odpowiedzi:

{
  "error": 0,
  "data":{
    "serial_number": "ABCDEFGHIJK",
    "third_serial_number": "third_serial_number",
    "name": "我的设备",
    "manufacturer": "SONOFF",
    "model": "BASICZBR3",
    "firmware_version": "1.1.0",
    "display_category": "switch",
    "capabilities": [
      {
        "capability": "power",
        "permission": "1100"
      },
      {
        "capability": "rssi",
        "permission": "0100"
      }
    ],
    "protocal": "zigbee",
    "state": {
      "power": {
        "powerState": "on"
      }
    },
    "tags": {
      "key": "value"
    },
    "online": true
  },
  "message": "success"
}

i. Usuń pod-urządzenie

Pozwól uprawnionym użytkownikom usuwać pod-urządzenia przez to API. :::tips

• URL：/open-api/V2/rest/devices/{serial_number}

• Metoda：DELETE

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
name	string	Y	Nazwa urządzenia.
tags	object	Y	Pary klucz-wartość w formacie JSON używane do przechowywania nazw kanałów urządzenia i innych informacji o pod-urządzeniach.
state	object	Y	Zmień stan urządzenia; szczegółowe informacje protokołu znajdują się w "Supported Device Capabilities."
capabilities	CapabilityObject []	Y	Informacje konfiguracyjne możliwości; wszystkie możliwości, które obsługują ustawianie konfiguracji, mogą być modyfikowane. Uwaga: uprawnienia nie mogą być zmieniane.

Pomyślna odpowiedź z danymi: :::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika została pomyślnie zakończona. **Kod statusu: **200 OK Kody błędów:

• 110000: Pod-urządzenie/grupa odpowiadająca ID nie istnieje.

• 110006: Nie udało się zaktualizować stanu urządzenia.

• 110019: Nie udało się uzyskać dostępu do adresu usługi urządzenia stron trzecich.

• 110024: Nie udało się zaktualizować konfiguracji urządzenia. ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

import axios from 'axios';

const serial_number = 'serial_number';
const access_token = 'access_token';

(async function main() {
  // włącz urządzenie
  await axios({
    url: `http://<nazwa domeny lub adres ip>/open-api/v2/rest/devices/${serial_number}`,
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${access_token}`
    },
    data: {
      state: {
        power: {
          powerState: 'on'
        }
      }
    }
  });
})()

j. Usuń pod-urządzenie

Pozwala uprawnionym użytkownikom usuwać pod-urządzenia przez to API. :::tips

• URL：/open-api/v2/rest/devices/{serial_number}

• Metoda：DELETE

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: Brak Pomyślna odpowiedź z danymi: :::tips Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

k. Zapytaj o stan urządzenia

Pozwala uprawnionym użytkownikom zapytać o stan urządzenia przez to API. :::tips

• URL：/open-api/v2/rest/devices/:serial_number/query-state/{capability}

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
query_state	object	N	Zapytaj o stan urządzenia; szczegóły protokołu znajdują się w "Supported Device Capabilities."

import axios from 'axios';

const serial_number = 'serial_number';
const access_token = 'access_token';

(async function main() {
  // włącz urządzenie
  await axios({
    url: `http://<nazwa domeny lub adres ip>/open-api/v2/rest/devices/${serial_number}/query-state/power-consumption`,
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${access_token}`
    },
    data: {
      "query_state":{
        "power-consumption":{
          "type": "summarize", // Typ statystyki, wymagane
          "timeRange": { // Zakres czasu do podsumowania, wymagane gdy type="summarize"
            "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia statystyk zużycia energii
            "end": "2020-07-05T09:00:00Z" // Czas zakończenia statystyk zużycia energii; jeśli pominięte, domyślnie aktualny czas
          }
        }
      }
    });
})()

Pomyślna odpowiedź z danymi: :::tips Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

3.4 Zarządzanie bezpieczeństwem

a. Pobierz listę zabezpieczeń

Pozwól uprawnionym użytkownikom modyfikować ustawienia bramki przez to API. :::tips

• URL：/open-api/v2/rest/security

• Metoda：GET

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: Brak Pomyślna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
security_list	ResponseSecurityObject[]	N	lista urządzeń w odpowiedzi

ResponseDeviceObject

Atrybut	Typ	Opcjonalne	Opis
sid	int	N	id zabezpieczenia
name	string	N	nazwa zabezpieczenia
enable	bool	N	czy włączone

• true Włączone

• false Wyłączone |

:::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {
    "security_list":[
      {
        "sid": 1,
        "name": "Tryb domowy",
        "enable": true
      }
    ]
  },
  "message": "success"
}

b. Włącz określony tryb zabezpieczeń

Pozwól uprawnionym użytkownikom włączyć określony tryb zabezpieczeń przez to API. :::tips

• URL：/open-api/v2/rest/security/{security_id}/enable

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: Brak Pomyślna odpowiedź z danymi:pusty obiekt {} :::tips Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

c. Wyłącz określony tryb zabezpieczeń

Pozwól uprawnionym użytkownikom wyłączyć określony tryb zabezpieczeń przez to API. :::tips

• URL：/open-api/v2/rest/security/{security_id}/disable

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: Brak Pomyślna odpowiedź z danymi:pusty obiekt {} :::tips Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

d. Jednoklikowe włączenie zabezpieczeń

Pozwól uprawnionym użytkownikom włączyć tryb jednoklikowych ustawień zabezpieczeń przez to API. :::tips

• URL：/open-api/v2/rest/security/enable

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: Brak Pomyślna odpowiedź z danymi:pusty obiekt {} :::tips Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

e. Wyłącz zabezpieczenia

Pozwól uprawnionym użytkownikom wyłączyć zabezpieczenia przez to API. :::tips

• URL：/open-api/v2/rest/security/disable

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Authorization: Bearer ::: Parametry żądania: Brak Pomyślna odpowiedź z danymi:pusty obiekt {} :::tips Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: **200 OK ::: Przykład odpowiedzi:

{
  "error": 0,
  "data": {},
  "message": "success"
}

4. Dostęp urządzeń stron trzecich

4.1 Instrukcja dostępu

Dostęp urządzenia

1.0.jpg

Dostęp bramki stron trzecich

2.0.jpg

Kroki dostępu

1. Określ klasyfikację urządzenia w bramce. Szczegóły sprawdź w [Supported Device Type].

2. Określ możliwości, do których urządzenie może mieć dostęp. Szczegóły sprawdź w [Supported Device Capabilities].

3. Wywołaj interfejs [Discovery Request], aby dodać urządzenie do bramki.

   1. Uwaga: Musisz podać adres usługi do odbierania instrukcji wydawanych przez bramkę, który służy do odbierania poleceń sterowania urządzeniem wydawanych przez bramkę.

4. Jeśli status urządzenia stron trzecich się zmieni, musisz wywołać interfejs [Device States Change Report], aby wysłać najnowszy stan z powrotem do bramki.

5. Po dodaniu urządzenie stron trzecich pojawi się na liście urządzeń, z większością funkcji bramki (inne urządzenia nie będące stroną trzecią). Powszechne otwarte interfejsy związane z urządzeniem będą działać normalnie.

• Wybierz odpowiednią kategorię urządzenia. Klasyfikacja wpłynie na ostateczny wygląd interfejsu użytkownika po podłączeniu urządzenia do bramki.

• Wybierz odpowiednią zdolność urządzenia. Lista możliwości określi stan protokołu urządzenia.

Proces programowy

a. Dostęp urządzenia

3.0.jpg

b. Dostęp bramki stron trzecich

4.0.jpg

4.2 Przykład dostępu

Przełącznik, Wtyczka

Synchronizuj urządzenia stron trzecich

// Żądanie
URL：/open-api/v2/rest/thirdparty/event
Metoda：POST
Nagłówek：
  Content-Type: application/json
  Autoryzacja: Bearer  <token>
Ciało:
{
  "event": {
    "header": {
      "name": "DiscoveryRequest",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "payload": {
      "endpoints": [
        {
          "third_serial_number": "third_serial_number_1",
          "name": "moja wtyczka",
          "display_category": "plug",
          "capabilities": [
            {
              "capability": "power",
              "permission": "1100"
            }
          ],
          "state": {
            "power": {
              "powerState": "on"
            }
          },
          "tags": {
            "key": "value"
          },
          "manufacturer": "nazwa producenta",
          "model": "nazwa modelu",
          "firmware_version": "wersja oprogramowania układowego",
          "service_address": "http://192.168.31.14/webhook"
      	}
      ]
    }
  }
}

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {
    "endpoints": [
      {
        "third_serial_number": "third_serial_number",
        "serial_number": "numer seryjny"
      }
    ]
  }
}

Zgłoś stan urządzenia

URL：/open-api/V2/rest/thirdparty/event
Metoda：POST
Nagłówek：
  Content-Type: application/json
  Autoryzacja: Bearer  <token>
Ciało:

{
  "event": {
    "header": {
      "name": "DeviceStatesChangeReport",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "endpoint": {
      "serial_number": "serial_number"
    },
    "payload": {
       "state": {
        "power": {
          "powerState": "on"
        }
      }
    }
  }
}

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {}
}

Zgłoś offline/online

{
  "event": {
    "header": {
      "name": "DeviceStatesChangeReport",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "endpoint": {
      "serial_number": "serial_number"
    },
    "payload": {
       "online": true
    }
  }
}

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {}
}

Odbierz instrukcje dotyczące sterowania urządzeniem przez bramkę

URL：<adres usługi>
Metoda：POST
Nagłówek：
  Content-Type: application/json
B

{
  "directive": {
    "header": {
      "name": "UpdateDeviceStates",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "endpoint": {
      "third_serial_number": "third_serial_number",
      "serial_number": "serial_number"
    },
    "payload": {
       "state": : {
         "power": {
           "powerState": "on"
         }
       }
    }
  }
}

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {}
}

Zapytaj o urządzenie

URL：/open-api/V2/rest/devices
Metoda：GET
Nagłówek：
  Content-Type: application/json
  Autoryzacja: Bearer  <token>
Ciało: Brak

{
  "error": 0,
  "data": {
    "device_list": [
      {
        "serial_number": "numer seryjny",
        "third_serial_number": "third_serial_number",
        "name": "moja wtyczka",
        "manufacturer": "nazwa producenta",
        "model": "nazwa modelu",
        "firmware_version": "wersja oprogramowania układowego",
        "display_category": "plug",
        "capabilities": [
          {
            "capability": "power",
            "permission": "readWrite"
          }
        ],
        "state": {
          "power": {
            "powerState": "on"
          }
        },
        "tags": {
          "key": "value"
        },
        "online": true
      }
    ]
  },
  "message": "success"
}

4.3 Web API

Interfejs żądań bramki dla stron trzecich

Format żądania

Pozwala uprawnionym użytkownikom wysyłać żądania zdarzeń do bramki przez to API. :::tips

• URL：/open-api/V2/rest/thirdparty/event

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Autorization: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
event	EventObject	N	Struktura obiektu zdarzenia żądania

EventObject

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
endpoint	EndpointObject	Y	Struktura endpointu żądania Uwaga: Pole jest puste przy synchronizacji nowej listy urządzeń.
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa żądania. parametr opcjonalny: DiscoveryRequest: Synchronizuj nowe urządzenia DeviceStatesChangeReport: Raport aktualizacji stanu urządzenia DeviceOnlineChangeReport: Raport statusu online urządzenia
message_id	string	N	ID wiadomości żądania, UUID_V4
version	string	N	Numer wersji protokołu żądania. Obecnie ustalony na 1

EndpointObject

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	N	Unikalny numer seryjny urządzenia zewnętrznego
tags	object	Y	Format JSON klucz-wartość, niestandardowe informacje o urządzeniu. [Funkcja zarządzania urządzeniami] - [Opis tagów]

PayloadObject W zależności od różnych header.name mają różne struktury żądań.

Format odpowiedzi

:::tips **Kod statusu: **200 OK Parametry odpowiedzi: :::

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka odpowiedzi
payload	PayloadObject	N	Struktura ładunku odpowiedzi

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa nagłówka odpowiedzi. parametry opcjonalne: Response: Pomyślna odpowiedź ErrorResponse: Odpowiedź z błędem
message_id	string	N	ID wiadomości nagłówka odpowiedzi, UUID_V4. Przekaż tutaj message_id z nagłówka żądania *Jeśli parametr message_id w żądaniu jest pominięty, to pole będzie pustym łańcuchem w odpowiedzi.
version	string	N	- Numer wersji protokołu żądania. Obecnie ustalony na 1.

Pomyślna odpowiedź--PayloadObject ：

W zależności od typu żądania, struktura odpowiedzi jest inna. Szczegóły znajdują się w dokumentacji konkretnego polecenia żądania.

Niepomyślna odpowiedź--PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
type	string	N	Rodzaje błędów:

• INVALID_PARAMETERS: Błąd parametrów

• AUTH_FAILURE: Błąd autoryzacji

• INTERNAL_ERROR: Błąd wewnętrznej usługi | | description | string | N | Opis błędu |

DiscoveryRequest Synchronizuj nową listę urządzeń

• Uwaga: Po zsynchronizowaniu urządzenie z bramką domyślnie jest online, czyli online=true. Późniejsze zmiany online zależą całkowicie od synchronizacji ze stroną trzecią przez interfejs DeviceOnlineChangeReport.

Parametry żądania: EndpointObject**：**Brak PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
endpoints	EndpointObject[]	N	Lista urządzeń

EndpointObject:

Atrybut	Typ	Opcjonalne	Opis
third_serial_number	string	N	Unikalny numer seryjny urządzenia zewnętrznego
name	string	N	Nazwa urządzenia
display_category	string	N	Kategoria urządzenia. Szczegóły w [Supported Device Type]. *Urządzenia stron trzecich obecnie nie obsługują dodawania kamer.
capabilities	CapabilityObject[]	N	Lista możliwości
state	object	N	Informacje o stanie początkowym
manufacturer	string	N	Producent
model	string	N	Model urządzenia
tags	object	Y	Format JSON klucz-wartość, niestandardowe informacje o urządzeniu: Służy do przechowywania kanałów urządzenia Służy do przechowywania jednostek temperatury Inne niestandardowe dane stron trzecich
firmware_version	string	N	Wersja firmware
service_address	string	N	Adres usługi. Na przykład http://192.168.31.14/service_address

Przykład żądania :

{
  "event": {
    "header": {
      "name": "DiscoveryRequest",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {
      "endpoints": [
        {
          "third_serial_number": "third_serial_number_1",
          "name": "moja wtyczka",
          "display_category": "plug",
          "capabilities": [
            {
              "capability": "power",
              "permission" "readWrite"
            }
          ],
          "state": {
            "power": {
              "powerState": "on"
            }
          },
          "tags": {
            "key": "value"
          },
          "manufacturer": "nazwa producenta",
          "model": "nazwa modelu",
          "firmware_version": "wersja oprogramowania układowego",
          "service_address": "http://192.168.31.14/service_address"
        }
      ]
    }
  }
}

Parametry odpowiedzi: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
endpoints	EndpointObject[]	N	Lista urządzeń

EndpointObject:

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	N	Unikalny numer seryjny urządzenia zewnętrznego

Przykład poprawnej odpowiedzi:

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {
    "endpoints": [
      {
        "serial_number": "numer seryjny",
        "third_serial_number": "third_serial_number"
      }
    ]
  }
}

Przykład odpowiedzi z błędem:

{
  "header": {
    "name": "ErrorResponse",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {
    "type": "INVALID_PARAMETERS",
    "description": "webhook nie może być pusty" 
  }
}

DeviceStatesChangeReport Raport zmiany stanu urządzenia

• Uwaga: Powtarzające się raporty stanu mogą fałszywie wywołać powiązane sceny.

Parametry żądania: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
state	object	N	Stan urządzenia, zobacz [Supported device cabilities] po szczegóły

Przykład żądania :

{
  "event": {
    "header": {
      "name": "DeviceStatesChangeReport",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "endpoint": {
      "serial_number": "serial_number",
      "third_serial_number": "third_serial_number",
    },
    "payload": {
       "state": {
        "power": {
          "powerState": "on"
        }
      }
    }
  }
}

Parametry odpowiedzi: PayloadObject: Pusty obiekt Przykład pomyślnej odpowiedzi:

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {}
}

DeviceOnlineChangeReport Raport statusu online urządzenia

• Uwaga: Powtarzające się raporty stanu mogą fałszywie wywołać powiązane sceny.

Parametry żądania: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
online	boolean	N	Status online urządzenia true: Online
false: Offline

Przykład żądania :

{
  "event": {
    "header": {
      "name": "DeviceOnlineChangeReport",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "endpoint": {
      "serial_number": "serial_number",
      "third_serial_number": "third_serial_number"
    },
    "payload": {
       "online": true
    }
  }
}

Parametry odpowiedzi: PayloadObject: Pusty obiekt Przykład pomyślnej odpowiedzi:

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {}
}

DeviceInformationUpdatedReport Raport zaktualizowanych informacji o urządzeniu

• Uwaga: Aktualizacja może wpłynąć na istniejące sceny lub funkcje zabezpieczeń.

Parametry żądania: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
capabilities

| CapabilityObject[]

| N

| Lista możliwości. Szczegóły można znaleźć w sekcji wspieranych możliwości urządzeń. **Uwaga: **Ten parametr zaktualizuje tylko wartość z ustawienia klucz w ramach CapabilityObject, a aktualizacje są dozwolone tylko jeśli uprawnienie dla ustawienia klucz jest 11 lub 01. Szczegółową definicję struktury ustawienia w CapabilityObject, można znaleźć w szczegółowym opisie w sekcji 2.3 Kategorie wyświetlania urządzeń i możliwości urządzeń. | | tags

| object

| Y

| Format JSON klucz-wartość, niestandardowe informacje o urządzeniu.

• Może być używane do przechowywania kanałów urządzenia

• Może być używane do przechowywania jednostek temperatury

• Inne niestandardowe dane stron trzecich |

Przykład żądania :

{
  "event": {
    "header": {
      "name": "DeviceInformationUpdatedReport",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "endpoint": {
      "serial_number": "serial_number",
      "third_serial_number": "third_serial_number"
    },
    "payload": {
      "capabilities": [
        {
          "capability": "detect",
          "permission": "0110",
          "settings":{
            "detectInterval":{
              "permission": "11",
              "type": "numeric",
              "value": 300,
            },
            "detectSensitivity":{
              "permission": "11",
              "type": "numeric",
              "value": 1000,
            }
          }
        }
      ]
    }
  }
}

parametry odpowiedzi: PayloadObject: Pusty obiekt Przykład pomyślnej odpowiedzi:

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "2"
  },
  "payload": {}
}

Bramka wysyła interfejs polecenia przez adres usługi urządzenia

• Uwaga:

1. Strony trzecie muszą odpowiedzieć na żądanie bramki w ciągu 3s. W przeciwnym razie bramka uzna przetwarzanie polecenia za przekroczone czasowo.

2. Jeśli usługa strony trzeciej jest offline, bramka ustawi urządzenie w stan offline, a usługa strony trzeciej musi zgłosić stan urządzenia (DeviceStatesChangeReport) lub stan online (DeviceOnlineChangeReport), zanim powróci do stanu online.

Format żądania

Bramka wysyła polecenia do strony trzeciej przez interfejs adresu usługi urządzenia. :::tips

• URL：

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
directive	DirectiveObject	N	Struktura obiektu dyrektywy

DirectiveObject

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
endpoint	EndpointObject	N	Struktura endpointu żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa żądania. Parametry opcjonalne: UpdateDeviceStates: Zaktualizuj stany urządzenia
message_id	string	N	ID wiadomości żądania, UUID_V4
version	string	N	Numer wersji protokołu żądania. Obecnie ustalony na 1.

EndpointObject

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	N	Unikalny numer seryjny urządzenia zewnętrznego
tags	object	N	Format JSON klucz-wartość, niestandardowe informacje o urządzeniu. [Funkcja zarządzania urządzeniami] - [Opis tagów]

PayloadObject: W zależności od różnych header.name, istnieje dla każdego specyficzna struktura żądania.

Przykład żądania :

{
  "directive": {
    "header": {
      "name": "UpdateDeviceStates",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "endpoint": {
      "serial_number": "serial_number",
      "third_serial_number": "third_serial_number",
      "tags": {}
    },
    "payload": {
      "state": {
        "power": {
          "powerState": "on"
        }
      }
    }
  }
}

Format odpowiedzi

:::tips **Kod statusu HTTP: **200 OK Atrybut odpowiedzi HTTP： :::

Atrybut	Typ	Opcjonalne	Opis
event	EventObject	N	Struktura zdarzenia odpowiedzi

EventObject

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa nagłówka odpowiedzi. Parametr opcjonalny: UpdateDeviceStatesResponse: Odpowiedź na aktualizację stanów urządzenia ErrorResponse: Odpowiedź z błędem
message_id	string	N	ID wiadomości nagłówka odpowiedzi, UUID_V4. Przekaż tutaj message_id z nagłówka żądania
version	string	N	Numer wersji protokołu żądania. Obecnie ustalony na 1.

Pomyślna odpowiedź--PayloadObject：

W zależności od typu żądania, struktura odpowiedzi jest inna. Szczegóły znajdują się w dokumentacji konkretnego polecenia żądania.

Niepomyślna odpowiedź--PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
type	string	N	Rodzaje błędów:

• ENDPOINT_UNREACHABLE: Urządzenie jest nieosiągalne lub offline

• ENDPOINT_LOW_POWER: Urządzenie jest w trybie niskiego zużycia energii i nie może być sterowane

• INVALID_DIRECTIVE: Nieprawidłowa dyrektywa od bramki

• NO_SUCH_ENDPOINT: Urządzenie nie istnieje

• NOT_SUPPORTED_IN_CURRENT_MODE: Bieżący tryb nie obsługuje tej operacji

• INTERNAL_ERROR: Błąd wewnętrznej usługi

• REMOTE_KEY_CODE_NOT_LEARNED: Kod klawisza pilota nie został nauczony |

:::porady Warunki: Parametry żądania są prawidłowe. **Kod statusu: **200 OK Parametry odpowiedzi: :::

{
  "event": {
    "header": {
      "name": "UpdateDeviceStatesResponse",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {}
  }
}

{
  "event": {
    "header": {
      "name": "ErrorResponse",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {
      "type": "ENDPOINT_UNREACHABLE"
    }
  }
}

UpdateDeviceStates

Parametry żądania: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
state	object	N	Stan urządzenia, zobacz [Supported device cabilities] po szczegóły.

Przykład żądania :

{
  "directive": {
    "header": {
      "name": "UpdateDeviceStates",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "endpoint": {
      "serial_number": "serial_number"
    },
    "payload": {
       "state": : {
         "power": {
           "powerState": "on"
         }
       }
    }
  }
}

Parametry odpowiedzi: PayloadObject：pusty obiekt Przykład pomyślnej odpowiedzi

{
  "header": {
    "name": "Response",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {}
}

QueryDeviceStates

Parametry żądania: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
state	object	N	Stan urządzenia, zobacz [Supported device cabilities] po szczegóły.

Przykład żądania :

{
  "directive": {
    "header": {
      "name": "QueryDeviceStates",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "endpoint": {
      "serial_number": "serial_number",
      "third_serial_number": "third_serial_number"
    },
    "payload": {
      "state": {
        "power-consumption": {
          "timeRange": {
            "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia statystyk zużycia energii, wymagane.
            "end": "2020-07-05T09:00:00Z"   // Czas zakończenia statystyk zużycia energii, wymagane.
          }
        }
      }
    }
  }
}

Parametry odpowiedzi: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
state	object	N	Stan urządzenia, zobacz [Supported device cabilities] po szczegóły.

Przykład odpowiedzi:

{
  "event": {
    "header": {
      "name": "Response",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "payload": {
      "state": {
        "power-consumption": {
          "electricityIntervals": [ // Podzielone na wiele rekordów w oparciu o configuration.resolution
            {
              "usage": 26.5, // Wartość zużycia energii, wymagane. Typ: number.
              "start": "2020-07-05T08:00:00Z", // Czas rozpoczęcia, wymagane. Typ: date.
              "end": "2020-07-05T09:00:00Z"    // Czas zakończenia, wymagane. Typ: date. Jeśli odstęp między end a start jest mniejszy niż resolution, wszystkie zgłoszone rekordy są uznawane za nieprawidłowe.
            },
            {
              "usage": 26.5, // Wartość zużycia energii, wymagane. Typ: number.
              "start": "2020-07-05T09:00:00Z", // Czas rozpoczęcia, wymagane. Typ: date.
              "end": "2020-07-05T10:00:00Z"    // Czas zakończenia, wymagane. Typ: date. Jeśli odstęp między end a start jest mniejszy niż resolution, wszystkie zgłoszone rekordy są uznawane za nieprawidłowe.
            }
          ]
        }
      }
    }
  }
}

ConfigureDeviceCapabilities

Parametry żądania: PayloadObject：

Atrybut	Typ	Opcjonalne	Opis
capabilities	CapabilityObject[]	N	Lista możliwości. Szczegóły można znaleźć w części obsługiwanych możliwości urządzeń. Uwaga, pole permission nie może być zmienione, przekaż tę samą wartość podczas synchronizacji.

Przykład żądania :

{
  "directive": {
    "header": {
      "name": "ConfigureDeviceCapabilities",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "endpoint": {
      "serial_number": "serial_number"
    },
    "payload": {
      "capabilities": [
        {
          "capability": "thermostat-mode-detect",
          "permission": "0110",
          "name": "temperature", // Typ detekcji kontroli temperatury, wymagane. Opcjonalne wartości: humidity (pomiar wilgotności), temperature (pomiar temperatury)
          "settings": {
            "setpointRange": {
              "permission": "11",
              "type": "object",
              "value": {
                "supported": [ // Obsługiwane ustawienia detekcji, wymagane.
                  {
                    "name": "lowerSetpoint", // Minimalna wartość, którą detekcja powinna utrzymywać. Należy podać albo lowerSetpoint albo upperSetpoint.
                    "value": { // Zakres detekcji, opcjonalne. Wypełnij jeśli istnieją warunki wstępne.
                      "value": 68.0, // Wartość temperatury lub wilgotności, wymagana.
                      "scale": "f" // Jednostka temperatury, wymagana jeśli name=temperature. Opcje: c (Celsjusz), f (Fahrenheit)
                    }
                  },
                  {
                    "name": "upperSetpoint", // Maksymalna wartość, którą detekcja powinna utrzymywać. Należy podać albo lowerSetpoint albo upperSetpoint.
                    "value": { // Zakres detekcji, opcjonalne. Wypełnij jeśli istnieją warunki wstępne.
                      "value": 68.0, // Wartość temperatury lub wilgotności, wymagana.
                      "scale": "f" // Jednostka temperatury, wymagana jeśli name=temperature. Opcje: c (Celsjusz), f (Fahrenheit)
                    }
                  }
                ]
              }
            },
            "supportedModes": {
              "type": "enum",
              "permission": "01",
              "values": [
                "COMFORT",
                "COLD",
                "HOT"
              ]
            }
          }
        }
      ]
    }
  }
}

Parametry odpowiedzi: PayloadObject：pusty obiekt Przykład pomyślnej odpowiedzi

{
  "event": {
    "header": {
      "name": "Response",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "2"
    },
    "payload": {}
  }
}

5. Zdarzenia wysyłane przez serwer

Opis interfejsu MDN EventSource：https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events

5.1 Instrukcja

Bramka obsługuje wysyłanie wiadomości do klienta za pomocą SSE (Server-sent events). Klient może monitorować wiadomości SSE po uzyskaniu poświadczeń dostępu i może parsować zawartość wiadomości push zgodnie z protokołem powiadomień zdarzeń interfejsu programistycznego po otrzymaniu wiadomości wysłanych przez bramkę. Należy zauważyć, że bramka obecnie używa protokołu HTTP1.1, więc SSE po stronie przeglądarki będzie miało maksymalnie nie więcej niż 6 połączeń (Szczegółowe informacje można znaleźć w opisie interfejsu MDN EventSource.)

5.2 Wspólny format

:::porady

• URL：/open-api/V2/sse/bridge

• Metoda：GET ::: Parametry żądania:

Nazwa	Typ	Opcjonalne	Opis
access_token	string	N	Token dostępu

Uwaga: Przy żądaniu połączenia SSE bramka sprawdzi access_token i zwróci błąd autoryzacji, jeśli jest nieprawidłowy. { "error": 401, "data": {}, "message": "invalid access_token"}

## Na przykład: Nazwa modułu: device Wersja: 1,v2,v3 Typ wiadomości: addDevice

Przykład:

const evtSource = new EventSource("http://<nazwa domeny lub adres ip>/open-api/v2/sse/bridge?access_token=xxxxxx");

evtSource.addEventListener('device#v2#addDevice',function (event) {
  try {
    const data = JSON.parse(event.data);
    console.log('data', data);
  } catch (error) {
    console.error(`błąd parsowania`,error);
  }
}

5.3 Moduł urządzeń

a. Zdarzenie dodania urządzenia

:::tips Nazwa modułu：device Wersja：v2 Typ wiadomości：addDevice event.data parametry： :::

Nazwa	Typ	Opcjonalne	Opis
payload	ResponseDeviceObjectObject - Interfejs taki sam jak Pobierz listę urządzeń	N	informacje o urządzeniu

Przykład:

// event.data
{
  "payload": {
    "serial_number": "ABCDEFGHIJK",
    "third_serial_number": "third_serial_number",
    "name": "Moje urządzenie",
    "manufacturer": "SONOFF",
    "model": "BASICZBR3",
    "firmware_version": "1.1.0",
    "display_category": "switch",
    "capabilities": [
      {
        "capability": "power",
        "permission": "1100"
      },
      {
        "capability": "rssi",
        "permission": "0100"
      }
    ],
    "protocal": "zigbee",
    "state": {
      "power": {
        "powerState": "on"
      }
    },
    "tags": {
      "key": "value"
    },
    "online": true
  }
}

b. Zdarzenie aktualizacji stanu urządzenia

:::tips Nazwa modułu：device Wersja：v2 Typ wiadomości：updateDeviceState event.data parametry： :::

Nazwa	Typ	Opcjonalne	Opis
endpoint	EndpointObject	N	Informacje o urządzeniu
payload	object。 Struktura taka sama jak stan urządzenia	N	Dane stanu urządzenia

EndpointObject:

Parametr	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	Y	Unikalny numer seryjny urządzenia stron trzecich. Dla urządzeń podłączonych przez otwarte interfejsy to pole jest wymagane.

Przykład:

// event.data
{
  "endpoint": {
    "serial_number": "serial_number",
    "third_serial_number": "third_serial_number"
  },
  "payload": {
    "power": {
      "powerState": "on"
    },
    "brightness": {
      "brightness": 100
    }
  }
}

c. Zdarzenie aktualizacji informacji o urządzeniu

:::tips Nazwa modułu：device Wersja：v2 Typ wiadomości：updateDeviceInfo event.data parametry： :::

Nazwa	Typ	Opcjonalne	Opis
endpoint	EndpointObject	N	Informacje o urządzeniu
payload	DeviceChangeObject	N	Dane zmiany urządzenia

EndpointObject:

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	Y	Unikalny numer seryjny urządzenia stron trzecich. Dla urządzeń podłączonych przez otwarte interfejsy to pole jest wymagane.

DeviceChangeObject

Nazwa	Typ	Opcjonalne	Opis
name	string	N	Nazwa urządzenia
capabilities	CapabilityObject []	Y	Lista możliwości urządzenia.
tags	object	Y	tagsobject | Nullable | Pary klucz-wartość w formacie JSON dla niestandardowych informacji o urządzeniu.

• Może być używane do przechowywania kanałów urządzenia.

• Może być używane do przechowywania jednostek temperatury.

• Dla innych niestandardowych danych stron trzecich. |

Przykład:

// event.data
{
  "endpoint": {
    "serial_number": "serial_number",
    "third_serial_number": "third_serial_number"
  },
  "payload": {
    "name": "nazwa urządzenia",
    "capabilities": [
      {
        "capability": "thermostat-mode-detect",
        "permission": "0110",
        "name": "temperature", // Typ detekcji kontroli temperatury, wymagane. Opcjonalne wartości: humidity (pomiar wilgotności), temperature (pomiar temperatury)
        "settings": {
          "setpointRange": {
            "permission": "11",
            "type": "object",
            "value": {
              "supported": [ // Obsługiwane ustawienia detekcji, wymagane.
                {
                  "name": "lowerSetpoint", // Minimalna wartość, którą detekcja powinna utrzymywać. Należy podać albo lowerSetpoint albo upperSetpoint.
                  "value": { // Zakres detekcji, opcjonalne. Wypełnij jeśli istnieją warunki wstępne.
                    "value": 68.0, // Wartość temperatury lub wilgotności, wymagana.
                    "scale": "f" // Jednostka temperatury, wymagana jeśli name=temperature. Opcje: c (Celsjusz), f (Fahrenheit)
                  }
                },
                {
                  "name": "upperSetpoint", // Maksymalna wartość, którą detekcja powinna utrzymywać. Należy podać albo lowerSetpoint albo upperSetpoint.
                  "value": { // Zakres detekcji, opcjonalne. Wypełnij jeśli istnieją warunki wstępne.
                    "value": 68.0, // Wartość temperatury lub wilgotności, wymagana.
                    "scale": "f" // Jednostka temperatury, wymagana jeśli name=temperature. Opcje: c (Celsjusz), f (Fahrenheit)
                  }
                }
              ]
            }
          },
          "supportedModes": {
            "type": "enum",
            "permission": "01",
            "values": [
              "COMFORT",
              "COLD",
              "HOT"
            ]
          }
        }
      }
    ]
  }
}

d. Zdarzenie usunięcia urządzenia

:::tips Nazwa modułu：device Wersja：v2 Typ wiadomości：deleteDevice event.data parametry： :::

** Nazwa **	** Typ **	** Opcjonalne**	** Opis **
endpoint	EndpointObject	N	Informacje o urządzeniu

EndpointObject:

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	Y	Unikalny numer seryjny urządzenia stron trzecich. Dla urządzeń podłączonych przez otwarte interfejsy to pole jest wymagane.

Przykład:

// event.data
{
  "endpoint": {
    "serial_number": "serial_number",
    "third_serial_number": "third_serial_number"
  }
}

e. Zdarzenie aktualizacji statusu online urządzenia

:::tips Nazwa modułu：device Wersja：v2 Typ wiadomości：updateDeviceOnline event.data parametry： :::

Nazwa	Typ	Opcjonalne	Opis
endpoint	EndpointObject	N	Informacje o urządzeniu
payload	DeviceChangeObject	N	Dane zmiany urządzenia

EndpointObject:

Atrybut	Typ	Opcjonalne	Opis
serial_number	string	N	Unikalny numer seryjny urządzenia
third_serial_number	string	Y	Unikalny numer seryjny urządzenia stron trzecich. Dla urządzeń podłączonych przez otwarte interfejsy to pole jest wymagane.

DeviceChangeObject

Nazwa	Typ	Opcjonalne	Opis
online	boolean	N	Status online urządzenia

Przykład:

// event.data
{
  "endpoint": {
    "serial_number": "serial_number",
    "third_serial_number": "third_serial_number"
  },
  "payload": {
    "online": false
  }
}

5.4 Moduł bramki

a. Zdarzenie aktualizacji stanu zabezpieczeń

:::tips Nazwa modułu：device Wersja：v2 Typ wiadomości：updateDeviceOnline event.data parametry： :::

Atrybut	Typ	Opcjonalne	Opis
payload	SecurityStateObject	N	Informacje o urządzeniu

SecurityStateObject

Atrybut	Typ	Opcjonalne	Opis
alarm_state	string	N

• arming | Uzbrojony

• disarming | Rozbrojony |

Przykład:

// event.data
{
  "payload": {
    "alarm_state": "alarming"
  }
}

5.5 Moduł bezpieczeństwa

a. Zdarzenie aktualizacji stanu uzbrojenia

:::tips Nazwa modułu：device Wersja：v2 Typ wiadomości：updateDeviceOnline event.data parametry： :::

Atrybut	Typ	Opcjonalne	Opis
payload	ArmStateObject	N	informacje o uzbrajaniu i rozbrajaniu

ArmStateObject：

Atrybut	Typ	Opcjonalne	Opis
arm_state	string	N

• arming | Uzbrojony

• disarming | Rozbrojony | | detail | DetailObject | N | Szczegóły uzbrojenia/rozbrojenia |

DetailObject：

Atrybut	Typ	Opcjonalne	Opis
sid	int	N	安防模式id
name	string	N	nazwa zabezpieczenia

Przykład

// event.data
{
  "payload": {
    "arm_state": "arming",
    "detail": {
      "sid": 1,
      "name": "Home Mode"
    }
  }
}

6. TTS (Funkcja silnika Text-to-Speech)

6.1 Instrukcja

Kluczowa rola

• Dostawca usługi TTS: Dostawca usługi silnika TTS odpowiada za zarejestrowanie silnika TTS na bramce oraz zapewnienie usług TTS

• Serwer bramki：iHost

• Klient Open API bramki

6.1.1 Rejestrowanie usługi silnika TTS

1. 【Dostawca usługi TTS】Wywołuje interfejs, aby zarejestrować silnik TTS na bramce.

2. 【Serwer bramki】Po pomyślnej rejestracji bramka przechowa podstawowe informacje o silniku TTS (w tym adres usługi server_address, a późniejsza komunikacja między bramką a Dostawcą usługi TTS będzie odbywać się przez adres server_address) oraz przydzieli wewnętrzne ID usługi silnika TTS w bramce.

image.png

6.1.2 Pobierz listę zsyntetyzowanych dźwięków

1. 【Klient Open API bramki】Wywołuje interfejs, aby uzyskać listę zarejestrowanych usług silnika TTS. Możesz uzyskać aktualną listę zarejestrowanych silników TTS (w tym ID silnika TTS przydzielone przez bramkę).

2. 【Klient Open API bramki】Wywołuje interfejs, aby uzyskać listę dźwięków dla określonego silnika TTS. Bramka wyda synchroniczne polecenie listy audio do wskazanego Dostawcy usługi TTS i zwróci wynik.

image.png

6.1.3 Syntetyzowanie mowy poprzez określenie silnika mowy

1. 【Klient Open API bramki】Wywołuje interfejs, aby uzyskać listę zarejestrowanych usług silnika TTS. Możesz uzyskać aktualną listę zarejestrowanych silników TTS (w tym ID silnika TTS przydzielone przez bramkę).

2. 【Klient Open API bramki】Wywołuje interfejs, aby uzyskać listę dźwięków dla określonego silnika TTS. Bramka wyda synchroniczne polecenie listy audio do wskazanego Dostawcy usługi TTS i zwróci wynik.

image.png

6.1.4 Syntetyzuj dźwięk i odtwarzaj mowę TTS.

1. 【Klient Open API bramki】Wywołuje interfejs, aby uzyskać listę zarejestrowanych usług silnika TTS. Możesz uzyskać aktualną listę zarejestrowanych silników TTS (w tym ID silnika TTS przydzielone przez bramkę).

2. 【Klient Open API bramki】Wywołuje interfejs, aby uzyskać listę dźwięków dla określonego silnika TTS. Bramka wyda synchroniczne polecenie listy audio do wskazanego Dostawcy usługi TTS i zwróci wynik. (w tym adres pliku audio TTS)

3. 【Klient Open API bramki】Zapisz adres pliku audio TTS z wyniku zwróconego w poprzednim kroku, wywołaj interfejs odtwarzania pliku audio i odtwórz go przez bramkę.

6.2 Moduł silnika TTS

6.2.1 Otwarta zdolność bramki

a. Pobierz listę zarejestrowanych usług silnika TTS

:::porady

• URL：/open-api/V2/rest/tts/engines

• Metoda：GET

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania: brak Poprawna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
engines	EngineObject []	N	Lista zarejestrowanych silników TTS

Struktura EngineObject

Atrybut	Typ	Opcjonalne	Opis
id	string	N	ID silnika przypisane przez bramkę
name	string	N	Nazwa usługi silnika TS

:::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. **Kod statusu: **200 OK Przykład odpowiedzi:： :::

{
  "error": 0,
  "data": {
    "engines": [
      {
        "id": "engine id",
        "name": "engine name"
      }
    ]
  },
  "message": "success"
}

b. Pobierz listę audio dla określonego silnika TTS

:::porady

• URL：/open-api/V2/rest/tts/engine/{id}/audio-list

• Metoda：GET

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania: brak Poprawna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
audio_list	AudioObject []	N	Lista audio

Struktura AudioObject

Atrybut	Typ	Opcjonalne	Opis
url	string	N	URL pliku audio, na przykład:
https://dl.espressif.cn/dl/audio/gs-16b-2c-44100hz.mp3
label	string	Y	Etykieta pliku audio

:::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. **Kod statusu: **200 OK **Kod błędu: **

• 190000 Silnik działa nieprawidłowo

Przykład odpowiedzi:： :::

{
  "error": 0,
  "data": {
    "audio_list": [
      {
        "url": "adres audio tts", // na przykład: https://dl.espressif.cn/dl/audio/gs-16b-2c-44100hz.mp3
        "label": "etykieta audio tts"
      }
    ]
  },
  "message": "success"
}

c. Wykonaj syntezę mowy przy użyciu określonego silnika TTS

:::porady

• URL：/open-api/V2/rest/tts/engine/{id}/synthesize

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
text	string	N	Tekst używany do syntezy audio
label	string	Y	Etykieta pliku audio
language	string	Y	Pole przeźroczyste. Opcjonalny kod języka dla żądania syntezy mowy. Konkretna lista obsługiwanych kodów językowych jest dostarczana przez dostawcę usługi silnika TTS. Należy zauważyć, że usługa silnika TTS musi obsługiwać domyślny język do syntezy mowy, co oznacza, że jeśli język nie zostanie przekazany, do syntezy zostanie użyty domyślny język silnika.
options	object	Y	Pole przeźroczyste. Służy do przekazania parametrów konfiguracyjnych wymaganych do syntezy do usługi silnika TTS.

Poprawna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
audio	AudioObject	N	Lista audio

Struktura AudioObject

Atrybut	Typ	Opcjonalne	Opis
url	string	N	URL pliku audio, na przykład:
https://dl.espressif.cn/dl/audio/gs-16b-2c-44100hz.mp3
label	string	Y	Etykieta pliku audio

:::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. **Kod statusu: **200 OK **Kod błędu: **

• 190000 Silnik działa nieprawidłowo

Przykład odpowiedzi:： :::

{
  "error": 0,
  "data": {
    "audio": {
        "url": "adres audio tts" // na przykład, https://dl.espressif.cn/dl/audio/gs-16b-2c-44100hz.mp3
        "label": "etykieta audio tts"
    }
  },
  "message": "success"
}

6.2.2 Komunikacja między bramką a usługą TTS

a. Rejestrowanie usługi silnika TTS

Wyślij żądanie do bramki przez Dostawcę usługi TTS

:::porady

• URL：/open-api/V2/rest/thirdparty/event

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
event	EventObject	N	Struktura obiektu zdarzenia żądania Informacje

EventObject

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa żądania. Parametr opcjonalny.

• RegisterTTSEngine | | message_id | string | N | ID wiadomości żądania, UUID_V4 | | version | string | N | Numer wersji protokołu żądania. Obecnie stały: 1 |

PayloadObject

Atrybut	Typ	Opcjonalne	Opis
service_address	string	N	Adres usługi. Na przykład, http:///
name	string	N	Nazwa usługi

Przykład żądania:

{
  "event": {
    "header": {
      "name": "RegisterTTSEngine",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {
        "service_address": "service_address",
        "name": "tts service name"
    }
  }
}

**Poprawne parametry odpowiedzi: **

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa nagłówka odpowiedzi. Parametr opcjonalny:

• Odpowiedź (odpowiedź pomyślna)

• ErrorResponse (odpowiedź z błędem) | | message_id | string | N | ID wiadomości nagłówka odpowiedzi, UUID_V4. Nadchodzące żądanie wiadomości tutaj: header.message_id | | version | string | N | Numer wersji protokołu żądania. Obecnie stały: 1 |

PayloadObject

Atrybut	Typ	Opcjonalne	Opis
engine_id	string	N	ID silnika przypisane przez bramkę

:::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. **Kod statusu: **200 OK Przykład odpowiedzi:： ::: Przykład poprawnej odpowiedzi:：

{
    "header": {
      "name": "Response",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {
      "engine_id": "engine id"
    }
  }

**Parametry odpowiedzi w przypadku nieprawidłowości: **

Atrybut	Typ	Opcjonalne	Opis
type	string	N	Typ błędu

• INVALID_PARAMETERS (Błąd parametrów)

• AUTH_FAILURE (Błąd uwierzytelniania)

• INTERNAL_ERROR (Wewnętrzny błąd usługi) | | description | string | N | Opis błędu |

Przykład odpowiedzi błędu:：

{
  "header": {
    "name": "ErrorResponse",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {
    "type": "INVALID_PARAMETERS",
    "description": "service_address nie może być puste" 
  }
}

b. Synchronizuj polecenie listy audio

Wyślij polecenie do Dostawcy usługi TTS przez bramkę.

:::porady

• URL：<adres usługi>

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
directive	DirectiveObject	N	Informacje o strukturze obiektu instrukcji

DirectiveObject

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa żądania. Parametr opcjonalny:

• SyncTTSAudioList | | message_id | string | N | ID wiadomości żądania, UUID_V4 | | version | string | N | Numer wersji protokołu żądania. Obecnie stały: 1 |

Przykład żądania:

{
  "directive": {
    "header": {
      "name": "SyncTTSAudioList",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {}
  }
}

**Poprawne parametry odpowiedzi: **

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa nagłówka odpowiedzi. Parametr opcjonalny:

• Odpowiedź (odpowiedź pomyślna)

• ErrorResponse (odpowiedź z błędem) | | message_id | string | N | ID wiadomości nagłówka odpowiedzi, UUID_V4. Nadchodzące żądanie wiadomości tutaj: header.message_id | | version | string | N | Numer wersji protokołu żądania. Obecnie stały: 1 |

PayloadObject:

Atrybut	Typ	Opcjonalne	Opis
audio_list	AudioObject []	N	Lista audio TTS

Struktura AudioObject

Atrybut	Typ	Opcjonalne	Opis
url	string	N	URL pliku audio, na przykład:
https://dl.espressif.cn/dl/audio/gs-16b-2c-44100hz.mp3
label	string	Y	Etykieta pliku audio

:::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. **Kod statusu: **200 OK Przykład odpowiedzi:： ::: Przykład poprawnej odpowiedzi:：

{
    "header": {
      "name": "Response",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {
      "audio_list": [
        {
            "url": "url audio tts",
            "label": "etykieta audio tts"
        }
      ]
    }
}

**Parametry odpowiedzi w przypadku nieprawidłowości: **

Atrybut	Typ	Opcjonalne	Opis
type	string	N	Typ błędu

• INVALID_PARAMETERS (Błąd parametrów)

• AUTH_FAILURE (Błąd uwierzytelniania)

• INTERNAL_ERROR (Wewnętrzny błąd usługi) | | description | string | N | Opis błędu |

Przykład odpowiedzi błędu:：

{
  "header": {
    "name": "ErrorResponse",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {
    "type": "INVALID_PARAMETERS",
    "description": "service_address nie może być puste" 
  }
}

c. Polecenie syntezy mowy

Wyślij polecenie do Dostawcy usługi TTS przez bramkę.

:::porady

• URL：<adres usługi>

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
directive	DirectiveObject	N	Informacje o strukturze obiektu instrukcji

DirectiveObject

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa żądania. Parametr opcjonalny:

• SynthesizeSpeech | | message_id | string | N | ID wiadomości żądania: UUID_V4 | | version | string | N | Numer wersji protokołu żądania. Obecnie stały: 1 |

PayloadObject

Atrybut	Typ	Opcjonalne	Opis
text	string	N	Tekst używany do syntezy audio
label	string	Y	Etykieta pliku audio
language	string	Y	Pole przeźroczyste. Opcjonalny kod języka dla żądania syntezy mowy. Konkretna lista obsługiwanych kodów językowych jest dostarczana przez dostawcę usługi silnika TTS. Należy zauważyć, że usługa silnika TTS musi obsługiwać domyślny język do syntezy mowy, co oznacza, że jeśli język nie zostanie przekazany, do syntezy zostanie użyty domyślny język silnika.
options	object	Y	Pole przeźroczyste. Służy do przekazania parametrów konfiguracyjnych wymaganych do syntezy do usługi silnika TTS.

Przykład żądania:

{
    "directive": {
        "header": {
            "name": "SynthesizeSpeech",
            "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
            "version": "1"
        },
        "payload": {
            "text": "Tekst wejściowy do syntezy.",
            "label": "etykieta audio tts"
        }
    }
}

**Poprawne parametry odpowiedzi: **

Atrybut	Typ	Opcjonalne	Opis
header	HeaderObject	N	Struktura nagłówka żądania
payload	PayloadObject	N	Struktura ładunku żądania

HeaderObject

Atrybut	Typ	Opcjonalne	Opis
name	string	N	Nazwa nagłówka odpowiedzi. Parametr opcjonalny:

• Odpowiedź (odpowiedź pomyślna)

• ErrorResponse (odpowiedź z błędem) | | message_id | string | N | ID wiadomości nagłówka odpowiedzi, UUID_V4. Nadchodzące żądanie wiadomości tutaj: header.message_id | | version | string | N | Numer wersji protokołu żądania. Obecnie stały: 1 |

PayloadObject

Atrybut	Typ	Opcjonalne	Opis
audio	AudioObject	N	Audio TTS

Struktura AudioObject

Atrybut	Typ	Opcjonalne	Opis
url	string	N	URL pliku audio, na przykład:
https://dl.espressif.cn/dl/audio/gs-16b-2c-44100hz.mp3
label	string	Y	Etykieta pliku audio

:::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. **Kod statusu: **200 OK Przykład odpowiedzi:： ::: Przykład poprawnej odpowiedzi:：

{
    "header": {
      "name": "Response",
      "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
      "version": "1"
    },
    "payload": {
      "audio": {
        "url": "url audio tts",
        "label": "etykieta audio tts"
      }
    }
}

**Parametry odpowiedzi w przypadku nieprawidłowości: **

Atrybut	Typ	Opcjonalne	Opis
type	string	N	Typ błędu

• INVALID_PARAMETERS (Błąd parametrów)

• AUTH_FAILURE (Błąd uwierzytelniania)

• INTERNAL_ERROR (Wewnętrzny błąd usługi) | | description | string | N | Opis błędu |

Przykład odpowiedzi błędu:：

{
  "header": {
    "name": "ErrorResponse",
    "message_id": "Unikalny identyfikator, najlepiej UUID w wersji 4",
    "version": "1"
  },
  "payload": {
    "type": "INVALID_PARAMETERS",
    "description": "service_address nie może być puste" 
  }
}

7. Moduł multimedialny

7.1 Odtwarzanie pliku audio

:::porady

• URL：/open-api/V2/rest/media/audio-player

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
audio_url	string	N	Adres URL audio

Poprawna odpowiedź z danymi: :::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. **Kod statusu: **200 OK Przykład odpowiedzi:： :::

{
  "error": 0,
  "data": {},
  "message": "success"
}

8. Niestandardowa karta UI

Niestandardowe karty UI pozwalają wyświetlać dowolne treści w karcie. Treść ta może być stroną internetową, obrazem lub dowolną usługą z interfejsem użytkownika. Wystarczy podać URL treści, którą chcesz wyświetlić. Karta UI automatycznie dopasuje swoją szerokość i wysokość, a zawartość zostanie wyrenderowana przy użyciu iFrame.

8.1 Instrukcja

Kluczowa rola

• Dostawca usługi UI: Dostawca odpowiedzialny za tworzenie niestandardowych kart UI na bramce.

• Serwer bramki: Serwer bramki (iHost).

• Klient Open API bramki: Klient Open API dla bramki.

8.1.1 Tworzenie niestandardowej karty UI

• [Dostawca usługi UI]: Wywołuje API w celu utworzenia niestandardowej karty UI na bramce.

• [Serwer bramki]: Po pomyślnej rejestracji bramka przechowuje podstawowe informacje o karcie UI (w tym konfigurację rozmiaru i URL zasobu karty) oraz przydziela wewnętrzne ID karty UI w bramce.

image.png

8.1.2 Pobieranie listy kart UI

• [Dostawca usługi UI]: Wywołuje API, aby pobrać listę kart UI.

• [Serwer bramki]: Zwraca listę kart UI przechowywanych na bramce, w tym niestandardowe karty UI nie utworzone przez wywołującego.

image.png

8.1.3 Modyfikowanie konfiguracji określonej karty UI

• [Dostawca usługi UI]: Wywołuje API, aby zmodyfikować konfigurację określonej karty UI, taką jak konfiguracja rozmiaru i URL zasobu.

• [Serwer bramki]: Po pomyślnej modyfikacji bramka zapisuje zaktualizowane informacje o karcie UI, w tym nową konfigurację rozmiaru i URL zasobu.

image.png

8.1.4 Usuwanie niestandardowej karty UI

1. [Dostawca usługi UI]: Wywołuje API, aby usunąć określoną niestandardową kartę UI.

2. [Serwer bramki]: Bramka usunie wszystkie informacje związane z określoną kartą UI.

image.png

8.2 Moduł niestandardowej karty UI

8.2.1 Tworzenie niestandardowej karty UI

Dostawca usługi UI wysyła żądanie do bramki w celu utworzenia niestandardowej karty UI.

:::porady

• URL：/open-api/v2/rest/ui/cards

• Metoda：POST

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
label	string	Y	Etykieta karty: Służy do opisu karty. Jest to alias karty.
cast_settings	CastSettingsObject	Y	Ustawienia karty Cast: Ustawienia konfiguracyjne dla kart cast.
web_settings	WebSettingsObject	N	Ustawienia karty Web: Ustawienia konfiguracyjne dla kart web.

CastSettingsObject:

Atrybut	Typ	Opcjonalne	Opis
dimensions	DimensionObject []	N	Konfiguracja rozmiaru: Musi zawierać co najmniej jedną konfigurację.
domyślny	string	N	Specyfikacja domyślna: Domyślna specyfikacja rozmiaru jest używana, z opcjonalnymi parametrami: 2x2

WebSettingsObject:

Atrybut	Typ	Opcjonalne	Opis
dimensions	DimensionObject []	N	Konfiguracja rozmiaru: Musi zawierać co najmniej jedną konfigurację.
drawer_component	DrawerObject	Y	Ustawienia wyświetlania komponentu Drawer.
domyślny	string	N	Specyfikacja domyślna:

• 1x1

• 2x1 |

DimensionObject:

Atrybut	Typ	Opcjonalne	Opis
src	string	N	URL zasobu: Na przykład: http://example.html
size	string	N	Specyfikacje rozmiaru:
Opcjonalne parametry CastSettingsObject:

• 2×2

Opcjonalne parametry WebSettingsObject:

• 1x1

• 2x1 |

DrawerObject:

Atrybut	Typ	Opcjonalne	Opis
src	string	N	URL zasobu: Na przykład: http://example.html

Pomyślna odpowiedź z danymi:

Atrybut	Typ	Opcjonalne	Opis
id	string	N	Unikalne ID karty UI

:::porady Warunki: Parametry żądania są prawidłowe i weryfikacja tożsamości użytkownika została pomyślnie przeprowadzona. **Kod stanu: ** 200 OK ::: 示例 żądania：

{
  "label": "ewelink cube card",
  "cast_settings": {
    "dimensions": [
      {
        "src": "https://ewelink.cc/ewelink-cube/",
        "size": "2×2"
      }
    ],
    "default": "2×2"
  },
  "web_settings": {
    "dimensions": [
      {
        "src": "https://ewelink.cc/ewelink-cube/",
        "size": "2×1"
      },
      {
        "src": "https://ewelink.cc/ewelink-cube/",
        "size": "1×1"
      }
    ],
    "drawer_component": {
      "src": "https://ewelink.cc/ewelink-cube/"
    },
    "default": "2×1"
  }
}

Przykład odpowiedzi:

{
  "error": 0,
  "data": {
    "id": "72cc5a4a-f486-4287-857f-b482d7818b16"
  },
  "message": "success"
}

8.2.2 Pobierz listę kart UI

:::porady

• URL：/open-api/v2/rest/ui/cards

• Metoda：GET

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania: Brak Parametry odpowiedzi:

Atrybut	Typ	Opcjonalne	Opis
data	CardObject[]	N	Lista kart UI

CardObjec Object:

Atrybut	Typ	Opcjonalne	Opis
id	string	N	ID karty: Unikalny identyfikator karty.
label	string	Y	Etykieta karty: Służy do opisu karty. Pełni funkcję aliasu lub nazwy karty.
cast_settings	CastSettingsObject	Y	Etykieta karty: Służy do opisu karty. Jest to alias karty.
web_settings	WebSettingsObject	N	Ustawienia karty Cast: Ustawienia konfiguracyjne dla kart cast.
app_name	string	Y	Ustawienia karty Web: Ustawienia konfiguracyjne dla kart web.

CastSettingsObject:

Atrybut	Typ	Opcjonalne	Opis
dimensions	DimensionObject []	N	Konfiguracja rozmiaru: Musi zawierać co najmniej jedną konfigurację.
domyślny	string	N	Specyfikacja domyślna:
Parametr opcjonalny: 2x2
używany	string	N	Aktualna specyfikacja:
Parametr opcjonalny: 2x2

WebSettingsObject:

Atrybut	Typ	Opcjonalne	Opis
dimensions	DimensionObject []	N	Konfiguracja rozmiaru: Musi zawierać co najmniej jedną konfigurację.
drawer_component	DrawerObject	Y	Ustawienia wyświetlania komponentu Drawer.
domyślny	string	N	Specyfikacja domyślna:
Parametr opcjonalny:

• 1x1

• 2x1 | | used | string | N | Aktualna specyfikacja: Parametr opcjonalny:

• 1x1

• 2x1 |

DimensionObject:

Atrybut	Typ	Opcjonalne	Opis
src	string	N	URL zasobu: Na przykład: http://example.html
size	string	N	Specyfikacje rozmiaru:
Parametr opcjonalny:

• 1x1

• 2x1

Uwaga: Obecnie karty cast obsługują tylko specyfikację 2x2. Specyfikacja 2x2 nie będzie skuteczna. |

DrawerObject:

Atrybut	Typ	Opcjonalne	Opis
src	string	N	URL zasobu: Na przykład: http://example.html

Przykład odpowiedzi:

{
  "error": 0,
  "data": [
    {
      "id": "72cc5a4a-f486-4287-857f-b482d7818b16",
      "label": "ewelink cube card",
      "cast_settings": {
        "dimensions": [
          {
            "src": "https://ewelink.cc/ewelink-cube/",
            "size": "2×2"
          }
        ],
        "default": "2×2",
        "used": "2×2"
      },
      "web_settings": {
        "dimensions": [
          {
            "src": "https://ewelink.cc/ewelink-cube/",
            "size": "2×1"
          },
          {
            "src": "https://ewelink.cc/ewelink-cube/",
            "size": "1×1"
          }
        ],
        "drawer_component": {
          "src": "https://ewelink.cc/ewelink-cube/"
        },
        "default": "2×1",
        "used": "2×1"
      },
      "appName": "ewelink-cube"
    }
  ],
  "message": "success"
}

8.2.3 Modyfikacja konfiguracji określonej karty UI

Autoryzowani użytkownicy mogą modyfikować konfigurację istniejącej karty UI za pomocą tego interfejsu. Dostawcy usług niestandardowych kart mogą modyfikować tylko karty UI, które sami utworzyli.

:::porady

• URL：/open-api/v2/rest/ui/cards/{id}

• Metoda：PUT

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania:

Atrybut	Typ	Opcjonalne	Opis
label	string	Y	Służy do opisu karty. Jest to alias karty.
cast_settings	CastSettingsObject	Y	Ustawienia karty Cast
web_settings	WebSettingsObject	Y	Ustawienia karty Web

CastSettingsObject:

Atrybut	Typ	Opcjonalne	Opis
używany	string	Y, Którykolwiek używany lub src musi być dostarczony, ale wymagany jest co najmniej jeden z tych parametrów.	Aktualna specyfikacja:
Parametr opcjonalny:

• 2x2

| | src | string | Y, Którykolwiek używany lub src musi być dostarczony, ale wymagany jest co najmniej jeden z tych parametrów. | URL zasobu: http://example.html |

WebSettingsObject:

Atrybut	Typ	Opcjonalne	Opis
używany	string	Y, Którykolwiek używany lub src musi być dostarczony, ale wymagany jest co najmniej jeden z tych parametrów.	Aktualna specyfikacja:
Parametr opcjonalny:

• 1x1

• 2x1 | | src | string | Y, Którykolwiek używany lub src musi być dostarczony, ale wymagany jest co najmniej jeden z tych parametrów. | URL zasobu: http://example.html |

Pomyślna odpowiedź z danymi: :::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. Karta UI będąca przedmiotem modyfikacji musi być utworzona przez dostawcę niestandardowych kart UI wywołującego interfejs. **Kod statusu: ** 200 OK Kod błędu:

• 406: Brak uprawnień do dostępu do tego zasobu ::: **Przykład odpowiedzi: **

{
  "error": 0,
  "data": {},
  "message": "success"
}

**Przykład żądania: **

{
  "cast_settings": {
    "used": "2×2"
  },
  "web_settings": {
    "used": "1×1"
  }
}

8.2.4 Usuwanie niestandardowej karty UI

Autoryzowani użytkownicy mogą usuwać istniejącą kartę UI za pomocą tego interfejsu. Dostawcy niestandardowych kart mogą usuwać tylko karty UI, które sami utworzyli.

:::porady

• URL：/open-api/v2/rest/ui/cards/{id}

• Metoda：DELETE

• Nagłówek：

  • Content-Type: application/json

  • Autoryzacja: Bearer ::: Parametry żądania: Brak Pomyślna odpowiedź z danymi: :::tips Warunki: Parametry żądania są prawidłowe, a weryfikacja tożsamości użytkownika zakończona pomyślnie. Karta UI będąca przedmiotem modyfikacji musi być utworzona przez dostawcę niestandardowych kart UI wywołującego interfejs. **Kod statusu: ** 200 OK Kod błędu:

• 406: Brak uprawnień do dostępu do tego zasobu. ::: **Przykład odpowiedzi: **

{
  "error": 0,
  "data": {},
  "message": "success"
}