alias: 'Desktop Dye Client'
description: ''
trigger:
  - platform: state
    entity_id:
      - input_text.YOUR_TEXT_INPUT_ENTITY
condition: []
action:
  - service: light.turn_on
    target:
      entity_id: light.YOUR_LIGHT_GROUP
    data:
      transition: 2
      rgb_color:
        - >-
          {{ states.input_text.YOUR_TEXT_INPUT_ENTITY.state.split("
          ")[0].split(",")[0] }}
        - >-
          {{ states.input_text.YOUR_TEXT_INPUT_ENTITY.state.split("
          ")[0].split(",")[1] }}
        - >-
          {{ states.input_text.YOUR_TEXT_INPUT_ENTITY.state.split("
          ")[0].split(",")[2] }}
      brightness_pct: >-
        {{ states.input_text.YOUR_TEXT_INPUT_ENTITY.state.split("
        ")[0].split(",")[3] }}
mode: single

# The ID of the screen to capture colors from.
# Is optional. If not specified, the screen primary screen is used.
# Run the application to see a list of screens and their IDs.
screen_id:

# The endpoint of the Home Assistant instance to send the colors to.
# This can usually be set to http://homeassistant.local:8123
# Is required. If not specified, the application will not start.
ha_endpoint: http://homeassistant.local:8123

# The API token to use to authenticate with Home Assistant.
# Is required. If not specified, the application will not start.
ha_token:

# The Home Assistant entity ID to send the colors to.
# This should be a text helper entity, and will usually start with 'input_text.'
# Is required. If not specified, the application will not start.
ha_target_entity_id:

# The amount of colors to sample and send to Home Assistant.
#
# Note that, depending on the algorithm used, the amount of colors sent may be less than
# this value.
#
# Is optional. If not specified, the application will sample 3 colors per capture.
# Must be between 1 and 10 (inclusive).
sample_size: 3

# The algorithm to use to select the colors to send to Home Assistant.
#
# There are two algorithms:
# - 'color_thief': A fast algorithm that selects the most dominant colors.
#   This is the default algorithm, and is relatively accurate for most use cases.
# - 'pigmnts': A slower algorithm based on the kmeans-algorithm that selects the
#    most dominant colors. Though generally slightly more accurate, it is also
#    significantly slower and not recommended for most use cases.
#
# Is optional. If not specified, the default 'color_thief' algorithm is used.
algorithm: color_thief

# The amount of seconds to wait between color captures.
#
# In other words, every this many seconds, the application will capture the colors on the
# screen, and send them to Home Assistant (if it is not already sending colors, and if the
# colors have changed).
#
# Is optional. If not specified, the application will capture colors every 3 seconds.
capture_interval: 3.0

# Selects the mode of color selection.
#
# This determines what colors are sent to Home Assistant, and in what order.
#
# There are three modes:
# - 'default': Orders the colors by occurrence, with the most dominant color first.
# - 'brightest': Orders the colors by brightness, with the brightest color first.
# - 'hue_shift': A special mode where a set of hues around the most dominant color are sent,
#    creating a gradient. In this mode, the primary color is not sent first, and may not
#    be sent at if the amount of colors in the gradient is an even number.
#
# Is optional. If not specified, the default mode is used.
mode: default

# Determines the amount of degrees of shift to use when selecting hues.
#
# This is only used when the mode is set to 'hues'.
#
# This value is used to shift the primary color to the left and right, creating a gradient.
# For example, if this is set to 45.0, the primary color will be shifted 45 degrees to the
# left and right, creating a gradient with a width of 90 degrees (with the primary color
# in the middle).
#
# Is optional. If not specified, the default value of 45.0 degrees is used.
hue_shift: 45.0

# Determines the format in which the colors are sent to Home Assistant.
#
# There are two formats:
# - 'rgb': The colors are sent as a comma-separated list of RGB values.
#   RGB values consist of three components; red, green, and blue,
#   and are integers in the range of 0-255 (inclusive).
#   Example: "255,255,0 255,0,0 0,255,0"
# - `rgbb`: The colors are sent as a comma-separated list of RGB values, with a brightness
#   component at the end. This is the default format.
#   The RGB values are integers in the range of 0-255 (inclusive), while
#   the brightness value is a float in the range of 0.0-100.0 (inclusive).
#   This is useful since Home Assistant devices generally don't support setting the brightness
#   through the RGB values, and instead require a separate brightness value.
#   Example: "255,255,0,100.0 255,0,0,100.0 0,255,0,100.0"
# - `hsb`: The colors are sent as a comma-separated list of HSB (hue, saturation, brightness)
#   values. While this format is more accurate, it is also more difficult to work with in
#   Home Assistant, and can lead to unexpected results in color accuracy. However, this is
#   the only format that supports setting a specific brightness for Home Assistant lights,
#   which the RGB format does not support.
#   HSB values are in the range of floats 0.0-360.0 for hue and floats 0.0-100.0 for the
#   saturation and brightness.
#   Example: "60.0,100.0,100.0 0.0,100.0,100.0 120.0,100.0,100.0"
#
# Is optional. If not specified, the default format (`rgbb`) is used.
color_format: rgbb

# Determines the factor by which to increase the brightness of every color.
#
# If provided, the brightness of every color is multiplied by this value. This
# is useful if the colors are too dark, or if the brightness of the colors is
# not sufficient for your lighting setup.
#
# Note that brightness values are clamped to the range of 0.0-100.0 (inclusive).
# Setting this value lower than 1.0 will decrease the brightness of the colors,
# while setting it to 0.0 will result in all colors being black.
#
# Example:
# - brightness_factor = 0.5, base brightness = 50.0, result = 25.0
# - brightness_factor = 2.0, base brightness = 50.0, result = 100.0
# - brightness_factor = 2.0, base brightness = 75.0, result = 100.0 (clamped)
#
# Is optional. If not specified, it is set to 1.0, which means no brightness
# adjustment is performed.
brightness_factor: 1.0

$ which desktop_dye_cli
## Take note of the path to the desktop_dye_cli binary, then run the following command.

sudo setcap cap_sys_admin+ep path/to/desktop_dye_cli
## Replace path/to/desktop_dye_cli with the actual path to the binary from the first command.