Data Structures | Macros | Typedefs | Enumerations
Definitions

Various definitions and types used in the RSS API. More...

## Data Structures
struct | acc_cal_result_t
| The result from a completed calibration. More...
struct | acc_cal_info_t
| Information about calibration. More...

## Macros
#define | ACC_CAL_RESULT_DATA_SIZE (240)
| The size of a sensor calibration result. More...
#define | ACC_MAX_NUM_SUBSWEEPS (4U)
| The maximum number of subsweeps in a configuration. More...

## Typedefs
typedef float | float32_t
| Type representing a 32-bit float. More...

## Enumerations
enum | acc_config_profile_t { ACC_CONFIG_PROFILE_1 = 1, ACC_CONFIG_PROFILE_2, ACC_CONFIG_PROFILE_3, ACC_CONFIG_PROFILE_4, ACC_CONFIG_PROFILE_5 }
| Profile. More...
enum | acc_config_idle_state_t { ACC_CONFIG_IDLE_STATE_DEEP_SLEEP, ACC_CONFIG_IDLE_STATE_SLEEP, ACC_CONFIG_IDLE_STATE_READY }
| Idle state. More...
enum | acc_config_prf_t { ACC_CONFIG_PRF_19_5_MHZ, ACC_CONFIG_PRF_15_6_MHZ, ACC_CONFIG_PRF_13_0_MHZ, ACC_CONFIG_PRF_8_7_MHZ, ACC_CONFIG_PRF_6_5_MHZ, ACC_CONFIG_PRF_5_2_MHZ }
| Pulse Repetition Frequency. More...

## Detailed Description

Various definitions and types used in the RSS API.

## Macro Definition Documentation

## ◆ ACC_CAL_RESULT_DATA_SIZE

#define ACC_CAL_RESULT_DATA_SIZE (240)

The size of a sensor calibration result.

Definition at line 20 of file acc_definitions_a121.h.

## ◆ ACC_MAX_NUM_SUBSWEEPS

#define ACC_MAX_NUM_SUBSWEEPS (4U)

The maximum number of subsweeps in a configuration.

Definition at line 25 of file acc_definitions_a121.h.

## Typedef Documentation

## ◆ float32_t

typedef float float32_t

Type representing a 32-bit float.

Definition at line 22 of file acc_definitions.h.

## Enumeration Type Documentation

## ◆ acc_config_idle_state_t

enum acc_config_idle_state_t

Idle state.

Idle state 'DEEP_SLEEP' is the deepest state where as much of the sensor hardware as possible is shut down and idle state 'READY' is the shallowest state where most of the sensor hardware is kept on.

DEEP_SLEEP is the slowest to transition from while READY is the fastest.

Enumerator
ACC_CONFIG_IDLE_STATE_DEEP_SLEEP | The deepest state where as much of the sensor hardware is shut down.
ACC_CONFIG_IDLE_STATE_SLEEP |
ACC_CONFIG_IDLE_STATE_READY | The shallowest state where most of the sensor hardware is kept on.

Definition at line 70 of file acc_definitions_a121.h.

## ◆ acc_config_prf_t

enum acc_config_prf_t

Pulse Repetition Frequency.

Pulse Repetition Frequency, PRF, is the frequency at which pulses are sent out from the radar system. The measurement time is approximately proportional to the PRF. The higher the PRF, the shorter the measurement time.

This parameter sets the Maximum Measurable Distance, MMD, that can be achieved. MMD is the maximum value for the end point, i.e.,the start point + (number of points * step length). For example, an MMD of 7.0 m means that the range cannot be set further out than 7.0 m.

It also sets the Maximum Unambiguous Range, MUR, that can be achieved. MUR is the maximum distance at which an object can be located to guarantee that its reflection corresponds to the most recent transmitted pulse. Objects farther away than the MUR may fold into the measured range. For example, with a MUR of 11.5 m, an object at 13.5 m could become visible at 2 m.

PRF Setting | PRF | MMD | MUR
--- | --- | --- | ---
ACC_CONFIG_PRF_19_5_MHZ* | 19.5 MHz | 3.1 m | 7.7 m
ACC_CONFIG_PRF_15_6_MHZ | 15.6 MHz | 5.1 m | 9.6 m
ACC_CONFIG_PRF_13_0_MHZ | 13.0 MHz | 7.0 m | 11.5 m
ACC_CONFIG_PRF_8_7_MHZ | 8.7 MHz | 12.7 m | 17.3 m
ACC_CONFIG_PRF_6_5_MHZ | 6.5 MHz | 18.5 m | 23.1 m
ACC_CONFIG_PRF_5_2_MHZ | 5.2 MHz | 24.3 m | 28.8 m

*19.5MHz is only available for profile 1.

Enumerator
ACC_CONFIG_PRF_19_5_MHZ | 19.5 MHz
ACC_CONFIG_PRF_15_6_MHZ | 15.6 MHz
ACC_CONFIG_PRF_13_0_MHZ | 13.0 MHz
ACC_CONFIG_PRF_8_7_MHZ | 8.7 MHz
ACC_CONFIG_PRF_6_5_MHZ | 6.5 MHz
ACC_CONFIG_PRF_5_2_MHZ | 5.2 MHz

Definition at line 111 of file acc_definitions_a121.h.

## ◆ acc_config_profile_t

enum acc_config_profile_t

Profile.

Each profile consists of a number of settings for the sensor that configures the RX and TX paths. Lower profiles have higher depth resolution while higher profiles have higher radar loop gain.

Enumerator
ACC_CONFIG_PROFILE_1 | The profile with the highest depth resolution and lowest radar loop gain.
ACC_CONFIG_PROFILE_2 |
ACC_CONFIG_PROFILE_3 |
ACC_CONFIG_PROFILE_4 |
ACC_CONFIG_PROFILE_5 | The profile with the lowest depth resolution and highest radar loop gain.

Definition at line 49 of file acc_definitions_a121.h.