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

Interface to the Rules API

See the official documentation for more information.

Link to this section Summary

Functions

Creates a new rule in the bridge rule engine.

Deletes the specified rule from the bridge.

Gets a list of all rules that are in the bridge.

Returns a rule object with id matching <id> or an error if <id> is not available.

Updates a rule in the bridge rule engine.

Link to this section Functions

Link to this function

create_rule(bridge, attributes)

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

Creates a new rule in the bridge rule engine.

Link to this function

delete_rule(bridge, rule_id)

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

Deletes the specified rule from the bridge.

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

Gets a list of all rules that are in the bridge.

Link to this function

get_rule_attributes(bridge, rule_id)

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

Returns a rule object with id matching <id> or an error if <id> is not available.

Link to this function

update_rule(bridge, rule_id, attributes)

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

Updates a rule in the bridge rule engine.