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 
8 /** \example example_processing_amplitude.c
9  * @brief example_processing_ampliude.c
10  * Example program that shows how to calculate the amplitude of the values in
11  * an A121 sparse IQ frame with one sweep. The result is similar to the output
12  * from A111 envelope and powerbin service.
13  */
14 
15 
16 #include <stdbool.h>
17 #include <stdint.h>
18 #include <stdio.h>
19 
20 #include "acc_config.h"
21 #include "acc_definitions_a121.h"
24 #include "acc_integration_log.h"
25 #include "acc_rss_a121.h"
26 #include "acc_version.h"
27 
28 
29 #include "acc_processing_helpers.h"
30 
31 
32 #define SENSOR_ID (1U)
33 
34 static void update_configuration(acc_config_t *config);
35 
36 
37 int app_main(int argc, char *argv[]);
38 
39 
40 int app_main(int argc, char *argv[])
41 {
42  (void)argc;
43  (void)argv;
44 
45  acc_control_helper_t control_helper_state = {0};
46 
47  printf("Acconeer software version %s\n", acc_version_get());
48 
50 
52  {
53  return EXIT_FAILURE;
54  }
55 
56  bool res = acc_control_helper_create(&control_helper_state, SENSOR_ID);
57 
58  if (!res)
59  {
60  printf("acc_control_helper_create() failed\n");
61  return EXIT_FAILURE;
62  }
63 
64  update_configuration(control_helper_state.config);
65 
66  res = acc_control_helper_activate(&control_helper_state);
67 
68  if (!res)
69  {
70  printf("acc_control_helper_activate() failed\n");
71  acc_control_helper_destroy(&control_helper_state);
72  return EXIT_FAILURE;
73  }
74 
75  uint32_t sweep_data_length = control_helper_state.proc_meta.sweep_data_length;
76 
77  acc_vector_iq_t *current_sweep = acc_vector_iq_alloc(sweep_data_length);
78  acc_vector_float_t *current_sweep_amplitude = acc_vector_float_alloc(sweep_data_length);
79 
80  bool mem_ok = (current_sweep != NULL) && (current_sweep_amplitude != NULL);
81  if (!mem_ok)
82  {
83  printf("Memory allocation for vectors failed\n");
84  }
85  else
86  {
87  uint32_t iterations = 25U;
88  for (uint32_t i = 0U; i < iterations; i++)
89  {
90  if (!acc_control_helper_get_next(&control_helper_state))
91  {
92  printf("acc_control_helper_get_next() failed\n");
93  break;
94  }
95 
96  acc_get_iq_sweep_vector(&control_helper_state, current_sweep);
97 
98  // The acc_vector_iq_amplitude function calculates the amplitude by taking
99  // absolute value of the complex valued elements in the IQ data vector.
100  // amplitude(z) = abs(z) = sqrt(real(z)^2 + imag(z)^2)
101  acc_vector_iq_amplitude(current_sweep, current_sweep_amplitude);
102 
103  acc_vector_float_print("Amplitude", current_sweep_amplitude);
104 
105  uint32_t max_peak_index = acc_vector_float_argmax(current_sweep_amplitude);
106  printf("Highest peak index: %" PRIu32 ", peak ampliude %" PRIfloat "\n",
107  max_peak_index,
108  ACC_LOG_FLOAT_TO_INTEGER(current_sweep_amplitude->data[max_peak_index]));
109  }
110  }
111 
112  acc_vector_iq_free(current_sweep);
113  acc_vector_float_free(current_sweep_amplitude);
114  acc_control_helper_destroy(&control_helper_state);
115 
116  printf("Application finished OK\n");
117 
118  return EXIT_SUCCESS;
119 }
120 
121 
122 static void update_configuration(acc_config_t *config)
123 {
124  int32_t start_point = 100; // start at 250 mm
125  uint16_t step_length = 2; // 2*2.5 mm = 5 mm
126  uint16_t num_points = 100; // range length 2*100*2.5 mm = 500 mm
127 
128  acc_config_start_point_set(config, start_point);
129  acc_config_num_points_set(config, num_points);
130  acc_config_step_length_set(config, step_length);
132  acc_config_hwaas_set(config, 30);
133  // The processing in this example assumes that sweeps_per_frame = 1
136 }
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:122
acc_control_helper_destroy
void acc_control_helper_destroy(acc_control_helper_t *radar)
Destroy a helper instance.
Definition: acc_control_helper.c:50
ACC_CONFIG_PROFILE_2
@ ACC_CONFIG_PROFILE_2
Definition: acc_definitions_a121.h:56
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_espidf_xe121.c:135
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
app_main
int app_main(int argc, char *argv[])
Assembly test example.
Definition: example_processing_amplitude.c:40
acc_hal_integration_a121.h
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:26
SENSOR_ID
#define SENSOR_ID
Definition: example_processing_amplitude.c:32
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
hal
static const acc_hal_a121_t hal
Definition: acc_hal_integration_espidf_xe121.c:121
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:123
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