View Source HueSDK.API.Configuration (HueSDK v0.1.1)

Interface to the Configuration API.

See the official documentation for more information.

Link to this section Summary

Functions

Creates a new user. The link button on the bridge must be pressed and this command executed within 30 seconds.

Returns list of all configuration elements in the bridge. Note all times are stored in UTC.

This command is used to fetch the entire datastore from the device, including settings and state information for lights, groups, schedules and configuration. It should only be used sparingly as it is resource intensive for the bridge, but is supplied e.g. for synchronization purposes.

Allows the user to set some configuration values.

Link to this section Functions

Link to this function

create_user(bridge, device_type)

View Source

Creates a new user. The link button on the bridge must be pressed and this command executed within 30 seconds.

Once a new user has been created, the user key is added to a ‘whitelist’, allowing access to API commands that require a whitelisted user. At present, all other API commands require a whitelisted user.

Link to this function

get_bridge_config(bridge)

View Source
@spec get_bridge_config(HueSDK.Bridge.t()) :: HueSDK.HTTP.response()

Returns list of all configuration elements in the bridge. Note all times are stored in UTC.

Link to this function

get_bridge_datastore(bridge)

View Source
@spec get_bridge_datastore(HueSDK.Bridge.t()) :: HueSDK.HTTP.response()

This command is used to fetch the entire datastore from the device, including settings and state information for lights, groups, schedules and configuration. It should only be used sparingly as it is resource intensive for the bridge, but is supplied e.g. for synchronization purposes.

Link to this function

modify_bridge_config(bridge, config)

View Source
@spec modify_bridge_config(HueSDK.Bridge.t(), map()) :: HueSDK.HTTP.response()

Allows the user to set some configuration values.