Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.owntracks.messages Namespace Reference

Functions

def _async_transition_message_enter (hass, context, message, location)
 
def _async_transition_message_leave (hass, context, message, location)
 
def _decrypt_payload (secret, topic, ciphertext)
 
def _parse_see_args (message, subscribe_topic)
 
def _parse_topic (topic, subscribe_topic)
 
def _set_gps_from_zone (kwargs, location, zone)
 
def async_handle_encrypted_message (hass, context, message)
 
def async_handle_location_message (hass, context, message)
 
def async_handle_message (hass, context, message)
 
def async_handle_not_impl_msg (hass, context, message)
 
def async_handle_transition_message (hass, context, message)
 
def async_handle_unsupported_msg (hass, context, message)
 
def async_handle_waypoint (hass, name_base, waypoint)
 
def async_handle_waypoints_message (hass, context, message)
 
def encrypt_message (secret, topic, message)
 
def get_cipher ()
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 HANDLERS = decorator.Registry()
 

Detailed Description

OwnTracks Message handlers.

Function Documentation

◆ _async_transition_message_enter()

def homeassistant.components.owntracks.messages._async_transition_message_enter (   hass,
  context,
  message,
  location 
)
private
Execute enter event.

Definition at line 204 of file messages.py.

◆ _async_transition_message_leave()

def homeassistant.components.owntracks.messages._async_transition_message_leave (   hass,
  context,
  message,
  location 
)
private
Execute leave event.

Definition at line 230 of file messages.py.

◆ _decrypt_payload()

def homeassistant.components.owntracks.messages._decrypt_payload (   secret,
  topic,
  ciphertext 
)
private
Decrypt encrypted payload.

Definition at line 107 of file messages.py.

◆ _parse_see_args()

def homeassistant.components.owntracks.messages._parse_see_args (   message,
  subscribe_topic 
)
private
Parse the OwnTracks location parameters, into the format see expects.

Async friendly.

Definition at line 56 of file messages.py.

◆ _parse_topic()

def homeassistant.components.owntracks.messages._parse_topic (   topic,
  subscribe_topic 
)
private
Parse an MQTT topic {sub_topic}/user/dev, return (user, dev) tuple.

Async friendly.

Definition at line 34 of file messages.py.

◆ _set_gps_from_zone()

def homeassistant.components.owntracks.messages._set_gps_from_zone (   kwargs,
  location,
  zone 
)
private
Set the see parameters from the zone parameters.

Async friendly.

Definition at line 92 of file messages.py.

◆ async_handle_encrypted_message()

def homeassistant.components.owntracks.messages.async_handle_encrypted_message (   hass,
  context,
  message 
)
Handle an encrypted message.

Definition at line 347 of file messages.py.

◆ async_handle_location_message()

def homeassistant.components.owntracks.messages.async_handle_location_message (   hass,
  context,
  message 
)
Handle a location message.

Definition at line 183 of file messages.py.

◆ async_handle_message()

def homeassistant.components.owntracks.messages.async_handle_message (   hass,
  context,
  message 
)
Handle an OwnTracks message.

Definition at line 383 of file messages.py.

◆ async_handle_not_impl_msg()

def homeassistant.components.owntracks.messages.async_handle_not_impl_msg (   hass,
  context,
  message 
)
Handle valid but not implemented message types.

Definition at line 373 of file messages.py.

◆ async_handle_transition_message()

def homeassistant.components.owntracks.messages.async_handle_transition_message (   hass,
  context,
  message 
)
Handle a transition message.

Definition at line 263 of file messages.py.

◆ async_handle_unsupported_msg()

def homeassistant.components.owntracks.messages.async_handle_unsupported_msg (   hass,
  context,
  message 
)
Handle an unsupported or invalid message type.

Definition at line 378 of file messages.py.

◆ async_handle_waypoint()

def homeassistant.components.owntracks.messages.async_handle_waypoint (   hass,
  name_base,
  waypoint 
)
Handle a waypoint.

Definition at line 293 of file messages.py.

◆ async_handle_waypoints_message()

def homeassistant.components.owntracks.messages.async_handle_waypoints_message (   hass,
  context,
  message 
)
Handle a waypoints message.

Definition at line 325 of file messages.py.

◆ encrypt_message()

def homeassistant.components.owntracks.messages.encrypt_message (   secret,
  topic,
  message 
)
Encrypt message.

Definition at line 151 of file messages.py.

◆ get_cipher()

def homeassistant.components.owntracks.messages.get_cipher ( )
Return decryption function and length of key.

Async friendly.

Definition at line 21 of file messages.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.owntracks.messages._LOGGER = logging.getLogger(__name__)
private

Definition at line 16 of file messages.py.

◆ HANDLERS

homeassistant.components.owntracks.messages.HANDLERS = decorator.Registry()

Definition at line 18 of file messages.py.