Macros | Functions
example_cargo_reg_protocol.h File Reference
`#include <stdbool.h>`
`#include <stdint.h>`

Go to the source code of this file.

## Macros
#define | EXAMPLE_CARGO_REG_REGISTER_COUNT 24U
#define | EXAMPLE_CARGO_REG_VERSION_ADDRESS 0U
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_ADDRESS 1U
#define | EXAMPLE_CARGO_REG_MEASURE_COUNTER_ADDRESS 2U
#define | EXAMPLE_CARGO_REG_ACTUAL_PRESENCE_UPDATE_RATE_ADDRESS 3U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_ADDRESS 4U
#define | EXAMPLE_CARGO_REG_CONTAINER_SIZE_ADDRESS 16U
#define | EXAMPLE_CARGO_REG_ACTIVATE_UTILIZATION_LEVEL_ADDRESS 17U
#define | EXAMPLE_CARGO_REG_UTILIZATION_SIGNAL_QUALITY_ADDRESS 18U
#define | EXAMPLE_CARGO_REG_UTILIZATION_THRESHOLD_SENSITIVITY_ADDRESS 19U
#define | EXAMPLE_CARGO_REG_ACTIVATE_PRESENCE_ADDRESS 20U
#define | EXAMPLE_CARGO_REG_PRESENCE_UPDATE_RATE_ADDRESS 21U
#define | EXAMPLE_CARGO_REG_PRESENCE_SWEEPS_PER_FRAME_ADDRESS 22U
#define | EXAMPLE_CARGO_REG_PRESENCE_SIGNAL_QUALITY_ADDRESS 23U
#define | EXAMPLE_CARGO_REG_PRESENCE_INTER_DETECTION_THRESHOLD_ADDRESS 24U
#define | EXAMPLE_CARGO_REG_PRESENCE_INTRA_DETECTION_THRESHOLD_ADDRESS 25U
#define | EXAMPLE_CARGO_REG_RESULT_HEADER_ADDRESS 32U
#define | EXAMPLE_CARGO_REG_UTILIZATION_DISTANCE_ADDRESS 33U
#define | EXAMPLE_CARGO_REG_UTILIZATION_LEVEL_MM_ADDRESS 34U
#define | EXAMPLE_CARGO_REG_UTILIZATION_LEVEL_PERCENT_ADDRESS 35U
#define | EXAMPLE_CARGO_REG_PRESENCE_DETECTED_ADDRESS 36U
#define | EXAMPLE_CARGO_REG_MAX_INTER_PRESENCE_SCORE_ADDRESS 37U
#define | EXAMPLE_CARGO_REG_MAX_INTRA_PRESENCE_SCORE_ADDRESS 38U
#define | EXAMPLE_CARGO_REG_COMMAND_ADDRESS 48U
#define | EXAMPLE_CARGO_REG_APPLICATION_ID_ADDRESS 65535U
#define | EXAMPLE_CARGO_REG_VERSION_FIELD_MAJOR_POS 16U
#define | EXAMPLE_CARGO_REG_VERSION_FIELD_MAJOR_MASK 0xffff0000
#define | EXAMPLE_CARGO_REG_VERSION_FIELD_MINOR_POS 8U
#define | EXAMPLE_CARGO_REG_VERSION_FIELD_MINOR_MASK 0x0000ff00
#define | EXAMPLE_CARGO_REG_VERSION_FIELD_PATCH_POS 0U
#define | EXAMPLE_CARGO_REG_VERSION_FIELD_PATCH_MASK 0x000000ff
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PROTOCOL_STATE_ERROR_POS 0U
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PROTOCOL_STATE_ERROR_MASK 0x00000001
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PACKET_LENGTH_ERROR_POS 1U
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PACKET_LENGTH_ERROR_MASK 0x00000002
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_ADDRESS_ERROR_POS 2U
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_ADDRESS_ERROR_MASK 0x00000004
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_FAILED_POS 3U
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_FAILED_MASK 0x00000008
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_TO_READ_ONLY_POS 4U
#define | EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_TO_READ_ONLY_MASK 0x00000010
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_OK_POS 0U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_OK_MASK 0x00000001
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_OK_POS 1U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_OK_MASK 0x00000002
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_OK_POS 2U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_OK_MASK 0x00000004
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_OK_POS 3U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_OK_MASK 0x00000008
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_OK_POS 4U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_OK_MASK 0x00000010
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_OK_POS 5U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_OK_MASK 0x00000020
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_OK_POS 6U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_OK_MASK 0x00000040
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_OK_POS 7U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_OK_MASK 0x00000080
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_ERROR_POS 8U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_ERROR_MASK 0x00000100
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_ERROR_POS 10U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_ERROR_MASK 0x00000400
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_ERROR_POS 11U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_ERROR_MASK 0x00000800
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_ERROR_POS 12U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_ERROR_MASK 0x00001000
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_ERROR_POS 13U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_ERROR_MASK 0x00002000
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_ERROR_POS 14U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_ERROR_MASK 0x00004000
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_ERROR_POS 15U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_ERROR_MASK 0x00008000
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_ERROR_POS 16U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_ERROR_MASK 0x00010000
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_APPLICATION_ERROR_POS 17U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_APPLICATION_ERROR_MASK 0x00020000
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_BUSY_POS 18U
#define | EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_BUSY_MASK 0x00040000
#define | EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_TEMPERATURE_POS 0U
#define | EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_TEMPERATURE_MASK 0x0000ffff
#define | EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_UTILIZATION_LEVEL_VALID_POS 17U
#define | EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_UTILIZATION_LEVEL_VALID_MASK 0x00020000
#define | EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_PRESENCE_VALID_POS 18U
#define | EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_PRESENCE_VALID_MASK 0x00040000
#define | EXAMPLE_CARGO_REG_COMMAND_ENUM_APPLY_CONFIGURATION 1U
#define | EXAMPLE_CARGO_REG_COMMAND_ENUM_MEASURE_UTILIZATION_LEVEL 4U
#define | EXAMPLE_CARGO_REG_COMMAND_ENUM_MEASURE_PRESENCE 5U
#define | EXAMPLE_CARGO_REG_COMMAND_ENUM_ENABLE_UART_LOGS 32U
#define | EXAMPLE_CARGO_REG_COMMAND_ENUM_DISABLE_UART_LOGS 33U
#define | EXAMPLE_CARGO_REG_COMMAND_ENUM_LOG_CONFIGURATION 34U
#define | EXAMPLE_CARGO_REG_COMMAND_ENUM_RESET_MODULE 0x52535421
#define | EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_DISTANCE_DETECTOR 1U
#define | EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_PRESENCE_DETECTOR 2U
#define | EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_REF_APP_BREATHING 3U
#define | EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_EXAMPLE_CARGO 4U

## Functions
void | example_cargo_reg_protocol_setup (void)
void | example_cargo_reg_protocol_write_default (void)
void | example_cargo_reg_read_version (uint32_t *value)
void | example_cargo_reg_read_protocol_status (uint32_t *value)
void | example_cargo_reg_read_measure_counter (uint32_t *value)
void | example_cargo_reg_read_actual_presence_update_rate (uint32_t *value)
void | example_cargo_reg_read_application_status (uint32_t *value)
void | example_cargo_reg_read_container_size (uint32_t *value)
bool | example_cargo_reg_write_container_size (const uint32_t value)
void | example_cargo_reg_read_activate_utilization_level (uint32_t *value)
bool | example_cargo_reg_write_activate_utilization_level (const uint32_t value)
void | example_cargo_reg_read_utilization_signal_quality (uint32_t *value)
bool | example_cargo_reg_write_utilization_signal_quality (const uint32_t value)
void | example_cargo_reg_read_utilization_threshold_sensitivity (uint32_t *value)
bool | example_cargo_reg_write_utilization_threshold_sensitivity (const uint32_t value)
void | example_cargo_reg_read_activate_presence (uint32_t *value)
bool | example_cargo_reg_write_activate_presence (const uint32_t value)
void | example_cargo_reg_read_presence_update_rate (uint32_t *value)
bool | example_cargo_reg_write_presence_update_rate (const uint32_t value)
void | example_cargo_reg_read_presence_sweeps_per_frame (uint32_t *value)
bool | example_cargo_reg_write_presence_sweeps_per_frame (const uint32_t value)
void | example_cargo_reg_read_presence_signal_quality (uint32_t *value)
bool | example_cargo_reg_write_presence_signal_quality (const uint32_t value)
void | example_cargo_reg_read_presence_inter_detection_threshold (uint32_t *value)
bool | example_cargo_reg_write_presence_inter_detection_threshold (const uint32_t value)
void | example_cargo_reg_read_presence_intra_detection_threshold (uint32_t *value)
bool | example_cargo_reg_write_presence_intra_detection_threshold (const uint32_t value)
void | example_cargo_reg_read_result_header (uint32_t *value)
void | example_cargo_reg_read_utilization_distance (uint32_t *value)
void | example_cargo_reg_read_utilization_level_mm (uint32_t *value)
void | example_cargo_reg_read_utilization_level_percent (uint32_t *value)
void | example_cargo_reg_read_presence_detected (uint32_t *value)
void | example_cargo_reg_read_max_inter_presence_score (uint32_t *value)
void | example_cargo_reg_read_max_intra_presence_score (uint32_t *value)
bool | example_cargo_reg_write_command (const uint32_t value)
void | example_cargo_reg_read_application_id (uint32_t *value)

## Macro Definition Documentation

## ◆ EXAMPLE_CARGO_REG_ACTIVATE_PRESENCE_ADDRESS

#define EXAMPLE_CARGO_REG_ACTIVATE_PRESENCE_ADDRESS 20U

Definition at line 23 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_ACTIVATE_UTILIZATION_LEVEL_ADDRESS

#define EXAMPLE_CARGO_REG_ACTIVATE_UTILIZATION_LEVEL_ADDRESS 17U

Definition at line 20 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_ACTUAL_PRESENCE_UPDATE_RATE_ADDRESS

#define EXAMPLE_CARGO_REG_ACTUAL_PRESENCE_UPDATE_RATE_ADDRESS 3U

Definition at line 17 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_ID_ADDRESS

#define EXAMPLE_CARGO_REG_APPLICATION_ID_ADDRESS 65535U

Definition at line 37 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_DISTANCE_DETECTOR

#define EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_DISTANCE_DETECTOR 1U

Definition at line 115 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_EXAMPLE_CARGO

#define EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_EXAMPLE_CARGO 4U

Definition at line 118 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_PRESENCE_DETECTOR

#define EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_PRESENCE_DETECTOR 2U

Definition at line 116 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_REF_APP_BREATHING

#define EXAMPLE_CARGO_REG_APPLICATION_ID_ENUM_REF_APP_BREATHING 3U

Definition at line 117 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_ADDRESS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_ADDRESS 4U

Definition at line 18 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_APPLICATION_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_APPLICATION_ERROR_MASK 0x00020000

Definition at line 93 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_APPLICATION_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_APPLICATION_ERROR_POS 17U

Definition at line 92 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_BUSY_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_BUSY_MASK 0x00040000

Definition at line 95 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_BUSY_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_BUSY_POS 18U

Definition at line 94 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_ERROR_MASK 0x00008000

Definition at line 89 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_ERROR_POS 15U

Definition at line 88 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_OK_MASK 0x00000040

Definition at line 73 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_BUFFER_OK_POS 6U

Definition at line 72 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_ERROR_MASK 0x00002000

Definition at line 85 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_ERROR_POS 13U

Definition at line 84 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_OK_MASK 0x00000010

Definition at line 69 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CALIBRATE_OK_POS 4U

Definition at line 68 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_ERROR_MASK 0x00001000

Definition at line 83 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_ERROR_POS 12U

Definition at line 82 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_OK_MASK 0x00000008

Definition at line 67 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CARGO_CREATE_OK_POS 3U

Definition at line 66 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_ERROR_MASK 0x00010000

Definition at line 91 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_ERROR_POS 16U

Definition at line 90 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_OK_MASK 0x00000080

Definition at line 75 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_CONFIG_APPLY_OK_POS 7U

Definition at line 74 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_ERROR_MASK 0x00000100

Definition at line 77 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_ERROR_POS 8U

Definition at line 76 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_OK_MASK 0x00000001

Definition at line 61 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_RSS_REGISTER_OK_POS 0U

Definition at line 60 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_ERROR_MASK 0x00004000

Definition at line 87 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_ERROR_POS 14U

Definition at line 86 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_OK_MASK 0x00000020

Definition at line 71 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_BUFFER_OK_POS 5U

Definition at line 70 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_ERROR_MASK 0x00000800

Definition at line 81 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_ERROR_POS 11U

Definition at line 80 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_OK_MASK 0x00000004

Definition at line 65 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CALIBRATE_OK_POS 2U

Definition at line 64 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_ERROR_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_ERROR_MASK 0x00000400

Definition at line 79 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_ERROR_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_ERROR_POS 10U

Definition at line 78 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_OK_MASK

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_OK_MASK 0x00000002

Definition at line 63 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_OK_POS

#define EXAMPLE_CARGO_REG_APPLICATION_STATUS_FIELD_SENSOR_CREATE_OK_POS 1U

Definition at line 62 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ADDRESS

#define EXAMPLE_CARGO_REG_COMMAND_ADDRESS 48U

Definition at line 36 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ENUM_APPLY_CONFIGURATION

#define EXAMPLE_CARGO_REG_COMMAND_ENUM_APPLY_CONFIGURATION 1U

Definition at line 106 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ENUM_DISABLE_UART_LOGS

#define EXAMPLE_CARGO_REG_COMMAND_ENUM_DISABLE_UART_LOGS 33U

Definition at line 110 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ENUM_ENABLE_UART_LOGS

#define EXAMPLE_CARGO_REG_COMMAND_ENUM_ENABLE_UART_LOGS 32U

Definition at line 109 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ENUM_LOG_CONFIGURATION

#define EXAMPLE_CARGO_REG_COMMAND_ENUM_LOG_CONFIGURATION 34U

Definition at line 111 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ENUM_MEASURE_PRESENCE

#define EXAMPLE_CARGO_REG_COMMAND_ENUM_MEASURE_PRESENCE 5U

Definition at line 108 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ENUM_MEASURE_UTILIZATION_LEVEL

#define EXAMPLE_CARGO_REG_COMMAND_ENUM_MEASURE_UTILIZATION_LEVEL 4U

Definition at line 107 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_COMMAND_ENUM_RESET_MODULE

#define EXAMPLE_CARGO_REG_COMMAND_ENUM_RESET_MODULE 0x52535421

Definition at line 112 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_CONTAINER_SIZE_ADDRESS

#define EXAMPLE_CARGO_REG_CONTAINER_SIZE_ADDRESS 16U

Definition at line 19 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_MAX_INTER_PRESENCE_SCORE_ADDRESS

#define EXAMPLE_CARGO_REG_MAX_INTER_PRESENCE_SCORE_ADDRESS 37U

Definition at line 34 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_MAX_INTRA_PRESENCE_SCORE_ADDRESS

#define EXAMPLE_CARGO_REG_MAX_INTRA_PRESENCE_SCORE_ADDRESS 38U

Definition at line 35 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_MEASURE_COUNTER_ADDRESS

#define EXAMPLE_CARGO_REG_MEASURE_COUNTER_ADDRESS 2U

Definition at line 16 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PRESENCE_DETECTED_ADDRESS

#define EXAMPLE_CARGO_REG_PRESENCE_DETECTED_ADDRESS 36U

Definition at line 33 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PRESENCE_INTER_DETECTION_THRESHOLD_ADDRESS

#define EXAMPLE_CARGO_REG_PRESENCE_INTER_DETECTION_THRESHOLD_ADDRESS 24U

Definition at line 27 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PRESENCE_INTRA_DETECTION_THRESHOLD_ADDRESS

#define EXAMPLE_CARGO_REG_PRESENCE_INTRA_DETECTION_THRESHOLD_ADDRESS 25U

Definition at line 28 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PRESENCE_SIGNAL_QUALITY_ADDRESS

#define EXAMPLE_CARGO_REG_PRESENCE_SIGNAL_QUALITY_ADDRESS 23U

Definition at line 26 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PRESENCE_SWEEPS_PER_FRAME_ADDRESS

#define EXAMPLE_CARGO_REG_PRESENCE_SWEEPS_PER_FRAME_ADDRESS 22U

Definition at line 25 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PRESENCE_UPDATE_RATE_ADDRESS

#define EXAMPLE_CARGO_REG_PRESENCE_UPDATE_RATE_ADDRESS 21U

Definition at line 24 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_ADDRESS

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_ADDRESS 1U

Definition at line 15 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_ADDRESS_ERROR_MASK

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_ADDRESS_ERROR_MASK 0x00000004

Definition at line 53 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_ADDRESS_ERROR_POS

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_ADDRESS_ERROR_POS 2U

Definition at line 52 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PACKET_LENGTH_ERROR_MASK

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PACKET_LENGTH_ERROR_MASK 0x00000002

Definition at line 51 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PACKET_LENGTH_ERROR_POS

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PACKET_LENGTH_ERROR_POS 1U

Definition at line 50 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PROTOCOL_STATE_ERROR_MASK

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PROTOCOL_STATE_ERROR_MASK 0x00000001

Definition at line 49 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PROTOCOL_STATE_ERROR_POS

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_PROTOCOL_STATE_ERROR_POS 0U

Definition at line 48 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_FAILED_MASK

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_FAILED_MASK 0x00000008

Definition at line 55 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_FAILED_POS

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_FAILED_POS 3U

Definition at line 54 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_TO_READ_ONLY_MASK

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_TO_READ_ONLY_MASK 0x00000010

Definition at line 57 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_TO_READ_ONLY_POS

#define EXAMPLE_CARGO_REG_PROTOCOL_STATUS_FIELD_WRITE_TO_READ_ONLY_POS 4U

Definition at line 56 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_REGISTER_COUNT

#define EXAMPLE_CARGO_REG_REGISTER_COUNT 24U

Definition at line 11 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_RESULT_HEADER_ADDRESS

#define EXAMPLE_CARGO_REG_RESULT_HEADER_ADDRESS 32U

Definition at line 29 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_PRESENCE_VALID_MASK

#define EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_PRESENCE_VALID_MASK 0x00040000

Definition at line 103 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_PRESENCE_VALID_POS

#define EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_PRESENCE_VALID_POS 18U

Definition at line 102 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_TEMPERATURE_MASK

#define EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_TEMPERATURE_MASK 0x0000ffff

Definition at line 99 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_TEMPERATURE_POS

#define EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_TEMPERATURE_POS 0U

Definition at line 98 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_UTILIZATION_LEVEL_VALID_MASK

#define EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_UTILIZATION_LEVEL_VALID_MASK 0x00020000

Definition at line 101 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_UTILIZATION_LEVEL_VALID_POS

#define EXAMPLE_CARGO_REG_RESULT_HEADER_FIELD_UTILIZATION_LEVEL_VALID_POS 17U

Definition at line 100 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_UTILIZATION_DISTANCE_ADDRESS

#define EXAMPLE_CARGO_REG_UTILIZATION_DISTANCE_ADDRESS 33U

Definition at line 30 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_UTILIZATION_LEVEL_MM_ADDRESS

#define EXAMPLE_CARGO_REG_UTILIZATION_LEVEL_MM_ADDRESS 34U

Definition at line 31 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_UTILIZATION_LEVEL_PERCENT_ADDRESS

#define EXAMPLE_CARGO_REG_UTILIZATION_LEVEL_PERCENT_ADDRESS 35U

Definition at line 32 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_UTILIZATION_SIGNAL_QUALITY_ADDRESS

#define EXAMPLE_CARGO_REG_UTILIZATION_SIGNAL_QUALITY_ADDRESS 18U

Definition at line 21 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_UTILIZATION_THRESHOLD_SENSITIVITY_ADDRESS

#define EXAMPLE_CARGO_REG_UTILIZATION_THRESHOLD_SENSITIVITY_ADDRESS 19U

Definition at line 22 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_VERSION_ADDRESS

#define EXAMPLE_CARGO_REG_VERSION_ADDRESS 0U

Definition at line 14 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_VERSION_FIELD_MAJOR_MASK

#define EXAMPLE_CARGO_REG_VERSION_FIELD_MAJOR_MASK 0xffff0000

Definition at line 41 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_VERSION_FIELD_MAJOR_POS

#define EXAMPLE_CARGO_REG_VERSION_FIELD_MAJOR_POS 16U

Definition at line 40 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_VERSION_FIELD_MINOR_MASK

#define EXAMPLE_CARGO_REG_VERSION_FIELD_MINOR_MASK 0x0000ff00

Definition at line 43 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_VERSION_FIELD_MINOR_POS

#define EXAMPLE_CARGO_REG_VERSION_FIELD_MINOR_POS 8U

Definition at line 42 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_VERSION_FIELD_PATCH_MASK

#define EXAMPLE_CARGO_REG_VERSION_FIELD_PATCH_MASK 0x000000ff

Definition at line 45 of file example_cargo_reg_protocol.h.

## ◆ EXAMPLE_CARGO_REG_VERSION_FIELD_PATCH_POS

#define EXAMPLE_CARGO_REG_VERSION_FIELD_PATCH_POS 0U

Definition at line 44 of file example_cargo_reg_protocol.h.

## Function Documentation

## ◆ example_cargo_reg_protocol_setup()

void example_cargo_reg_protocol_setup | ( | void |  | ) |

The example_cargo protocol setup function.

Definition at line 142 of file example_cargo_reg_protocol.c.

## ◆ example_cargo_reg_protocol_write_default()

void example_cargo_reg_protocol_write_default | ( | void |  | ) |

The example_cargo protocol write default register value function.

Definition at line 148 of file example_cargo_reg_protocol.c.

## ◆ example_cargo_reg_read_activate_presence()

void example_cargo_reg_read_activate_presence | ( | uint32_t * | value | ) |

Read: Whether to activate presence measurements. The command MEASURE_PRESENCE cannot succeed if this register if false.

Definition at line 185 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_activate_utilization_level()

void example_cargo_reg_read_activate_utilization_level | ( | uint32_t * | value | ) |

Read: Whether to activate utilization level measurements. The command MEASURE_UTILIZATION_LEVEL cannot succeed if this register if false.

Definition at line 137 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_actual_presence_update_rate()

void example_cargo_reg_read_actual_presence_update_rate | ( | uint32_t * | value | ) |

Read: Get the actual update rate (frame rate) of presence during a burst

Definition at line 77 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_application_id()

void example_cargo_reg_read_application_id | ( | uint32_t * | value | ) |

Read: The application id register.

Definition at line 29 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_application_status()

void example_cargo_reg_read_application_status | ( | uint32_t * | value | ) |

Read: Get example app status flags.

Definition at line 87 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_container_size()

void example_cargo_reg_read_container_size | ( | uint32_t * | value | ) |

Read: Size of the container. Valid values to write are 10U, 20U and 40U.

Definition at line 92 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_max_inter_presence_score()

void example_cargo_reg_read_max_inter_presence_score | ( | uint32_t * | value | ) |

Read: Inter presence score is a measure of the amount of slow motion detected. This register contains the maximum inter presence score during the 5s presence burst.

Definition at line 339 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_max_intra_presence_score()

void example_cargo_reg_read_max_intra_presence_score | ( | uint32_t * | value | ) |

Read: Intra presence score is measure of the amount of slow motion detected. This register contains the maximum intra presence score during the 5s presence burst.

Definition at line 348 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_measure_counter()

void example_cargo_reg_read_measure_counter | ( | uint32_t * | value | ) |

Read: Get the measure counter, the number of measurements performed since restart.

Definition at line 72 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_presence_detected()

void example_cargo_reg_read_presence_detected | ( | uint32_t * | value | ) |

Read: Whether presence was detected during the 5s presence burst

Definition at line 330 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_presence_inter_detection_threshold()

void example_cargo_reg_read_presence_inter_detection_threshold | ( | uint32_t * | value | ) |

Read: This is the threshold for detecting slower movements between frames. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors inter detection threshold parameter.

Definition at line 249 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_presence_intra_detection_threshold()

void example_cargo_reg_read_presence_intra_detection_threshold | ( | uint32_t * | value | ) |

Read: This is the threshold for detecting faster movements between frames. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors intra detection threshold parameter.

Definition at line 265 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_presence_signal_quality()

void example_cargo_reg_read_presence_signal_quality | ( | uint32_t * | value | ) |

Read: Signal quality. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors signal quality parameter.

Definition at line 233 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_presence_sweeps_per_frame()

void example_cargo_reg_read_presence_sweeps_per_frame | ( | uint32_t * | value | ) |

Read: The number of sweeps that will be captured in each frame (measurement). For more information, see documentation about the Presence Detectors sweeps_per_frame parameter.

Definition at line 217 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_presence_update_rate()

void example_cargo_reg_read_presence_update_rate | ( | uint32_t * | value | ) |

Read: The presence detector update rate (frame rate). This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors frame rate parameter.

Definition at line 201 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_protocol_status()

void example_cargo_reg_read_protocol_status | ( | uint32_t * | value | ) |

Read: Get protocol error flags.

Definition at line 39 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_result_header()

void example_cargo_reg_read_result_header | ( | uint32_t * | value | ) |

Read: The result header for the cargo result.

Definition at line 281 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_utilization_distance()

void example_cargo_reg_read_utilization_distance | ( | uint32_t * | value | ) |

Read: The distance, in millimeters, to the detection.

Definition at line 303 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_utilization_level_mm()

void example_cargo_reg_read_utilization_level_mm | ( | uint32_t * | value | ) |

Read: The fill level in millimeters. Fill level is the distance from the detection to the back of the container.

Definition at line 312 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_utilization_level_percent()

void example_cargo_reg_read_utilization_level_percent | ( | uint32_t * | value | ) |

Read: The fill level in percent. Fill level is the distance from the detection to the back of the container.

Definition at line 321 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_utilization_signal_quality()

void example_cargo_reg_read_utilization_signal_quality | ( | uint32_t * | value | ) |

Read: Signal quality. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Distance Detectors signal quality parameter.

Definition at line 153 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_utilization_threshold_sensitivity()

void example_cargo_reg_read_utilization_threshold_sensitivity | ( | uint32_t * | value | ) |

Read: Threshold sensitivity. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Distance Detectors threshold sensitivity parameter.

Definition at line 169 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_read_version()

void example_cargo_reg_read_version | ( | uint32_t * | value | ) |

Read: Get the RSS version.

Definition at line 34 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_activate_presence()

bool example_cargo_reg_write_activate_presence | ( | const uint32_t | value | ) |

Write: Whether to activate presence measurements. The command MEASURE_PRESENCE cannot succeed if this register if false.

Definition at line 192 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_activate_utilization_level()

bool example_cargo_reg_write_activate_utilization_level | ( | const uint32_t | value | ) |

Write: Whether to activate utilization level measurements. The command MEASURE_UTILIZATION_LEVEL cannot succeed if this register if false.

Definition at line 144 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_command()

bool example_cargo_reg_write_command | ( | const uint32_t | value | ) |

Write: Execute command.

Definition at line 82 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_container_size()

bool example_cargo_reg_write_container_size | ( | const uint32_t | value | ) |

Write: Size of the container. Valid values to write are 10U, 20U and 40U.

Definition at line 113 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_presence_inter_detection_threshold()

bool example_cargo_reg_write_presence_inter_detection_threshold | ( | const uint32_t | value | ) |

Write: This is the threshold for detecting slower movements between frames. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors inter detection threshold parameter.

Definition at line 256 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_presence_intra_detection_threshold()

bool example_cargo_reg_write_presence_intra_detection_threshold | ( | const uint32_t | value | ) |

Write: This is the threshold for detecting faster movements between frames. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors intra detection threshold parameter.

Definition at line 272 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_presence_signal_quality()

bool example_cargo_reg_write_presence_signal_quality | ( | const uint32_t | value | ) |

Write: Signal quality. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors signal quality parameter.

Definition at line 240 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_presence_sweeps_per_frame()

bool example_cargo_reg_write_presence_sweeps_per_frame | ( | const uint32_t | value | ) |

Write: The number of sweeps that will be captured in each frame (measurement). For more information, see documentation about the Presence Detectors sweeps_per_frame parameter.

Definition at line 224 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_presence_update_rate()

bool example_cargo_reg_write_presence_update_rate | ( | const uint32_t | value | ) |

Write: The presence detector update rate (frame rate). This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Presence Detectors frame rate parameter.

Definition at line 208 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_utilization_signal_quality()

bool example_cargo_reg_write_utilization_signal_quality | ( | const uint32_t | value | ) |

Write: Signal quality. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Distance Detectors signal quality parameter.

Definition at line 160 of file example_cargo_reg_protocol_access.c.

## ◆ example_cargo_reg_write_utilization_threshold_sensitivity()

bool example_cargo_reg_write_utilization_threshold_sensitivity | ( | const uint32_t | value | ) |

Write: Threshold sensitivity. This register is x1000 compared to the Cargo Example Application. For more information, see documentation about the Distance Detectors threshold sensitivity parameter.

Definition at line 176 of file example_cargo_reg_protocol_access.c.