example_service_sensor_off.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 #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"
15 #include "acc_hal_definitions_a121.h"
16 #include "acc_hal_integration_a121.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_sensor_off.c
25 * @brief This is an example on how to power off the sensor between measurements using the Service API
26 * @n
27 * The example executes as follows:
28 * - Create a configuration
29 * - Create a processing instance using the previously created configuration
30 * - Create a sensor instance
31 * - Power on sensor
32 * - Prepare sensor
33 * - Perform a sensor measurement and read out the data
34 * - Power off sensor
35 * - Process the measurement
36 * - Destroy the sensor instance
37 * - Destroy the processing instance
38 * - Destroy the configuration
39 */
40
41 #define SENSOR_ID (1U)
42 #define SENSOR_TIMEOUT_MS (1000U)
43 #define MAX_DATA_ENTRY_LEN 15 // "-32000+-32000i" + zero termination
44
45 static void set_config(acc_config_t *config);
46
47 static void print_data(acc_int16_complex_t *data, uint16_t data_length);
48
49 static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer);
50
51 int acconeer_main(int argc, char *argv[]);
52
53 int acconeer_main(int argc, char *argv[])
54 {
55 (void)argc;
56 (void)argv;
57 acc_config_t *config = NULL;
58 acc_processing_t *processing = NULL;
59 acc_sensor_t *sensor = NULL;
60 void *buffer = NULL;
61 uint32_t buffer_size = 0;
62 acc_processing_metadata_t proc_meta;
63 acc_processing_result_t proc_result;
64
65 printf("Acconeer software version %s\n", acc_version_get());
66
67 const acc_hal_a121_t *hal = acc_hal_rss_integration_get_implementation();
68
69 if (!acc_rss_hal_register(hal))
70 {
71 return EXIT_FAILURE;
72 }
73
74 config = acc_config_create();
75 if (config == NULL)
76 {
77 printf("acc_config_create() failed\n");
78 cleanup(config, processing, sensor, buffer);
79 return EXIT_FAILURE;
80 }
81
82 set_config(config);
83
84 processing = acc_processing_create(config, &proc_meta);
85 if (processing == NULL)
86 {
87 printf("acc_processing_create() failed\n");
88 cleanup(config, processing, sensor, buffer);
89 return EXIT_FAILURE;
90 }
91
92 if (!acc_rss_get_buffer_size(config, &buffer_size))
93 {
94 printf("acc_rss_get_buffer_size() failed\n");
95 cleanup(config, processing, sensor, buffer);
96 return EXIT_FAILURE;
97 }
98
99 buffer = acc_integration_mem_alloc(buffer_size);
100 if (buffer == NULL)
101 {
102 printf("buffer allocation failed\n");
103 cleanup(config, processing, sensor, buffer);
104 return EXIT_FAILURE;
105 }
106
107 acc_hal_integration_sensor_supply_on(SENSOR_ID);
108 acc_hal_integration_sensor_enable(SENSOR_ID);
109
110 sensor = acc_sensor_create(SENSOR_ID);
111 if (sensor == NULL)
112 {
113 printf("acc_sensor_create() failed\n");
114 cleanup(config, processing, sensor, buffer);
115 return EXIT_FAILURE;
116 }
117
118 bool status;
119 bool cal_complete = false;
120 acc_cal_result_t cal_result;
121
122 do
123 {
124 status = acc_sensor_calibrate(sensor, &cal_complete, &cal_result, buffer, buffer_size);
125
126 if (status && !cal_complete)
127 {
128 status = acc_hal_integration_wait_for_sensor_interrupt(SENSOR_ID, SENSOR_TIMEOUT_MS);
129 }
130 } while (status && !cal_complete);
131
132 if (!status)
133 {
134 printf("acc_sensor_calibrate() failed\n");
135 acc_sensor_status(sensor);
136 cleanup(config, processing, sensor, buffer);
137 return EXIT_FAILURE;
138 }
139
140 // Reset sensor after calibration by disabling it
141 acc_hal_integration_sensor_disable(SENSOR_ID);
142 acc_hal_integration_sensor_supply_off(SENSOR_ID);
143
144 for (uint32_t i = 0U; i < 5U; i++)
145 {
146 acc_hal_integration_sensor_supply_on(SENSOR_ID);
147 acc_hal_integration_sensor_enable(SENSOR_ID);
148 if (!acc_sensor_prepare(sensor, config, &cal_result, buffer, buffer_size))
149 {
150 printf("acc_sensor_prepare() failed\n");
151 acc_sensor_status(sensor);
152 cleanup(config, processing, sensor, buffer);
153 return EXIT_FAILURE;
154 }
155
156 if (!acc_sensor_measure(sensor))
157 {
158 printf("acc_sensor_measure failed\n");
159 acc_sensor_status(sensor);
160 cleanup(config, processing, sensor, buffer);
161 return EXIT_FAILURE;
162 }
163
164 if (!acc_hal_integration_wait_for_sensor_interrupt(SENSOR_ID, SENSOR_TIMEOUT_MS))
165 {
166 printf("Sensor interrupt timeout\n");
167 acc_sensor_status(sensor);
168 cleanup(config, processing, sensor, buffer);
169 return EXIT_FAILURE;
170 }
171
172 if (!acc_sensor_read(sensor, buffer, buffer_size))
173 {
174 printf("acc_sensor_read failed\n");
175 acc_sensor_status(sensor);
176 cleanup(config, processing, sensor, buffer);
177 return EXIT_FAILURE;
178 }
179
180 acc_hal_integration_sensor_disable(SENSOR_ID);
181 acc_hal_integration_sensor_supply_off(SENSOR_ID);
182
183 acc_processing_execute(processing, buffer, &proc_result);
184
185 print_data(proc_result.frame, proc_meta.frame_data_length);
186
187 /*
188 * Here the system can be put into low power mode until
189 * requesting the next frame.
190 */
191 }
192
193 cleanup(config, processing, sensor, buffer);
194
195 printf("Application finished OK\n");
196
197 return EXIT_SUCCESS;
198 }
199
200 static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer)
201 {
202 acc_hal_integration_sensor_disable(SENSOR_ID);
203 acc_hal_integration_sensor_supply_off(SENSOR_ID);
204
205 if (sensor != NULL)
206 {
207 acc_sensor_destroy(sensor);
208 }
209
210 if (processing != NULL)
211 {
212 acc_processing_destroy(processing);
213 }
214
215 if (config != NULL)
216 {
217 acc_config_destroy(config);
218 }
219
220 if (buffer != NULL)
221 {
222 acc_integration_mem_free(buffer);
223 }
224 }
225
226 static void print_data(acc_int16_complex_t *data, uint16_t data_length)
227 {
228 printf("Processed data:\n");
229 char buffer[MAX_DATA_ENTRY_LEN];
230
231 for (uint16_t i = 0; i < data_length; i++)
232 {
233 if ((i > 0) && ((i % 8) == 0))
234 {
235 printf("\n");
236 }
237
238 snprintf(buffer, sizeof(buffer), "%" PRIi16 "+%" PRIi16 "i", data[i].real, data[i].imag);
239
240 printf("%14s ", buffer);
241 }
242
243 printf("\n");
244 }
245
246 static void set_config(acc_config_t *config)
247 {
248 // Add configuration of the sensor here
249
250 acc_config_start_point_set(config, 80);
251 acc_config_num_points_set(config, 160);
252 }
cleanup
static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer)
Definition: example_service_sensor_off.c:200
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_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.
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
acc_sensor_read
bool acc_sensor_read(const acc_sensor_t *sensor, void *buffer, uint32_t buffer_size)
Read out radar data.
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_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: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
acconeer_main
int acconeer_main(int argc, char *argv[])
Assembly test example.
Definition: example_service_sensor_off.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
MAX_DATA_ENTRY_LEN
#define MAX_DATA_ENTRY_LEN
Definition: example_service_sensor_off.c:43
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
buffer_size
uint32_t buffer_size
Definition: i2c_example_cargo.c:41
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
SENSOR_TIMEOUT_MS
#define SENSOR_TIMEOUT_MS
Definition: example_service_sensor_off.c:42
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
SENSOR_ID
#define SENSOR_ID
Definition: example_service_sensor_off.c:41
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
set_config
static void set_config(acc_config_t *config)
Definition: example_service_sensor_off.c:246
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.
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
print_data
static void print_data(acc_int16_complex_t *data, uint16_t data_length)
Definition: example_service_sensor_off.c:226
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.