modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h
asxeem/openaliro
Module

aliro_uwb_adapter.h

reader-device public interface.

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h2 documented symbols

Overview

reader-device public interface.

depends on cherry.h cherry_ccc.h  ·  used by aliro_ranging.c aliro_uwb_adapter.c aliro_uwb_internal.h aliro_uwb_msg.c

API

Cstruct aliro_uwb_preferred_hopping_configs

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:46

Ordered hopping preferences (at least one default sequence required).

Cstruct aliro_uwb_adapter_reader_config

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:54

Reader-side selection preferences (borrowed for the adapter's lifetime).

##define ALIRO_UWB_ADAPTER_PREFERRED_HOP_CONFIG_MAX 3

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:16

Maximum number of preferred hopping configurations the reader may list.

Cenum aliro_uwb_err

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:22

Status codes returned by the Aliro UWB adapter.

Cenum aliro_hopping_config

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:37

Reader-preferred hopping configuration.

Fstruct 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)

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:76

Create a reader-mode adapter. @param cherry_ctx Cherry library context to bind the new reader adapter to. @param caps Device capabilities to advertise during CCC discovery. @param config Reader adapter configuration, borrowed for the adapter's lifetime. @return New adapter, or NULL on bad parameters or allocation failure.

Fvoid aliro_uwb_adapter_set_diagnostics(struct aliro_uwb_adapter *aliro_ctx, struct cherry_common_diag_cfg config)

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:86

Set the diagnostics configuration applied to new sessions. @param aliro_ctx Adapter context to update. @param config Diagnostic configuration to apply for CCC reporting.

Fvoid aliro_uwb_adapter_destroy(struct aliro_uwb_adapter *aliro_ctx)

modules/woz_uwb/src/aliro/include/aliro_uwb_adapter/aliro_uwb_adapter.h:93

Release an adapter context. @param aliro_ctx Adapter context to release.