Home Assistant Unofficial Reference 2024.12.1
Variables
homeassistant.components.modbus.const Namespace Reference

Variables

int ACTIVE_SCAN_INTERVAL = 2
 
 ATTR_ADDRESS = CONF_ADDRESS
 
string ATTR_HUB = "hub"
 
string ATTR_SLAVE = "slave"
 
string ATTR_UNIT = "unit"
 
string ATTR_VALUE = "value"
 
string CALL_TYPE_COIL = "coil"
 
string CALL_TYPE_DISCRETE = "discrete_input"
 
string CALL_TYPE_REGISTER_HOLDING = "holding"
 
string CALL_TYPE_REGISTER_INPUT = "input"
 
string CALL_TYPE_WRITE_COIL = "write_coil"
 
string CALL_TYPE_WRITE_COILS = "write_coils"
 
string CALL_TYPE_WRITE_REGISTER = "write_register"
 
string CALL_TYPE_WRITE_REGISTERS = "write_registers"
 
string CALL_TYPE_X_COILS = "coils"
 
string CALL_TYPE_X_REGISTER_HOLDINGS = "holdings"
 
string CONF_BAUDRATE = "baudrate"
 
string CONF_BYTESIZE = "bytesize"
 
string CONF_CLIMATES = "climates"
 
string CONF_DATA_TYPE = "data_type"
 
string CONF_DEVICE_ADDRESS = "device_address"
 
string CONF_FAN_MODE_AUTO = "state_fan_auto"
 
string CONF_FAN_MODE_DIFFUSE = "state_fan_diffuse"
 
string CONF_FAN_MODE_FOCUS = "state_fan_focus"
 
string CONF_FAN_MODE_HIGH = "state_fan_high"
 
string CONF_FAN_MODE_LOW = "state_fan_low"
 
string CONF_FAN_MODE_MEDIUM = "state_fan_medium"
 
string CONF_FAN_MODE_MIDDLE = "state_fan_middle"
 
string CONF_FAN_MODE_OFF = "state_fan_off"
 
string CONF_FAN_MODE_ON = "state_fan_on"
 
string CONF_FAN_MODE_REGISTER = "fan_mode_register"
 
string CONF_FAN_MODE_TOP = "state_fan_top"
 
string CONF_FAN_MODE_VALUES = "values"
 
string CONF_FANS = "fans"
 
string CONF_HVAC_MODE_AUTO = "state_auto"
 
string CONF_HVAC_MODE_COOL = "state_cool"
 
string CONF_HVAC_MODE_DRY = "state_dry"
 
string CONF_HVAC_MODE_FAN_ONLY = "state_fan_only"
 
string CONF_HVAC_MODE_HEAT = "state_heat"
 
string CONF_HVAC_MODE_HEAT_COOL = "state_heat_cool"
 
string CONF_HVAC_MODE_OFF = "state_off"
 
string CONF_HVAC_MODE_REGISTER = "hvac_mode_register"
 
string CONF_HVAC_MODE_VALUES = "values"
 
string CONF_HVAC_ONOFF_REGISTER = "hvac_onoff_register"
 
string CONF_INPUT_TYPE = "input_type"
 
string CONF_MAX_TEMP = "max_temp"
 
string CONF_MAX_VALUE = "max_value"
 
string CONF_MIN_TEMP = "min_temp"
 
string CONF_MIN_VALUE = "min_value"
 
string CONF_MSG_WAIT = "message_wait_milliseconds"
 
string CONF_NAN_VALUE = "nan_value"
 
string CONF_PARITY = "parity"
 
string CONF_PRECISION = "precision"
 
string CONF_SCALE = "scale"
 
string CONF_SLAVE_COUNT = "slave_count"
 
string CONF_STATE_CLOSED = "state_closed"
 
string CONF_STATE_CLOSING = "state_closing"
 
string CONF_STATE_OFF = "state_off"
 
string CONF_STATE_ON = "state_on"
 
string CONF_STATE_OPEN = "state_open"
 
string CONF_STATE_OPENING = "state_opening"
 
string CONF_STATUS_REGISTER = "status_register"
 
string CONF_STATUS_REGISTER_TYPE = "status_register_type"
 
string CONF_STEP = "temp_step"
 
string CONF_STOPBITS = "stopbits"
 
string CONF_SWAP = "swap"
 
string CONF_SWAP_BYTE = "byte"
 
string CONF_SWAP_WORD = "word"
 
string CONF_SWAP_WORD_BYTE = "word_byte"
 
string CONF_SWING_MODE_REGISTER = "swing_mode_register"
 
string CONF_SWING_MODE_SWING_BOTH = "swing_mode_state_both"
 
string CONF_SWING_MODE_SWING_HORIZ = "swing_mode_state_horizontal"
 
string CONF_SWING_MODE_SWING_OFF = "swing_mode_state_off"
 
string CONF_SWING_MODE_SWING_ON = "swing_mode_state_on"
 
string CONF_SWING_MODE_SWING_VERT = "swing_mode_state_vertical"
 
string CONF_SWING_MODE_VALUES = "values"
 
string CONF_TARGET_TEMP = "target_temp_register"
 
string CONF_TARGET_TEMP_WRITE_REGISTERS = "target_temp_write_registers"
 
string CONF_VERIFY = "verify"
 
string CONF_VIRTUAL_COUNT = "virtual_count"
 
string CONF_WRITE_REGISTERS = "write_registers"
 
string CONF_WRITE_TYPE = "write_type"
 
string CONF_ZERO_SUPPRESS = "zero_suppress"
 
string DEFAULT_HUB = "modbus_hub"
 
int DEFAULT_SCAN_INTERVAL = 15
 
int DEFAULT_SLAVE = 1
 
string DEFAULT_STRUCTURE_PREFIX = ">f"
 
string DEFAULT_TEMP_UNIT = "C"
 
string MODBUS_DOMAIN = "modbus"
 
tuple PLATFORMS
 
string RTUOVERTCP = "rtuovertcp"
 
string SERIAL = "serial"
 
string SERVICE_RESTART = "restart"
 
string SERVICE_STOP = "stop"
 
string SERVICE_WRITE_COIL = "write_coil"
 
string SERVICE_WRITE_REGISTER = "write_register"
 
string SIGNAL_START_ENTITY = "modbus.start"
 
string SIGNAL_STOP_ENTITY = "modbus.stop"
 
string TCP = "tcp"
 
string UDP = "udp"
 

Detailed Description

Constants used in modbus integration.

Variable Documentation

◆ ACTIVE_SCAN_INTERVAL

int homeassistant.components.modbus.const.ACTIVE_SCAN_INTERVAL = 2

Definition at line 144 of file const.py.

◆ ATTR_ADDRESS

homeassistant.components.modbus.const.ATTR_ADDRESS = CONF_ADDRESS

Definition at line 91 of file const.py.

◆ ATTR_HUB

string homeassistant.components.modbus.const.ATTR_HUB = "hub"

Definition at line 92 of file const.py.

◆ ATTR_SLAVE

string homeassistant.components.modbus.const.ATTR_SLAVE = "slave"

Definition at line 94 of file const.py.

◆ ATTR_UNIT

string homeassistant.components.modbus.const.ATTR_UNIT = "unit"

Definition at line 93 of file const.py.

◆ ATTR_VALUE

string homeassistant.components.modbus.const.ATTR_VALUE = "value"

Definition at line 95 of file const.py.

◆ CALL_TYPE_COIL

string homeassistant.components.modbus.const.CALL_TYPE_COIL = "coil"

Definition at line 115 of file const.py.

◆ CALL_TYPE_DISCRETE

string homeassistant.components.modbus.const.CALL_TYPE_DISCRETE = "discrete_input"

Definition at line 116 of file const.py.

◆ CALL_TYPE_REGISTER_HOLDING

string homeassistant.components.modbus.const.CALL_TYPE_REGISTER_HOLDING = "holding"

Definition at line 117 of file const.py.

◆ CALL_TYPE_REGISTER_INPUT

string homeassistant.components.modbus.const.CALL_TYPE_REGISTER_INPUT = "input"

Definition at line 118 of file const.py.

◆ CALL_TYPE_WRITE_COIL

string homeassistant.components.modbus.const.CALL_TYPE_WRITE_COIL = "write_coil"

Definition at line 119 of file const.py.

◆ CALL_TYPE_WRITE_COILS

string homeassistant.components.modbus.const.CALL_TYPE_WRITE_COILS = "write_coils"

Definition at line 120 of file const.py.

◆ CALL_TYPE_WRITE_REGISTER

string homeassistant.components.modbus.const.CALL_TYPE_WRITE_REGISTER = "write_register"

Definition at line 121 of file const.py.

◆ CALL_TYPE_WRITE_REGISTERS

string homeassistant.components.modbus.const.CALL_TYPE_WRITE_REGISTERS = "write_registers"

Definition at line 122 of file const.py.

◆ CALL_TYPE_X_COILS

string homeassistant.components.modbus.const.CALL_TYPE_X_COILS = "coils"

Definition at line 123 of file const.py.

◆ CALL_TYPE_X_REGISTER_HOLDINGS

string homeassistant.components.modbus.const.CALL_TYPE_X_REGISTER_HOLDINGS = "holdings"

Definition at line 124 of file const.py.

◆ CONF_BAUDRATE

string homeassistant.components.modbus.const.CONF_BAUDRATE = "baudrate"

Definition at line 16 of file const.py.

◆ CONF_BYTESIZE

string homeassistant.components.modbus.const.CONF_BYTESIZE = "bytesize"

Definition at line 17 of file const.py.

◆ CONF_CLIMATES

string homeassistant.components.modbus.const.CONF_CLIMATES = "climates"

Definition at line 18 of file const.py.

◆ CONF_DATA_TYPE

string homeassistant.components.modbus.const.CONF_DATA_TYPE = "data_type"

Definition at line 19 of file const.py.

◆ CONF_DEVICE_ADDRESS

string homeassistant.components.modbus.const.CONF_DEVICE_ADDRESS = "device_address"

Definition at line 20 of file const.py.

◆ CONF_FAN_MODE_AUTO

string homeassistant.components.modbus.const.CONF_FAN_MODE_AUTO = "state_fan_auto"

Definition at line 55 of file const.py.

◆ CONF_FAN_MODE_DIFFUSE

string homeassistant.components.modbus.const.CONF_FAN_MODE_DIFFUSE = "state_fan_diffuse"

Definition at line 59 of file const.py.

◆ CONF_FAN_MODE_FOCUS

string homeassistant.components.modbus.const.CONF_FAN_MODE_FOCUS = "state_fan_focus"

Definition at line 58 of file const.py.

◆ CONF_FAN_MODE_HIGH

string homeassistant.components.modbus.const.CONF_FAN_MODE_HIGH = "state_fan_high"

Definition at line 54 of file const.py.

◆ CONF_FAN_MODE_LOW

string homeassistant.components.modbus.const.CONF_FAN_MODE_LOW = "state_fan_low"

Definition at line 52 of file const.py.

◆ CONF_FAN_MODE_MEDIUM

string homeassistant.components.modbus.const.CONF_FAN_MODE_MEDIUM = "state_fan_medium"

Definition at line 53 of file const.py.

◆ CONF_FAN_MODE_MIDDLE

string homeassistant.components.modbus.const.CONF_FAN_MODE_MIDDLE = "state_fan_middle"

Definition at line 57 of file const.py.

◆ CONF_FAN_MODE_OFF

string homeassistant.components.modbus.const.CONF_FAN_MODE_OFF = "state_fan_off"

Definition at line 51 of file const.py.

◆ CONF_FAN_MODE_ON

string homeassistant.components.modbus.const.CONF_FAN_MODE_ON = "state_fan_on"

Definition at line 50 of file const.py.

◆ CONF_FAN_MODE_REGISTER

string homeassistant.components.modbus.const.CONF_FAN_MODE_REGISTER = "fan_mode_register"

Definition at line 49 of file const.py.

◆ CONF_FAN_MODE_TOP

string homeassistant.components.modbus.const.CONF_FAN_MODE_TOP = "state_fan_top"

Definition at line 56 of file const.py.

◆ CONF_FAN_MODE_VALUES

string homeassistant.components.modbus.const.CONF_FAN_MODE_VALUES = "values"

Definition at line 60 of file const.py.

◆ CONF_FANS

string homeassistant.components.modbus.const.CONF_FANS = "fans"

Definition at line 21 of file const.py.

◆ CONF_HVAC_MODE_AUTO

string homeassistant.components.modbus.const.CONF_HVAC_MODE_AUTO = "state_auto"

Definition at line 67 of file const.py.

◆ CONF_HVAC_MODE_COOL

string homeassistant.components.modbus.const.CONF_HVAC_MODE_COOL = "state_cool"

Definition at line 65 of file const.py.

◆ CONF_HVAC_MODE_DRY

string homeassistant.components.modbus.const.CONF_HVAC_MODE_DRY = "state_dry"

Definition at line 68 of file const.py.

◆ CONF_HVAC_MODE_FAN_ONLY

string homeassistant.components.modbus.const.CONF_HVAC_MODE_FAN_ONLY = "state_fan_only"

Definition at line 69 of file const.py.

◆ CONF_HVAC_MODE_HEAT

string homeassistant.components.modbus.const.CONF_HVAC_MODE_HEAT = "state_heat"

Definition at line 64 of file const.py.

◆ CONF_HVAC_MODE_HEAT_COOL

string homeassistant.components.modbus.const.CONF_HVAC_MODE_HEAT_COOL = "state_heat_cool"

Definition at line 66 of file const.py.

◆ CONF_HVAC_MODE_OFF

string homeassistant.components.modbus.const.CONF_HVAC_MODE_OFF = "state_off"

Definition at line 63 of file const.py.

◆ CONF_HVAC_MODE_REGISTER

string homeassistant.components.modbus.const.CONF_HVAC_MODE_REGISTER = "hvac_mode_register"

Definition at line 61 of file const.py.

◆ CONF_HVAC_MODE_VALUES

string homeassistant.components.modbus.const.CONF_HVAC_MODE_VALUES = "values"

Definition at line 70 of file const.py.

◆ CONF_HVAC_ONOFF_REGISTER

string homeassistant.components.modbus.const.CONF_HVAC_ONOFF_REGISTER = "hvac_onoff_register"

Definition at line 62 of file const.py.

◆ CONF_INPUT_TYPE

string homeassistant.components.modbus.const.CONF_INPUT_TYPE = "input_type"

Definition at line 22 of file const.py.

◆ CONF_MAX_TEMP

string homeassistant.components.modbus.const.CONF_MAX_TEMP = "max_temp"

Definition at line 23 of file const.py.

◆ CONF_MAX_VALUE

string homeassistant.components.modbus.const.CONF_MAX_VALUE = "max_value"

Definition at line 24 of file const.py.

◆ CONF_MIN_TEMP

string homeassistant.components.modbus.const.CONF_MIN_TEMP = "min_temp"

Definition at line 25 of file const.py.

◆ CONF_MIN_VALUE

string homeassistant.components.modbus.const.CONF_MIN_VALUE = "min_value"

Definition at line 26 of file const.py.

◆ CONF_MSG_WAIT

string homeassistant.components.modbus.const.CONF_MSG_WAIT = "message_wait_milliseconds"

Definition at line 27 of file const.py.

◆ CONF_NAN_VALUE

string homeassistant.components.modbus.const.CONF_NAN_VALUE = "nan_value"

Definition at line 28 of file const.py.

◆ CONF_PARITY

string homeassistant.components.modbus.const.CONF_PARITY = "parity"

Definition at line 29 of file const.py.

◆ CONF_PRECISION

string homeassistant.components.modbus.const.CONF_PRECISION = "precision"

Definition at line 30 of file const.py.

◆ CONF_SCALE

string homeassistant.components.modbus.const.CONF_SCALE = "scale"

Definition at line 31 of file const.py.

◆ CONF_SLAVE_COUNT

string homeassistant.components.modbus.const.CONF_SLAVE_COUNT = "slave_count"

Definition at line 32 of file const.py.

◆ CONF_STATE_CLOSED

string homeassistant.components.modbus.const.CONF_STATE_CLOSED = "state_closed"

Definition at line 33 of file const.py.

◆ CONF_STATE_CLOSING

string homeassistant.components.modbus.const.CONF_STATE_CLOSING = "state_closing"

Definition at line 34 of file const.py.

◆ CONF_STATE_OFF

string homeassistant.components.modbus.const.CONF_STATE_OFF = "state_off"

Definition at line 35 of file const.py.

◆ CONF_STATE_ON

string homeassistant.components.modbus.const.CONF_STATE_ON = "state_on"

Definition at line 36 of file const.py.

◆ CONF_STATE_OPEN

string homeassistant.components.modbus.const.CONF_STATE_OPEN = "state_open"

Definition at line 37 of file const.py.

◆ CONF_STATE_OPENING

string homeassistant.components.modbus.const.CONF_STATE_OPENING = "state_opening"

Definition at line 38 of file const.py.

◆ CONF_STATUS_REGISTER

string homeassistant.components.modbus.const.CONF_STATUS_REGISTER = "status_register"

Definition at line 39 of file const.py.

◆ CONF_STATUS_REGISTER_TYPE

string homeassistant.components.modbus.const.CONF_STATUS_REGISTER_TYPE = "status_register_type"

Definition at line 40 of file const.py.

◆ CONF_STEP

string homeassistant.components.modbus.const.CONF_STEP = "temp_step"

Definition at line 41 of file const.py.

◆ CONF_STOPBITS

string homeassistant.components.modbus.const.CONF_STOPBITS = "stopbits"

Definition at line 42 of file const.py.

◆ CONF_SWAP

string homeassistant.components.modbus.const.CONF_SWAP = "swap"

Definition at line 43 of file const.py.

◆ CONF_SWAP_BYTE

string homeassistant.components.modbus.const.CONF_SWAP_BYTE = "byte"

Definition at line 44 of file const.py.

◆ CONF_SWAP_WORD

string homeassistant.components.modbus.const.CONF_SWAP_WORD = "word"

Definition at line 45 of file const.py.

◆ CONF_SWAP_WORD_BYTE

string homeassistant.components.modbus.const.CONF_SWAP_WORD_BYTE = "word_byte"

Definition at line 46 of file const.py.

◆ CONF_SWING_MODE_REGISTER

string homeassistant.components.modbus.const.CONF_SWING_MODE_REGISTER = "swing_mode_register"

Definition at line 71 of file const.py.

◆ CONF_SWING_MODE_SWING_BOTH

string homeassistant.components.modbus.const.CONF_SWING_MODE_SWING_BOTH = "swing_mode_state_both"

Definition at line 72 of file const.py.

◆ CONF_SWING_MODE_SWING_HORIZ

string homeassistant.components.modbus.const.CONF_SWING_MODE_SWING_HORIZ = "swing_mode_state_horizontal"

Definition at line 73 of file const.py.

◆ CONF_SWING_MODE_SWING_OFF

string homeassistant.components.modbus.const.CONF_SWING_MODE_SWING_OFF = "swing_mode_state_off"

Definition at line 74 of file const.py.

◆ CONF_SWING_MODE_SWING_ON

string homeassistant.components.modbus.const.CONF_SWING_MODE_SWING_ON = "swing_mode_state_on"

Definition at line 75 of file const.py.

◆ CONF_SWING_MODE_SWING_VERT

string homeassistant.components.modbus.const.CONF_SWING_MODE_SWING_VERT = "swing_mode_state_vertical"

Definition at line 76 of file const.py.

◆ CONF_SWING_MODE_VALUES

string homeassistant.components.modbus.const.CONF_SWING_MODE_VALUES = "values"

Definition at line 77 of file const.py.

◆ CONF_TARGET_TEMP

string homeassistant.components.modbus.const.CONF_TARGET_TEMP = "target_temp_register"

Definition at line 47 of file const.py.

◆ CONF_TARGET_TEMP_WRITE_REGISTERS

string homeassistant.components.modbus.const.CONF_TARGET_TEMP_WRITE_REGISTERS = "target_temp_write_registers"

Definition at line 48 of file const.py.

◆ CONF_VERIFY

string homeassistant.components.modbus.const.CONF_VERIFY = "verify"

Definition at line 79 of file const.py.

◆ CONF_VIRTUAL_COUNT

string homeassistant.components.modbus.const.CONF_VIRTUAL_COUNT = "virtual_count"

Definition at line 80 of file const.py.

◆ CONF_WRITE_REGISTERS

string homeassistant.components.modbus.const.CONF_WRITE_REGISTERS = "write_registers"

Definition at line 78 of file const.py.

◆ CONF_WRITE_TYPE

string homeassistant.components.modbus.const.CONF_WRITE_TYPE = "write_type"

Definition at line 81 of file const.py.

◆ CONF_ZERO_SUPPRESS

string homeassistant.components.modbus.const.CONF_ZERO_SUPPRESS = "zero_suppress"

Definition at line 82 of file const.py.

◆ DEFAULT_HUB

string homeassistant.components.modbus.const.DEFAULT_HUB = "modbus_hub"

Definition at line 137 of file const.py.

◆ DEFAULT_SCAN_INTERVAL

int homeassistant.components.modbus.const.DEFAULT_SCAN_INTERVAL = 15

Definition at line 138 of file const.py.

◆ DEFAULT_SLAVE

int homeassistant.components.modbus.const.DEFAULT_SLAVE = 1

Definition at line 139 of file const.py.

◆ DEFAULT_STRUCTURE_PREFIX

string homeassistant.components.modbus.const.DEFAULT_STRUCTURE_PREFIX = ">f"

Definition at line 140 of file const.py.

◆ DEFAULT_TEMP_UNIT

string homeassistant.components.modbus.const.DEFAULT_TEMP_UNIT = "C"

Definition at line 141 of file const.py.

◆ MODBUS_DOMAIN

string homeassistant.components.modbus.const.MODBUS_DOMAIN = "modbus"

Definition at line 142 of file const.py.

◆ PLATFORMS

tuple homeassistant.components.modbus.const.PLATFORMS
Initial value:
1 = (
2  (Platform.BINARY_SENSOR, CONF_BINARY_SENSORS),
3  (Platform.CLIMATE, CONF_CLIMATES),
4  (Platform.COVER, CONF_COVERS),
5  (Platform.LIGHT, CONF_LIGHTS),
6  (Platform.FAN, CONF_FANS),
7  (Platform.SENSOR, CONF_SENSORS),
8  (Platform.SWITCH, CONF_SWITCHES),
9 )

Definition at line 146 of file const.py.

◆ RTUOVERTCP

string homeassistant.components.modbus.const.RTUOVERTCP = "rtuovertcp"

Definition at line 84 of file const.py.

◆ SERIAL

string homeassistant.components.modbus.const.SERIAL = "serial"

Definition at line 85 of file const.py.

◆ SERVICE_RESTART

string homeassistant.components.modbus.const.SERVICE_RESTART = "restart"

Definition at line 130 of file const.py.

◆ SERVICE_STOP

string homeassistant.components.modbus.const.SERVICE_STOP = "stop"

Definition at line 129 of file const.py.

◆ SERVICE_WRITE_COIL

string homeassistant.components.modbus.const.SERVICE_WRITE_COIL = "write_coil"

Definition at line 127 of file const.py.

◆ SERVICE_WRITE_REGISTER

string homeassistant.components.modbus.const.SERVICE_WRITE_REGISTER = "write_register"

Definition at line 128 of file const.py.

◆ SIGNAL_START_ENTITY

string homeassistant.components.modbus.const.SIGNAL_START_ENTITY = "modbus.start"

Definition at line 134 of file const.py.

◆ SIGNAL_STOP_ENTITY

string homeassistant.components.modbus.const.SIGNAL_STOP_ENTITY = "modbus.stop"

Definition at line 133 of file const.py.

◆ TCP

string homeassistant.components.modbus.const.TCP = "tcp"

Definition at line 86 of file const.py.

◆ UDP

string homeassistant.components.modbus.const.UDP = "udp"

Definition at line 87 of file const.py.