example_service_multiple_configurations.c
Go to the documentation of this file.
1 // Copyright (c) Acconeer AB, 2020-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_definitions_a121.h"
14 #include "acc_definitions_common.h"
17 #include "acc_integration.h"
18 #include "acc_processing.h"
19 #include "acc_rss_a121.h"
20 #include "acc_sensor.h"
21 
22 #include "acc_version.h"
23 
24 /** \example example_service_multiple_configurations.c
25  * @brief This is an example on how the Service API can be used with multiple configurations
26  * @n
27  * The example executes as follows:
28  * - Create a first configuration
29  * - Create a second configuration
30  * - Create a processing instance using the first configuration
31  * - Create a second processing instance using the second configuration
32  * - Create a sensor instance
33  * - Prepare a sensor for the first configuration
34  * - Perform a sensor measurement and read out the data
35  * - Process the measurement with the first processing instance
36  * - Prepare a sensor for the second configuration
37  * - Perform a sensor measurement and read out the data
38  * - Process the measurement with the second processing instance
39  * - Destroy the sensor instance
40  * - Destroy the first processing instance
41  * - Destroy the second processing instance
42  * - Destroy the first configuration
43  * - Destroy the second configuration
44  */
45 
46 #define SENSOR_ID (1U)
47 #define SENSOR_TIMEOUT_MS (1000U)
48 #define MAX_DATA_ENTRY_LEN (15U) // "-32000+-32000i" + zero termination
49 #define NBR_CONFIGS (2U)
50 
51 typedef struct example_config
52 {
53  int16_t start_point;
54  uint16_t num_points;
55  uint16_t sweeps_per_frame;
57 
58 static void print_data(acc_int16_complex_t *data, uint16_t data_length, uint32_t cfg);
59 
60 static void cleanup(acc_config_t **config, acc_processing_t **processing, acc_sensor_t *sensor, void *buffer, uint32_t nbr_configs);
61 
62 int acconeer_main(int argc, char *argv[]);
63 
64 int acconeer_main(int argc, char *argv[])
65 {
66  (void)argc;
67  (void)argv;
68 
69  acc_config_t *config[NBR_CONFIGS] = {NULL};
70  acc_processing_t *processing[NBR_CONFIGS] = {NULL};
71  acc_sensor_t *sensor = NULL;
72  void *buffer = NULL;
73  uint32_t buffer_size = 0;
75  acc_processing_result_t proc_result;
76 
77  example_config_t example_configurations[] = {{
78  .start_point = 100,
79  .num_points = 100,
80  .sweeps_per_frame = 1,
81  },
82  {
83  .start_point = 120,
84  .num_points = 120,
85  .sweeps_per_frame = 3,
86  }};
87 
88  printf("Acconeer software version %s\n", acc_version_get());
89 
91 
92  if (!acc_rss_hal_register(hal))
93  {
94  return EXIT_FAILURE;
95  }
96 
97  for (uint32_t cfg = 0U; cfg < NBR_CONFIGS; cfg++)
98  {
99  config[cfg] = acc_config_create();
100  if (config[cfg] == NULL)
101  {
102  printf("acc_config_create() failed\n");
103  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
104  return EXIT_FAILURE;
105  }
106 
107  acc_config_start_point_set(config[cfg], example_configurations[cfg].start_point);
108  acc_config_num_points_set(config[cfg], example_configurations[cfg].num_points);
109  acc_config_sweeps_per_frame_set(config[cfg], example_configurations[cfg].sweeps_per_frame);
110 
111  processing[cfg] = acc_processing_create(config[cfg], &proc_meta[cfg]);
112  if (processing[cfg] == NULL)
113  {
114  printf("acc_processing_create() failed\n");
115  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
116  return EXIT_FAILURE;
117  }
118 
119  uint32_t current_buffer_size = 0;
120 
121  if (!acc_rss_get_buffer_size(config[cfg], &current_buffer_size))
122  {
123  printf("acc_rss_get_buffer_size() failed\n");
124  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
125  return EXIT_FAILURE;
126  }
127 
128  if (buffer_size < current_buffer_size)
129  {
130  buffer_size = current_buffer_size;
131  }
132  }
133 
135  if (buffer == NULL)
136  {
137  printf("buffer allocation failed\n");
138  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
139  return EXIT_FAILURE;
140  }
141 
144 
146  if (sensor == NULL)
147  {
148  printf("acc_sensor_create() failed\n");
149  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
150  return EXIT_FAILURE;
151  }
152 
153  bool status;
154  bool cal_complete = false;
155  acc_cal_result_t cal_result;
156 
157  do
158  {
159  status = acc_sensor_calibrate(sensor, &cal_complete, &cal_result, buffer, buffer_size);
160 
161  if (status && !cal_complete)
162  {
164  }
165  } while (status && !cal_complete);
166 
167  if (!status)
168  {
169  printf("acc_sensor_calibrate() failed\n");
171  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
172  return EXIT_FAILURE;
173  }
174 
175  // Reset sensor after calibration by disabling it
178 
179  for (uint32_t i = 0U; i < 5U; i++)
180  {
181  for (uint32_t cfg = 0U; cfg < NBR_CONFIGS; cfg++)
182  {
183  if (!acc_sensor_prepare(sensor, config[cfg], &cal_result, buffer, buffer_size))
184  {
185  printf("acc_sensor_prepare() failed\n");
187  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
188  return EXIT_FAILURE;
189  }
190 
192  {
193  printf("acc_sensor_measure failed\n");
195  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
196  return EXIT_FAILURE;
197  }
198 
200  {
201  printf("Sensor interrupt timeout\n");
203  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
204  return EXIT_FAILURE;
205  }
206 
208  {
209  printf("acc_sensor_read failed\n");
211  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
212  return EXIT_FAILURE;
213  }
214 
215  acc_processing_execute(processing[cfg], buffer, &proc_result);
216 
217  print_data(proc_result.frame, proc_meta[cfg].frame_data_length, cfg);
218  }
219  }
220 
221  cleanup(config, processing, sensor, buffer, NBR_CONFIGS);
222 
223  printf("Application finished OK\n");
224 
225  return EXIT_SUCCESS;
226 }
227 
228 static void cleanup(acc_config_t **config, acc_processing_t **processing, acc_sensor_t *sensor, void *buffer, uint32_t nbr_configs)
229 {
232 
233  if (sensor != NULL)
234  {
236  }
237 
238  for (uint32_t cfg = 0U; cfg < nbr_configs; cfg++)
239  {
240  if (processing[cfg] != NULL)
241  {
242  acc_processing_destroy(processing[cfg]);
243  }
244 
245  if (config[cfg] != NULL)
246  {
248  }
249  }
250 
251  if (buffer != NULL)
252  {
254  }
255 }
256 
257 static void print_data(acc_int16_complex_t *data, uint16_t data_length, uint32_t cfg)
258 {
259  printf("Processed data for config %" PRIu32 ":\n", cfg);
261 
262  for (uint16_t i = 0; i < data_length; i++)
263  {
264  if ((i > 0) && ((i % 8) == 0))
265  {
266  printf("\n");
267  }
268 
269  snprintf(buffer, sizeof(buffer), "%" PRIi16 "+%" PRIi16 "i", data[i].real, data[i].imag);
270 
271  printf("%14s ", buffer);
272  }
273 
274  printf("\n");
275 }
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.
SENSOR_ID
#define SENSOR_ID
Definition: example_service_multiple_configurations.c:46
example_config::num_points
uint16_t num_points
Definition: example_service_multiple_configurations.c:54
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_stm32cube_xm.c:104
acc_rss_a121.h
acc_processing_destroy
void acc_processing_destroy(acc_processing_t *handle)
Destroy a processing instance identified with the provided processing handle.
print_data
static void print_data(acc_int16_complex_t *data, uint16_t data_length, uint32_t cfg)
Definition: example_service_multiple_configurations.c:257
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_stm32cube_xm.c:99
acc_processing_result_t
Result provided by the processing module.
Definition: acc_processing.h:71
example_config
Definition: example_detector_presence_multiple_configurations.c:48
acc_sensor_read
bool acc_sensor_read(const acc_sensor_t *sensor, void *buffer, uint32_t buffer_size)
Read out radar data.
MAX_DATA_ENTRY_LEN
#define MAX_DATA_ENTRY_LEN
Definition: example_service_multiple_configurations.c:48
buffer
void * buffer
Definition: i2c_example_cargo.c:40
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_int16_complex_t
Data type for interger-based representation of complex numbers.
Definition: acc_definitions_common.h:40
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.
NBR_CONFIGS
#define NBR_CONFIGS
Definition: example_service_multiple_configurations.c:49
acc_cal_result_t
The result from a completed calibration.
Definition: acc_definitions_a121.h:30
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_create
acc_config_t * acc_config_create(void)
Create a configuration.
acc_integration.h
config
cargo_config_t config
Definition: i2c_example_cargo.c:34
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
example_config::start_point
int16_t start_point
Definition: example_service_multiple_configurations.c:53
acc_integration_mem_alloc
void * acc_integration_mem_alloc(size_t size)
Allocate dynamic memory.
Definition: acc_integration_stm32.c:592
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
example_config::sweeps_per_frame
uint16_t sweeps_per_frame
Definition: example_service_multiple_configurations.c:55
acc_rss_hal_register
bool acc_rss_hal_register(const acc_hal_a121_t *hal)
Register an integration.
acc_sensor.h
buffer_size
uint32_t buffer_size
Definition: i2c_example_cargo.c:41
example_config_t
struct example_config example_config_t
sensor
acc_sensor_t * sensor
Definition: i2c_example_cargo.c:33
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_stm32cube_xm.c:130
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:24
acconeer_main
int acconeer_main(int argc, char *argv[])
Assembly test example.
Definition: example_service_multiple_configurations.c:64
printf
#define printf
Definition: printf.h:60
snprintf
#define snprintf
Definition: printf.h:84
acc_hal_integration_sensor_enable
void acc_hal_integration_sensor_enable(acc_sensor_id_t sensor_id)
Enable sensor.
Definition: acc_hal_integration_stm32cube_xm.c:109
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_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_stm32cube_xm.c:119
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_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_stm32.c:602
acc_definitions_common.h
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.
cleanup
static void cleanup(acc_config_t **config, acc_processing_t **processing, acc_sensor_t *sensor, void *buffer, uint32_t nbr_configs)
Definition: example_service_multiple_configurations.c:228
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
SENSOR_TIMEOUT_MS
#define SENSOR_TIMEOUT_MS
Definition: example_service_multiple_configurations.c:47
acc_sensor_destroy
void acc_sensor_destroy(acc_sensor_t *sensor)
Destroy a sensor instance freeing any resources allocated.
acc_definitions_a121.h
acc_sensor_create
acc_sensor_t * acc_sensor_create(acc_sensor_id_t sensor_id)
Create a sensor instance.