Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ads Namespace Reference

Namespaces

 binary_sensor
 
 const
 
 cover
 
 entity
 
 hub
 
 light
 
 select
 
 sensor
 
 switch
 
 valve
 

Functions

bool setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
dictionary ADS_TYPEMAP
 
string CONF_ADS_FACTOR = "factor"
 
string CONF_ADS_TYPE = "adstype"
 
string CONF_ADS_VALUE = "value"
 
 CONFIG_SCHEMA
 
 SCHEMA_SERVICE_WRITE_DATA_BY_NAME
 
string SERVICE_WRITE_DATA_BY_NAME = "write_data_by_name"
 

Detailed Description

Support for Automation Device Specification (ADS).

Function Documentation

◆ setup()

bool homeassistant.components.ads.setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the ADS component.

Definition at line 73 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.ads._LOGGER = logging.getLogger(__name__)
private

Definition at line 21 of file __init__.py.

◆ ADS_TYPEMAP

dictionary homeassistant.components.ads.ADS_TYPEMAP
Initial value:
1 = {
2  AdsType.BOOL: pyads.PLCTYPE_BOOL,
3  AdsType.BYTE: pyads.PLCTYPE_BYTE,
4  AdsType.INT: pyads.PLCTYPE_INT,
5  AdsType.UINT: pyads.PLCTYPE_UINT,
6  AdsType.SINT: pyads.PLCTYPE_SINT,
7  AdsType.USINT: pyads.PLCTYPE_USINT,
8  AdsType.DINT: pyads.PLCTYPE_DINT,
9  AdsType.UDINT: pyads.PLCTYPE_UDINT,
10  AdsType.WORD: pyads.PLCTYPE_WORD,
11  AdsType.DWORD: pyads.PLCTYPE_DWORD,
12  AdsType.REAL: pyads.PLCTYPE_REAL,
13  AdsType.LREAL: pyads.PLCTYPE_LREAL,
14  AdsType.STRING: pyads.PLCTYPE_STRING,
15  AdsType.TIME: pyads.PLCTYPE_TIME,
16  AdsType.DATE: pyads.PLCTYPE_DATE,
17  AdsType.DATE_AND_TIME: pyads.PLCTYPE_DT,
18  AdsType.TOD: pyads.PLCTYPE_TOD,
19 }

Definition at line 24 of file __init__.py.

◆ CONF_ADS_FACTOR

string homeassistant.components.ads.CONF_ADS_FACTOR = "factor"

Definition at line 44 of file __init__.py.

◆ CONF_ADS_TYPE

string homeassistant.components.ads.CONF_ADS_TYPE = "adstype"

Definition at line 45 of file __init__.py.

◆ CONF_ADS_VALUE

string homeassistant.components.ads.CONF_ADS_VALUE = "value"

Definition at line 46 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.ads.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_DEVICE): cv.string,
6  vol.Required(CONF_PORT): cv.port,
7  vol.Optional(CONF_IP_ADDRESS): cv.string,
8  }
9  )
10  },
11  extra=vol.ALLOW_EXTRA,
12 )

Definition at line 51 of file __init__.py.

◆ SCHEMA_SERVICE_WRITE_DATA_BY_NAME

homeassistant.components.ads.SCHEMA_SERVICE_WRITE_DATA_BY_NAME
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_ADS_TYPE): vol.Coerce(AdsType),
4  vol.Required(CONF_ADS_VALUE): vol.Coerce(int),
5  vol.Required(CONF_ADS_VAR): cv.string,
6  }
7 )

Definition at line 64 of file __init__.py.

◆ SERVICE_WRITE_DATA_BY_NAME

string homeassistant.components.ads.SERVICE_WRITE_DATA_BY_NAME = "write_data_by_name"

Definition at line 49 of file __init__.py.