Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.aprs.device_tracker Namespace Reference

Classes

class  AprsListenerThread
 

Functions

int gps_accuracy (tuple[float, float] gps, int posambiguity)
 
str make_filter (list callsigns)
 
bool setup_scanner (HomeAssistant hass, ConfigType config, SeeCallback see, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_ALTITUDE = "altitude"
 
string ATTR_COMMENT = "comment"
 
string ATTR_COURSE = "course"
 
string ATTR_FORMAT = "format"
 
string ATTR_FROM = "from"
 
string ATTR_OBJECT_NAME = "object_name"
 
string ATTR_POS_AMBIGUITY = "posambiguity"
 
string ATTR_SPEED = "speed"
 
string CONF_CALLSIGNS = "callsigns"
 
string DEFAULT_HOST = "rotate.aprs2.net"
 
string DEFAULT_PASSWORD = "-1"
 
float DEFAULT_TIMEOUT = 30.0
 
string DOMAIN = "aprs"
 
int FILTER_PORT = 14580
 
list MSG_FORMATS = ["compressed", "uncompressed", "mic-e", "object"]
 
 PLATFORM_SCHEMA
 

Detailed Description

Support for APRS device tracking.

Function Documentation

◆ gps_accuracy()

int homeassistant.components.aprs.device_tracker.gps_accuracy ( tuple[float, float]  gps,
int  posambiguity 
)
Calculate the GPS accuracy based on APRS posambiguity.

Definition at line 72 of file device_tracker.py.

◆ make_filter()

str homeassistant.components.aprs.device_tracker.make_filter ( list  callsigns)
Make a server-side filter from a list of callsigns.

Definition at line 67 of file device_tracker.py.

◆ setup_scanner()

bool homeassistant.components.aprs.device_tracker.setup_scanner ( HomeAssistant  hass,
ConfigType  config,
SeeCallback  see,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the APRS tracker.

Definition at line 90 of file device_tracker.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.aprs.device_tracker._LOGGER = logging.getLogger(__name__)
private

Definition at line 35 of file device_tracker.py.

◆ ATTR_ALTITUDE

string homeassistant.components.aprs.device_tracker.ATTR_ALTITUDE = "altitude"

Definition at line 37 of file device_tracker.py.

◆ ATTR_COMMENT

string homeassistant.components.aprs.device_tracker.ATTR_COMMENT = "comment"

Definition at line 39 of file device_tracker.py.

◆ ATTR_COURSE

string homeassistant.components.aprs.device_tracker.ATTR_COURSE = "course"

Definition at line 38 of file device_tracker.py.

◆ ATTR_FORMAT

string homeassistant.components.aprs.device_tracker.ATTR_FORMAT = "format"

Definition at line 41 of file device_tracker.py.

◆ ATTR_FROM

string homeassistant.components.aprs.device_tracker.ATTR_FROM = "from"

Definition at line 40 of file device_tracker.py.

◆ ATTR_OBJECT_NAME

string homeassistant.components.aprs.device_tracker.ATTR_OBJECT_NAME = "object_name"

Definition at line 42 of file device_tracker.py.

◆ ATTR_POS_AMBIGUITY

string homeassistant.components.aprs.device_tracker.ATTR_POS_AMBIGUITY = "posambiguity"

Definition at line 43 of file device_tracker.py.

◆ ATTR_SPEED

string homeassistant.components.aprs.device_tracker.ATTR_SPEED = "speed"

Definition at line 44 of file device_tracker.py.

◆ CONF_CALLSIGNS

string homeassistant.components.aprs.device_tracker.CONF_CALLSIGNS = "callsigns"

Definition at line 46 of file device_tracker.py.

◆ DEFAULT_HOST

string homeassistant.components.aprs.device_tracker.DEFAULT_HOST = "rotate.aprs2.net"

Definition at line 48 of file device_tracker.py.

◆ DEFAULT_PASSWORD

string homeassistant.components.aprs.device_tracker.DEFAULT_PASSWORD = "-1"

Definition at line 49 of file device_tracker.py.

◆ DEFAULT_TIMEOUT

float homeassistant.components.aprs.device_tracker.DEFAULT_TIMEOUT = 30.0

Definition at line 50 of file device_tracker.py.

◆ DOMAIN

string homeassistant.components.aprs.device_tracker.DOMAIN = "aprs"

Definition at line 33 of file device_tracker.py.

◆ FILTER_PORT

int homeassistant.components.aprs.device_tracker.FILTER_PORT = 14580

Definition at line 52 of file device_tracker.py.

◆ MSG_FORMATS

list homeassistant.components.aprs.device_tracker.MSG_FORMATS = ["compressed", "uncompressed", "mic-e", "object"]

Definition at line 54 of file device_tracker.py.

◆ PLATFORM_SCHEMA

homeassistant.components.aprs.device_tracker.PLATFORM_SCHEMA
Initial value:
1 = DEVICE_TRACKER_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_CALLSIGNS): cv.ensure_list,
4  vol.Required(CONF_USERNAME): cv.string,
5  vol.Optional(CONF_PASSWORD, default=DEFAULT_PASSWORD): cv.string,
6  vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
7  vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): vol.Coerce(float),
8  }
9 )

Definition at line 56 of file device_tracker.py.