example_processing_amplitude.c
Go to the documentation of this file.
1 // Copyright (c) Acconeer AB, 2022-2024
2 // All rights reserved
3 // This file is subject to the terms and conditions defined in the file
4 // 'LICENSES/license_acconeer.txt', (BSD 3-Clause License) which is part
5 // of this source code package.
6
7 /** \example example_processing_amplitude.c
8 * @brief example_processing_ampliude.c
9 * Example program that shows how to calculate the amplitude of the values in
10 * an A121 sparse IQ frame with one sweep. The result is similar to the output
11 * from A111 envelope and powerbin service.
12 */
13
14 #include <stdbool.h>
15 #include <stdint.h>
16 #include <stdio.h>
17
18 #include "acc_config.h"
19 #include "acc_definitions_a121.h"
20 #include "acc_hal_definitions_a121.h"
21 #include "acc_hal_integration_a121.h"
22 #include "acc_integration_log.h"
23 #include "acc_rss_a121.h"
24 #include "acc_version.h"
25
26 #include "acc_processing_helpers.h"
27
28 #define SENSOR_ID (1U)
29
30 static void update_configuration(acc_config_t *config);
31
32 int acconeer_main(int argc, char *argv[]);
33
34 int acconeer_main(int argc, char *argv[])
35 {
36 (void)argc;
37 (void)argv;
38
39 acc_control_helper_t control_helper_state = {0};
40
41 printf("Acconeer software version %s\n", acc_version_get());
42
43 const acc_hal_a121_t *hal = acc_hal_rss_integration_get_implementation();
44
45 if (!acc_rss_hal_register(hal))
46 {
47 return EXIT_FAILURE;
48 }
49
50 bool res = acc_control_helper_create(&control_helper_state, SENSOR_ID);
51
52 if (!res)
53 {
54 printf("acc_control_helper_create() failed\n");
55 return EXIT_FAILURE;
56 }
57
58 update_configuration(control_helper_state.config);
59
60 res = acc_control_helper_activate(&control_helper_state);
61
62 if (!res)
63 {
64 printf("acc_control_helper_activate() failed\n");
65 acc_control_helper_destroy(&control_helper_state);
66 return EXIT_FAILURE;
67 }
68
69 uint32_t sweep_data_length = control_helper_state.proc_meta.sweep_data_length;
70
71 acc_vector_iq_t *current_sweep = acc_vector_iq_alloc(sweep_data_length);
72 acc_vector_float_t *current_sweep_amplitude = acc_vector_float_alloc(sweep_data_length);
73
74 bool mem_ok = (current_sweep != NULL) && (current_sweep_amplitude != NULL);
75 if (!mem_ok)
76 {
77 printf("Memory allocation for vectors failed\n");
78 }
79 else
80 {
81 uint32_t iterations = 25U;
82 for (uint32_t i = 0U; i < iterations; i++)
83 {
84 if (!acc_control_helper_get_next(&control_helper_state))
85 {
86 printf("acc_control_helper_get_next() failed\n");
87 break;
88 }
89
90 acc_get_iq_sweep_vector(&control_helper_state, current_sweep);
91
92 // The acc_vector_iq_amplitude function calculates the amplitude by taking
93 // absolute value of the complex valued elements in the IQ data vector.
94 // amplitude(z) = abs(z) = sqrt(real(z)^2 + imag(z)^2)
95 acc_vector_iq_amplitude(current_sweep, current_sweep_amplitude);
96
97 acc_vector_float_print("Amplitude", current_sweep_amplitude);
98
99 uint32_t max_peak_index = acc_vector_float_argmax(current_sweep_amplitude);
100 printf("Highest peak index: %" PRIu32 ", peak ampliude %" PRIfloat "\n",
101 max_peak_index,
102 ACC_LOG_FLOAT_TO_INTEGER(current_sweep_amplitude->data[max_peak_index]));
103 }
104 }
105
106 acc_vector_iq_free(current_sweep);
107 acc_vector_float_free(current_sweep_amplitude);
108 acc_control_helper_destroy(&control_helper_state);
109
110 printf("Application finished OK\n");
111
112 return EXIT_SUCCESS;
113 }
114
115 static void update_configuration(acc_config_t *config)
116 {
117 int32_t start_point = 100; // start at 250 mm
118 uint16_t step_length = 2; // 2*2.5 mm = 5 mm
119 uint16_t num_points = 100; // range length 2*100*2.5 mm = 500 mm
120
121 acc_config_start_point_set(config, start_point);
122 acc_config_num_points_set(config, num_points);
123 acc_config_step_length_set(config, step_length);
124 acc_config_profile_set(config, ACC_CONFIG_PROFILE_2);
125 acc_config_hwaas_set(config, 30);
126 // The processing in this example assumes that sweeps_per_frame = 1
127 acc_config_sweeps_per_frame_set(config, 1);
128 acc_config_prf_set(config, ACC_CONFIG_PRF_13_0_MHZ);
129 }
acc_config_start_point_set
void acc_config_start_point_set(acc_config_t *config, int32_t start_point)
Set the starting point of the sweep.
acc_control_helper_create
bool acc_control_helper_create(acc_control_helper_t *radar, acc_sensor_id_t sensor_id)
Create a helper instance.
Definition: acc_control_helper.c:41
acc_rss_a121.h
acc_vector_float_free
void acc_vector_float_free(acc_vector_float_t *vector)
Free storage of data elements in a float vector.
Definition: acc_processing_helpers.c:85
acc_vector_iq_free
void acc_vector_iq_free(acc_vector_iq_t *vector)
Free storage of data elements in an IQ vector.
Definition: acc_processing_helpers.c:73
acc_control_helper_t::config
acc_config_t * config
Definition: acc_control_helper.h:25
acc_version.h
acc_config_profile_set
void acc_config_profile_set(acc_config_t *config, acc_config_profile_t profile)
Set a profile.
acc_config_sweeps_per_frame_set
void acc_config_sweeps_per_frame_set(acc_config_t *config, uint16_t sweeps)
Set sweeps per frame.
acc_vector_float_t::data
float * data
Definition: acc_processing_helpers.h:36
update_configuration
static void update_configuration(acc_config_t *config)
Definition: example_processing_amplitude.c:115
acc_control_helper_destroy
void acc_control_helper_destroy(acc_control_helper_t *radar)
Destroy a helper instance.
Definition: acc_control_helper.c:50
config
cargo_config_t config
Definition: i2c_example_cargo.c:34
ACC_CONFIG_PROFILE_2
@ ACC_CONFIG_PROFILE_2
Definition: acc_definitions_a121.h:53
acc_hal_rss_integration_get_implementation
const acc_hal_a121_t * acc_hal_rss_integration_get_implementation(void)
Get hal implementation reference.
Definition: acc_hal_integration_stm32cube_xm.c:152
acc_vector_iq_t
Definition: acc_processing_helpers.h:27
acc_hal_a121_t
Definition: acc_hal_definitions_a121.h:82
acc_control_helper_t::proc_meta
acc_processing_metadata_t proc_meta
Definition: acc_control_helper.h:32
acc_rss_hal_register
bool acc_rss_hal_register(const acc_hal_a121_t *hal)
Register an integration.
acc_vector_iq_amplitude
void acc_vector_iq_amplitude(const acc_vector_iq_t *vector_a, acc_vector_float_t *vector_out)
Amplitude of an IQ vector.
Definition: acc_processing_helpers.c:305
acc_config_hwaas_set
void acc_config_hwaas_set(acc_config_t *config, uint16_t hwaas)
Set the hardware accelerated average samples (HWAAS)
acc_processing_metadata_t::sweep_data_length
uint16_t sweep_data_length
Definition: acc_processing.h:41
acc_hal_integration_a121.h
acconeer_main
int acconeer_main(int argc, char *argv[])
Assembly test example.
Definition: example_processing_amplitude.c:34
acc_version_get
const char * acc_version_get(void)
Get the version of the Acconeer software.
acc_config_t
struct acc_config acc_config_t
Definition: acc_config.h:24
printf
#define printf
Definition: printf.h:60
SENSOR_ID
#define SENSOR_ID
Definition: example_processing_amplitude.c:28
acc_config_step_length_set
void acc_config_step_length_set(acc_config_t *config, uint16_t step_length)
Set the step length in a sweep.
acc_config_num_points_set
void acc_config_num_points_set(acc_config_t *config, uint16_t num_points)
Set the number of data points to measure.
acc_hal_definitions_a121.h
acc_processing_helpers.h
acc_vector_float_t
Definition: acc_processing_helpers.h:33
acc_integration_log.h
ACC_LOG_FLOAT_TO_INTEGER
#define ACC_LOG_FLOAT_TO_INTEGER(a)
Definition: acc_integration_log.h:26
acc_vector_iq_alloc
acc_vector_iq_t * acc_vector_iq_alloc(uint32_t data_length)
Allocate storage for an IQ vector.
Definition: acc_processing_helpers.c:27
acc_vector_float_alloc
acc_vector_float_t * acc_vector_float_alloc(uint32_t data_length)
Allocate storage for a float vector.
Definition: acc_processing_helpers.c:50
acc_vector_float_print
void acc_vector_float_print(const char *label, acc_vector_float_t *vector_a)
Print float vector.
Definition: acc_processing_helpers.c:401
acc_control_helper_t
Definition: acc_control_helper.h:23
acc_control_helper_activate
bool acc_control_helper_activate(acc_control_helper_t *radar)
Activate the sensor.
Definition: acc_control_helper.c:81
acc_config_prf_set
void acc_config_prf_set(acc_config_t *config, acc_config_prf_t prf)
Set Pulse Repetition Frequency.
ACC_CONFIG_PRF_13_0_MHZ
@ ACC_CONFIG_PRF_13_0_MHZ
Definition: acc_definitions_a121.h:118
acc_config.h
PRIfloat
#define PRIfloat
Specifier for printing float type using integers.
Definition: acc_integration_log.h:31
acc_control_helper_get_next
bool acc_control_helper_get_next(acc_control_helper_t *radar)
Perform a radar measurement and wait for the result.
Definition: acc_control_helper.c:157
acc_get_iq_sweep_vector
void acc_get_iq_sweep_vector(const acc_control_helper_t *control_helper_state, acc_vector_iq_t *vector_out)
Converts a newly captured IQ frame with one sweep to an IQ vector.
Definition: acc_processing_helpers.c:138
acc_definitions_a121.h
acc_vector_float_argmax
uint32_t acc_vector_float_argmax(acc_vector_float_t *vector_a)
Index of element with maximum value in a float vector.
Definition: acc_processing_helpers.c:357