8.3 KiB
Table of Contents
yahuelib
yahuelib.controller
LightController Objects
class LightController(_BaseController)
Control a Philips Hue Light using the API of your Hue Bridge.
Arguments:
number: int- The number of your lightbridge_ip_address: str- The IP address of your Hue Bridgebridge_api_user: str- The user used to authenticate to the API
Use the class method .from_name(name:str, ...) to use the name of a light instead of the number.
check_reachable
def check_reachable() -> bool
Check if the light is reachable
check_on
def check_on() -> bool
Check if the light is on
set_on
def set_on(on: bool)
Turn the light on/off
get_brightness
def get_brightness() -> int
Get the brightness
set_brightness
def set_brightness(brightness: float)
Set the brightness
get_hue
def get_hue() -> int
Get the hue
set_hue
def set_hue(hue: float)
Set the hue
get_saturation
def get_saturation() -> int
Get the saturation
set_saturation
def set_saturation(saturation: float)
Set the saturation
get_color_temperature
def get_color_temperature()
Get the white color temperature in Mired
set_color_temperature
def set_color_temperature(mired: int)
Set the white color temperature in Mired (154 - 500)
alert
def alert()
Flash the light once.
alert_long
def alert_long()
Flash the light for 10 seconds.
GroupController Objects
class GroupController(_BaseController)
Control a Philips Hue Light Group (Room/Zone) using the API of your Hue Bridge.
Arguments:
number: int- The number of your light groupbridge_ip_address: str- The IP address of your Hue Bridgebridge_api_user: str- The user used to authenticate to the API
Use the class method .from_name(name:str, ...) to use the name of a group instead of the number.
check_any_on
def check_any_on() -> bool
Check if any light in this group is on
check_all_on
def check_all_on() -> bool
Check if all lights in this group are on
set_all_on
def set_all_on(on: bool)
Turn on/off all lights in this group
get_brightness
def get_brightness() -> int
Get the last set brightness in this group
set_brightness
def set_brightness(brightness: float)
Set the brightness of all lights in this group
get_hue
def get_hue() -> int
Get the last set hue in this group
set_hue
def set_hue(hue: float)
Set the hue of all lights in this group
get_saturation
def get_saturation() -> int
Get the last set saturation in this group
set_saturation
def set_saturation(saturation: float)
Set the saturation of all lights in this group
get_color_temperature
def get_color_temperature()
Get the last set white color temperature in Mired
set_color_temperature
def set_color_temperature(mired: int)
Set the white color temperature in Mired (154 - 500) for all lights in this group
alert
def alert()
Flash all lights in the group once.
alert_long
def alert_long()
Flash all lights in the group for 10 seconds.
yahuelib.utils
rgb_to_hsv
def rgb_to_hsv(r: int, g: int, b: int) -> tuple
Convert RGB colors (255, 220, 100) to HSV (0.129, 0.608, 1.0)
kelvin_to_mired
def kelvin_to_mired(kelvin: int)
Convert the color temperature from Kelvin to Mired
yahuelib.exceptions
LightOrGroupNotFound Objects
class LightOrGroupNotFound(Exception)
LightOrGroupNotFound Exception
APIError Objects
class APIError(Exception)
Generic APIError Exception