UNPKG

domoticz-api-linker

Version:

Domoticz API Javascript Bridge Connector

github.com/lalmat/domoticz-api

lalmat/domoticz-api

129 lines (81 loc) • 4.21 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
## Devices ### **domoticz.deviceManager.items()** Get all devices, including the hidden ones --- ### **domoticz.deviceManager.getByIdx(idx)** Get a specific device using the idx device property value. | Parameter | Description | | --------- | ----------------------------------- | | idx | idx value of the device in Domoticz | --- ### **domoticz.deviceManager.getByType(filter, orderBy="Name")** Get all devices of a certain type. | Parameter | Description | | --------- | -------------------------------------- | | filter | a supported device type | | orderBy | device property to use during order by | > `filter` is an item of `domoticz.deviceTypes.*` like `domoticz.deviceType.LIGHT` --- ### **domoticz.deviceManager.getFavorites()** Get Domoticz Favorites Devices --- ### **domoticz.deviceManager.switch(idx, command="On")** Change state of a Light/Switch device. | Parameter | Description | | --------- | --------------------------------------------------------- | | idx | idx value of the device in Domoticz | | command | A Domoticz device command On/Off/... **case sensitive !** | --- ### **domoticz.deviceManager.toggle(idx)** Toggle a Light/Switch device. | Parameter | Description | | --------- | ----------------------------------- | | idx | idx value of the device in Domoticz | --- ### **domoticz.deviceManager.rename(idx, newName)** Rename the device | Parameter | Description | | --------- | ----------------------------------- | | idx | idx value of the device in Domoticz | | newName | New name of the device | --- ### **domoticz.deviceManager.protect(idx, state)** Change protection mode of the device. An administrator password is needed in a popup to switch a protected device. | Parameter | Description | | --------- | ----------------------------------- | | idx | idx value of the device in Domoticz | | state | true/false | --- ### **domoticz.deviceManager.updateTemperature(idx, temperature)** Update the temperature associated to the device (Termometers). | Parameter | Description | | ----------- | ----------------------------------- | | idx | idx value of the device in Domoticz | | temperature | Numeric value of the temperature | --- ### **domoticz.deviceManager.updateHumidity(idx, humidityPercent, humidityState)** Update the temperature associated to the device (Termometers). | Parameter | Description | | --------------- | ----------------------------------------- | | idx | idx value of the device in Domoticz | | humidityPercent | Percent of humidity, ex: 45% | | humidityState | 0: Normal, 1: Confortable, 2: Dry, 3: Wet | --- ### **domoticz.deviceManager.updateBarometer(idx, barometer, barometerForecast)** Update the temperature associated to the device (Termometers). | Parameter | Description | | --------------- | ----------------------------------- | | idx | idx value of the device in Domoticz | | humidityPercent | Atmospheric Pressure | | humidityState | a deviceHumidityType | > Use a `domoticz.deviceHumidityTypes.*` (or if your device is a 'General' type, use one of `domoticz.deviceHumidityGeneralTypes.*` instead. ### **domoticz.deviceManager.updateDevice(idx, sValue, nValue = 0)** This is a generic device update, used by update devices methods above. You can use this method if there's no specific method for an update. Refer to the [Domoticz API](https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's#Update_devices.2Fsensors) to find what to use as `sValue` and `nValue`. | Parameter | Description | | --------- | ------------------------------------ | | idx | idx value of the device in Domoticz | | sValue | sValue param of API calls | | nValue | nValue param of API call (default:0) |