Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.firmata.board.FirmataBoard Class Reference

Public Member Functions

None __init__ (self, Mapping config)
 
bool async_reset (self)
 
bool async_setup (self, tries=0)
 
tuple[Literal[0, 1], int] get_pin_type (self, FirmataPinType pin)
 
bool mark_pin_used (self, FirmataPinType pin)
 

Public Attributes

 api
 
 binary_sensors
 
 config
 
 firmware_version
 
 lights
 
 name
 
 protocol_version
 
 sensors
 
 switches
 

Detailed Description

Manages a single Firmata board.

Definition at line 36 of file board.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.firmata.board.FirmataBoard.__init__ (   self,
Mapping  config 
)
Initialize the board.

Definition at line 39 of file board.py.

Member Function Documentation

◆ async_reset()

bool homeassistant.components.firmata.board.FirmataBoard.async_reset (   self)
Reset the board to default state.

Definition at line 105 of file board.py.

◆ async_setup()

bool homeassistant.components.firmata.board.FirmataBoard.async_setup (   self,
  tries = 0 
)
Set up a Firmata instance.

Definition at line 61 of file board.py.

◆ get_pin_type()

tuple[Literal[0, 1], int] homeassistant.components.firmata.board.FirmataBoard.get_pin_type (   self,
FirmataPinType  pin 
)
Return the type and Firmata location of a pin on the board.

Definition at line 124 of file board.py.

◆ mark_pin_used()

bool homeassistant.components.firmata.board.FirmataBoard.mark_pin_used (   self,
FirmataPinType  pin 
)
Test if a pin is used already on the board or mark as used.

Definition at line 117 of file board.py.

Member Data Documentation

◆ api

homeassistant.components.firmata.board.FirmataBoard.api

Definition at line 65 of file board.py.

◆ binary_sensors

homeassistant.components.firmata.board.FirmataBoard.binary_sensors

Definition at line 48 of file board.py.

◆ config

homeassistant.components.firmata.board.FirmataBoard.config

Definition at line 41 of file board.py.

◆ firmware_version

homeassistant.components.firmata.board.FirmataBoard.firmware_version

Definition at line 82 of file board.py.

◆ lights

homeassistant.components.firmata.board.FirmataBoard.lights

Definition at line 47 of file board.py.

◆ name

homeassistant.components.firmata.board.FirmataBoard.name

Definition at line 45 of file board.py.

◆ protocol_version

homeassistant.components.firmata.board.FirmataBoard.protocol_version

Definition at line 44 of file board.py.

◆ sensors

homeassistant.components.firmata.board.FirmataBoard.sensors

Definition at line 49 of file board.py.

◆ switches

homeassistant.components.firmata.board.FirmataBoard.switches

Definition at line 46 of file board.py.


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