Module plugins.gpio.BinarySensor

Classes

class BinarySensor (parent: Platform, config: BinarySensorConfiguration)

Read the state of a GPIO pin

Expand source code

class BinarySensor(BaseSensor, Debuggable):
    '''Read the state of a GPIO pin'''
    
    def __init__(self, parent: Platform, config: BinarySensorConfiguration) -> None:
        super().__init__(parent, config)
        self.configuration = config
        self.state = BinaryState()

        self.input_device = DigitalInputDevice(
            pin = self.configuration.pin,
            pull_up = self.configuration.pull_up,
            active_state = self.configuration.active_state,
            bounce_time = self.configuration.bounce_time,
        )

        self.on_high_automations = Automation.create_automations(self, self.configuration.on_high)
        self.on_low_automations = Automation.create_automations(self, self.configuration.on_low)
        
        self.input_device.when_activated = Handler(self, self.on_high_automations, True).invoke
        self.input_device.when_deactivated = Handler(self, self.on_low_automations, False).invoke

Ancestors

• BaseSensor
• BaseScript
• Stackable
• Identifyable
• Disposeable
• VariableProvider
• Debuggable

Inherited members

• BaseSensor:
  • on_state_changed
  • start
• Debuggable:
  • log_debug

class BinarySensorConfiguration (**data: Any)

Sensor to read the state of a GPIO pin.

YAML configuration

Expand source code

@configuration
class BinarySensorConfiguration(SensorConfiguration):
    '''Sensor to read the state of a GPIO pin.'''

    pin: str
    '''GPIO PIN name. e.g. GPIO22'''

    pull_up: Optional[bool] = True
    '''True=enable software pull up, False=enable software pulldown, None=disabled(floating)'''

    active_state: Optional[bool] = None
    '''True: Active=HIGH, False: Active=LOW, None=auto-select with pull_up not None'''

    bounce_time: Optional[int] = None
    '''Length of time (in seconds) to ignore changes after initial change'''

    on_high: list[AutomationConfiguration] = []
    '''List of Automations to execute when the GPIO is set to HIGH, see `modules.base.Configuration.AutomationConfiguration`'''
    
    on_low: list[AutomationConfiguration] = []
    '''List of Automations to execute when the GPIO is set to LOW, see `modules.base.Configuration.AutomationConfiguration`'''

    @validator('platform')
    def check_platform(cls, v):
        platform_name = "gpio"
        if v != platform_name:
            raise ValueError("wrong script platform: " + platform_name + ", is: " + v)
        return v    

    @validator('type')
    def check_type(cls, v):
        type_name = "BinarySensor"
        if v != type_name:
            raise ValueError("wrong type: " + type_name + ", is: " + v)
        return v          

Ancestors

• SensorConfiguration
• ScriptConfiguration
• StackableConfiguration
• IdConfiguration
• VariablesConfiguration
• Configuration
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var active_state : Optional[bool]

True: Active=HIGH, False: Active=LOW, None=auto-select with pull_up not None

var bounce_time : Optional[int]

Length of time (in seconds) to ignore changes after initial change

var on_high : list

List of Automations to execute when the GPIO is set to HIGH, see AutomationConfiguration

var on_low : list

List of Automations to execute when the GPIO is set to LOW, see AutomationConfiguration

var pin : str

GPIO PIN name. e.g. GPIO22

var pull_up : Optional[bool]

True=enable software pull up, False=enable software pulldown, None=disabled(floating)

Static methods

def check_platform(v)

Expand source code

@validator('platform')
def check_platform(cls, v):
    platform_name = "gpio"
    if v != platform_name:
        raise ValueError("wrong script platform: " + platform_name + ", is: " + v)
    return v    

def check_type(v)

Expand source code

@validator('type')
def check_type(cls, v):
    type_name = "BinarySensor"
    if v != type_name:
        raise ValueError("wrong type: " + type_name + ", is: " + v)
    return v          

Inherited members

• SensorConfiguration:
  • comment
  • debug
  • id
  • on_dispose
  • on_init
  • variables
• ScriptConfiguration:
  • on_state_changed
  • platform
  • type

class BinaryState

Represents the state of the GPIO pin

Expand source code

class BinaryState(BaseState):
    '''Represents the state of the GPIO pin'''

    is_high = False
    '''Returns if the GPIO pin is HIGH(True) or LOW(False)'''

Ancestors

• BaseState

Class variables

var is_high

Returns if the GPIO pin is HIGH(True) or LOW(False)

class Handler (binary_sensor: BinarySensor, automations: list, is_pressed)

Expand source code

class Handler():
    def __init__(self, binary_sensor: BinarySensor, automations: list[Automation], is_pressed) -> None: #type: ignore
        self.automations = automations
        self.is_pressed = is_pressed
        self.binary_sensor = binary_sensor

    def invoke(self):
        self.binary_sensor.log_debug(str(self.is_pressed))

        self.binary_sensor.state.is_high = self.is_pressed
        call_stack = CallStack().with_element(self)

        for automation in self.automations:
            automation.invoke(call_stack)

        self.binary_sensor.on_state_changed(call_stack)

Methods

def invoke(self)

Expand source code

def invoke(self):
    self.binary_sensor.log_debug(str(self.is_pressed))

    self.binary_sensor.state.is_high = self.is_pressed
    call_stack = CallStack().with_element(self)

    for automation in self.automations:
        automation.invoke(call_stack)

    self.binary_sensor.on_state_changed(call_stack)