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

Namespaces

 binary_sensor
 
 camera
 
 const
 
 helpers
 
 sensor
 
 switch
 

Classes

class  AmcrestChecker
 
class  AmcrestDevice
 

Functions

list[dict[str, Any]] _has_unique_names (list[dict[str, Any]] devices)
 
None _monitor_events (HomeAssistant hass, str name, AmcrestChecker api, set[str] event_codes)
 
None _start_event_monitor (HomeAssistant hass, str name, AmcrestChecker api, set[str] event_codes)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 AMCREST_SCHEMA
 
dictionary AUTHENTICATION_LIST = {"basic": "basic"}
 
string CONF_CONTROL_LIGHT = "control_light"
 
string CONF_FFMPEG_ARGUMENTS = "ffmpeg_arguments"
 
string CONF_RESOLUTION = "resolution"
 
string CONF_STREAM_SOURCE = "stream_source"
 
 CONFIG_SCHEMA
 
string DEFAULT_ARGUMENTS = "-pred 1"
 
string DEFAULT_NAME = "Amcrest Camera"
 
int DEFAULT_PORT = 80
 
string DEFAULT_RESOLUTION = "high"
 
int MAX_ERRORS = 5
 
string NOTIFICATION_ID = "amcrest_notification"
 
string NOTIFICATION_TITLE = "Amcrest Camera Setup"
 
 RECHECK_INTERVAL = timedelta(minutes=1)
 
 SCAN_INTERVAL = timedelta(seconds=10)
 

Detailed Description

Support for Amcrest IP cameras.

Function Documentation

◆ _has_unique_names()

list[dict[str, Any]] homeassistant.components.amcrest._has_unique_names ( list[dict[str, Any]]  devices)
private

Definition at line 86 of file __init__.py.

◆ _monitor_events()

None homeassistant.components.amcrest._monitor_events ( HomeAssistant  hass,
str  name,
AmcrestChecker  api,
set[str]  event_codes 
)
private

Definition at line 326 of file __init__.py.

◆ _start_event_monitor()

None homeassistant.components.amcrest._start_event_monitor ( HomeAssistant  hass,
str  name,
AmcrestChecker  api,
set[str]  event_codes 
)
private

Definition at line 352 of file __init__.py.

◆ async_setup()

bool homeassistant.components.amcrest.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Amcrest IP Camera component.

Definition at line 367 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 64 of file __init__.py.

◆ AMCREST_SCHEMA

homeassistant.components.amcrest.AMCREST_SCHEMA

Definition at line 92 of file __init__.py.

◆ AUTHENTICATION_LIST

dictionary homeassistant.components.amcrest.AUTHENTICATION_LIST = {"basic": "basic"}

Definition at line 83 of file __init__.py.

◆ CONF_CONTROL_LIGHT

string homeassistant.components.amcrest.CONF_CONTROL_LIGHT = "control_light"

Definition at line 69 of file __init__.py.

◆ CONF_FFMPEG_ARGUMENTS

string homeassistant.components.amcrest.CONF_FFMPEG_ARGUMENTS = "ffmpeg_arguments"

Definition at line 68 of file __init__.py.

◆ CONF_RESOLUTION

string homeassistant.components.amcrest.CONF_RESOLUTION = "resolution"

Definition at line 66 of file __init__.py.

◆ CONF_STREAM_SOURCE

string homeassistant.components.amcrest.CONF_STREAM_SOURCE = "stream_source"

Definition at line 67 of file __init__.py.

◆ CONFIG_SCHEMA

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

Definition at line 126 of file __init__.py.

◆ DEFAULT_ARGUMENTS

string homeassistant.components.amcrest.DEFAULT_ARGUMENTS = "-pred 1"

Definition at line 74 of file __init__.py.

◆ DEFAULT_NAME

string homeassistant.components.amcrest.DEFAULT_NAME = "Amcrest Camera"

Definition at line 71 of file __init__.py.

◆ DEFAULT_PORT

int homeassistant.components.amcrest.DEFAULT_PORT = 80

Definition at line 72 of file __init__.py.

◆ DEFAULT_RESOLUTION

string homeassistant.components.amcrest.DEFAULT_RESOLUTION = "high"

Definition at line 73 of file __init__.py.

◆ MAX_ERRORS

int homeassistant.components.amcrest.MAX_ERRORS = 5

Definition at line 75 of file __init__.py.

◆ NOTIFICATION_ID

string homeassistant.components.amcrest.NOTIFICATION_ID = "amcrest_notification"

Definition at line 78 of file __init__.py.

◆ NOTIFICATION_TITLE

string homeassistant.components.amcrest.NOTIFICATION_TITLE = "Amcrest Camera Setup"

Definition at line 79 of file __init__.py.

◆ RECHECK_INTERVAL

homeassistant.components.amcrest.RECHECK_INTERVAL = timedelta(minutes=1)

Definition at line 76 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.amcrest.SCAN_INTERVAL = timedelta(seconds=10)

Definition at line 81 of file __init__.py.