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

Namespaces

 alarm_control_panel
 
 binary_sensor
 

Functions

bool setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_DISCOVER_DEVICES = "egardia_sensor"
 
string CONF_REPORT_SERVER_CODES = "report_server_codes"
 
string CONF_REPORT_SERVER_ENABLED = "report_server_enabled"
 
string CONF_REPORT_SERVER_PORT = "report_server_port"
 
string CONF_VERSION = "version"
 
 CONFIG_SCHEMA
 
string DEFAULT_NAME = "Egardia"
 
int DEFAULT_PORT = 80
 
bool DEFAULT_REPORT_SERVER_ENABLED = False
 
int DEFAULT_REPORT_SERVER_PORT = 52010
 
string DEFAULT_VERSION = "GATE-01"
 
string DOMAIN = "egardia"
 
string EGARDIA_DEVICE = "egardiadevice"
 
string EGARDIA_NAME = "egardianame"
 
string EGARDIA_REPORT_SERVER_CODES = "egardia_rs_codes"
 
string EGARDIA_REPORT_SERVER_ENABLED = "egardia_rs_enabled"
 
string EGARDIA_SERVER = "egardia_server"
 
string NOTIFICATION_ID = "egardia_notification"
 
string NOTIFICATION_TITLE = "Egardia"
 
string REPORT_SERVER_CODES_IGNORE = "ignore"
 
 SERVER_CODE_SCHEMA
 

Detailed Description

Interfaces with Egardia/Woonveilig alarm control panel.

Function Documentation

◆ setup()

bool homeassistant.components.egardia.setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Egardia platform.

Definition at line 84 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 23 of file __init__.py.

◆ ATTR_DISCOVER_DEVICES

string homeassistant.components.egardia.ATTR_DISCOVER_DEVICES = "egardia_sensor"

Definition at line 25 of file __init__.py.

◆ CONF_REPORT_SERVER_CODES

string homeassistant.components.egardia.CONF_REPORT_SERVER_CODES = "report_server_codes"

Definition at line 27 of file __init__.py.

◆ CONF_REPORT_SERVER_ENABLED

string homeassistant.components.egardia.CONF_REPORT_SERVER_ENABLED = "report_server_enabled"

Definition at line 28 of file __init__.py.

◆ CONF_REPORT_SERVER_PORT

string homeassistant.components.egardia.CONF_REPORT_SERVER_PORT = "report_server_port"

Definition at line 29 of file __init__.py.

◆ CONF_VERSION

string homeassistant.components.egardia.CONF_VERSION = "version"

Definition at line 30 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.egardia.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_HOST): cv.string,
6  vol.Required(CONF_PASSWORD): cv.string,
7  vol.Required(CONF_USERNAME): cv.string,
8  vol.Optional(CONF_VERSION, default=DEFAULT_VERSION): cv.string,
9  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
10  vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
11  vol.Optional(CONF_REPORT_SERVER_CODES, default={}): SERVER_CODE_SCHEMA,
12  vol.Optional(
13  CONF_REPORT_SERVER_ENABLED, default=DEFAULT_REPORT_SERVER_ENABLED
14  ): cv.boolean,
15  vol.Optional(
16  CONF_REPORT_SERVER_PORT, default=DEFAULT_REPORT_SERVER_PORT
17  ): cv.port,
18  }
19  )
20  },
21  extra=vol.ALLOW_EXTRA,
22 )

Definition at line 60 of file __init__.py.

◆ DEFAULT_NAME

string homeassistant.components.egardia.DEFAULT_NAME = "Egardia"

Definition at line 32 of file __init__.py.

◆ DEFAULT_PORT

int homeassistant.components.egardia.DEFAULT_PORT = 80

Definition at line 33 of file __init__.py.

◆ DEFAULT_REPORT_SERVER_ENABLED

bool homeassistant.components.egardia.DEFAULT_REPORT_SERVER_ENABLED = False

Definition at line 34 of file __init__.py.

◆ DEFAULT_REPORT_SERVER_PORT

int homeassistant.components.egardia.DEFAULT_REPORT_SERVER_PORT = 52010

Definition at line 35 of file __init__.py.

◆ DEFAULT_VERSION

string homeassistant.components.egardia.DEFAULT_VERSION = "GATE-01"

Definition at line 36 of file __init__.py.

◆ DOMAIN

string homeassistant.components.egardia.DOMAIN = "egardia"

Definition at line 37 of file __init__.py.

◆ EGARDIA_DEVICE

string homeassistant.components.egardia.EGARDIA_DEVICE = "egardiadevice"

Definition at line 39 of file __init__.py.

◆ EGARDIA_NAME

string homeassistant.components.egardia.EGARDIA_NAME = "egardianame"

Definition at line 40 of file __init__.py.

◆ EGARDIA_REPORT_SERVER_CODES

string homeassistant.components.egardia.EGARDIA_REPORT_SERVER_CODES = "egardia_rs_codes"

Definition at line 41 of file __init__.py.

◆ EGARDIA_REPORT_SERVER_ENABLED

string homeassistant.components.egardia.EGARDIA_REPORT_SERVER_ENABLED = "egardia_rs_enabled"

Definition at line 42 of file __init__.py.

◆ EGARDIA_SERVER

string homeassistant.components.egardia.EGARDIA_SERVER = "egardia_server"

Definition at line 43 of file __init__.py.

◆ NOTIFICATION_ID

string homeassistant.components.egardia.NOTIFICATION_ID = "egardia_notification"

Definition at line 45 of file __init__.py.

◆ NOTIFICATION_TITLE

string homeassistant.components.egardia.NOTIFICATION_TITLE = "Egardia"

Definition at line 46 of file __init__.py.

◆ REPORT_SERVER_CODES_IGNORE

string homeassistant.components.egardia.REPORT_SERVER_CODES_IGNORE = "ignore"

Definition at line 48 of file __init__.py.

◆ SERVER_CODE_SCHEMA

homeassistant.components.egardia.SERVER_CODE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional("arm"): vol.All(cv.ensure_list_csv, [cv.string]),
4  vol.Optional("disarm"): vol.All(cv.ensure_list_csv, [cv.string]),
5  vol.Optional("armhome"): vol.All(cv.ensure_list_csv, [cv.string]),
6  vol.Optional("triggered"): vol.All(cv.ensure_list_csv, [cv.string]),
7  vol.Optional("ignore"): vol.All(cv.ensure_list_csv, [cv.string]),
8  }
9 )

Definition at line 50 of file __init__.py.