src.bluetooth_sig.gatt.characteristics.navigation¶

Navigation characteristic implementation.

Classes¶

Name	Description
`HeadingSource`	Heading source enumeration.
`NavigationCharacteristic`	Navigation characteristic.
`NavigationData`	Parsed data from Navigation characteristic.
`NavigationFlags`	Navigation flags as per Bluetooth SIG specification.
`NavigationIndicatorType`	Navigation indicator type enumeration.

Module Contents¶

class src.bluetooth_sig.gatt.characteristics.navigation.HeadingSource¶

Bases: enum.IntEnum

Heading source enumeration.

HEADING_BASED_ON_MAGNETIC_COMPASS = 1¶

HEADING_BASED_ON_MOVEMENT = 0¶

class src.bluetooth_sig.gatt.characteristics.navigation.NavigationCharacteristic¶

Bases: src.bluetooth_sig.gatt.characteristics.base.BaseCharacteristic[NavigationData]

Navigation characteristic.

Used to represent data related to a navigation sensor.

DESTINATION_REACHED_MASK = 256¶

HEADING_SOURCE_MASK = 32¶

HEADING_SOURCE_SHIFT = 5¶

NAVIGATION_INDICATOR_TYPE_MASK = 64¶

NAVIGATION_INDICATOR_TYPE_SHIFT = 6¶

POSITION_STATUS_MASK = 6¶

POSITION_STATUS_SHIFT = 1¶

WAYPOINT_REACHED_MASK = 128¶

allow_variable_length: bool = True¶

max_length = 19¶

min_length = 6¶

class src.bluetooth_sig.gatt.characteristics.navigation.NavigationData¶

Bases: msgspec.Struct

Parsed data from Navigation characteristic.

bearing: float¶

destination_reached: bool | None = None¶

estimated_time_of_arrival: datetime.datetime | None = None¶

flags: NavigationFlags¶

heading: float¶

heading_source: HeadingSource | None = None¶

navigation_indicator_type: NavigationIndicatorType | None = None¶

position_status: src.bluetooth_sig.types.location.PositionStatus | None = None¶

remaining_distance: float | None = None¶

remaining_vertical_distance: float | None = None¶

waypoint_reached: bool | None = None¶

class src.bluetooth_sig.gatt.characteristics.navigation.NavigationFlags¶

Bases: enum.IntFlag

Navigation flags as per Bluetooth SIG specification.

ESTIMATED_TIME_OF_ARRIVAL_PRESENT = 4¶

REMAINING_DISTANCE_PRESENT = 1¶

REMAINING_VERTICAL_DISTANCE_PRESENT = 2¶

class src.bluetooth_sig.gatt.characteristics.navigation.NavigationIndicatorType¶

Bases: enum.IntEnum

Navigation indicator type enumeration.

TO_DESTINATION = 1¶

TO_WAYPOINT = 0¶