example_service_subsweeps.c
Go to the documentation of this file.
1 // Copyright (c) Acconeer AB, 2021-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 #include <stdbool.h>
8 #include <stdint.h>
9 #include <stdio.h>
10 #include <stdlib.h>
11 
12 #include "acc_config.h"
13 #include "acc_config_subsweep.h"
14 #include "acc_definitions_a121.h"
15 #include "acc_definitions_common.h"
18 #include "acc_integration.h"
19 #include "acc_processing.h"
20 #include "acc_rss_a121.h"
21 #include "acc_sensor.h"
22 
23 #include "acc_version.h"
24 
25 
26 /** \example example_service_subsweeps.c
27  * @brief This is an example on how to use subsweeps with the Service API
28  * @n
29  * The example executes as follows:
30  * - Create a configuration
31  * - Configure multiple subsweeps
32  * - Create a processing instance using the previously created configuration
33  * - Create a sensor instance
34  * - Prepare a sensor
35  * - Perform a sensor measurement and read out the data
36  * - Process the measurement subsweeps
37  * - Destroy the sensor instance
38  * - Destroy the processing instance
39  * - Destroy the configuration
40  */
41 
42 #define SENSOR_ID (1U)
43 #define SENSOR_TIMEOUT_MS (1000U)
44 #define MAX_DATA_ENTRY_LEN 15 // "-32000+-32000i" + zero termination
45 
46 static void print_data(acc_int16_complex_t *data, uint16_t data_length);
47 
48 
49 static void cleanup(acc_config_t *config, acc_processing_t *processing,
50  acc_sensor_t *sensor, void *buffer);
51 
52 
53 int app_main(int argc, char *argv[]);
54 
55 
56 int app_main(int argc, char *argv[])
57 {
58  (void)argc;
59  (void)argv;
60  acc_config_t *config = NULL;
61  acc_processing_t *processing = NULL;
62  acc_sensor_t *sensor = NULL;
63  void *buffer = NULL;
64  uint32_t buffer_size = 0;
65  acc_processing_metadata_t proc_meta;
66  acc_processing_result_t proc_result;
67 
68  printf("Acconeer software version %s\n", acc_version_get());
69 
71 
73  {
74  return EXIT_FAILURE;
75  }
76 
77  config = acc_config_create();
78  if (config == NULL)
79  {
80  printf("acc_config_create() failed\n");
81  cleanup(config, processing, sensor, buffer);
82  return EXIT_FAILURE;
83  }
84 
85  // Collect 16 sweeps per frame, applicable for all subsweeps
87 
88  // Setup 3 subsweeps with different gains, start points and number of points
90 
94 
98 
100  acc_config_subsweep_start_point_set(config, 500, 2);
101  acc_config_subsweep_num_points_set(config, 10, 2);
102 
103  // Print the configuration
104  acc_config_log(config);
105 
106  processing = acc_processing_create(config, &proc_meta);
107  if (processing == NULL)
108  {
109  printf("acc_processing_create() failed\n");
110  cleanup(config, processing, sensor, buffer);
111  return EXIT_FAILURE;
112  }
113 
114  if (!acc_rss_get_buffer_size(config, &buffer_size))
115  {
116  printf("acc_rss_get_buffer_size() failed\n");
117  cleanup(config, processing, sensor, buffer);
118  return EXIT_FAILURE;
119  }
120 
121  buffer = acc_integration_mem_alloc(buffer_size);
122  if (buffer == NULL)
123  {
124  printf("buffer allocation failed\n");
125  cleanup(config, processing, sensor, buffer);
126  return EXIT_FAILURE;
127  }
128 
131 
132  sensor = acc_sensor_create(SENSOR_ID);
133  if (sensor == NULL)
134  {
135  printf("acc_sensor_create() failed\n");
136  cleanup(config, processing, sensor, buffer);
137  return EXIT_FAILURE;
138  }
139 
140  bool status;
141  bool cal_complete = false;
142  acc_cal_result_t cal_result;
143 
144  do
145  {
146  status = acc_sensor_calibrate(sensor, &cal_complete, &cal_result, buffer, buffer_size);
147 
148  if (status && !cal_complete)
149  {
151  }
152  } while (status && !cal_complete);
153 
154  if (!status)
155  {
156  printf("acc_sensor_calibrate() failed\n");
157  acc_sensor_status(sensor);
158  cleanup(config, processing, sensor, buffer);
159  return EXIT_FAILURE;
160  }
161 
162  // Reset sensor after calibration by disabling it
165 
166  if (!acc_sensor_prepare(sensor, config, &cal_result, buffer, buffer_size))
167  {
168  printf("acc_sensor_prepare() failed\n");
169  acc_sensor_status(sensor);
170  cleanup(config, processing, sensor, buffer);
171  return EXIT_FAILURE;
172  }
173 
174  for (uint32_t i = 0U; i < 5U; i++)
175  {
176  if (!acc_sensor_measure(sensor))
177  {
178  printf("acc_sensor_measure failed\n");
179  acc_sensor_status(sensor);
180  cleanup(config, processing, sensor, buffer);
181  return EXIT_FAILURE;
182  }
183 
185  {
186  printf("Sensor interrupt timeout\n");
187  acc_sensor_status(sensor);
188  cleanup(config, processing, sensor, buffer);
189  return EXIT_FAILURE;
190  }
191 
192  if (!acc_sensor_read(sensor, buffer, buffer_size))
193  {
194  printf("acc_sensor_read failed\n");
195  acc_sensor_status(sensor);
196  cleanup(config, processing, sensor, buffer);
197  return EXIT_FAILURE;
198  }
199 
200  acc_processing_execute(processing, buffer, &proc_result);
201 
202  // The number of sweeps can also be readout with acc_config_sweeps_per_frame_get()
203  uint16_t sweeps_per_frame = proc_meta.frame_data_length / proc_meta.sweep_data_length;
204  uint8_t number_of_subsweeps = acc_config_num_subsweeps_get(config);
205 
206  for (uint16_t sweep_index = 0; sweep_index < sweeps_per_frame; sweep_index++)
207  {
208  for (uint8_t subsweep_index = 0; subsweep_index < number_of_subsweeps; subsweep_index++)
209  {
210  /* Each sweep is offsetted sweep_data_length into the frame,
211  and within the sweep the specific subsweep is offsetted
212  subsweep_data_offset. */
213  uint16_t subsweep_offset = sweep_index * proc_meta.sweep_data_length +
214  proc_meta.subsweep_data_offset[subsweep_index];
215  uint16_t subsweep_length = proc_meta.subsweep_data_length[subsweep_index];
216  acc_int16_complex_t *subsweep_data = &proc_result.frame[subsweep_offset];
217 
218  printf("Subsweep: %" PRIu8 ", sweep: %" PRIu16 ", processed data:\n", subsweep_index, sweep_index);
219  print_data(subsweep_data, subsweep_length);
220  }
221  }
222  }
223 
224  cleanup(config, processing, sensor, buffer);
225 
226  printf("Application finished OK\n");
227 
228  return EXIT_SUCCESS;
229 }
230 
231 
232 static void cleanup(acc_config_t *config, acc_processing_t *processing,
233  acc_sensor_t *sensor, void *buffer)
234 {
237 
238  if (sensor != NULL)
239  {
240  acc_sensor_destroy(sensor);
241  }
242 
243  if (processing != NULL)
244  {
245  acc_processing_destroy(processing);
246  }
247 
248  if (config != NULL)
249  {
250  acc_config_destroy(config);
251  }
252 
253  if (buffer != NULL)
254  {
255  acc_integration_mem_free(buffer);
256  }
257 }
258 
259 
260 static void print_data(acc_int16_complex_t *data, uint16_t data_length)
261 {
262  char buffer[MAX_DATA_ENTRY_LEN];
263 
264  for (uint16_t i = 0; i < data_length; i++)
265  {
266  if ((i > 0) && ((i % 8) == 0))
267  {
268  printf("\n");
269  }
270 
271  snprintf(buffer, sizeof(buffer), "%" PRIi16 "+%" PRIi16 "i", data[i].real, data[i].imag);
272 
273  printf("%14s ", buffer);
274  }
275 
276  printf("\n");
277 }
acc_hal_integration_sensor_supply_off
void acc_hal_integration_sensor_supply_off(acc_sensor_id_t sensor_id)
Power off sensor supply.
Definition: acc_hal_integration_espidf_xe121.c:192
acc_rss_a121.h
acc_processing_metadata_t::subsweep_data_offset
uint16_t subsweep_data_offset[(4U)]
Definition: acc_processing.h:43
acc_processing_destroy
void acc_processing_destroy(acc_processing_t *handle)
Destroy a processing instance identified with the provided processing handle.
acc_hal_integration_sensor_supply_on
void acc_hal_integration_sensor_supply_on(acc_sensor_id_t sensor_id)
Power on sensor supply.
Definition: acc_hal_integration_espidf_xe121.c:185
acc_processing_result_t
Result provided by the processing module.
Definition: acc_processing.h:71
print_data
static void print_data(acc_int16_complex_t *data, uint16_t data_length)
Definition: example_service_subsweeps.c:260
acc_sensor_read
bool acc_sensor_read(const acc_sensor_t *sensor, void *buffer, uint32_t buffer_size)
Read out radar data.
acc_version.h
acc_rss_get_buffer_size
bool acc_rss_get_buffer_size(const acc_config_t *config, uint32_t *buffer_size)
Get the buffer size needed for the specified config.
acc_config_num_subsweeps_get
uint8_t acc_config_num_subsweeps_get(const acc_config_t *config)
Get the number of subsweeps to use.
acc_int16_complex_t
Data type for interger-based representation of complex numbers.
Definition: acc_definitions_common.h:43
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_config_destroy
void acc_config_destroy(acc_config_t *config)
Destroy a configuration freeing any resources allocated.
acc_cal_result_t
The result from a completed calibration.
Definition: acc_definitions_a121.h:32
acc_processing_execute
void acc_processing_execute(acc_processing_t *handle, void *buffer, acc_processing_result_t *result)
Process the data according to the configuration used in create.
acc_config_subsweep.h
acc_config_create
acc_config_t * acc_config_create(void)
Create a configuration.
acc_integration.h
cleanup
static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer)
Definition: example_service_subsweeps.c:232
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_integration_mem_alloc
void * acc_integration_mem_alloc(size_t size)
Allocate dynamic memory.
Definition: acc_integration_esp32.c:38
app_main
int app_main(int argc, char *argv[])
Assembly test example.
Definition: example_service_subsweeps.c:56
acc_processing_metadata_t
Metadata that will be populated by the processing module during creation.
Definition: acc_processing.h:36
acc_hal_a121_t
Definition: acc_hal_definitions_a121.h:82
acc_rss_hal_register
bool acc_rss_hal_register(const acc_hal_a121_t *hal)
Register an integration.
acc_sensor.h
acc_processing_metadata_t::sweep_data_length
uint16_t sweep_data_length
Definition: acc_processing.h:41
acc_hal_integration_wait_for_sensor_interrupt
bool acc_hal_integration_wait_for_sensor_interrupt(acc_sensor_id_t sensor_id, uint32_t timeout_ms)
Wait for a sensor interrupt.
Definition: acc_hal_integration_espidf_xe121.c:100
acc_hal_integration_a121.h
acc_processing_metadata_t::frame_data_length
uint16_t frame_data_length
Definition: acc_processing.h:39
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
acc_config_num_subsweeps_set
void acc_config_num_subsweeps_set(acc_config_t *config, uint8_t num_subsweeps)
Set the number of subsweeps to use.
acc_hal_integration_sensor_enable
void acc_hal_integration_sensor_enable(acc_sensor_id_t sensor_id)
Enable sensor.
Definition: acc_hal_integration_espidf_xe121.c:199
acc_config_subsweep_start_point_set
void acc_config_subsweep_start_point_set(acc_config_t *config, int32_t start_point, uint8_t index)
Set the starting point of the sweep.
acc_hal_definitions_a121.h
SENSOR_TIMEOUT_MS
#define SENSOR_TIMEOUT_MS
Definition: example_service_subsweeps.c:43
acc_processing_result_t::frame
acc_int16_complex_t * frame
Definition: acc_processing.h:91
acc_hal_integration_sensor_disable
void acc_hal_integration_sensor_disable(acc_sensor_id_t sensor_id)
Disable sensor.
Definition: acc_hal_integration_espidf_xe121.c:214
acc_processing_t
struct acc_processing_handle acc_processing_t
Definition: acc_processing.h:30
acc_sensor_status
void acc_sensor_status(const acc_sensor_t *sensor)
Check the status of the sensor.
acc_config_subsweep_receiver_gain_set
void acc_config_subsweep_receiver_gain_set(acc_config_t *config, uint8_t gain, uint8_t index)
Set receiver gain setting.
hal
static const acc_hal_a121_t hal
Definition: acc_hal_integration_espidf_xe121.c:121
acc_sensor_prepare
bool acc_sensor_prepare(acc_sensor_t *sensor, const acc_config_t *config, const acc_cal_result_t *cal_result, void *buffer, uint32_t buffer_size)
Prepare a sensor to do a measurement.
acc_integration_mem_free
void acc_integration_mem_free(void *ptr)
Free dynamic memory.
Definition: acc_integration_esp32.c:57
acc_definitions_common.h
acc_config_log
void acc_config_log(const acc_config_t *config)
Print a configuration to the log.
SENSOR_ID
#define SENSOR_ID
Definition: example_service_subsweeps.c:42
acc_config.h
acc_sensor_calibrate
bool acc_sensor_calibrate(acc_sensor_t *sensor, bool *cal_complete, acc_cal_result_t *cal_result, void *buffer, uint32_t buffer_size)
Calibrate a sensor.
acc_config_subsweep_num_points_set
void acc_config_subsweep_num_points_set(acc_config_t *config, uint16_t num_points, uint8_t index)
Set the number of data points to measure.
acc_sensor_measure
bool acc_sensor_measure(acc_sensor_t *sensor)
Start a radar measurement with previously prepared configuration.
acc_processing_create
acc_processing_t * acc_processing_create(const acc_config_t *config, acc_processing_metadata_t *processing_metadata)
Create a processing instance with the provided configuration.
acc_processing.h
acc_sensor_t
struct acc_sensor acc_sensor_t
Definition: acc_sensor.h:31
acc_sensor_destroy
void acc_sensor_destroy(acc_sensor_t *sensor)
Destroy a sensor instance freeing any resources allocated.
acc_processing_metadata_t::subsweep_data_length
uint16_t subsweep_data_length[(4U)]
Definition: acc_processing.h:45
acc_definitions_a121.h
MAX_DATA_ENTRY_LEN
#define MAX_DATA_ENTRY_LEN
Definition: example_service_subsweeps.c:44
acc_sensor_create
acc_sensor_t * acc_sensor_create(acc_sensor_id_t sensor_id)
Create a sensor instance.