react to 'LIFX' api response error codes

Description

react to 'LIFX' api response error codes

Usage

check_lifx_response(response)

Arguments

Value

depending on the status either: an error; a warning and the response as is; the response as is without any message.

References

error messages copied from https://api.developer.lifx.com/docs/errors

LIFX': A package for controlling 'LIFX' smart bulbs

Description

The 'LIFX' R package is an interface to the ['LIFX' smart bulb api](https://api.developer.lifx.com/docs).

most important 'LIFX' functions

• lx_save_token

• lx_list_lights

• lx_color

• lx_effect_breathe and other effects

GET request

Description

GET request

Usage

lx_GET(selector = "all", endpoint, token = lx_get_token())

Arguments

Value

an 'httr' response object (see response)

POST request

Description

POST request

Usage

lx_POST(selector = "all", endpoint, token, ...)

Arguments

Value

an 'httr' response object (see response)

PUT request

Description

PUT request

Usage

lx_PUT(selector = "all", endpoint, token, ...)

Arguments

Value

an 'httr' response object (see response)

check if 'LIFX' color name is valid

Description

check if 'LIFX' color name is valid

Usage

lx_check_color(color_name, token = lx_get_token())

Arguments

Details

calls the API endpoint https://api.lifx.com/v1/color to check if the color is valid.

Value

logical TRUE if the color name is valid; FALSE if not; throws an error if the API could not be reached or another issue occurred.

Examples

## Not run: 
lx_check_color("INVALID_COLOR_NAME") # invalid 'LIFX' color string returns FALSE
lx_check_color("#FFFFFF") # valid 'LIFX' color string returns TRUE
lx_check_color("orange") # valid 'LIFX' color string returns TRUE
lx_check_color('brightness:1 hue:50') # valid 'LIFX' color string returns TRUE

## End(Not run)

change the state of 'LIFX' lamps

Description

change the state of 'LIFX' lamps

Usage

lx_color(
  hue = NULL,
  saturation = NULL,
  brightness = NULL,
  kelvin = NULL,
  duration = NULL,
  infrared = NULL,
  color_name = NULL,
  fast = FALSE,
  delta = FALSE,
  selector = "all",
  power = NULL,
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

Examples

## Not run: 
lx_color(hue = 200)
lx_color(saturation = 0.8)
lx_color(hue = 200, saturation = 0.5, brightness = 0.5)
lx_color(color_name = 'cyan', brightness = 1)
lx_color(kelvin = 5000, fast = TRUE)
lx_color(brightness = -0.3, delta = TRUE)

## End(Not run)

picking a color by name or hsbk

Description

picking a color by name or hsbk

Usage

lx_color_name(
  hue = NULL,
  saturation = NULL,
  brightness = NULL,
  kelvin = NULL,
  color_name = NULL,
  check = TRUE,
  token = lx_get_token()
)

Arguments

Value

a character string specifying a light color as expected by the 'LIFX' API. Outputs from this function have their own class and printing style, but a pure character string can be used just as well.

Examples

## Not run: 

strong_red <- lx_color_name(hue = 0, saturation = 1, brightness = 1)
lx_color(color_name = strong_red)

dim_green <- lx_color_name(color_name = "#00FF00", saturation = 1, brightness = 0.1)
lx_color(color_name = dim_green)

unsaturated_cyan <- lx_color_name(color_name = "cyan", saturation = 0.3)
lx_color(color_name = unsaturated_cyan)

## End(Not run)

Change light state relative to current state (wrapper for POST state delta

Description

Change light state relative to current state (wrapper for POST state delta

Usage

lx_delta(
  hue = NULL,
  saturation = NULL,
  brightness = NULL,
  kelvin = NULL,
  infrared = NULL,
  duration = 0,
  power = NULL,
  selector = "all",
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

References

https://api.developer.lifx.com/docs/state-delta

"Breathe" effect

Description

"Breathe" effect

Usage

lx_effect_breathe(
  color,
  from_color = NULL,
  period = 1,
  cycles = 1,
  persist = FALSE,
  power_on = TRUE,
  peak = 0.5,
  selector = "all",
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

Examples

## Not run: 
lx_effect_breathe(color = "red",from_color = "blue",period = 3,cycles = 5,power_on = TRUE)

## End(Not run)

"Flame" effect

Description

"Flame" effect

Usage

lx_effect_flame(
  period = 5,
  duration = 10^10,
  power_on = TRUE,
  fast = FALSE,
  selector = "all",
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

Examples

## Not run: 
lx_effect_flame(period = 2, duration = 3)

## End(Not run)

"Morph" effect

Description

"Morph" effect

Usage

lx_effect_morph(
  period = 5,
  duration = 10^10,
  palette,
  power_on = TRUE,
  fast = FALSE,
  selector = "all",
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

Examples

## Not run: 
lx_effect_morph(period = 2, palette = c("red", "blue"))

## End(Not run)

"Move" effect

Description

"Move" effect

Usage

lx_effect_move(
  direction = "forward",
  period = 1,
  cycles = 10^10,
  power_on = TRUE,
  fast = FALSE,
  selector = "all",
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

Examples

## Not run: 
lx_effect_move(direction = "backward", period = 2, cycles = 5)

## End(Not run)

Turn effects off

Description

Turn effects off

Usage

lx_effect_off(power_off = FALSE, selector = "all", token = lx_get_token())

Arguments

Value

an 'httr' response object (see response)

Examples

## Not run: lx_effect_off()

"Pulse" effect

Description

"Pulse" effect

Usage

lx_effect_pulse(
  color,
  from_color = NULL,
  period = 1,
  cycles = 1,
  persist = FALSE,
  power_on = TRUE,
  selector = "all",
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

Examples

## Not run: 
lx_effect_pulse(color = "red",from_color = "blue", period = 3,cycles = 5, persist = TRUE)

## End(Not run)

retrieve lifx_token from R environment

Description

retrieve lifx_token from R environment

Usage

lx_get_token()

Details

To use the 'LIFX' API, you need to get a personal access token from your 'LIFX' account. Usually you save API tokens in your r environment file; that way you only have to enter it once per system. How to get a token: 1. go to https://cloud.lifx.com/sign_in and sign in (if you do not have an account, you must download the mobile app and register there. 2. generate or look up your access token

You do not need to save the token in the environment; you can use all functions in this package by passing a valid 'token' argument.

Value

the 'LIFX' api token found in environmental variables

See Also

lx_has_token, lx_save_token

Examples

## Not run: 
lx_get_token()

## End(Not run)

check whether a lifx api token is stored in the R environment file.

Description

check whether a lifx api token is stored in the R environment file.

Usage

lx_has_token()

Details

To use the 'LIFX' API, you need to get a personal access token from your 'LIFX' account. Usually you save API tokens in your r environment file; that way you only have to enter it once per system. How to get a token: 1. go to https://cloud.lifx.com/sign_in and sign in (if you do not have an account, you must download the mobile app and register there. 2. generate or look up your access token

You do not need to save the token in the environment; you can use all functions in this package by passing a valid 'token' argument.

Value

logical TRUE if a token was found

See Also

lx_save_token, lx_get_token

Examples

lx_has_token()

list available lights

Description

list available lights

Usage

lx_list_lights(selector = "all", token = lx_get_token())

Arguments

Details

each item in the returned list contains (depending on the type of lamp), the following named items:

• Reachability: connected, last_seen, seconds_since_seen

• Light identifiers / selectors: id, uuid, label, group, location

• Status: power, color, brightness, effect

• Hardware information: product

Value

a list with each item representing one light. Each item itself is a list with all relevant information about the light and it's state

Examples

## Not run: 
lx_list_lights()

lights <- lx_list_lights(
  lx_selector(location = "kitchen")
)

first_kitchen_light <- lights[[1]]

first_kitchen_light$power
first_kitchen_light$color$hue
first_kitchen_light$color$saturation

first_kitchen_light$group


## End(Not run)

get 'LIFX' API rate limit

Description

get 'LIFX' API rate limit

Usage

lx_rate_limit(token = lx_get_token())

Arguments

Value

a named vector of three numbers:

1. 'limit': The rate limit 2. 'remaining': how many calls are remaining 3. 'reset': the Unix timestamp for when the next window begins. Usually every minute.

Examples

## Not run: lx_rate_limit()

save a lifx API token in your r environment file

Description

save a lifx API token in your r environment file

Usage

lx_save_token(token)

Arguments

Details

To use the 'LIFX' API, you need to get a personal access token from your 'LIFX' account. Usually you save API tokens in your r environment file; that way you only have to enter it once per system. How to get a token: 1. go to https://cloud.lifx.com/sign_in and sign in (if you do not have an account, you must download the mobile app and register there. 2. generate or look up your access token

You do not need to save the token in the environment; you can use all functions in this package by passing a valid 'token' argument.

Value

logical TRUE if saving token has been successful

See Also

lx_has_token, lx_get_token

Examples

## Not run: 
lx_save_token("asodfjawea9499fao8u4a09fw0s8fu439wfrsud7") # put your token here

## End(Not run)

select lights

Description

use this function to select lights that you want to communicate with

Usage

lx_selector(
  id = NULL,
  label = NULL,
  group_id = NULL,
  group = NULL,
  location_id = NULL,
  location = NULL,
  zones = NULL
)

Arguments

Details

this creates strings to select lamps in the format that the 'LIFX' api expects (see https://api.developer.lifx.com/docs/selectors). This function is intended to be used to create a 'selector' that is then passed to a function that changes the state of the lamps.

Value

a character string in the format expected by the 'LIFX' API for selectors. It has it's own class and printing style, but a regular character string can be used just as well.

Examples

lx_selector(id = '1234')
lx_selector(label = "my_light")
lx_selector(location = 'kitchen', zone = 3)
lx_selector(location = 'kitchen', group = 'ceiling')

set light state (lifx API endpoint PUT set state)

Description

set light state (lifx API endpoint PUT set state)

Usage

lx_state(
  power = NULL,
  color_name = NULL,
  brightness = NULL,
  infrared = NULL,
  duration = 0,
  fast = FALSE,
  selector = "all",
  token = lx_get_token()
)

Arguments

Value

an 'httr' response object (see response)

References

https://api.developer.lifx.com/docs/set-state

Toggle light

Description

Toggle light

Usage

lx_toggle(duration = 0, selector = "all", token = lx_get_token())

Arguments

Examples

## Not run: 
lx_toggle(duration = 5)
lx_toggle(selector = lx_selector(location = "kitchen"))

## End(Not run)