Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.firmata.pin.FirmataBinaryDigitalInput Class Reference
Inheritance diagram for homeassistant.components.firmata.pin.FirmataBinaryDigitalInput:
[legend]
Collaboration diagram for homeassistant.components.firmata.pin.FirmataBinaryDigitalInput:
[legend]

Public Member Functions

None __init__ (self, FirmataBoard board, FirmataPinType pin, str pin_mode, bool negate)
 
bool is_on (self)
 
None latch_callback (self, list data)
 
None start_pin (self, Callable[[], None] forward_callback)
 
None stop_pin (self)
 
- Public Member Functions inherited from homeassistant.components.firmata.pin.FirmataBoardPin
None __init__ (self, FirmataBoard board, FirmataPinType pin, str pin_mode)
 
def setup (self)
 

Private Attributes

 _forward_callback
 
 _negate
 
 _pin_mode
 
 _state
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.firmata.pin.FirmataBoardPin
 board
 

Detailed Description

Representation of a Firmata Digital Input Pin.

Definition at line 146 of file pin.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.firmata.pin.FirmataBinaryDigitalInput.__init__ (   self,
FirmataBoard  board,
FirmataPinType  pin,
str  pin_mode,
bool   negate 
)
Initialize the digital input pin.

Definition at line 151 of file pin.py.

Member Function Documentation

◆ is_on()

bool homeassistant.components.firmata.pin.FirmataBinaryDigitalInput.is_on (   self)
Return true if digital input is on.

Definition at line 192 of file pin.py.

◆ latch_callback()

None homeassistant.components.firmata.pin.FirmataBinaryDigitalInput.latch_callback (   self,
list  data 
)
Update pin state on callback.

Definition at line 196 of file pin.py.

◆ start_pin()

None homeassistant.components.firmata.pin.FirmataBinaryDigitalInput.start_pin (   self,
Callable[[], None]  forward_callback 
)
Get initial state and start reporting a pin.

Definition at line 159 of file pin.py.

◆ stop_pin()

None homeassistant.components.firmata.pin.FirmataBinaryDigitalInput.stop_pin (   self)
Stop reporting digital input pin.

Definition at line 181 of file pin.py.

Member Data Documentation

◆ _forward_callback

homeassistant.components.firmata.pin.FirmataBinaryDigitalInput._forward_callback
private

Definition at line 166 of file pin.py.

◆ _negate

homeassistant.components.firmata.pin.FirmataBinaryDigitalInput._negate
private

Definition at line 155 of file pin.py.

◆ _pin_mode

homeassistant.components.firmata.pin.FirmataBinaryDigitalInput._pin_mode
private

Definition at line 168 of file pin.py.

◆ _state

homeassistant.components.firmata.pin.FirmataBinaryDigitalInput._state
private

Definition at line 176 of file pin.py.


The documentation for this class was generated from the following file: