Using scenes in pyscript

[tal]

I made a little helper that uses scenes and presents a new service that allows you to assign a scene but apply the values as a max/min.

To get this to work you have to add this to your config

pyscript:
  apps:
    scene_utils:
      scenes: !include scenes.yaml

The code will auto-reload if someone uses the GUI to edit scenes. This allows yourself for partners to change the definitions without needing to edit the code.

It creates a new service that you can call with.

scene.my_test_scene.special_apply(tranistion=60, conditional="min")

Pyscipt app: `apps/scene_utils.py`

VALID_LIGHT_KEYS = {
    'transition',
    'hs_color',
    'xy_color',
    'rgb_color',
    'white_value',
    'color_temp',
    'kelvin',
    'color_name',
}


def get_scene(entity_id):
    attr = state.getattr(entity_id)
    # scenes = pyscript.config["global"]["scenes"]
    scenes = pyscript.app_config['scenes']

    if attr is None:
        return None

    for scene in scenes:
        if scene["id"] == attr["id"]:
            return scene

    return None


@event_trigger('scene_reloaded')
def scene_changed(**kwargs):
    """
    If the scenes have changed we have to reload this to get the new app_config which contains the scenes
    """
    pyscript.reload(global_ctx='apps.light_utils')


@service
@service('scene.special_apply')
def apply_scene(entity_id=None, transition=0, conditional=None):
    """yaml
description: Applies the scene but takes the brightness values as a max/min instead of moving to it directly.
fields:
  entity_id:
     description: The entity_id of the scene you wish to apply
     example: scene.got_home
  transition:
    description: The time in seconds to transition to this new scene.
    example: 60
  conditional:
    description: If this scene should be applied as a max value or min value, can only be (`min` or `max`).
    example: max
"""
    scene = get_scene(entity_id)
    log.error(f"attempting to get scene entity: {entity_id}")
    if scene is None:
        log.error(f"no scene with entity: {entity_id}")
        return
    log.debug(f"got scene: {scene}")

    has_conditional = conditional is not None

    def conditional_prefixer(key):
        nonlocal conditional

        if conditional is not None:
            return conditional + "_" + key
        else:
            return key

    for device_id, value in scene['entities'].items():
        domain, name = device_id.split('.')

        if domain != 'light':
            # TODO: deal with non-light entity
            log.error(
                f"this service can currently only handle lights. From scene {entity_id} unable to handle entity {device_id}")
            continue

        if 'state' in value and value['state'] == 'off':
            if transition > 0:
                light.turn_off(entity_id=device_id, transition=transition)
            else:
                light.turn_off(entity_id=device_id)

        args = {k: value[k] for k in value.keys() & VALID_LIGHT_KEYS}

        if transition > 0:
            args['transition'] = transition

        if "brightness_pct" in value:
            args[conditional_prefixer('brightness_pct')] = value['brightness_pct']
        elif "brightness" in value:
            args[conditional_prefixer('brightness')] = value['brightness']

        turn_on(entity_id=device_id, **args)


def turn_on(entity_id=None, max_brightness_pct=None, max_brightness=None, min_brightness_pct=None, min_brightness=None, **kwargs):
    args = {k: kwargs[k] for k in kwargs.keys() & VALID_LIGHT_KEYS}

    attrs = state.getattr(entity_id)
    current_brightness = int(attrs.get('brightness', 0))

    if min_brightness_pct is not None:
        current_brightness_pct = (current_brightness / 255.0) * 100

        log.debug(f"current_brightness_pct={current_brightness_pct} min_brightness_pct={min_brightness_pct}")
        if current_brightness_pct < min_brightness_pct:
            args['brightness_pct'] = min_brightness_pct
        else:
            return
    elif min_brightness is not None:
        log.debug(f"current_brightness={current_brightness} min_brightness={min_brightness}")
        if current_brightness < min_brightness:
            args['brightness'] = min_brightness
        else:
            return
    elif max_brightness_pct is not None:
        current_brightness_pct = (current_brightness / 255.0) * 100

        log.debug(f"current_brightness_pct={current_brightness_pct} max_brightness_pct={max_brightness_pct}")
        if current_brightness_pct < max_brightness_pct:
            args['brightness_pct'] = max_brightness_pct
        else:
            return
    elif max_brightness is not None:
        log.debug(f"current_brightness={current_brightness} max_brightness={max_brightness}")
        if current_brightness > max_brightness:
            args['brightness'] = max_brightness
        else:
            return
    elif "brightness" in kwargs:
        args['brightness'] = kwargs['brightness']
    elif "brightness_pct" in kwargs:
        args['brightness_pct'] = kwargs['brightness_pct']
    else:
        log.error(f"no brightness level provided for entity={entity_id}")
        return

    log.info(f"applying: entity={entity_id} args={args}")
    light.turn_on(entity_id=entity_id, **args)

[craigbarratt]

Nice! Thanks for sharing. And I see you are using some new 1.3.0 features too 👍