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

Variables

string ATTR_ALTITUDE = "altitude"
 
string ATTR_APP_DATA = "app_data"
 
string ATTR_APP_ID = "app_id"
 
string ATTR_APP_NAME = "app_name"
 
string ATTR_APP_VERSION = "app_version"
 
string ATTR_CAMERA_ENTITY_ID = "camera_entity_id"
 
string ATTR_CONFIG_ENTRY_ID = "entry_id"
 
string ATTR_COURSE = "course"
 
string ATTR_DEVICE_NAME = "device_name"
 
string ATTR_EVENT_DATA = "event_data"
 
string ATTR_EVENT_TYPE = "event_type"
 
string ATTR_MANUFACTURER = "manufacturer"
 
string ATTR_MODEL = "model"
 
string ATTR_NO_LEGACY_ENCRYPTION = "no_legacy_encryption"
 
string ATTR_OS_NAME = "os_name"
 
string ATTR_OS_VERSION = "os_version"
 
string ATTR_PUSH_RATE_LIMITS = "rateLimits"
 
string ATTR_PUSH_RATE_LIMITS_ERRORS = "errors"
 
string ATTR_PUSH_RATE_LIMITS_MAXIMUM = "maximum"
 
string ATTR_PUSH_RATE_LIMITS_RESETS_AT = "resetsAt"
 
string ATTR_PUSH_RATE_LIMITS_SUCCESSFUL = "successful"
 
string ATTR_PUSH_TOKEN = "push_token"
 
string ATTR_PUSH_URL = "push_url"
 
string ATTR_PUSH_WEBSOCKET_CHANNEL = "push_websocket_channel"
 
string ATTR_SENSOR_ATTRIBUTES = "attributes"
 
string ATTR_SENSOR_DEVICE_CLASS = "device_class"
 
string ATTR_SENSOR_DISABLED = "disabled"
 
string ATTR_SENSOR_ENTITY_CATEGORY = "entity_category"
 
string ATTR_SENSOR_ICON = "icon"
 
string ATTR_SENSOR_NAME = "name"
 
string ATTR_SENSOR_STATE = "state"
 
string ATTR_SENSOR_STATE_CLASS = "state_class"
 
string ATTR_SENSOR_TYPE = "type"
 
string ATTR_SENSOR_TYPE_BINARY_SENSOR = "binary_sensor"
 
string ATTR_SENSOR_TYPE_SENSOR = "sensor"
 
string ATTR_SENSOR_UNIQUE_ID = "unique_id"
 
string ATTR_SENSOR_UOM = "unit_of_measurement"
 
string ATTR_SPEED = "speed"
 
string ATTR_SUPPORTS_ENCRYPTION = "supports_encryption"
 
string ATTR_TEMPLATE = "template"
 
string ATTR_TEMPLATE_VARIABLES = "variables"
 
string ATTR_VERTICAL_ACCURACY = "vertical_accuracy"
 
string ATTR_WEBHOOK_DATA = "data"
 
string ATTR_WEBHOOK_ENCRYPTED = "encrypted"
 
string ATTR_WEBHOOK_ENCRYPTED_DATA = "encrypted_data"
 
string ATTR_WEBHOOK_ID = "webhook_id"
 
string ATTR_WEBHOOK_TYPE = "type"
 
string CONF_CLOUDHOOK_URL = "cloudhook_url"
 
string CONF_REMOTE_UI_URL = "remote_ui_url"
 
string CONF_SECRET = "secret"
 
string CONF_USER_ID = "user_id"
 
string DATA_CONFIG_ENTRIES = "config_entries"
 
string DATA_DELETED_IDS = "deleted_ids"
 
string DATA_DEVICES = "devices"
 
string DATA_NOTIFY = "notify"
 
string DATA_PUSH_CHANNEL = "push_channel"
 
string DATA_STORE = "store"
 
string DOMAIN = "mobile_app"
 
string ERR_ENCRYPTION_ALREADY_ENABLED = "encryption_already_enabled"
 
string ERR_ENCRYPTION_NOT_AVAILABLE = "encryption_not_available"
 
string ERR_ENCRYPTION_REQUIRED = "encryption_required"
 
string ERR_INVALID_FORMAT = "invalid_format"
 
string ERR_SENSOR_NOT_REGISTERED = "not_registered"
 
 SCHEMA_APP_DATA
 
string SIGNAL_LOCATION_UPDATE = DOMAIN + "_location_update_{}"
 
string SIGNAL_SENSOR_UPDATE = f"{DOMAIN}_sensor_update"
 
string STORAGE_KEY = DOMAIN
 
int STORAGE_VERSION = 1
 

Detailed Description

Constants for mobile_app.

Variable Documentation

◆ ATTR_ALTITUDE

string homeassistant.components.mobile_app.const.ATTR_ALTITUDE = "altitude"

Definition at line 52 of file const.py.

◆ ATTR_APP_DATA

string homeassistant.components.mobile_app.const.ATTR_APP_DATA = "app_data"

Definition at line 24 of file const.py.

◆ ATTR_APP_ID

string homeassistant.components.mobile_app.const.ATTR_APP_ID = "app_id"

Definition at line 25 of file const.py.

◆ ATTR_APP_NAME

string homeassistant.components.mobile_app.const.ATTR_APP_NAME = "app_name"

Definition at line 26 of file const.py.

◆ ATTR_APP_VERSION

string homeassistant.components.mobile_app.const.ATTR_APP_VERSION = "app_version"

Definition at line 27 of file const.py.

◆ ATTR_CAMERA_ENTITY_ID

string homeassistant.components.mobile_app.const.ATTR_CAMERA_ENTITY_ID = "camera_entity_id"

Definition at line 86 of file const.py.

◆ ATTR_CONFIG_ENTRY_ID

string homeassistant.components.mobile_app.const.ATTR_CONFIG_ENTRY_ID = "entry_id"

Definition at line 28 of file const.py.

◆ ATTR_COURSE

string homeassistant.components.mobile_app.const.ATTR_COURSE = "course"

Definition at line 53 of file const.py.

◆ ATTR_DEVICE_NAME

string homeassistant.components.mobile_app.const.ATTR_DEVICE_NAME = "device_name"

Definition at line 29 of file const.py.

◆ ATTR_EVENT_DATA

string homeassistant.components.mobile_app.const.ATTR_EVENT_DATA = "event_data"

Definition at line 45 of file const.py.

◆ ATTR_EVENT_TYPE

string homeassistant.components.mobile_app.const.ATTR_EVENT_TYPE = "event_type"

Definition at line 46 of file const.py.

◆ ATTR_MANUFACTURER

string homeassistant.components.mobile_app.const.ATTR_MANUFACTURER = "manufacturer"

Definition at line 30 of file const.py.

◆ ATTR_MODEL

string homeassistant.components.mobile_app.const.ATTR_MODEL = "model"

Definition at line 31 of file const.py.

◆ ATTR_NO_LEGACY_ENCRYPTION

string homeassistant.components.mobile_app.const.ATTR_NO_LEGACY_ENCRYPTION = "no_legacy_encryption"

Definition at line 32 of file const.py.

◆ ATTR_OS_NAME

string homeassistant.components.mobile_app.const.ATTR_OS_NAME = "os_name"

Definition at line 33 of file const.py.

◆ ATTR_OS_VERSION

string homeassistant.components.mobile_app.const.ATTR_OS_VERSION = "os_version"

Definition at line 34 of file const.py.

◆ ATTR_PUSH_RATE_LIMITS

string homeassistant.components.mobile_app.const.ATTR_PUSH_RATE_LIMITS = "rateLimits"

Definition at line 38 of file const.py.

◆ ATTR_PUSH_RATE_LIMITS_ERRORS

string homeassistant.components.mobile_app.const.ATTR_PUSH_RATE_LIMITS_ERRORS = "errors"

Definition at line 39 of file const.py.

◆ ATTR_PUSH_RATE_LIMITS_MAXIMUM

string homeassistant.components.mobile_app.const.ATTR_PUSH_RATE_LIMITS_MAXIMUM = "maximum"

Definition at line 40 of file const.py.

◆ ATTR_PUSH_RATE_LIMITS_RESETS_AT

string homeassistant.components.mobile_app.const.ATTR_PUSH_RATE_LIMITS_RESETS_AT = "resetsAt"

Definition at line 41 of file const.py.

◆ ATTR_PUSH_RATE_LIMITS_SUCCESSFUL

string homeassistant.components.mobile_app.const.ATTR_PUSH_RATE_LIMITS_SUCCESSFUL = "successful"

Definition at line 42 of file const.py.

◆ ATTR_PUSH_TOKEN

string homeassistant.components.mobile_app.const.ATTR_PUSH_TOKEN = "push_token"

Definition at line 36 of file const.py.

◆ ATTR_PUSH_URL

string homeassistant.components.mobile_app.const.ATTR_PUSH_URL = "push_url"

Definition at line 37 of file const.py.

◆ ATTR_PUSH_WEBSOCKET_CHANNEL

string homeassistant.components.mobile_app.const.ATTR_PUSH_WEBSOCKET_CHANNEL = "push_websocket_channel"

Definition at line 35 of file const.py.

◆ ATTR_SENSOR_ATTRIBUTES

string homeassistant.components.mobile_app.const.ATTR_SENSOR_ATTRIBUTES = "attributes"

Definition at line 69 of file const.py.

◆ ATTR_SENSOR_DEVICE_CLASS

string homeassistant.components.mobile_app.const.ATTR_SENSOR_DEVICE_CLASS = "device_class"

Definition at line 70 of file const.py.

◆ ATTR_SENSOR_DISABLED

string homeassistant.components.mobile_app.const.ATTR_SENSOR_DISABLED = "disabled"

Definition at line 71 of file const.py.

◆ ATTR_SENSOR_ENTITY_CATEGORY

string homeassistant.components.mobile_app.const.ATTR_SENSOR_ENTITY_CATEGORY = "entity_category"

Definition at line 72 of file const.py.

◆ ATTR_SENSOR_ICON

string homeassistant.components.mobile_app.const.ATTR_SENSOR_ICON = "icon"

Definition at line 73 of file const.py.

◆ ATTR_SENSOR_NAME

string homeassistant.components.mobile_app.const.ATTR_SENSOR_NAME = "name"

Definition at line 74 of file const.py.

◆ ATTR_SENSOR_STATE

string homeassistant.components.mobile_app.const.ATTR_SENSOR_STATE = "state"

Definition at line 75 of file const.py.

◆ ATTR_SENSOR_STATE_CLASS

string homeassistant.components.mobile_app.const.ATTR_SENSOR_STATE_CLASS = "state_class"

Definition at line 76 of file const.py.

◆ ATTR_SENSOR_TYPE

string homeassistant.components.mobile_app.const.ATTR_SENSOR_TYPE = "type"

Definition at line 77 of file const.py.

◆ ATTR_SENSOR_TYPE_BINARY_SENSOR

string homeassistant.components.mobile_app.const.ATTR_SENSOR_TYPE_BINARY_SENSOR = "binary_sensor"

Definition at line 78 of file const.py.

◆ ATTR_SENSOR_TYPE_SENSOR

string homeassistant.components.mobile_app.const.ATTR_SENSOR_TYPE_SENSOR = "sensor"

Definition at line 79 of file const.py.

◆ ATTR_SENSOR_UNIQUE_ID

string homeassistant.components.mobile_app.const.ATTR_SENSOR_UNIQUE_ID = "unique_id"

Definition at line 80 of file const.py.

◆ ATTR_SENSOR_UOM

string homeassistant.components.mobile_app.const.ATTR_SENSOR_UOM = "unit_of_measurement"

Definition at line 81 of file const.py.

◆ ATTR_SPEED

string homeassistant.components.mobile_app.const.ATTR_SPEED = "speed"

Definition at line 51 of file const.py.

◆ ATTR_SUPPORTS_ENCRYPTION

string homeassistant.components.mobile_app.const.ATTR_SUPPORTS_ENCRYPTION = "supports_encryption"

Definition at line 43 of file const.py.

◆ ATTR_TEMPLATE

string homeassistant.components.mobile_app.const.ATTR_TEMPLATE = "template"

Definition at line 48 of file const.py.

◆ ATTR_TEMPLATE_VARIABLES

string homeassistant.components.mobile_app.const.ATTR_TEMPLATE_VARIABLES = "variables"

Definition at line 49 of file const.py.

◆ ATTR_VERTICAL_ACCURACY

string homeassistant.components.mobile_app.const.ATTR_VERTICAL_ACCURACY = "vertical_accuracy"

Definition at line 54 of file const.py.

◆ ATTR_WEBHOOK_DATA

string homeassistant.components.mobile_app.const.ATTR_WEBHOOK_DATA = "data"

Definition at line 56 of file const.py.

◆ ATTR_WEBHOOK_ENCRYPTED

string homeassistant.components.mobile_app.const.ATTR_WEBHOOK_ENCRYPTED = "encrypted"

Definition at line 57 of file const.py.

◆ ATTR_WEBHOOK_ENCRYPTED_DATA

string homeassistant.components.mobile_app.const.ATTR_WEBHOOK_ENCRYPTED_DATA = "encrypted_data"

Definition at line 58 of file const.py.

◆ ATTR_WEBHOOK_ID

string homeassistant.components.mobile_app.const.ATTR_WEBHOOK_ID = "webhook_id"

Definition at line 59 of file const.py.

◆ ATTR_WEBHOOK_TYPE

string homeassistant.components.mobile_app.const.ATTR_WEBHOOK_TYPE = "type"

Definition at line 60 of file const.py.

◆ CONF_CLOUDHOOK_URL

string homeassistant.components.mobile_app.const.CONF_CLOUDHOOK_URL = "cloudhook_url"

Definition at line 12 of file const.py.

◆ CONF_REMOTE_UI_URL

string homeassistant.components.mobile_app.const.CONF_REMOTE_UI_URL = "remote_ui_url"

Definition at line 13 of file const.py.

◆ CONF_SECRET

string homeassistant.components.mobile_app.const.CONF_SECRET = "secret"

Definition at line 14 of file const.py.

◆ CONF_USER_ID

string homeassistant.components.mobile_app.const.CONF_USER_ID = "user_id"

Definition at line 15 of file const.py.

◆ DATA_CONFIG_ENTRIES

string homeassistant.components.mobile_app.const.DATA_CONFIG_ENTRIES = "config_entries"

Definition at line 17 of file const.py.

◆ DATA_DELETED_IDS

string homeassistant.components.mobile_app.const.DATA_DELETED_IDS = "deleted_ids"

Definition at line 18 of file const.py.

◆ DATA_DEVICES

string homeassistant.components.mobile_app.const.DATA_DEVICES = "devices"

Definition at line 19 of file const.py.

◆ DATA_NOTIFY

string homeassistant.components.mobile_app.const.DATA_NOTIFY = "notify"

Definition at line 21 of file const.py.

◆ DATA_PUSH_CHANNEL

string homeassistant.components.mobile_app.const.DATA_PUSH_CHANNEL = "push_channel"

Definition at line 22 of file const.py.

◆ DATA_STORE

string homeassistant.components.mobile_app.const.DATA_STORE = "store"

Definition at line 20 of file const.py.

◆ DOMAIN

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

Definition at line 7 of file const.py.

◆ ERR_ENCRYPTION_ALREADY_ENABLED

string homeassistant.components.mobile_app.const.ERR_ENCRYPTION_ALREADY_ENABLED = "encryption_already_enabled"

Definition at line 62 of file const.py.

◆ ERR_ENCRYPTION_NOT_AVAILABLE

string homeassistant.components.mobile_app.const.ERR_ENCRYPTION_NOT_AVAILABLE = "encryption_not_available"

Definition at line 63 of file const.py.

◆ ERR_ENCRYPTION_REQUIRED

string homeassistant.components.mobile_app.const.ERR_ENCRYPTION_REQUIRED = "encryption_required"

Definition at line 64 of file const.py.

◆ ERR_INVALID_FORMAT

string homeassistant.components.mobile_app.const.ERR_INVALID_FORMAT = "invalid_format"

Definition at line 66 of file const.py.

◆ ERR_SENSOR_NOT_REGISTERED

string homeassistant.components.mobile_app.const.ERR_SENSOR_NOT_REGISTERED = "not_registered"

Definition at line 65 of file const.py.

◆ SCHEMA_APP_DATA

homeassistant.components.mobile_app.const.SCHEMA_APP_DATA
Initial value:
1 = vol.Schema(
2  {
3  vol.Inclusive(ATTR_PUSH_TOKEN, "push_cloud"): cv.string,
4  vol.Inclusive(ATTR_PUSH_URL, "push_cloud"): cv.url,
5  # Set to True to indicate that this registration will connect via websocket channel
6  # to receive push notifications.
7  vol.Optional(ATTR_PUSH_WEBSOCKET_CHANNEL): cv.boolean,
8  },
9  extra=vol.ALLOW_EXTRA,
10 )

Definition at line 88 of file const.py.

◆ SIGNAL_LOCATION_UPDATE

string homeassistant.components.mobile_app.const.SIGNAL_LOCATION_UPDATE = DOMAIN + "_location_update_{}"

Definition at line 84 of file const.py.

◆ SIGNAL_SENSOR_UPDATE

string homeassistant.components.mobile_app.const.SIGNAL_SENSOR_UPDATE = f"{DOMAIN}_sensor_update"

Definition at line 83 of file const.py.

◆ STORAGE_KEY

string homeassistant.components.mobile_app.const.STORAGE_KEY = DOMAIN

Definition at line 9 of file const.py.

◆ STORAGE_VERSION

int homeassistant.components.mobile_app.const.STORAGE_VERSION = 1

Definition at line 10 of file const.py.