Plugin API
Plugin API description.
Signature of methods from/config.json.
gateway/setItemValueCommand
Set item value.
One of parameters "item_id" or "item_ids" should be specified.
signature:
Field | Type | Required | Description |
---|---|---|---|
item_id | string | - | Item object id |
item_ids | array of strings | - | List of items to send multicast request |
value | depends on item type | + | New item value. |
gateway/addItemDictionaryValueCommand
Add value to item with dictionary type.
signature:
Field | Type | Required | Description |
---|---|---|---|
item_id | string | + | Item object id |
value_type | strings | + | Type of value in dictionary |
value | depends on item type | + | Value to add |
gateway/setItemDictionaryValueCommand
Change dictionary record value.
signature:
Field | Type | Required | Description |
---|---|---|---|
item_id | string | + | Item object id |
key | string | + | Dictionary record id |
value_type | strings | + | Type of value in dictionary |
value | depends on item type | + | Value to add |
gateway/removeItemDictionaryValueCommand
Delete dictionary record.
signature:
Field | Type | Required | Description |
---|---|---|---|
item_id | string | + | Item object id |
key | string | + | Dictionary record id |
gateway/resetSettingCommand
Reset setting to default.
One of "setting_id" and "device_id" parameters should be specified, "setting_id" takes precedence.
signature:
Field | Type | Required | Description |
---|---|---|---|
setting_id | string | - | Setting object id |
device_id | string | - | Device object id |
gateway/setSettingValueCommand
Change setting value.
signature:
Field | Type | Required | Description |
---|---|---|---|
setting_id | string | + | Setting object id |
value | depends on setting type | - | Value to set. Not required for action settings. |
gateway/setSettingDictionaryValueCommand
Change dictionary setting record value.
signature:
Field | Type | Required | Description |
---|---|---|---|
setting_id | string | + | Setting object id |
key | string | + | Record id |
value | depends on setting type | - | Value to set. If not specified, dictionary record should be deleted. |