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

Namespaces

 binary_sensor
 
 camera
 
 sensor
 
 switch
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_PATH_ZMS = "path_zms"
 
 CONFIG_SCHEMA
 
string DEFAULT_PATH = "/zm/"
 
string DEFAULT_PATH_ZMS = "/zm/cgi-bin/nph-zms"
 
bool DEFAULT_SSL = False
 
int DEFAULT_TIMEOUT = 10
 
bool DEFAULT_VERIFY_SSL = True
 
string DOMAIN = "zoneminder"
 
 HOST_CONFIG_SCHEMA
 
string SERVICE_SET_RUN_STATE = "set_run_state"
 
 SET_RUN_STATE_SCHEMA
 

Detailed Description

Support for ZoneMinder.

Function Documentation

◆ async_setup()

bool homeassistant.components.zoneminder.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the ZoneMinder component.

Definition at line 58 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 25 of file __init__.py.

◆ CONF_PATH_ZMS

string homeassistant.components.zoneminder.CONF_PATH_ZMS = "path_zms"

Definition at line 27 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.zoneminder.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {DOMAIN: vol.All(cv.ensure_list, [HOST_CONFIG_SCHEMA])}, extra=vol.ALLOW_EXTRA
3 )

Definition at line 48 of file __init__.py.

◆ DEFAULT_PATH

string homeassistant.components.zoneminder.DEFAULT_PATH = "/zm/"

Definition at line 29 of file __init__.py.

◆ DEFAULT_PATH_ZMS

string homeassistant.components.zoneminder.DEFAULT_PATH_ZMS = "/zm/cgi-bin/nph-zms"

Definition at line 30 of file __init__.py.

◆ DEFAULT_SSL

bool homeassistant.components.zoneminder.DEFAULT_SSL = False

Definition at line 31 of file __init__.py.

◆ DEFAULT_TIMEOUT

int homeassistant.components.zoneminder.DEFAULT_TIMEOUT = 10

Definition at line 32 of file __init__.py.

◆ DEFAULT_VERIFY_SSL

bool homeassistant.components.zoneminder.DEFAULT_VERIFY_SSL = True

Definition at line 33 of file __init__.py.

◆ DOMAIN

string homeassistant.components.zoneminder.DOMAIN = "zoneminder"

Definition at line 34 of file __init__.py.

◆ HOST_CONFIG_SCHEMA

homeassistant.components.zoneminder.HOST_CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_HOST): cv.string,
4  vol.Optional(CONF_PASSWORD): cv.string,
5  vol.Optional(CONF_PATH, default=DEFAULT_PATH): cv.string,
6  vol.Optional(CONF_PATH_ZMS, default=DEFAULT_PATH_ZMS): cv.string,
7  vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
8  vol.Optional(CONF_USERNAME): cv.string,
9  vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
10  }
11 )

Definition at line 36 of file __init__.py.

◆ SERVICE_SET_RUN_STATE

string homeassistant.components.zoneminder.SERVICE_SET_RUN_STATE = "set_run_state"

Definition at line 52 of file __init__.py.

◆ SET_RUN_STATE_SCHEMA

homeassistant.components.zoneminder.SET_RUN_STATE_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(ATTR_ID): cv.string, vol.Required(ATTR_NAME): cv.string}
3 )

Definition at line 53 of file __init__.py.