This request delivers data about a gatway. Also useful to check if a gateway exists.
gateway/slcHardwareID of gateway
GET
-
-
| Entity | Type | Nullable | Description |
|---|---|---|---|
| gateway | array (mainEntity) | no |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| id | int | no | slcID of gateway |
| hw_id | string | no | slcHardwareID of a gateway |
| name | string | yes | name |
| customer_id | int | no | slcID of customer |
| latitude | float | no | latitude (WGS84) |
| longitude | float | no | longitude (WGS84) |
| rf_channel | byte | no | current rf channel (0-3) |
| rf_pin | ushort | no | current rf pin code (0-9999) |
| env_brightness_master | bool | yes | true if this device is acting as environment brightness master |
| ext_out_config | array[4] (gatewayExtOutConfig) | no | configuration of logical output (0-4 entries) |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| output_type | int (outputType) | no | type of output |
| name | string | yes | Frei definierbarer Name der logischen Ausgangs-Konfiguration |
| physical_outputs | byte[4] - 0-4 entries | no | Zeigt auf einen oder mehrere physikalische, nicht invertierende Ausgänge (0-3); Im Latching-Modus sind dies die "Ein / On"-Ausgänge |
| physical_inv_outputs | byte[4] - 0-4 entries | no | Zeigt auf einen oder mehrere physikalische, invertierende Ausgänge (0-3); Im Latching-Modus sind dies die "Aus / Off"-Ausgänge |
| pulse_duration | int | no | Puls-Dauer für gepulste-Ausgänge (Latching) in ms (default = 1000ms) |
| pulse_repeat_interval | int | yes | Puls-Wiederholdauer (Latching) in ms (Default = 10000ms) |
| state_feedback_input | byte | yes | Id (2-3) des externen Erweiterungseingangs für die Statusrückführung (PulseFeedback-Typ) 2-3: Digital Eingang (ExtIn 3 oder 4) |
| state_feedback_input_inverted | bool | yes | Definiert, ob der Status-Feedback-Eingang invertiert werden soll. |
| operationMode_type | int (operationModeType) | no | Typ des Ausgangs-Betriebsmodus |
| default_state | bool | yes | Default-Ausgangsstatus (ein/aus) für die Modi: Const (0); Time (1); TimeAndBrightness (3); TimeOrBrightness (4); Manual (8); Central Control (9) |
| env_brightness_on | byte | yes | Einschaltpunkt im Umgebungshelligkeits-Modus (Roh-Wert) |
| env_brightness_off | byte | yes | Ausschaltpunkt im Umgebungshelligkeits-Modus (Roh-Wert) |
| time_slices | array[32] (gatewayExtOutTimeSlice) | yes | Im Time-Modus (2, 4, 5): Zeit/Wochentags-Zeitschlitz (1-32 Einträge) |
| ainput_on_value | float | yes | Einschaltpunkt des Analogen Erweiterungs-Eingangs (in Volt) |
| ext_input | byte | yes | Id (0-3) des externen Erweiterungseingangs im DInput oder AInput-Modus: 0-1: Analog Eingang (ExtIn 1 oder 2) 2-3: Digital Eingang (ExtIn 3 oder 4) |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| days | byte (flags) | no | Weekday(s) when this time slice is active |
| output_state | bool | no | Ausgangsstatus (true = high; false = low) während dieser Zeitschlitz aktiv ist |
| start_time | time | no | start time of this time slice |
| end_time | time | no | end time of this time slice |
| start_date | date | yes | Start date of this time slice. Wenn null => Nur nach Zeit / Wochentage |
| end_date | date | yes | End date of this time slice. Wenn null => Nur nach Zeit / Wochentage |
| Value | Description |
|---|---|
| 0 | Static |
| 1 | Latching |
| 2 | PulseFeedback |
| Value | Description |
|---|---|
| 0 | Permanent aus- / ausgeschaltet (Konstanter Wert) |
| 1 | Nach Datum / Zeit / Wochentag |
| 2 | Nach Umgebungshelligkeit |
| 3 | Nach Zeit und Umgebungshelligkeit |
| 4 | Nach Zeit oder Umgebungshelligkeit |
| 5 | Nach digitalem Erweiterungs-Eingang |
| 6 | Nach digitalem Erweiterungs-Eingang (invertiert) |
| 7 | Nach analogem Erweiterungs-Eingang |
| 8 | Manuell mit virtuellem Schalter (auf Gateway) |
| 9 | Zentral (von der Webanwendung) kontrolliert: Jobs => ein / aus |
n.a.
{
"gateway": {
"id": 48,
"hw_id": "8119905F-ED5AD56C-89860823-A1FA05CE",
"name": "Demo Hess",
"customer_id": 10,
"latitude": null,
"longitude": null,
"rf_channel": 0,
"rf_pin": 0,
"env_brightness_master": false,
"ext_out_config": []
}
}