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

Public Member Functions

None __init__ (self, FirmataBoard board, FirmataPinType pin, str pin_mode, int differential)
 
None latch_callback (self, list data)
 
None start_pin (self, Callable[[], None] forward_callback)
 
int state (self)
 
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

 _differential
 
 _forward_callback
 
 _state
 

Additional Inherited Members

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

Detailed Description

Representation of a Firmata Analog Input Pin.

Definition at line 215 of file pin.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.firmata.pin.FirmataAnalogInput.__init__ (   self,
FirmataBoard  board,
FirmataPinType  pin,
str  pin_mode,
int   differential 
)
Initialize the analog input pin.

Definition at line 221 of file pin.py.

Member Function Documentation

◆ latch_callback()

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

Definition at line 262 of file pin.py.

◆ start_pin()

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

Definition at line 229 of file pin.py.

◆ state()

int homeassistant.components.firmata.pin.FirmataAnalogInput.state (   self)
Return sensor state.

Definition at line 258 of file pin.py.

◆ stop_pin()

None homeassistant.components.firmata.pin.FirmataAnalogInput.stop_pin (   self)
Stop reporting analog input pin.

Definition at line 247 of file pin.py.

Member Data Documentation

◆ _differential

homeassistant.components.firmata.pin.FirmataAnalogInput._differential
private

Definition at line 225 of file pin.py.

◆ _forward_callback

homeassistant.components.firmata.pin.FirmataAnalogInput._forward_callback
private

Definition at line 236 of file pin.py.

◆ _state

homeassistant.components.firmata.pin.FirmataAnalogInput._state
private

Definition at line 243 of file pin.py.


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