mash-sensor-tof-pc/src/philips_hue_counter.py

from datetime import datetime
from pathlib import Path
from typing import Dict
from interface.philips_hue import PhilipsHue
from sensor.people_counter import PeopleCounter
from sensor.tof_sensor import Directions
from sensor.vl53l1x_sensor import VL53L1XSensor
import logging
import json


# Should lights already turn on where there is any kind of motion in the sensor
ENABLE_MOTION_TRIGGERED_LIGHT = True


LOG_FILE_PATH = "log.txt"   # Path for logs
hue_conf = {
    'bridge_ip': '',
    'transition_time': 10,  # seconds
    'light_group': '',
    # If file exists, application is considered 'registered' at the bridge
    'registered_file': 'smart_light_registered.bridge'
}   # Custom configuration for philips hue


hue: PhilipsHue = PhilipsHue(hue_conf)  # Light interface
counter: PeopleCounter = PeopleCounter(VL53L1XSensor())  # Sensor object
peopleCount: int = 0    # Global count of people on the inside
motion_triggered_lights = False   # Is light on because of any detected motion

logging.getLogger().setLevel(logging.INFO)


def change_cb(countChange: int, directionState: Dict):
    """Handles basic logging of event data for later analysis.

    Args:
        countChange (int): The change in the number of people. Usually on of [-1, 0, 1].
        directionState (Dict): Object describing the internal state of the sensor.
    """
    data = {
        'version': 'v0.0',
        'previousPeopleCount': peopleCount,
        'countChange': countChange,
        'directionState': directionState,
        'dateTime': datetime.now(),
        'motionTriggeredLights': motion_triggered_lights
    }

    try:
        with open(LOG_FILE_PATH, 'a') as f:
            f.write(json.dumps(data, default=str) + "\n")
    except Exception as ex:
        logging.exception(f'Unable to write log file. {ex}')


def count_change(change: int) -> None:
    """Handles light state when people count changes

    Args:
        change (int): The change in the number of people. Usually on of [-1, 0, 1].
    """
    global hue
    global peopleCount
    global motion_triggered_lights

    # Are lights on at the moment?
    previous_lights_state = get_light_state()

    # Apply correction
    if peopleCount <= 0 and previous_lights_state and not motion_triggered_lights:
        # Count was 0, but lights were on (not because of motion triggers) => people count was not actually 0
        peopleCount = 1
        logging.debug(f'People count corrected to {peopleCount}')
    elif peopleCount > 0 and not previous_lights_state:
        # Count was >0, but lights were off => people count was actually 0
        peopleCount = 0
        logging.debug(f'People count corrected to {peopleCount}')

    peopleCount += change
    if peopleCount < 0:
        peopleCount = 0
    logging.debug(f'People count changed by {change}')

    # Handle light
    target_light_state = peopleCount > 0

    # Return, if there is no change
    if previous_lights_state == target_light_state:
        if previous_lights_state:
            # Signaling that the people count is taking control over the light now
            motion_triggered_lights = False
        return

    set_light_state(target_light_state)


def trigger_change(triggerState: Dict):
    """Handles motion triggered light state.

    Args:
        triggerState (Dict): Describing in what directions the sensor is triggerd.
    """
    global hue
    global motion_triggered_lights

    target_light_state = None

    # Is someone walking close to the door?
    motion_detected = triggerState[Directions.INSIDE] or triggerState[Directions.OUTSIDE]
    target_light_state = motion_detected

    # Does motion triggered light need to do anything?
    if peopleCount > 0:
        # State is successfully handled by the count
        motion_triggered_lights = False
        return

    # Only look at changing situations
    if target_light_state == motion_triggered_lights:
        return

    set_light_state(target_light_state)

    # Save state
    motion_triggered_lights = target_light_state


def set_light_state(target_light_state: bool) -> bool:
    """Sets the lights to the given state.

    Args:
        target_light_state (bool): Should lights on the inside be on or off.

    Returns:
        bool: Previous light state.
    """
    # Are lights on at the moment?
    previous_lights_state = get_light_state()
    if target_light_state == previous_lights_state:
        return previous_lights_state

    # Adjust light as necessary
    hue.set_group(hue_conf['light_group'], {'on': target_light_state})
    logging.debug(
        f'Light state changed to {target_light_state} for early light')

    return previous_lights_state


def get_light_state() -> bool:
    """
    Returns:
        bool: Current light state.
    """
    return hue.get_group(hue_conf['light_group'])['state']['any_on']


# Represents callback trigger order
counter.hookChange(change_cb)
counter.hookCounting(count_change)
counter.hookTrigger(trigger_change)

counter.run()