modules/woz_uwb/src/aliro/include/cherry/cherry_session.h
asxeem/openaliro
Module

cherry_session.h

generic base-session interface.

modules/woz_uwb/src/aliro/include/cherry/cherry_session.h

Overview

generic base-session interface.

depends on cherry.h cherry_common.h  ·  used by cherry_ccc.h cherry_ccc_shim.c

API

Fvoid * cherry_session_get_user_data(struct cherry_session *session)

modules/woz_uwb/src/aliro/include/cherry/cherry_session.h:19

Return the opaque client pointer stored at session creation.

Fvoid cherry_session_destroy(struct cherry_session *session)

modules/woz_uwb/src/aliro/include/cherry/cherry_session.h:22

Stop if needed, tear down, and release the session.

Fenum cherry_err cherry_session_start(struct cherry_session *session)

modules/woz_uwb/src/aliro/include/cherry/cherry_session.h:25

Request the session to start ranging.

Fenum cherry_err cherry_session_stop(struct cherry_session *session)

modules/woz_uwb/src/aliro/include/cherry/cherry_session.h:28

Request the session to stop ranging.

Fenum cherry_err cherry_session_set_antennas(struct cherry_session *session, uint8_t tx_antenna_set, uint8_t rx_antenna_set)

modules/woz_uwb/src/aliro/include/cherry/cherry_session.h:31

Select the Tx/Rx antenna sets for the first ranging round.

Fenum cherry_err cherry_session_set_diagnostics(struct cherry_session *session, struct cherry_common_diag_cfg config, bool enable_fallback)

modules/woz_uwb/src/aliro/include/cherry/cherry_session.h:35

Enable/disable per-session diagnostics (config passed by value).