huex v0.5.0 Huex
Elixir client for Philips Hue connected light bulbs.
- Query functions return the response from the API.
- Command functions return a
Bridge
struct in order to be pipeline friendly.
Read more on the GitHub page.
Summary
Types
Group identifier can be either a numberic or a binary (e.g. “1”). Special group 0 always contains all the lights
Tuple containing respectively the hue (0-65535), staturation (0-255) and value/brillance (0-255) components
Light identifier can be either a numberic or a binary (e.g. “1”)
Possible status of a Bridge
Tuple containing the x (0-0.8) and y (0-0.8) component of the color
Functions
Requests authorization for the given username
on the given bridge
.
Returns an “authorized” connection
Creates a connection with the bridge available on the given host or IP address. Requires the connection to be authorized
Fetches all informations available about the given group
connected to the bridge
.
Requires the connection to be authorized
Lists the light groups configured for the given bridge
.
Requires the connection to be authorized
Fetches all informations available in the bridge
Fetches all informations available about the given light
connected to the bridge
.
Requires the connection to be authorized
Lists the lights connected to the given bridge
.
Requires the connection to be authorized
Sets the brigthness of the given light (a value between 0 and 1). Requires the connection to be authorized
Sets the brigthness of the given light (a value between 0 and 1) using the given transition time (in ms). Requires the connection to be authorized
Sets the color of the given light using Philips’ proprietary bi-dimensional color space. Requires the connection to be authorized
Sets the color of the given light using Philips’ proprietary bi-dimensional color space using the given transition time (in ms). Requires the connection to be authorized
Sets the brigthness of the given group (a value between 0 and 1). Requires the connection to be authorized
Sets the brigthness of the given group (a value between 0 and 1) using the given transition time (in ms). Requires the connection to be authorized
Sets the color of the given group using Philips’ proprietary bi-dimensional color space. Requires the connection to be authorized
Sets the color of the given group using Philips’ proprietary bi-dimensional color space using the given transition time (in ms). Requires the connection to be authorized
Sets the state of the given group. For a list of accepted keys, look at the state
object in the response of group_info
Requires the connection to be authorized
Sets the state of the given light. For a list of accepted keys, look at the state
object in the response of light_info
Requires the connection to be authorized
Turns the given group off. Requires the connection to be authorized
Turns the given group off using the given transition time (in ms). Requires the connection to be authorized
Turns the given group on. Requires the connection to be authorized
Turns the given group on using the given transition time (in ms). Requires the connection to be authorized
Turns the given light off. Requires the connection to be authorized
Turns the given light off using the given transition time (in ms). Requires the connection to be authorized
Turns the given light on. Requires the connection to be authorized
Turns the given light on using the given transition time (in ms). Requires the connection to be authorized
Types
group :: non_neg_integer | binary
Group identifier can be either a numberic or a binary (e.g. “1”). Special group 0 always contains all the lights.
hsv_color :: {non_neg_integer, non_neg_integer, non_neg_integer}
Tuple containing respectively the hue (0-65535), staturation (0-255) and value/brillance (0-255) components
light :: non_neg_integer | binary
Light identifier can be either a numberic or a binary (e.g. “1”)
status :: nil | :ok | :error
Possible status of a Bridge
xy_color :: {float, float}
Tuple containing the x (0-0.8) and y (0-0.8) component of the color
Functions
Specs
authorize(Huex.Bridge.t, binary) :: Huex.Bridge.t
Requests authorization for the given username
on the given bridge
.
Returns an “authorized” connection.
The authorization process is as follow:
- Call
authorize
once, it will return an error - Press the link button on top of your bridge device
- Call
authorize
again with the same parameters, it should succeed
Specs
connect(binary, binary) :: Huex.Bridge.t
Creates a connection with the bridge available on the given host or IP address. Requires the connection to be authorized.
Specs
group_info(Huex.Bridge.t, group) :: Map.t
Fetches all informations available about the given group
connected to the bridge
.
Requires the connection to be authorized.
Specs
groups(Huex.Bridge.t) :: Map.t
Lists the light groups configured for the given bridge
.
Requires the connection to be authorized.
Specs
light_info(Huex.Bridge.t, light) :: Map.t
Fetches all informations available about the given light
connected to the bridge
.
Requires the connection to be authorized.
Specs
lights(Huex.Bridge.t) :: Map.t
Lists the lights connected to the given bridge
.
Requires the connection to be authorized.
Specs
set_brightness(Huex.Bridge.t, light, float) :: Huex.Bridge.t
Sets the brigthness of the given light (a value between 0 and 1). Requires the connection to be authorized.
Specs
set_brightness(Huex.Bridge.t, light, float, non_neg_integer) :: Huex.Bridge.t
Sets the brigthness of the given light (a value between 0 and 1) using the given transition time (in ms). Requires the connection to be authorized.
Specs
set_color(Huex.Bridge.t, light, xy_color) :: Huex.Bridge.t
set_color(Huex.Bridge.t, light, hsv_color) :: Huex.Bridge.t
Sets the color of the given light using Philips’ proprietary bi-dimensional color space. Requires the connection to be authorized.
Specs
set_color(Huex.Bridge.t, light, xy_color, non_neg_integer) :: Huex.Bridge.t
set_color(Huex.Bridge.t, light, hsv_color, non_neg_integer) :: Huex.Bridge.t
Sets the color of the given light using Philips’ proprietary bi-dimensional color space using the given transition time (in ms). Requires the connection to be authorized.
Specs
set_group_brightness(Huex.Bridge.t, group, float) :: Huex.Bridge.t
Sets the brigthness of the given group (a value between 0 and 1). Requires the connection to be authorized.
Specs
set_group_brightness(Huex.Bridge.t, group, float, non_neg_integer) :: Huex.Bridge.t
Sets the brigthness of the given group (a value between 0 and 1) using the given transition time (in ms). Requires the connection to be authorized.
Specs
set_group_color(Huex.Bridge.t, group, xy_color) :: Huex.Bridge.t
set_group_color(Huex.Bridge.t, group, hsv_color) :: Huex.Bridge.t
Sets the color of the given group using Philips’ proprietary bi-dimensional color space. Requires the connection to be authorized.
Specs
set_group_color(Huex.Bridge.t, group, xy_color, non_neg_integer) :: Huex.Bridge.t
set_group_color(Huex.Bridge.t, group, hsv_color, non_neg_integer) :: Huex.Bridge.t
Sets the color of the given group using Philips’ proprietary bi-dimensional color space using the given transition time (in ms). Requires the connection to be authorized.
Specs
set_group_state(Huex.Bridge.t, group, Map.t) :: Huex.Bridge.t
Sets the state of the given group. For a list of accepted keys, look at the state
object in the response of group_info
Requires the connection to be authorized.
Specs
set_state(Huex.Bridge.t, light, Map.t) :: Huex.Bridge.t
Sets the state of the given light. For a list of accepted keys, look at the state
object in the response of light_info
Requires the connection to be authorized.
Specs
turn_group_off(Huex.Bridge.t, group) :: Huex.Bridge.t
Turns the given group off. Requires the connection to be authorized.
Specs
turn_group_off(Huex.Bridge.t, group, non_neg_integer) :: Huex.Bridge.t
Turns the given group off using the given transition time (in ms). Requires the connection to be authorized.
Specs
turn_group_on(Huex.Bridge.t, group) :: Huex.Bridge.t
Turns the given group on. Requires the connection to be authorized.
Specs
turn_group_on(Huex.Bridge.t, group, non_neg_integer) :: Huex.Bridge.t
Turns the given group on using the given transition time (in ms). Requires the connection to be authorized.
Specs
turn_off(Huex.Bridge.t, light) :: Huex.Bridge.t
Turns the given light off. Requires the connection to be authorized.
Specs
turn_off(Huex.Bridge.t, light, non_neg_integer) :: Huex.Bridge.t
Turns the given light off using the given transition time (in ms). Requires the connection to be authorized.
Specs
turn_on(Huex.Bridge.t, light) :: Huex.Bridge.t
Turns the given light on. Requires the connection to be authorized.
Specs
turn_on(Huex.Bridge.t, light, non_neg_integer) :: Huex.Bridge.t
Turns the given light on using the given transition time (in ms). Requires the connection to be authorized.