openaliro
Aliro reader: UWB/CCC core and ESP32-S3/C5/C6 port
Loading...
Searching...
No Matches
aliro_uwb_adapter.h
Go to the documentation of this file.
1
3#pragma once
4
5#include <cherry/cherry.h>
6#include <cherry/cherry_ccc.h>
7
8#include <stddef.h>
9#include <stdint.h>
10
11#ifdef __cplusplus
12extern "C" {
13#endif
14
16#define ALIRO_UWB_ADAPTER_PREFERRED_HOP_CONFIG_MAX 3
17
20
23 ALIRO_UWB_ERR_NONE,
24 ALIRO_UWB_ERR_INVALID_PARAMETER,
25 ALIRO_UWB_ERR_UWBS_TIMEOUT,
26 ALIRO_UWB_ERR_INTERNAL,
27 ALIRO_UWB_ERR_SESSION_INIT,
28 ALIRO_UWB_ERR_SESSION_ACTIVE,
29 ALIRO_UWB_ERR_SESSION_CONFIG,
30 ALIRO_UWB_ERR_MESSAGE_UNSUPPORTED,
31 ALIRO_UWB_ERR_MESSAGE_STATE,
32 ALIRO_UWB_ERR_INVALID_STATE,
33 ALIRO_UWB_ERR_MSG_MALFORMED,
34};
35
38 ALIRO_HOPPING_CONFIG_DISABLED = CHERRY_CCC_HOPPING_MODE_DISABLE,
39 ALIRO_HOPPING_CONFIG_CONTINUOUS_DEFAULT = CHERRY_CCC_HOPPING_MODE_CONTINUOUS_DEFAULT,
40 ALIRO_HOPPING_CONFIG_ADAPTIVE_DEFAULT = CHERRY_CCC_HOPPING_MODE_ADAPTATIVE_DEFAULT,
41};
42
50
68
76struct aliro_uwb_adapter *
80
88
93void aliro_uwb_adapter_destroy(struct aliro_uwb_adapter *aliro_ctx);
94
95#ifdef __cplusplus
96}
97#endif
struct aliro_uwb_adapter * aliro_uwb_adapter_create_reader(struct cherry *cherry_ctx, struct cherry_core_event_device_capabilities *caps, struct aliro_uwb_adapter_reader_config *config)
Create a reader-mode adapter.
Definition aliro_uwb_adapter.c:118
void aliro_uwb_adapter_set_diagnostics(struct aliro_uwb_adapter *aliro_ctx, struct cherry_common_diag_cfg config)
Set the diagnostics configuration applied to new sessions.
Definition aliro_uwb_adapter.c:160
void aliro_uwb_adapter_destroy(struct aliro_uwb_adapter *aliro_ctx)
Release an adapter context.
Definition aliro_uwb_adapter.c:179
#define ALIRO_UWB_ADAPTER_PREFERRED_HOP_CONFIG_MAX
Maximum number of preferred hopping configurations the reader may list.
Definition aliro_uwb_adapter.h:16
aliro_uwb_err
Status codes returned by the Aliro UWB adapter.
Definition aliro_uwb_adapter.h:22
aliro_hopping_config
Reader-preferred hopping configuration.
Definition aliro_uwb_adapter.h:37
— Cherry core (context + device-capabilities) interface.
— CCC/Aliro-session interface (seam the adapter drives).
Reader-side selection preferences (borrowed for the adapter's lifetime).
Definition aliro_uwb_adapter.h:54
uint8_t min_ran_multiplier
Lower bound on the selected RAN multiplier (T_Block = N x 96 ms).
Definition aliro_uwb_adapter.h:56
uint8_t r1_antennas[2]
{Tx, Rx} antenna sets for the first ranging round.
Definition aliro_uwb_adapter.h:64
struct aliro_uwb_preferred_hopping_configs preferred_hopping_configs
Ordered preferred hopping configurations.
Definition aliro_uwb_adapter.h:60
uint8_t r2_antennas[2]
{Tx, Rx} antenna sets for the second ranging round (MAC mode 1).
Definition aliro_uwb_adapter.h:66
uint8_t mac_mode
MAC mode: b0-b5 round offset, b6-b7 number of ranging rounds.
Definition aliro_uwb_adapter.h:62
Session-independent reader state shared across all ranging sessions for an Aliro UWB adapter.
Definition aliro_uwb_internal.h:16
struct cherry * cherry_ctx
Cherry library context managing CCC session lifecycle and event dispatch.
Definition aliro_uwb_internal.h:20
struct aliro_uwb_adapter_reader_config * config
Reader adapter configuration supplied by the caller (e.g., ranging parameters, capabilities).
Definition aliro_uwb_internal.h:25
Ordered hopping preferences (at least one default sequence required).
Definition aliro_uwb_adapter.h:46
Per-session diagnostics selection flags and CIR window parameters, passed by value.
Definition cherry_common.h:15
UWBS capability container reported by the peer during device discovery; only the CCC capabilities mem...
Definition cherry.h:50
Opaque Cherry context holder.
Definition cherry_ccc_shim.c:27