aliro_uwb_adapter.h File Reference

— reader-device public interface. More...

#include <cherry/cherry.h>
#include <cherry/cherry_ccc.h>
#include <stddef.h>
#include <stdint.h>

Include dependency graph for aliro_uwb_adapter.h:

Go to the source code of this file.

Data Structures
struct	aliro_uwb_preferred_hopping_configs
	Ordered hopping preferences (at least one default sequence required). More...
struct	aliro_uwb_adapter_reader_config
	Reader-side selection preferences (borrowed for the adapter's lifetime). More...

Macros
#define	ALIRO_UWB_ADAPTER_PREFERRED_HOP_CONFIG_MAX   3
	Maximum number of preferred hopping configurations the reader may list.

Enumerations
enum	aliro_uwb_err
	Status codes returned by the Aliro UWB adapter.
enum	aliro_hopping_config
	Reader-preferred hopping configuration.

Functions
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.
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.
void	aliro_uwb_adapter_destroy (struct aliro_uwb_adapter *aliro_ctx)
	Release an adapter context.

Detailed Description

— reader-device public interface.

Function Documentation

aliro_uwb_adapter_create_reader()

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.

Parameters

cherry_ctx	Cherry library context to bind the new reader adapter to.
caps	Device capabilities to advertise during CCC discovery.
config	Reader adapter configuration, borrowed for the adapter's lifetime.

Returns

New adapter, or NULL on bad parameters or allocation failure.

Create a reader-mode adapter.

aliro_uwb_adapter_destroy()

void aliro_uwb_adapter_destroy

(

struct aliro_uwb_adapter *

aliro_ctx

)

Release an adapter context.

Parameters

aliro_ctx

Adapter context to release.

Release an adapter context.

aliro_uwb_adapter_set_diagnostics()

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.

Parameters

aliro_ctx	Adapter context to update.
config	Diagnostic configuration to apply for CCC reporting.

Set the diagnostics configuration applied to new sessions.