How truesense-it/portentauwbshield works
This is an Arduino library for using the Portenta UWB Shield. A sketch calls the public UWB API, configures and manages ranging sessions, then receives ranging or data notifications; the HAL abstracts the underlying UWB stack. README capabilities include TWR, TDoA, and Apple Nearby Interaction. The graph includes the distinct role and data-transfer APIs; several are linked only where the source index establishes references, so unsampled runtime behavior is not inferred.
Main entry points: UWBSession.hpp UWB session · UWB.hpp UWB engine · uwb_hal.hpp UWB HAL · UWBAppParamList.hpp App parameters
Components 32
Public API
- Shield API
src/PortentaUWBShield.h - UWB engine
src/uwbapps/UWB.hpp
Sessions and Nearby
- UWB session
src/uwbapps/UWBSession.hpp - Session manager
src/uwbapps/UWBSessionManager.hpp - Nearby session
src/uwbapps/NearbySession.hpp - Nearby manager
src/uwbapps/NearbySessionManager.hpp
Ranging and Data
- TWR roles
src/uwbapps/UWBRangingController.hpp - Controlee role
src/uwbapps/UWBRangingControlee.hpp - One-to-many
src/uwbapps/UWBRangingOneToMany.hpp - Multi-session anchor
src/uwbapps/UWBMultiSessionAnchor.hpp - Multi-session tag
src/uwbapps/UWBMultiSessionTag.hpp - TDoA roles
src/uwbapps/UWBDltdoaInitiator.hpp - TDoA responder
src/uwbapps/UWBDltdoaResponder.hpp - TDoA tag
src/uwbapps/UWBDltdoaTag.hpp - TDoA anchors
src/uwbapps/UWBUltdoaAnchor.hpp - Sync anchor
src/uwbapps/UWBUltdoaSyncAnchor.hpp - In-band transmit
src/uwbapps/UWBInbandDataTx.hpp - In-band receive
src/uwbapps/UWBInbandDataRx.hpp - Ranging results
src/uwbapps/UWBRangingData.hpp - Notifications
src/uwbapps/UWBNotification.hpp - Anchor coordinates
src/uwbapps/UWBAnchorCoordinates.hpp - Active rounds
src/uwbapps/UWBActiveRounds.hpp
HAL and Parameters
- UWB HAL
src/hal/uwb_hal.hpp - UWB types
src/hal/uwb_types.hpp - App parameters
src/uwbapps/UWBAppParamList.hpp - Parameter values
src/uwbapps/UWBAppParamsList.hpp - Vendor parameters
src/uwbapps/UWBVendorParamList.hpp - Ranging parameters
src/uwbapps/UWBRangingParams.hpp - MAC address
src/uwbapps/UWBMacAddress.hpp - MAC list
src/uwbapps/UWBMacAddressList.hpp
Other components
- Arduino sketch
- BLE peer
Connections 48
- Arduino sketch → Shield API: uses
README.md - Shield API → UWB engine: exposes
src/PortentaUWBShield.h - UWB engine → Session manager: manages sessions
src/uwbapps/UWB.cpp - UWB engine → Nearby manager: references
src/uwbapps/UWB.hpp - BLE peer → Nearby manager: connects
src/uwbapps/NearbySessionManager.hpp - Nearby manager → Nearby session: finds sessions
src/uwbapps/NearbySessionManager.hpp - Session manager → UWB session: stores sessions
src/uwbapps/UWBSessionManager.hpp - Nearby session → UWB session: extends
src/uwbapps/NearbySession.hpp - UWB session → UWB HAL: controls sessions
src/uwbapps/UWBSession.hpp - TWR roles → UWB engine: uses engine
src/uwbapps/UWBRangingController.hpp - TWR roles → UWB session: uses session
src/uwbapps/UWBRangingController.hpp - Controlee role → UWB engine: uses engine
src/uwbapps/UWBRangingControlee.hpp - Controlee role → UWB session: uses session
src/uwbapps/UWBRangingControlee.hpp - One-to-many → UWB session: uses session
src/uwbapps/UWBRangingOneToMany.hpp - Multi-session anchor → UWB engine: uses engine
src/uwbapps/UWBMultiSessionAnchor.hpp - Multi-session anchor → UWB session: uses session
src/uwbapps/UWBMultiSessionAnchor.hpp - Multi-session tag → UWB engine: uses engine
src/uwbapps/UWBMultiSessionTag.hpp - Multi-session tag → UWB session: uses session
src/uwbapps/UWBMultiSessionTag.hpp - TDoA roles → UWB engine: uses engine
src/uwbapps/UWBDltdoaInitiator.hpp - TDoA roles → UWB session: uses session
src/uwbapps/UWBDltdoaInitiator.hpp - TDoA roles → Anchor coordinates: uses coordinates
src/uwbapps/UWBDltdoaInitiator.hpp - TDoA roles → Active rounds: tracks rounds
src/uwbapps/UWBDltdoaInitiator.hpp - TDoA responder → UWB engine: uses engine
src/uwbapps/UWBDltdoaResponder.hpp - TDoA responder → UWB session: uses session
src/uwbapps/UWBDltdoaResponder.hpp - TDoA tag → UWB engine: uses engine
src/uwbapps/UWBDltdoaTag.hpp - TDoA tag → UWB session: uses session
src/uwbapps/UWBDltdoaTag.hpp - TDoA anchors → UWB engine: uses engine
src/uwbapps/UWBUltdoaAnchor.hpp - TDoA anchors → UWB session: uses session
src/uwbapps/UWBUltdoaAnchor.hpp - Sync anchor → UWB engine: uses engine
src/uwbapps/UWBUltdoaSyncAnchor.hpp - Sync anchor → UWB session: uses session
src/uwbapps/UWBUltdoaSyncAnchor.hpp - In-band transmit → UWB engine: uses engine
src/uwbapps/UWBInbandDataTx.hpp - In-band transmit → UWB session: sends through
src/uwbapps/UWBInbandDataTx.hpp - In-band receive → UWB engine: uses engine
src/uwbapps/UWBInbandDataRx.hpp - In-band receive → UWB session: uses session
src/uwbapps/UWBInbandDataRx.hpp - UWB engine → Notifications: registers callbacks
src/uwbapps/UWB.hpp - UWB engine → Ranging results: reports ranging
src/uwbapps/UWB.hpp - Ranging results → UWB types: decodes measurements
src/uwbapps/UWBRangingData.hpp - UWB session → Ranging parameters: configures with
src/uwbapps/UWBSession.hpp - UWB session → App parameters: uses parameters
src/uwbapps/UWBSession.hpp - UWB session → Vendor parameters: uses parameters
src/uwbapps/UWBSession.hpp - UWB HAL → UWB types: uses types
src/hal/uwb_hal.hpp - UWB HAL → App parameters: uses parameters
src/hal/uwb_hal.hpp - UWB HAL → Vendor parameters: uses parameters
src/hal/uwb_hal.hpp - UWB HAL → Ranging parameters: uses parameters
src/hal/uwb_hal.hpp - App parameters → Parameter values: uses values
src/uwbapps/UWBAppParamList.hpp - App parameters → MAC address: uses addresses
src/uwbapps/UWBAppParamList.hpp - App parameters → MAC list: uses address lists
src/uwbapps/UWBAppParamList.hpp - Vendor parameters → Parameter values: uses values
src/uwbapps/UWBVendorParamList.hpp