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

Interface to the Scenes API.

See the official documentation for more information.

Link to this section Summary

Functions

Creates the given scene with all lights in the provided lights resource.

Deletes a scene from the bridge.

Gets a list of all scenes currently stored in the bridge.

Gets the attributes of a given scene.

Modifies or creates a new scene.

Link to this section Functions

Link to this function

create_scene(bridge, attributes)

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

Creates the given scene with all lights in the provided lights resource.

Link to this function

delete_scene(bridge, scene_id)

View Source
@spec delete_scene(HueSDK.Bridge.t(), String.t()) :: HueSDK.HTTP.response()

Deletes a scene from the bridge.

@spec get_all_scenes(HueSDK.Bridge.t()) :: HueSDK.HTTP.response()

Gets a list of all scenes currently stored in the bridge.

Link to this function

get_scene_attributes(bridge, scene_id)

View Source
@spec get_scene_attributes(HueSDK.Bridge.t(), String.t()) :: HueSDK.HTTP.response()

Gets the attributes of a given scene.

Link to this function

modify_scene(bridge, scene_id, attributes)

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

Modifies or creates a new scene.