Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifiprotect.const Namespace Reference

Variables

string ATTR_ANONYMIZE = "anonymize"
 
string ATTR_BITRATE = "bitrate"
 
string ATTR_CHANNEL_ID = "channel_id"
 
string ATTR_DURATION = "duration"
 
string ATTR_EVENT_ID = "event_id"
 
string ATTR_EVENT_SCORE = "event_score"
 
string ATTR_FPS = "fps"
 
string ATTR_HEIGHT = "height"
 
string ATTR_MESSAGE = "message"
 
string ATTR_WIDTH = "width"
 
int AUTH_RETRIES = 2
 
string CONF_ALL_UPDATES = "all_updates"
 
string CONF_ALLOW_EA = "allow_ea_channel"
 
string CONF_DISABLE_RTSP = "disable_rtsp"
 
string CONF_MAX_MEDIA = "max_media"
 
string CONF_OVERRIDE_CHOST = "override_connection_host"
 
list CONFIG_OPTIONS
 
string DEFAULT_ATTRIBUTION = "Powered by UniFi Protect Server"
 
string DEFAULT_BRAND = "Ubiquiti"
 
int DEFAULT_MAX_MEDIA = 1000
 
int DEFAULT_PORT = 443
 
bool DEFAULT_VERIFY_SSL = False
 
dictionary DEVICES_FOR_SUBSCRIBE = DEVICES_WITH_ENTITIES | {ModelType.EVENT}
 
dictionary DEVICES_THAT_ADOPT
 
dictionary DEVICES_WITH_ENTITIES = DEVICES_THAT_ADOPT | {ModelType.NVR}
 
string DISPATCH_ADD = "add_device"
 
string DISPATCH_ADOPT = "adopt_device"
 
string DISPATCH_CHANNELS = "new_camera_channels"
 
string DOMAIN = "unifiprotect"
 
 Final
 
 MIN_REQUIRED_PROTECT_V = Version("1.20.0")
 
tuple OUTDATED_LOG_MESSAGE
 
list PLATFORMS
 
string TYPE_EMPTY_VALUE = ""
 

Detailed Description

Constant definitions for UniFi Protect Integration.

Variable Documentation

◆ ATTR_ANONYMIZE

string homeassistant.components.unifiprotect.const.ATTR_ANONYMIZE = "anonymize"

Definition at line 23 of file const.py.

◆ ATTR_BITRATE

string homeassistant.components.unifiprotect.const.ATTR_BITRATE = "bitrate"

Definition at line 19 of file const.py.

◆ ATTR_CHANNEL_ID

string homeassistant.components.unifiprotect.const.ATTR_CHANNEL_ID = "channel_id"

Definition at line 20 of file const.py.

◆ ATTR_DURATION

string homeassistant.components.unifiprotect.const.ATTR_DURATION = "duration"

Definition at line 22 of file const.py.

◆ ATTR_EVENT_ID

string homeassistant.components.unifiprotect.const.ATTR_EVENT_ID = "event_id"

Definition at line 15 of file const.py.

◆ ATTR_EVENT_SCORE

string homeassistant.components.unifiprotect.const.ATTR_EVENT_SCORE = "event_score"

Definition at line 14 of file const.py.

◆ ATTR_FPS

string homeassistant.components.unifiprotect.const.ATTR_FPS = "fps"

Definition at line 18 of file const.py.

◆ ATTR_HEIGHT

string homeassistant.components.unifiprotect.const.ATTR_HEIGHT = "height"

Definition at line 17 of file const.py.

◆ ATTR_MESSAGE

string homeassistant.components.unifiprotect.const.ATTR_MESSAGE = "message"

Definition at line 21 of file const.py.

◆ ATTR_WIDTH

string homeassistant.components.unifiprotect.const.ATTR_WIDTH = "width"

Definition at line 16 of file const.py.

◆ AUTH_RETRIES

int homeassistant.components.unifiprotect.const.AUTH_RETRIES = 2

Definition at line 12 of file const.py.

◆ CONF_ALL_UPDATES

string homeassistant.components.unifiprotect.const.CONF_ALL_UPDATES = "all_updates"

Definition at line 26 of file const.py.

◆ CONF_ALLOW_EA

string homeassistant.components.unifiprotect.const.CONF_ALLOW_EA = "allow_ea_channel"

Definition at line 29 of file const.py.

◆ CONF_DISABLE_RTSP

string homeassistant.components.unifiprotect.const.CONF_DISABLE_RTSP = "disable_rtsp"

Definition at line 25 of file const.py.

◆ CONF_MAX_MEDIA

string homeassistant.components.unifiprotect.const.CONF_MAX_MEDIA = "max_media"

Definition at line 28 of file const.py.

◆ CONF_OVERRIDE_CHOST

string homeassistant.components.unifiprotect.const.CONF_OVERRIDE_CHOST = "override_connection_host"

Definition at line 27 of file const.py.

◆ CONFIG_OPTIONS

list homeassistant.components.unifiprotect.const.CONFIG_OPTIONS
Initial value:
1 = [
2  CONF_ALL_UPDATES,
3  CONF_DISABLE_RTSP,
4  CONF_OVERRIDE_CHOST,
5 ]

Definition at line 31 of file const.py.

◆ DEFAULT_ATTRIBUTION

string homeassistant.components.unifiprotect.const.DEFAULT_ATTRIBUTION = "Powered by UniFi Protect Server"

Definition at line 38 of file const.py.

◆ DEFAULT_BRAND

string homeassistant.components.unifiprotect.const.DEFAULT_BRAND = "Ubiquiti"

Definition at line 39 of file const.py.

◆ DEFAULT_MAX_MEDIA

int homeassistant.components.unifiprotect.const.DEFAULT_MAX_MEDIA = 1000

Definition at line 41 of file const.py.

◆ DEFAULT_PORT

int homeassistant.components.unifiprotect.const.DEFAULT_PORT = 443

Definition at line 37 of file const.py.

◆ DEFAULT_VERIFY_SSL

bool homeassistant.components.unifiprotect.const.DEFAULT_VERIFY_SSL = False

Definition at line 40 of file const.py.

◆ DEVICES_FOR_SUBSCRIBE

dictionary homeassistant.components.unifiprotect.const.DEVICES_FOR_SUBSCRIBE = DEVICES_WITH_ENTITIES | {ModelType.EVENT}

Definition at line 52 of file const.py.

◆ DEVICES_THAT_ADOPT

dictionary homeassistant.components.unifiprotect.const.DEVICES_THAT_ADOPT
Initial value:
1 = {
2  ModelType.CAMERA,
3  ModelType.LIGHT,
4  ModelType.VIEWPORT,
5  ModelType.SENSOR,
6  ModelType.DOORLOCK,
7  ModelType.CHIME,
8 }

Definition at line 43 of file const.py.

◆ DEVICES_WITH_ENTITIES

dictionary homeassistant.components.unifiprotect.const.DEVICES_WITH_ENTITIES = DEVICES_THAT_ADOPT | {ModelType.NVR}

Definition at line 51 of file const.py.

◆ DISPATCH_ADD

string homeassistant.components.unifiprotect.const.DISPATCH_ADD = "add_device"

Definition at line 77 of file const.py.

◆ DISPATCH_ADOPT

string homeassistant.components.unifiprotect.const.DISPATCH_ADOPT = "adopt_device"

Definition at line 78 of file const.py.

◆ DISPATCH_CHANNELS

string homeassistant.components.unifiprotect.const.DISPATCH_CHANNELS = "new_camera_channels"

Definition at line 79 of file const.py.

◆ DOMAIN

string homeassistant.components.unifiprotect.const.DOMAIN = "unifiprotect"

Definition at line 9 of file const.py.

◆ Final

homeassistant.components.unifiprotect.const.Final

Definition at line 81 of file const.py.

◆ MIN_REQUIRED_PROTECT_V

homeassistant.components.unifiprotect.const.MIN_REQUIRED_PROTECT_V = Version("1.20.0")

Definition at line 54 of file const.py.

◆ OUTDATED_LOG_MESSAGE

tuple homeassistant.components.unifiprotect.const.OUTDATED_LOG_MESSAGE
Initial value:
1 = (
2  "You are running v%s of UniFi Protect. Minimum required version is v%s. Please"
3  " upgrade UniFi Protect and then retry"
4 )

Definition at line 55 of file const.py.

◆ PLATFORMS

list homeassistant.components.unifiprotect.const.PLATFORMS
Initial value:
1 = [
2  Platform.BINARY_SENSOR,
3  Platform.BUTTON,
4  Platform.CAMERA,
5  Platform.EVENT,
6  Platform.LIGHT,
7  Platform.LOCK,
8  Platform.MEDIA_PLAYER,
9  Platform.NUMBER,
10  Platform.SELECT,
11  Platform.SENSOR,
12  Platform.SWITCH,
13  Platform.TEXT,
14 ]

Definition at line 62 of file const.py.

◆ TYPE_EMPTY_VALUE

string homeassistant.components.unifiprotect.const.TYPE_EMPTY_VALUE = ""

Definition at line 60 of file const.py.