Package 'ekl'

Title: R Based Controls For Elgato Key Lights
Description: Provides functions to control Elgato Key lights using their built in API.
Authors: Mark Sellors [aut, cre]
Maintainer: Mark Sellors <[email protected]>
License: MIT + file LICENSE
Version: 0.0.0.9000
Built: 2024-10-31 02:47:41 UTC
Source: https://github.com/sellorm/ekl

Help Index


Get's the current state of your Elgato Key Light

Description

Get's the current state of your Elgato Key Light

Usage

get_state(keylight_ip = NULL)

Arguments

keylight_ip

optional IP address of your Keylight. Setting the EKL_IP env var is preferred


Fine grained control of the light state

Description

Fine grained control of the light state

Usage

set_state(state, brightness = NA, temp = NA, keylight_ip = NULL)

Arguments

state

One of "on" or "off"

brightness

int from 1-100. If not supplied the current setting is retained.

temp

int corresponding to the desired colour temperature (143-344) If not supplied the current setting is retained.

keylight_ip

optional IP address of your Keylight. Setting the EKL_IP env var is preferred


Toggles the light on/off

Description

Toggles the light on/off

Usage

toggle(keylight_ip = NULL)

Arguments

keylight_ip

optional IP address of your Keylight. Setting the EKL_IP env var is preferred