Source code for lpf2.hub_property

"""Hub-property identifiers (LWP 3.5.2).

Passed to :meth:`lpf2.hub.getHubPropStr` and used by
:class:`lpf2.hub_emulation` to publish hub metadata.
"""

from __future__ import annotations

[docs] ADVERTISING_NAME: int = 0x01
"""Advertised hub name (UTF-8, up to 14 bytes)."""
[docs] BUTTON: int = 0x02
"""Power-button state."""
[docs] FW_VERSION: int = 0x03
"""Firmware version."""
[docs] HW_VERSION: int = 0x04
"""Hardware version."""
[docs] RSSI: int = 0x05
"""BLE RSSI (dBm, signed)."""
[docs] BATTERY_VOLTAGE: int = 0x06
"""Battery level percentage (0..100)."""
[docs] BATTERY_TYPE: int = 0x07
"""Battery type (see :mod:`lpf2.battery_type`)."""
[docs] MANUFACTURER_NAME: int = 0x08
"""Manufacturer name string."""
[docs] RADIO_FIRMWARE_VERSION: int = 0x09
"""Radio firmware version string."""
[docs] LEGO_WIRELESS_PROTOCOL_VERSION: int = 0x0A
"""LWP version reported by the hub."""
[docs] SYSTEM_TYPE_ID: int = 0x0B
"""System/hub type id byte."""
[docs] HW_NETWORK_ID: int = 0x0C
"""Hardware network id."""
[docs] PRIMARY_MAC_ADDRESS: int = 0x0D
"""Primary BLE MAC."""
[docs] SECONDARY_MAC_ADDRESS: int = 0x0E
"""Secondary BLE MAC (for hubs with two radios)."""
[docs] HARDWARE_NETWORK_FAMILY: int = 0x0F
"""Hardware network family byte."""