sampleName

associationAdd

The original request that served to create the action.

Basement

End date and time for manual mode (timestamp)

End date and time for vacation mode (timestamp)

Start date and time for vacation mode (timestamp)

name

Field required for PartitionBreached type. Does not occur in PartitionArmed and PartitionDisarmed.

Field required for PartitionArmed and PartitionDisarmed types. Does not occur in PartitionBreached.

associationClear

Lifeline

Does group support Multichannel Associations

associationRemove

associationSet

associationSetAll

First floor zone

Continue binding process. It should be send only if any of actions is in Confirm state.

other

Sample title

Action which will be run on the service. Value depends on service value.

test

sunrise

String representing time period for which we want data to be returned. It is complient with ISO-8601 and accepts values like: YYYY (2019) YYYY-MM (2019-07) YYYY-Www (2020-W01 week 01 is the week containing first Thursday of a year) YYYY-MM-DD (2020-01-12) YYYY-MM-DDThh (2020-01-12T13). This parameter must be in gateway (not browser) timezone.

setValue

deviceName

MultilevelSensor

List of device ids for which we want to add/delete interfaces.

List of interfaces which we want to add/delete to/from devices.

cpu0

cpu1

Cancel ongoing binding process.

Ongoing Binding process can be cancel in any stage.
Conflict error will be returned if binding is in Idle/Success/Failure or Canceled state.


Binding request conflicts with current binding process state

Confirm that device was bound successfully.

This action is allowed only in 'Bound' state. In other states Conflict error will be returned.


Mimics device random movement.

To finish elero binding process user has to send movement keys that mimic device's random moves.
This action is allowed only in 'Binding' state. In other states Conflict error will be returned.


Trigger new binding process.

There can be only one ongoing binding process whether it is a nice or an elero process.
Conflict error will be returned if other ongoing process exists.


Binding request was sent to device. Device will start moving randomly up and down.
User should copy these moves in the user interface. After few correct moves device will be bound.


Device was bound. User can test if it works correctly and finish or cancel binding process.

Binding process finished. If device was already bound it will be unbound.

This state is the same as Idle in the sense that there are no ongoing processes.
New binding process can be issued in this state.


Binding process Failed. If device was already bound it will be unbound.

This state is the same as Idle in the sense that there are no ongoing processes.
New binding process can be issued in this state.


There are no ongoing binding processes. User can start the new one.

Binding request was accepted and added to queue.

Binding process finished. Device was created in HC Server.

This state is the same as Idle in the sense that there are no ongoing processes.
New binding process can be issued in this state.


Send test commands to bounded device.

After device was bound user can test if device operates properly by sending up/down/stop command.
Test process is not mandatory and user can confirm or reject bound process without tests.
This action is allowed only in 'Bound' state. In other states Conflict error will be returned.


How long the billing period lasts - curently only 1,2,3,6,12 months are supported

Day at which billing period ended: YYYY-MM-DD. This value is empty for current period.

Day at which billing period started: YYYY-MM-DD

Cost of energy consumed during billig period

name of device; this is important if record coresponds to device that is already deleted

Id of room the device is in; this is important if record coresponds to device that is already deleted

table lamp

refrigerator

wallplug

Finishes binding process. If something did successfully bind, appropriate devices will be populated to HC

This flag only denotes that this HC can become a slave, but not necessarily with this master. version and zwaveEngineVersion needs to be taken into account.

Serial number of slave that is going to be added to network

Identification number assigned by master.

com.fibaro.yrWeather

Describes whether the plugin is predefined in the system.

remaing time in seconds of remote access (provided only if remoteAccess==true)

indicates whether insteller can use remote acces to gateway

List of linked devices ids in which the device is used.

HCProvider

Thermostat

My Home

Location type. If 'true': Home location, if 'false': Other location. There can be only one Home Location

The latitude of the location in EPSG:4326 coordinate system

The longitude of the location in EPSG:4326 coordinate system

Timestamp: Date and time of last modification

Temperature Unit: Celsius (C) or Fahrenheit(F)

Time zone difference, in minutes, from current locale (host system settings) to UTC

Climate panel Heating/Cooling mode (Auto -> control heating and cooling, Heat -> only heating, Cool -> only cooling, Off -> system is turned off)

DeviceName

One of available device type from provider. If not specified use outputType.

Data describing the characteristics of individual notifications. Data specific to particular types of notifications.

Scene id associated with notification. Return SatelConfigurationRequest, FirmwareUpdateRequest and GenericDeviceRequest

Additional info about firmware update. Return for FirmwareUpdateRequest

Notification name. Return for GenericSystemNotificationRequest

Progress of the operation related to notification (in percent: 0-100). Return for SatelConfigurationRequest and FirmwareUpdateRequest

Scene id associated with notification. Return for GenericSceneRequest

Notification status for FirmwareUpdateNotification. Possible options: 'Available', 'QueuedForUpdate', 'Downloading', 'WaitingForCommunication', 'Updating', 'UpdateOk', 'UpdateFail', 'UpToDate', 'QueuedForCheck'. Return for GenericSystemNotificationRequest

Additional type for GenericSystemNotification. Possible options: 'Generic', 'EmailInvalid', 'DeviceNotConfigured', 'DeviceNoTemplate', 'NoFibaroPartitionInAlarm', 'ZwavePollingTime', 'UserNameDuplicated'. Return for GenericSystemNotificationRequest

Task id associated with notification. Return for ZwaveReconfigurationNotificationRequest

Text describing the notification, visible in the notification center.Return for GenericDeviceRequest, GenericSceneRequest and GenericSystemNotificationRequest

Notification title. Return for GenericDeviceRequest and GenericSceneRequest

Notification button url. Return for GenericSystemNotificationRequest

Notification button text. Return for GenericSystemNotificationRequest

Notification icon. Return for GenericDeviceRequest

Flag:if true: notification can be deleted, if false: notificaiton can't be deleted

Notification priority: 'info', 'warning' or 'alert'

Notification type, each type of notification has its own data structure

Flag: if true: notification marked as read, if false: notification marked as unread

Climate panel operation mode (Schedule, Manual or Vacation)

button_001

The Text displayed as the content of the button

Magic page

horizontal_001

image_001

label_001

The text to be displayed inside of the label.

select_001

The text to be displayed next to component.

slider_001

space_001

switch_001

vertical_001

Vacation

turnOn

Home

Away

main

newRoom

If scene is running return true otherwise false.

front garden weekend

New schedule name

Idle denotes initial (unbind) state

WaitForClick1 - wait for user to click button on remote controller. User should click button that control action he is going to bind.

WaitForClick2 - wait for user to click the same button.

Confirm denotes that confirmation is required from user for process to continue, i.e. binding mode was enabled on gate/screen.

Fail denotes that binding action for one or more targets failed. User can retry binding by repeating the same bind request. Only failed targets will be retried.


title

The Gateway Software is constantly developed and improved, particularly taking into account users' comments on the functionality of the software, as well as in order to fix errors and to enable configuration of the Gateway with existing and new peripheral devices, manufactured by the Producer and by other entities ('Peripheral Devices')....

User 1

plugin1

Home Center 3 REST Api

programID

deviceId

Returns list of all additional interfaces

interfaceName

Returns list of all devices id which can add this additional interface.

Get list of all devices id which can add this additional interface.

Returns list of devices that may be added to partition

The start time 'from' which historical entries will be shown. Default value is 0 if not specifiad.

from

The end time 'to' which historical entries will be shown. Default value is current timestamp if not specifiad.

The number of items to skip before starting to collect the result set. Default value is 50 if not specifiad.

pageSize

The number of items to return. Default value is 0 if not specifiad.

page

Sort history records by timestamp either in ascending or descending(default) order.

order

Filter history records by type. If not specified return all records.

type

Returns list of historical entries that match query criterias

Returns list of alarm partitions allowed for logged user

Partitions in read only mode due to breached

Creates new alarm partition. The partition will be disarmed by default.

Fibaro-User-PIN

PIN. It is optional and depends on user settings

Returns list of alarm partition ids allowed for logged user

partitionID

Partition in read only mode, due to armed or due to breached

Partition with given id has been disarmed

nodeId

actionId

It's not allowed to delete action, e.g. action is in progress.

List of groups information from all endpoints.

Node was not found or it does not handle AGI.

Returns static information about association groups for given nodeId.

List of all endpoints association groups.

Returns all associations for given nodeId

endpointId

Returns static information about association groups for given {nodeId, endpointId}

Returns all associations for given {nodeId, endpointId}

Timestamp in seconds - from when we want to have data. For last hour type: 'now-3600'

timestampFrom

Timestamp in seconds - for when we want to have data. For now type: 'now'

timestampTo

Conflict. Custom event with provided name already exists

customEventName

Custom event with provided name already exists

filter

types

Filter messages younger than or equal to parameter value in timestamp.

Filter messages older than or equal to parameter value in timestamp.

The identifier of the message that will be returned first. If last is set to 0 then return from the newest message.

last

Number of returned messages. -1 means all messages.

offset

Return list of device notifications settings

Get information about device notifications settings

deviceID

Device notifications setting has been deleted

Clear notifications settings for given device

Get notifications settings for given device

Device notifications settings has been set

Update notifications settings for given device

roomID

interface

timestamp

Not found if one of device does not exist or one of intefaces is unsupported

actionName

Return timestamp and id of action if delay specified.

Returns status of current binding process.

Conflict with current binding process state.

Returns sum of energy cost, production and consumption for whole house for current and previous billing periods

Summary of energy cost and consumption during current and last billing periods

Array of time periods for which data is returned

period

Returns sum of energy consumption broken down into rooms

roomId

Returns sum of energy consumption in room broken down into devices

Details of energy production/consumption in room

Returns sum of energy production and consumption for whole house with list of top consuming devices

Returns date and cost of energy installation