Crate a121_sys

Source
Expand description

§a121-sys Crate Documentation

Welcome to the a121-sys crate, providing raw FFI bindings for the Acconeer A121 radar sensor. This crate offers low-level access to the A121 sensor’s capabilities, designed for embedded systems and no_std environments.

§Usage

Add a121-sys to your Cargo.toml:

[dependencies]
# For real hardware
a121-sys = { version = "0.5", features = ["distance", "presence"] }

# For testing/development with stub library
a121-sys = { version = "0.5", features = ["stub_library", "distance", "presence"] }

§Features

  • distance: Enable distance measurement functionality
  • presence: Enable presence detection functionality
  • stub_library: Use stub implementations for testing/development without hardware
  • std: Enable functionality requiring the standard library

§Library Requirements

This crate requires the Acconeer A121 static libraries and the arm-none-eabi-gcc toolchain. You can either:

  1. Use the real libraries:

    • Obtain the official Acconeer A121 SDK
    • Set ACC_RSS_LIBS environment variable to the library location
  2. Use stub libraries (for testing/development):

    • Enable the stub_library feature

§Logging Integration

The crate provides a way to integrate with the sensor’s native logging through a C log wrapper. Implement the rust_log function to capture log messages:

use core::ffi::c_char;

#[no_mangle]
pub extern "C" fn rust_log(level: u32, message: *const c_char) {
    // Your logging implementation here
}

§Embedded Usage

The crate is designed for embedded systems and supports:

  • no_std environments
  • Cortex-M4 targets (specifically thumbv7em-none-eabihf, or risc)
  • Both real hardware and stub implementations

Example target configuration:

[build]
target = "thumbv7em-none-eabihf"

[target.thumbv7em-none-eabihf]
rustflags = [
    "-C", "link-arg=-mcpu=cortex-m4",
    "-C", "link-arg=-mthumb",
    "-C", "link-arg=-mfloat-abi=hard",
    "-C", "link-arg=-mfpu=fpv4-sp-d16",
]

§Safety

This crate provides raw FFI bindings which are inherently unsafe. Users should:

  • Take care when implementing the logging callback
  • Ensure proper initialization of the sensor
  • Follow proper memory management practices
  • Consider using higher-level safe wrappers (like the a121 crate)

§Development and Testing

For development without hardware:

  1. Enable the stub library feature:

    a121-sys = { version = "0.5", features = ["stub_library"] }
  2. Install required toolchain:

    rustup target add thumbv7em-none-eabihf
    # Install ARM GCC toolchain for your platform

§Environment Variables

  • ACC_RSS_LIBS: Path to the Acconeer A121 libraries
  • CPATH: Additional C header paths (usually set automatically)

§Version Compatibility

  • Current bindings version: 1.8.0
  • Minimum Supported Rust Version (MSRV): 1.82.0

Structs§

__atomic_wide_counter__bindgen_ty_1
__fsid_t
__once_flag
__pthread_cond_s
__pthread_internal_list
__pthread_internal_slist
__pthread_mutex_s
__pthread_rwlock_arch_t
__sigset_t
acc_cal_info_t
@brief Information about calibration.
acc_cal_result_t
@brief The result from a completed calibration.
acc_config
@defgroup config Config @ingroup service
acc_detector_cal_result_dynamic_t
@brief The result from a completed calibration update
acc_detector_distance_config
acc_detector_distance_handle
acc_detector_distance_result_t
@brief Distance Detector result returned from @ref acc_detector_distance_process
acc_detector_presence_config
@brief Presence detector configuration container
acc_detector_presence_handle
@brief Presence detector handle
acc_detector_presence_metadata_t
brief Metadata for presence detector
acc_detector_presence_processing_config
@brief Presence processing configuration container
acc_detector_presence_processing_handle
@brief Presence detector handle container
acc_detector_presence_processing_result_t
@brief Presence detector results container
acc_detector_presence_result_t
@brief Presence detector results container
acc_hal_a121_t
acc_hal_optimization_t
@brief This struct contains function pointers that are optional to support different optimizations
acc_int16_complex_t
@brief Data type for interger-based representation of complex numbers
acc_processing_handle
@brief Generic processing handle
acc_processing_metadata_t
@brief Metadata that will be populated by the processing module during creation
acc_processing_result_t
@brief Result provided by the processing module
acc_rss_assembly_test
@brief The acc_rss_assembly_test instance
acc_rss_assembly_test_result_t
@brief The result struct of acc_rss_assembly_test
acc_sensor
@defgroup service Service
div_t
drand48_data
fd_set
imaxdiv_t
ldiv_t
lldiv_t
max_align_t
random_data
timespec
timeval

Constants§

ACC_CAL_RESULT_DATA_SIZE
ACC_DETECTOR_CAL_RESULT_DYNAMIC_DATA_SIZE
ACC_DETECTOR_DISTANCE_RESULT_MAX_NUM_DISTANCES
ACC_HAL_SPI_TRANSFER_SIZE_REQUIRED
ACC_MAX_NUM_SUBSWEEPS
ACC_RSS_ASSEMBLY_TEST_MIN_BUFFER_SIZE
BIG_ENDIAN
BYTE_ORDER
EXIT_FAILURE
EXIT_SUCCESS
FD_SETSIZE
INT8_MAX
INT8_MIN
INT16_MAX
INT16_MIN
INT32_MAX
INT32_MIN
INTPTR_MAX
INTPTR_MIN
INT_FAST8_MAX
INT_FAST8_MIN
INT_FAST16_MAX
INT_FAST16_MIN
INT_FAST32_MAX
INT_FAST32_MIN
INT_LEAST8_MAX
INT_LEAST8_MIN
INT_LEAST16_MAX
INT_LEAST16_MIN
INT_LEAST32_MAX
INT_LEAST32_MIN
LITTLE_ENDIAN
PDP_ENDIAN
PRIX8
PRIX16
PRIX32
PRIX64
PRIXFAST8
PRIXFAST16
PRIXFAST32
PRIXFAST64
PRIXLEAST8
PRIXLEAST16
PRIXLEAST32
PRIXLEAST64
PRIXMAX
PRIXPTR
PRId8
PRId16
PRId32
PRId64
PRIdFAST8
PRIdFAST16
PRIdFAST32
PRIdFAST64
PRIdLEAST8
PRIdLEAST16
PRIdLEAST32
PRIdLEAST64
PRIdMAX
PRIdPTR
PRIi8
PRIi16
PRIi32
PRIi64
PRIiFAST8
PRIiFAST16
PRIiFAST32
PRIiFAST64
PRIiLEAST8
PRIiLEAST16
PRIiLEAST32
PRIiLEAST64
PRIiMAX
PRIiPTR
PRIo8
PRIo16
PRIo32
PRIo64
PRIoFAST8
PRIoFAST16
PRIoFAST32
PRIoFAST64
PRIoLEAST8
PRIoLEAST16
PRIoLEAST32
PRIoLEAST64
PRIoMAX
PRIoPTR
PRIsensor_id
PRIu8
PRIu16
PRIu32
PRIu64
PRIuFAST8
PRIuFAST16
PRIuFAST32
PRIuFAST64
PRIuLEAST8
PRIuLEAST16
PRIuLEAST32
PRIuLEAST64
PRIuMAX
PRIuPTR
PRIx8
PRIx16
PRIx32
PRIx64
PRIxFAST8
PRIxFAST16
PRIxFAST32
PRIxFAST64
PRIxLEAST8
PRIxLEAST16
PRIxLEAST32
PRIxLEAST64
PRIxMAX
PRIxPTR
PTRDIFF_MAX
PTRDIFF_MIN
RAND_MAX
SCNd8
SCNd16
SCNd32
SCNd64
SCNdFAST8
SCNdFAST16
SCNdFAST32
SCNdFAST64
SCNdLEAST8
SCNdLEAST16
SCNdLEAST32
SCNdLEAST64
SCNdMAX
SCNdPTR
SCNi8
SCNi16
SCNi32
SCNi64
SCNiFAST8
SCNiFAST16
SCNiFAST32
SCNiFAST64
SCNiLEAST8
SCNiLEAST16
SCNiLEAST32
SCNiLEAST64
SCNiMAX
SCNiPTR
SCNo8
SCNo16
SCNo32
SCNo64
SCNoFAST8
SCNoFAST16
SCNoFAST32
SCNoFAST64
SCNoLEAST8
SCNoLEAST16
SCNoLEAST32
SCNoLEAST64
SCNoMAX
SCNoPTR
SCNu8
SCNu16
SCNu32
SCNu64
SCNuFAST8
SCNuFAST16
SCNuFAST32
SCNuFAST64
SCNuLEAST8
SCNuLEAST16
SCNuLEAST32
SCNuLEAST64
SCNuMAX
SCNuPTR
SCNx8
SCNx16
SCNx32
SCNx64
SCNxFAST8
SCNxFAST16
SCNxFAST32
SCNxFAST64
SCNxLEAST8
SCNxLEAST16
SCNxLEAST32
SCNxLEAST64
SCNxMAX
SCNxPTR
SIG_ATOMIC_MAX
SIG_ATOMIC_MIN
SIZE_MAX
UINT8_MAX
UINT16_MAX
UINT32_MAX
UINTPTR_MAX
UINT_FAST8_MAX
UINT_FAST16_MAX
UINT_FAST32_MAX
UINT_LEAST8_MAX
UINT_LEAST16_MAX
UINT_LEAST32_MAX
WCONTINUED
WEXITED
WINT_MAX
WINT_MIN
WNOHANG
WNOWAIT
WSTOPPED
WUNTRACED
_ALLOCA_H
_ATFILE_SOURCE
_BITS_BYTESWAP_H
_BITS_ENDIANNESS_H
_BITS_ENDIAN_H
_BITS_PTHREADTYPES_ARCH_H
_BITS_PTHREADTYPES_COMMON_H
_BITS_STDINT_INTN_H
_BITS_STDINT_UINTN_H
_BITS_TIME64_H
_BITS_TYPESIZES_H
_BITS_TYPES_H
_BITS_UINTN_IDENTITY_H
_BITS_WCHAR_H
_DEFAULT_SOURCE
_ENDIAN_H
_FEATURES_H
_INTTYPES_H
_POSIX_C_SOURCE
_POSIX_SOURCE
_STDC_PREDEF_H
_STDINT_H
_STDLIB_H
_STRUCT_TIMESPEC
_SYS_CDEFS_H
_SYS_SELECT_H
_SYS_TYPES_H
_THREAD_MUTEX_INTERNAL_H
_THREAD_SHARED_TYPES_H
__BIG_ENDIAN
__BIT_TYPES_DEFINED__
__BYTE_ORDER
__FD_SETSIZE
__FLOAT_WORD_ORDER
__GLIBC_MINOR__
__GLIBC_USE_DEPRECATED_GETS
__GLIBC_USE_DEPRECATED_SCANF
__GLIBC_USE_IEC_60559_BFP_EXT
__GLIBC_USE_IEC_60559_BFP_EXT_C2X
__GLIBC_USE_IEC_60559_EXT
__GLIBC_USE_IEC_60559_FUNCS_EXT
__GLIBC_USE_IEC_60559_FUNCS_EXT_C2X
__GLIBC_USE_IEC_60559_TYPES_EXT
__GLIBC_USE_ISOC2X
__GLIBC_USE_LIB_EXT2
__GLIBC__
__GNU_LIBRARY__
__HAVE_DISTINCT_FLOAT16
__HAVE_DISTINCT_FLOAT32
__HAVE_DISTINCT_FLOAT64
__HAVE_DISTINCT_FLOAT32X
__HAVE_DISTINCT_FLOAT64X
__HAVE_DISTINCT_FLOAT128
__HAVE_DISTINCT_FLOAT128X
__HAVE_FLOAT16
__HAVE_FLOAT32
__HAVE_FLOAT64
__HAVE_FLOAT32X
__HAVE_FLOAT64X
__HAVE_FLOAT64X_LONG_DOUBLE
__HAVE_FLOAT128
__HAVE_FLOAT128X
__HAVE_FLOATN_NOT_TYPEDEF
__HAVE_GENERIC_SELECTION
__INO_T_MATCHES_INO64_T
__KERNEL_OLD_TIMEVAL_MATCHES_TIMEVAL64
__LDOUBLE_REDIRECTS_TO_FLOAT128_ABI
__LITTLE_ENDIAN
__OFF_T_MATCHES_OFF64_T
__PDP_ENDIAN
__PRI64_PREFIX
__PRIPTR_PREFIX
__PTHREAD_MUTEX_HAVE_PREV
__RLIM_T_MATCHES_RLIM64_T
__SIZEOF_PTHREAD_ATTR_T
__SIZEOF_PTHREAD_BARRIERATTR_T
__SIZEOF_PTHREAD_BARRIER_T
__SIZEOF_PTHREAD_CONDATTR_T
__SIZEOF_PTHREAD_COND_T
__SIZEOF_PTHREAD_MUTEXATTR_T
__SIZEOF_PTHREAD_MUTEX_T
__SIZEOF_PTHREAD_RWLOCKATTR_T
__SIZEOF_PTHREAD_RWLOCK_T
__STATFS_MATCHES_STATFS64
__STDC_IEC_559_COMPLEX__
__STDC_IEC_559__
__STDC_IEC_60559_BFP__
__STDC_IEC_60559_COMPLEX__
__STDC_ISO_10646__
__SYSCALL_WORDSIZE
__TIMESIZE
__USE_ATFILE
__USE_FORTIFY_LEVEL
__USE_ISOC11
__USE_ISOC95
__USE_ISOC99
__USE_MISC
__USE_POSIX
__USE_POSIX2
__USE_POSIX199309
__USE_POSIX199506
__USE_POSIX_IMPLICITLY
__USE_XOPEN2K
__USE_XOPEN2K8
__WALL
__WCLONE
__WCOREFLAG
__WNOTHREAD
__WORDSIZE
__WORDSIZE_TIME64_COMPAT32
__W_CONTINUED
____gwchar_t_defined
__bool_true_false_are_defined
__clock_t_defined
__clockid_t_defined
__glibc_c99_flexarr_available
__have_pthread_attr_t
__ldiv_t_defined
__lldiv_t_defined
__sigset_t_defined
__time_t_defined
__timer_t_defined
__timeval_defined
acc_config_idle_state_t_ACC_CONFIG_IDLE_STATE_DEEP_SLEEP
The deepest state where as much of the sensor hardware is shut down.
acc_config_idle_state_t_ACC_CONFIG_IDLE_STATE_READY
The shallowest state where most of the sensor hardware is kept on.
acc_config_idle_state_t_ACC_CONFIG_IDLE_STATE_SLEEP
The deepest state where as much of the sensor hardware is shut down.
acc_config_prf_t_ACC_CONFIG_PRF_5_2_MHZ
5.2 MHz
acc_config_prf_t_ACC_CONFIG_PRF_6_5_MHZ
6.5 MHz
acc_config_prf_t_ACC_CONFIG_PRF_8_7_MHZ
8.7 MHz
acc_config_prf_t_ACC_CONFIG_PRF_13_0_MHZ
13.0 MHz
acc_config_prf_t_ACC_CONFIG_PRF_15_6_MHZ
15.6 MHz
acc_config_prf_t_ACC_CONFIG_PRF_19_5_MHZ
19.5 MHz
acc_config_profile_t_ACC_CONFIG_PROFILE_1
The profile with the highest depth resolution and lowest radar loop gain.
acc_config_profile_t_ACC_CONFIG_PROFILE_2
The profile with the highest depth resolution and lowest radar loop gain.
acc_config_profile_t_ACC_CONFIG_PROFILE_3
The profile with the highest depth resolution and lowest radar loop gain.
acc_config_profile_t_ACC_CONFIG_PROFILE_4
The profile with the highest depth resolution and lowest radar loop gain.
acc_config_profile_t_ACC_CONFIG_PROFILE_5
The profile with the lowest depth resolution and highest radar loop gain.
acc_detector_distance_peak_sorting_t_ACC_DETECTOR_DISTANCE_PEAK_SORTING_CLOSEST
Return peaks with the closest detection first.
acc_detector_distance_peak_sorting_t_ACC_DETECTOR_DISTANCE_PEAK_SORTING_STRONGEST
Return peaks with the peak with the highest RCS first.
acc_detector_distance_reflector_shape_t_ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_GENERIC
Use a generic reflector shape for RCS calculation
acc_detector_distance_reflector_shape_t_ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_PLANAR
Use a planar reflector shape for RCS calculation
acc_detector_distance_threshold_method_t_ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_CFAR
Uses the CFAR algorithm as a threshold
acc_detector_distance_threshold_method_t_ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_AMPLITUDE
Compares processed data against a fixed amplitude value
acc_detector_distance_threshold_method_t_ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_STRENGTH
Compares processed data against a fixed strength value
acc_detector_distance_threshold_method_t_ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_RECORDED
Compares processed data against a recorded threshold
acc_log_level_t_ACC_LOG_LEVEL_DEBUG
DEBUG log level.
acc_log_level_t_ACC_LOG_LEVEL_ERROR
ERROR log level.
acc_log_level_t_ACC_LOG_LEVEL_INFO
INFO log level.
acc_log_level_t_ACC_LOG_LEVEL_VERBOSE
VERBOSE log level.
acc_log_level_t_ACC_LOG_LEVEL_WARNING
WARNING log level.
acc_rss_assembly_test_test_id_t_ACC_RSS_ASSEMBLY_TEST_ID_BASIC_READ
Test SPI basic read functionality.
acc_rss_assembly_test_test_id_t_ACC_RSS_ASSEMBLY_TEST_ID_CLOCK_AND_SUPPLY
Test clock and supply stability.
acc_rss_assembly_test_test_id_t_ACC_RSS_ASSEMBLY_TEST_ID_COMMUNICATION
Test SPI communication.
acc_rss_assembly_test_test_id_t_ACC_RSS_ASSEMBLY_TEST_ID_ENABLE_PIN
Test enable pin.
acc_rss_assembly_test_test_id_t_ACC_RSS_ASSEMBLY_TEST_ID_INTERRUPT
Test interrupt pin.
acc_rss_assembly_test_test_id_t_ACC_RSS_ASSEMBLY_TEST_ID_SENSOR_CALIBRATION
Test sensor calibration.
acc_rss_test_integration_status_t_ACC_RSS_TEST_INTEGRATION_STATUS_OK
The test status is OK
acc_rss_test_integration_status_t_ACC_RSS_TEST_INTEGRATION_STATUS_TIMEOUT
The test has timed out
acc_rss_test_state_t_ACC_RSS_TEST_STATE_COMPLETE
The test is complete
acc_rss_test_state_t_ACC_RSS_TEST_STATE_ONGOING
The test is ongoing, the application should call test function again
acc_rss_test_state_t_ACC_RSS_TEST_STATE_TOGGLE_ENABLE_PIN
The application should toggle enable pin and then call test function again
acc_rss_test_state_t_ACC_RSS_TEST_STATE_WAIT_FOR_INTERRUPT
The application should wait for interrupt and then call test function again
false_
true_

Functions§

_Exit
__ctype_get_mb_cur_max
a64l
abort
abs
acc_config_continuous_sweep_mode_get
@brief Get continuous sweep mode
acc_config_continuous_sweep_mode_set
@brief Set continuous sweep mode
acc_config_create
@brief Create a configuration
acc_config_destroy
@brief Destroy a configuration freeing any resources allocated
acc_config_double_buffering_get
@brief Get the double buffering configuration
acc_config_double_buffering_set
@brief Enable or disable double buffering
acc_config_enable_loopback_get
@brief Get the enable loopback configuration
acc_config_enable_loopback_set
@brief Enable or disable loopback
acc_config_enable_tx_get
@brief Get transmitter enable configuration
acc_config_enable_tx_set
@brief Enable or disable the transmitter
acc_config_frame_rate_get
@brief Get the frame rate
acc_config_frame_rate_set
@brief Set the frame rate
acc_config_hwaas_get
@brief Get the hardware accelerated average samples (HWAAS)
acc_config_hwaas_set
@brief Set the hardware accelerated average samples (HWAAS)
acc_config_inter_frame_idle_state_get
@brief Get inter frame idle state
acc_config_inter_frame_idle_state_set
@brief Set inter frame idle state
acc_config_inter_sweep_idle_state_get
@brief Get inter sweep idle state
acc_config_inter_sweep_idle_state_set
@brief Set inter sweep idle state
acc_config_log
@brief Print a configuration to the log
acc_config_num_points_get
@brief Get the number of data points to measure
acc_config_num_points_set
@brief Set the number of data points to measure
acc_config_num_subsweeps_get
@brief Get the number of subsweeps to use
acc_config_num_subsweeps_set
@brief Set the number of subsweeps to use
acc_config_phase_enhancement_get
@brief Get the phase enhancement configuration
acc_config_phase_enhancement_set
@brief Enable or disable phase enhancement
acc_config_prf_get
@brief Get Pulse Repetition Frequency
acc_config_prf_set
@brief Set Pulse Repetition Frequency
acc_config_profile_get
@brief Get the currently used profile
acc_config_profile_set
@brief Set a profile
acc_config_receiver_gain_get
@brief Get receiver gain setting
acc_config_receiver_gain_set
@brief Set receiver gain setting
acc_config_start_point_get
@brief Get the starting point of the sweep
acc_config_start_point_set
@brief Set the starting point of the sweep
acc_config_step_length_get
@brief Get the step length in a sweep
acc_config_step_length_set
@brief Set the step length in a sweep
acc_config_subsweep_enable_loopback_get
@brief Get the enable loopback configuration
acc_config_subsweep_enable_loopback_set
@brief Set the loopback enabled configuration
acc_config_subsweep_enable_tx_get
@brief Get transmitter enable mode
acc_config_subsweep_enable_tx_set
@brief Enable or disable the transmitter
acc_config_subsweep_hwaas_get
@brief Get the hardware accelerated average samples (HWAAS)
acc_config_subsweep_hwaas_set
@brief Set the hardware accelerated average samples (HWAAS)
acc_config_subsweep_num_points_get
@brief Get the number of data points to measure
acc_config_subsweep_num_points_set
@brief Set the number of data points to measure
acc_config_subsweep_phase_enhancement_get
@brief Get the phase enhancement enabled configuration
acc_config_subsweep_phase_enhancement_set
@brief Set the phase enhancement enabled configuration
acc_config_subsweep_prf_get
@brief Get Pulse Repetition Frequency
acc_config_subsweep_prf_set
@brief Set Pulse Repetition Frequency
acc_config_subsweep_profile_get
@brief Get the currently used profile
acc_config_subsweep_profile_set
@brief Set a profile
acc_config_subsweep_receiver_gain_get
@brief Get receiver gain setting
acc_config_subsweep_receiver_gain_set
@brief Set receiver gain setting
acc_config_subsweep_start_point_get
@brief Get the starting point of the sweep
acc_config_subsweep_start_point_set
@brief Set the starting point of the sweep
acc_config_subsweep_step_length_get
@brief Get the step length in a sweep
acc_config_subsweep_step_length_set
@brief Set the step length in a sweep
acc_config_sweep_rate_get
@brief Get the sweep rate
acc_config_sweep_rate_set
@brief Set the sweep rate
acc_config_sweeps_per_frame_get
@brief Get the number of sweeps per frame
acc_config_sweeps_per_frame_set
@brief Set sweeps per frame
acc_detector_distance_calibrate
@brief Calibrate detector
acc_detector_distance_config_close_range_leakage_cancellation_get
@brief Get if close range leakage cancellation is enabled
acc_detector_distance_config_close_range_leakage_cancellation_set
@brief Enable close range leakage cancellation
acc_detector_distance_config_create
@brief Create a Distance Detector configuration
acc_detector_distance_config_destroy
@brief Destroy Distance Detector configuration
acc_detector_distance_config_end_get
@brief Get end of measured interval (m)
acc_detector_distance_config_end_set
@brief Set end of measured interval (m)
acc_detector_distance_config_fixed_amplitude_threshold_value_get
@brief Get fixed amplitude threshold value
acc_detector_distance_config_fixed_amplitude_threshold_value_set
@brief Set fixed amplitude threshold value
acc_detector_distance_config_fixed_strength_threshold_value_get
@brief Get fixed strength threshold value
acc_detector_distance_config_fixed_strength_threshold_value_set
@brief Set fixed strength threshold value
acc_detector_distance_config_log
@brief Log Distance configuration, typically through printf
acc_detector_distance_config_max_profile_get
@brief Get maximum Profile
acc_detector_distance_config_max_profile_set
@brief Set maximum Profile
acc_detector_distance_config_max_step_length_get
@brief Get maximum step length
acc_detector_distance_config_max_step_length_set
@brief Set maximum step length
acc_detector_distance_config_num_frames_recorded_threshold_get
@brief Get number of frames to use for recorded threshold
acc_detector_distance_config_num_frames_recorded_threshold_set
@brief Set number of frames to use for recorded threshold
acc_detector_distance_config_peak_sorting_get
@brief Get peak sorting method
acc_detector_distance_config_peak_sorting_set
@brief Set peak sorting method
acc_detector_distance_config_prf_override_get
@brief Get if PRF override is set and its value
acc_detector_distance_config_prf_override_set
@brief Override automatically set PRF
acc_detector_distance_config_reflector_shape_get
@brief Get reflector shape
acc_detector_distance_config_reflector_shape_set
@brief Set reflector shape
acc_detector_distance_config_signal_quality_get
@brief Get signal quality
acc_detector_distance_config_signal_quality_set
@brief Set signal quality (dB)
acc_detector_distance_config_start_get
@brief Get start of measured interval (m)
acc_detector_distance_config_start_set
@brief Set start of measured interval (m)
acc_detector_distance_config_threshold_method_get
@brief Get threshold method
acc_detector_distance_config_threshold_method_set
@brief Set threshold method
acc_detector_distance_config_threshold_sensitivity_get
@brief Get threshold sensitivity
acc_detector_distance_config_threshold_sensitivity_set
@brief Set threshold sensitivity
acc_detector_distance_create
@brief Create Distance Detector handle using the provided Distance Detector configuration
acc_detector_distance_destroy
@brief Destroy Distance Detector handle, freeing its resources
acc_detector_distance_get_sizes
@brief Get the memory size needed to use the Distance Detector API functions
acc_detector_distance_prepare
@brief Prepare the Detector for measurements
acc_detector_distance_process
@brief Process sensor data into a Detector result
acc_detector_distance_update_calibration
@brief Perform a subset of the full Detector calibration
acc_detector_presence_config_auto_profile_get
@brief Get if automatic selection of profile based on start point of measurement is enabled
acc_detector_presence_config_auto_profile_set
@brief Enable automatic selection of profile based on start point of measurement
acc_detector_presence_config_auto_step_length_get
@brief Get if automatic selection of step length based on the profile is enabled
acc_detector_presence_config_auto_step_length_set
@brief Enable automatic selection of step length based on the profile
acc_detector_presence_config_automatic_subsweeps_get
@brief Get if automatic subsweeps should be used
acc_detector_presence_config_automatic_subsweeps_set
@brief Set if automatic subsweeps should be used
acc_detector_presence_config_create
@brief Create a configuration for a presence detector
acc_detector_presence_config_destroy
@brief Destroy a presence detector configuration
acc_detector_presence_config_end_get
@brief Get the end point of measurement interval in meters
acc_detector_presence_config_end_set
@brief Set the end point of measurement interval in meters
acc_detector_presence_config_frame_rate_app_driven_get
@brief Get if the application should maintain the requested frame rate
acc_detector_presence_config_frame_rate_app_driven_set
@brief Set if the application should maintain the requested frame rate
acc_detector_presence_config_frame_rate_get
@brief Get the frame rate
acc_detector_presence_config_frame_rate_set
@brief Set the frame rate
acc_detector_presence_config_hwaas_get
@brief Get the hardware accelerated average samples (HWAAS)
acc_detector_presence_config_hwaas_set
@brief Set the hardware accelerated average samples (HWAAS)
acc_detector_presence_config_inter_detection_get
@brief Get if inter-frame presence detection is enabled
acc_detector_presence_config_inter_detection_set
@brief Set inter-frame presence detection
acc_detector_presence_config_inter_detection_threshold_get
@brief Get the detection threshold for the inter-frame presence detection
acc_detector_presence_config_inter_detection_threshold_set
@brief Set the detection threshold for the inter-frame presence detection
acc_detector_presence_config_inter_frame_deviation_time_const_get
@brief Get the time constant of the low pass filter for the inter-frame deviation between fast and slow
acc_detector_presence_config_inter_frame_deviation_time_const_set
@brief Set the time constant of the low pass filter for the inter-frame deviation between fast and slow
acc_detector_presence_config_inter_frame_fast_cutoff_get
@brief Get the cutoff frequency of the low pass filter for the fast filtered absolute sweep mean
acc_detector_presence_config_inter_frame_fast_cutoff_set
@brief Set the cutoff frequency of the low pass filter for the fast filtered absolute sweep mean
acc_detector_presence_config_inter_frame_idle_state_get
@brief Get inter frame idle state
acc_detector_presence_config_inter_frame_idle_state_set
@brief Set inter frame idle state
acc_detector_presence_config_inter_frame_presence_timeout_get
@brief Get the inter-frame presence timeout in seconds
acc_detector_presence_config_inter_frame_presence_timeout_set
@brief Set the inter-frame presence timeout in seconds
acc_detector_presence_config_inter_frame_slow_cutoff_get
@brief Get the cutoff frequency of the low pass filter for the slow filtered absolute sweep mean
acc_detector_presence_config_inter_frame_slow_cutoff_set
@brief Set the cutoff frequency of the low pass filter for the slow filtered absolute sweep mean
acc_detector_presence_config_inter_output_time_const_get
@brief Get the time constant for the output in the inter-frame part
acc_detector_presence_config_inter_output_time_const_set
@brief Set the time constant for the output in the inter-frame part
acc_detector_presence_config_inter_phase_boost_get
@brief Get if inter-frame phase boost is enabled
acc_detector_presence_config_inter_phase_boost_set
@brief Set inter-frame phase boost
acc_detector_presence_config_intra_detection_get
@brief Get if frame intra-frame presence detection is enabled
acc_detector_presence_config_intra_detection_set
@brief Set intra-frame presence detection
acc_detector_presence_config_intra_detection_threshold_get
@brief Get the detection threshold for the intra-frame presence detection
acc_detector_presence_config_intra_detection_threshold_set
@brief Set the detection threshold for the intra-frame presence detection
acc_detector_presence_config_intra_frame_time_const_get
@brief Get the time constant for the depthwise filtering in the intra-frame part
acc_detector_presence_config_intra_frame_time_const_set
@brief Set the time constant for the depthwise filtering in the intra-frame part
acc_detector_presence_config_intra_output_time_const_get
@brief Get the time constant for the output in the intra-frame part
acc_detector_presence_config_intra_output_time_const_set
@brief Set the time constant for the output in the intra-frame part
acc_detector_presence_config_log
@brief Print a configuration to the log
acc_detector_presence_config_profile_get
@brief Get the currently set profile
acc_detector_presence_config_profile_set
@brief Set a profile
acc_detector_presence_config_reset_filters_on_prepare_get
@brief Get if the presence filters should reset on prepare
acc_detector_presence_config_reset_filters_on_prepare_set
@brief Set if the presence filters should reset on prepare
acc_detector_presence_config_sensor_get
@brief Get sensor ID
acc_detector_presence_config_sensor_set
@brief Set sensor ID
acc_detector_presence_config_signal_quality_get
@brief Get signal quality
acc_detector_presence_config_signal_quality_set
@brief Set signal quality
acc_detector_presence_config_start_get
@brief Get the start point of measurement interval in meters
acc_detector_presence_config_start_set
@brief Set the start point of measurement interval in meters
acc_detector_presence_config_step_length_get
@brief Get the step length in points
acc_detector_presence_config_step_length_set
@brief Set the step length in points
acc_detector_presence_config_sweeps_per_frame_get
@brief Get the number of sweeps per frame
acc_detector_presence_config_sweeps_per_frame_set
@brief Set the number of sweeps per frame
acc_detector_presence_create
@brief Create a presence detector with the provided configuration
acc_detector_presence_destroy
@brief Destroy a presence detector identified with the provided handle
acc_detector_presence_get_buffer_size
@brief Get the buffer size needed for the provided presence detector handle
acc_detector_presence_get_distance_m
@brief Calculate distance in meter for a point in a sweep (including subsweeps)
acc_detector_presence_prepare
@brief Prepare the detector to do a measurement
acc_detector_presence_process
@brief Process the data according to the configuration used in @ref acc_detector_presence_config_create
acc_detector_presence_processing_config_create
@brief Create a configuration for a presence processor
acc_detector_presence_processing_config_destroy
@brief Destroy a presence processor configuration
acc_detector_presence_processing_config_frame_rate_get
@brief Get the frame rate
acc_detector_presence_processing_config_frame_rate_set
@brief Set the frame rate
acc_detector_presence_processing_config_inter_detection_get
@brief Get if inter-frame presence detection is enabled
acc_detector_presence_processing_config_inter_detection_set
@brief Set inter-frame presence detection
acc_detector_presence_processing_config_inter_detection_threshold_get
@brief Get the detection threshold for the inter-frame presence detection
acc_detector_presence_processing_config_inter_detection_threshold_set
@brief Set the detection threshold for the inter-frame presence detection
acc_detector_presence_processing_config_inter_frame_deviation_time_const_get
@brief Get the time constant of the low pass filter for the inter-frame deviation between fast and slow
acc_detector_presence_processing_config_inter_frame_deviation_time_const_set
@brief Set the time constant of the low pass filter for the inter-frame deviation between fast and slow
acc_detector_presence_processing_config_inter_frame_fast_cutoff_get
@brief Get the cutoff frequency of the low pass filter for the fast filtered absolute sweep mean
acc_detector_presence_processing_config_inter_frame_fast_cutoff_set
@brief Set the cutoff frequency of the low pass filter for the fast filtered absolute sweep mean
acc_detector_presence_processing_config_inter_frame_presence_timeout_get
@brief Get the inter-frame presence timeout in seconds
acc_detector_presence_processing_config_inter_frame_presence_timeout_set
@brief Set the inter-frame presence timeout in seconds
acc_detector_presence_processing_config_inter_frame_slow_cutoff_get
@brief Get the cutoff frequency of the low pass filter for the slow filtered absolute sweep mean
acc_detector_presence_processing_config_inter_frame_slow_cutoff_set
@brief Set the cutoff frequency of the low pass filter for the slow filtered absolute sweep mean
acc_detector_presence_processing_config_inter_output_time_const_get
@brief Get the time constant for the output in the inter-frame part
acc_detector_presence_processing_config_inter_output_time_const_set
@brief Set the time constant for the output in the inter-frame part
acc_detector_presence_processing_config_inter_phase_boost_get
@brief Get if inter-frame phase boost is enabled
acc_detector_presence_processing_config_inter_phase_boost_set
@brief Set inter-frame phase boost
acc_detector_presence_processing_config_intra_detection_get
@brief Get if frame intra-frame presence detection is enabled
acc_detector_presence_processing_config_intra_detection_set
@brief Set intra-frame presence detection
acc_detector_presence_processing_config_intra_detection_threshold_get
@brief Get the detection threshold for the intra-frame presence detection
acc_detector_presence_processing_config_intra_detection_threshold_set
@brief Set the detection threshold for the intra-frame presence detection
acc_detector_presence_processing_config_intra_frame_time_const_get
@brief Get the time constant for the depthwise filtering in the intra-frame part
acc_detector_presence_processing_config_intra_frame_time_const_set
@brief Set the time constant for the depthwise filtering in the intra-frame part
acc_detector_presence_processing_config_intra_output_time_const_get
@brief Get the time constant for the output in the intra-frame part
acc_detector_presence_processing_config_intra_output_time_const_set
@brief Set the time constant for the output in the intra-frame part
acc_detector_presence_processing_create
@brief Create a processing handle with the provided base configuration
acc_detector_presence_processing_destroy
@brief Destroy a processing handle
acc_detector_presence_processing_get_buffer_size
@brief Get the buffer size needed for presence processing
acc_detector_presence_processing_process
@brief Process sensor data
acc_detector_presence_processing_reset
@brief Reset existing processing buffers
acc_processing_create
@brief Create a processing instance with the provided configuration
acc_processing_destroy
@brief Destroy a processing instance identified with the provided processing handle
acc_processing_execute
@brief Process the data according to the configuration used in create
acc_processing_get_temperature_adjustment_factors
@brief Calculate temperature compensation for mean sweep and background noise (tx off) standard deviation
acc_processing_meter_to_points
@brief Convert a distance or step length in meter to points
acc_processing_points_to_meter
@brief Convert a distance or step length in points to meter
acc_rss_assembly_test_create
@brief Create a sensor assembly test instance
acc_rss_assembly_test_destroy
@brief Destroy a sensor assembly test instance freeing any resources allocated.
acc_rss_assembly_test_disable
@brief Disable a test in assembly test
acc_rss_assembly_test_disable_all_tests
@brief Disable all assembly tests
acc_rss_assembly_test_enable
@brief Enable a test in assembly test
acc_rss_assembly_test_enable_all_tests
@brief Enable all assembly tests
acc_rss_assembly_test_enable_diagnostic_logs
@brief Enable diagnostic logs for the assembly test,
acc_rss_assembly_test_execute
@brief Execute the assembly test
acc_rss_assembly_test_get_results
@brief A function to get the results from the sensor assembly test
acc_rss_get_buffer_size
@brief Get the buffer size needed for the specified config
acc_rss_hal_register
@brief Register an integration
acc_rss_set_log_level
@brief Set the log level that determines when the integration HAL logger function is called
acc_sensor_calibrate
@brief Calibrate a sensor
acc_sensor_connected
@brief Check if a sensor is connected and responsive
acc_sensor_create
@brief Create a sensor instance
acc_sensor_destroy
@brief Destroy a sensor instance freeing any resources allocated.
acc_sensor_get_cal_info
@brief Gets calibration information from a calibration result
acc_sensor_hibernate_off
@brief Restore sensor after exiting hibernation
acc_sensor_hibernate_on
@brief Prepare sensor for entering hibernation
acc_sensor_measure
@brief Start a radar measurement with previously prepared configuration
acc_sensor_prepare
@brief Prepare a sensor to do a measurement
acc_sensor_read
@brief Read out radar data
acc_sensor_status
@brief Check the status of the sensor
acc_sensor_validate_calibration
@brief Validate calibration result
acc_version_get
@brief Get the version of the Acconeer software
acc_version_get_hex
@brief Get the version of the Acconeer software as a hex number
aligned_alloc
alloca
at_quick_exit
atexit
atof
atoi
atol
atoll
bsearch
c_log_stub
calloc
clearenv
div
drand48
drand48_r
ecvt
ecvt_r
erand48
erand48_r
exit
fcvt
fcvt_r
free
gcvt
getenv
getloadavg
getsubopt
imaxabs
imaxdiv
initstate
initstate_r
jrand48
jrand48_r
l64a
labs
lcong48
lcong48_r
ldiv
llabs
lldiv
lrand48
lrand48_r
malloc
mblen
mbstowcs
mbtowc
mkdtemp
mkstemp
mkstemps
mktemp
mrand48
mrand48_r
nrand48
nrand48_r
on_exit
posix_memalign
pselect
putenv
qecvt
qecvt_r
qfcvt
qfcvt_r
qgcvt
qsort
quick_exit
rand
rand_r
random
random_r
realloc
reallocarray
realpath
rpmatch
seed48
seed48_r
select
setenv
setstate
setstate_r
srand
srand48
srand48_r
srandom
srandom_r
strtod
strtof
strtoimax
strtol
strtold
strtoll
strtoq
strtoul
strtoull
strtoumax
strtouq
system
unsetenv
valloc
wcstoimax
wcstombs
wcstoumax
wctomb

Type Aliases§

_Float32
_Float64
_Float32x
_Float64x
__blkcnt64_t
__blkcnt_t
__blksize_t
__caddr_t
__clock_t
__clockid_t
__compar_fn_t
__daddr_t
__dev_t
__fd_mask
__fsblkcnt64_t
__fsblkcnt_t
__fsfilcnt64_t
__fsfilcnt_t
__fsword_t
__gid_t
__gwchar_t
__id_t
__ino64_t
__ino_t
__int8_t
__int16_t
__int32_t
__int64_t
__int_least8_t
__int_least16_t
__int_least32_t
__int_least64_t
__intmax_t
__intptr_t
__key_t
__loff_t
__mode_t
__nlink_t
__off64_t
__off_t
__pid_t
__pthread_list_t
__pthread_slist_t
__quad_t
__rlim64_t
__rlim_t
__sig_atomic_t
__socklen_t
__ssize_t
__suseconds64_t
__suseconds_t
__syscall_slong_t
__syscall_ulong_t
__thrd_t
__time_t
__timer_t
__tss_t
__u_char
__u_int
__u_long
__u_quad_t
__u_short
__uid_t
__uint8_t
__uint16_t
__uint32_t
__uint64_t
__uint_least8_t
__uint_least16_t
__uint_least32_t
__uint_least64_t
__uintmax_t
__useconds_t
acc_config_idle_state_t
@brief Idle state
acc_config_prf_t
@brief Pulse Repetition Frequency
acc_config_profile_t
@brief Profile
acc_config_t
acc_detector_distance_config_t
@brief Distance Detector configuration
acc_detector_distance_handle_t
@brief Distance Detector handle
acc_detector_distance_peak_sorting_t
@brief Enum for peak sorting algorithms
acc_detector_distance_reflector_shape_t
@brief Enum for reflector shapes
acc_detector_distance_threshold_method_t
@brief Enum for threshold methods
acc_detector_presence_config_t
acc_detector_presence_handle_t
acc_detector_presence_processing_config_t
acc_detector_presence_processing_handle_t
acc_hal_log_function_t
@brief Definition of a log function
acc_hal_mem_alloc_function_t
@brief Definition of a memory allocation function
acc_hal_mem_free_function_t
@brief Definition of a memory free function
acc_hal_sensor_transfer8_function_t
@brief Definition of a sensor transfer function
acc_hal_sensor_transfer16_function_t
@brief Definition of an optimized 16-bit sensor transfer function
acc_log_level_t
@brief This enum represents the different log levels for RSS
acc_processing_t
acc_rss_assembly_test_t
acc_rss_assembly_test_test_id_t
@brief Test identity enum for acc_rss_assembly_test
acc_rss_test_integration_status_t
@brief Integration status for rss tests
acc_rss_test_state_t
@brief Return code for rss tests
acc_sensor_id_t
@brief Type representing a sensor ID
acc_sensor_t
blkcnt_t
blksize_t
caddr_t
clock_t
clockid_t
daddr_t
dev_t
fd_mask
fsblkcnt_t
fsfilcnt_t
fsid_t
gid_t
id_t
ino_t
int_fast8_t
int_fast16_t
int_fast32_t
int_fast64_t
int_least8_t
int_least16_t
int_least32_t
int_least64_t
intmax_t
key_t
loff_t
mode_t
nlink_t
off_t
pid_t
pthread_key_t
pthread_once_t
pthread_spinlock_t
pthread_t
quad_t
register_t
sigset_t
suseconds_t
time_t
timer_t
u_char
u_int
u_int8_t
u_int16_t
u_int32_t
u_int64_t
u_long
u_quad_t
u_short
uid_t
uint
uint_fast8_t
uint_fast16_t
uint_fast32_t
uint_fast64_t
uint_least8_t
uint_least16_t
uint_least32_t
uint_least64_t
uintmax_t
ulong
ushort
wchar_t

Unions§

__atomic_wide_counter
pthread_attr_t
pthread_barrier_t
pthread_barrierattr_t
pthread_cond_t
pthread_condattr_t
pthread_mutex_t
pthread_mutexattr_t
pthread_rwlock_t
pthread_rwlockattr_t