example_service_low_power_sensor_hibernate.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_low_power_sensor_hibernate.c
25 * @brief This is an example on how to put the sensor in hibernation and the system in a low power state between measurements
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 * - Enable sensor
32 * - Prepare a sensor
33 * - Enter hibernation
34 * - Loop forever:
35 * - Exit hibernation
36 * - Perform a sensor measurement and read out the data
37 * - Enter hibernation
38 * - Process the measurement
39 * - Put the system in deep sleep for a specified amount of time
40 * - Destroy the sensor instance
41 * - Destroy the processing instance
42 * - Destroy the configuration
43 */
44
45 #define SENSOR_ID (1U)
46 #define SENSOR_TIMEOUT_MS (1000U)
47 #define MAX_DATA_ENTRY_LEN 15 // "-32000+-32000i" + zero termination
48
49 #define SUSPEND_TIME_BETWEEN_UPDATES_MS (10000) // 0.1Hz
50
51 static void set_config(acc_config_t *config);
52
53 static void print_data(acc_int16_complex_t *data, uint16_t data_length);
54
55 static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer);
56
57 int acconeer_main(int argc, char *argv[]);
58
59 int acconeer_main(int argc, char *argv[])
60 {
61 (void)argc;
62 (void)argv;
63 acc_config_t *config = NULL;
64 acc_processing_t *processing = NULL;
65 acc_sensor_t *sensor = NULL;
66 void *buffer = NULL;
67 uint32_t buffer_size = 0;
68 acc_processing_metadata_t proc_meta;
69 acc_processing_result_t proc_result;
70
71 printf("Acconeer software version %s\n", acc_version_get());
72
73 const acc_hal_a121_t *hal = acc_hal_rss_integration_get_implementation();
74 acc_integration_set_periodic_wakeup(SUSPEND_TIME_BETWEEN_UPDATES_MS);
75
76 if (!acc_rss_hal_register(hal))
77 {
78 return EXIT_FAILURE;
79 }
80
81 config = acc_config_create();
82 if (config == NULL)
83 {
84 printf("acc_config_create() failed\n");
85 cleanup(config, processing, sensor, buffer);
86 return EXIT_FAILURE;
87 }
88
89 set_config(config);
90
91 processing = acc_processing_create(config, &proc_meta);
92 if (processing == NULL)
93 {
94 printf("acc_processing_create() failed\n");
95 cleanup(config, processing, sensor, buffer);
96 return EXIT_FAILURE;
97 }
98
99 if (!acc_rss_get_buffer_size(config, &buffer_size))
100 {
101 printf("acc_rss_get_buffer_size() failed\n");
102 cleanup(config, processing, sensor, buffer);
103 return EXIT_FAILURE;
104 }
105
106 buffer = acc_integration_mem_alloc(buffer_size);
107 if (buffer == NULL)
108 {
109 printf("buffer allocation failed\n");
110 cleanup(config, processing, sensor, buffer);
111 return EXIT_FAILURE;
112 }
113
114 acc_hal_integration_sensor_supply_on(SENSOR_ID);
115 acc_hal_integration_sensor_enable(SENSOR_ID);
116
117 sensor = acc_sensor_create(SENSOR_ID);
118 if (sensor == NULL)
119 {
120 printf("acc_sensor_create() failed\n");
121 cleanup(config, processing, sensor, buffer);
122 return EXIT_FAILURE;
123 }
124
125 bool status;
126 bool cal_complete = false;
127 acc_cal_result_t cal_result;
128
129 do
130 {
131 status = acc_sensor_calibrate(sensor, &cal_complete, &cal_result, buffer, buffer_size);
132
133 if (status && !cal_complete)
134 {
135 status = acc_hal_integration_wait_for_sensor_interrupt(SENSOR_ID, SENSOR_TIMEOUT_MS);
136 }
137 } while (status && !cal_complete);
138
139 if (!status)
140 {
141 printf("acc_sensor_calibrate() failed\n");
142 acc_sensor_status(sensor);
143 cleanup(config, processing, sensor, buffer);
144 return EXIT_FAILURE;
145 }
146
147 // Reset sensor after calibration by disabling it
148 acc_hal_integration_sensor_disable(SENSOR_ID);
149
150 acc_hal_integration_sensor_enable(SENSOR_ID);
151
152 if (!acc_sensor_prepare(sensor, config, &cal_result, buffer, buffer_size))
153 {
154 printf("acc_sensor_prepare() failed\n");
155 acc_sensor_status(sensor);
156 cleanup(config, processing, sensor, buffer);
157 return EXIT_FAILURE;
158 }
159
160 if (!acc_sensor_hibernate_on(sensor))
161 {
162 printf("acc_sensor_hibernate_on failed\n");
163 acc_sensor_status(sensor);
164 cleanup(config, processing, sensor, buffer);
165 return EXIT_FAILURE;
166 }
167
168 acc_hal_integration_sensor_disable(SENSOR_ID);
169
170 while (true)
171 {
172 acc_hal_integration_sensor_enable(SENSOR_ID);
173 if (!acc_sensor_hibernate_off(sensor))
174 {
175 printf("acc_sensor_hibernate_off failed\n");
176 acc_sensor_status(sensor);
177 cleanup(config, processing, sensor, buffer);
178 return EXIT_FAILURE;
179 }
180
181 if (!acc_sensor_measure(sensor))
182 {
183 printf("acc_sensor_measure failed\n");
184 acc_sensor_status(sensor);
185 cleanup(config, processing, sensor, buffer);
186 return EXIT_FAILURE;
187 }
188
189 if (!acc_hal_integration_wait_for_sensor_interrupt(SENSOR_ID, SENSOR_TIMEOUT_MS))
190 {
191 printf("Sensor interrupt timeout\n");
192 acc_sensor_status(sensor);
193 cleanup(config, processing, sensor, buffer);
194 return EXIT_FAILURE;
195 }
196
197 if (!acc_sensor_read(sensor, buffer, buffer_size))
198 {
199 printf("acc_sensor_read failed\n");
200 acc_sensor_status(sensor);
201 cleanup(config, processing, sensor, buffer);
202 return EXIT_FAILURE;
203 }
204
205 if (!acc_sensor_hibernate_on(sensor))
206 {
207 printf("acc_sensor_hibernate_on failed\n");
208 acc_sensor_status(sensor);
209 cleanup(config, processing, sensor, buffer);
210 return EXIT_FAILURE;
211 }
212
213 acc_hal_integration_sensor_disable(SENSOR_ID);
214
215 acc_processing_execute(processing, buffer, &proc_result);
216
217 print_data(proc_result.frame, proc_meta.frame_data_length);
218
219 acc_integration_sleep_until_periodic_wakeup();
220 }
221
222 acc_hal_integration_sensor_enable(SENSOR_ID);
223 if (!acc_sensor_hibernate_off(sensor))
224 {
225 printf("acc_sensor_hibernate_off failed\n");
226 acc_sensor_status(sensor);
227 cleanup(config, processing, sensor, buffer);
228 return EXIT_FAILURE;
229 }
230
231 cleanup(config, processing, sensor, buffer);
232
233 printf("Application finished OK\n");
234
235 return EXIT_SUCCESS;
236 }
237
238 static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer)
239 {
240 acc_hal_integration_sensor_disable(SENSOR_ID);
241 acc_hal_integration_sensor_supply_off(SENSOR_ID);
242
243 if (sensor != NULL)
244 {
245 acc_sensor_destroy(sensor);
246 }
247
248 if (processing != NULL)
249 {
250 acc_processing_destroy(processing);
251 }
252
253 if (config != NULL)
254 {
255 acc_config_destroy(config);
256 }
257
258 if (buffer != NULL)
259 {
260 acc_integration_mem_free(buffer);
261 }
262 }
263
264 static void print_data(acc_int16_complex_t *data, uint16_t data_length)
265 {
266 printf("Processed data:\n");
267 char buffer[MAX_DATA_ENTRY_LEN];
268
269 for (uint16_t i = 0; i < data_length; i++)
270 {
271 if ((i > 0) && ((i % 8) == 0))
272 {
273 printf("\n");
274 }
275
276 snprintf(buffer, sizeof(buffer), "%" PRIi16 "+%" PRIi16 "i", data[i].real, data[i].imag);
277
278 printf("%14s ", buffer);
279 }
280
281 printf("\n");
282 }
283
284 static void set_config(acc_config_t *config)
285 {
286 // Add configuration of the sensor here
287
288 acc_config_start_point_set(config, 80);
289 acc_config_num_points_set(config, 160);
290 }
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.
SUSPEND_TIME_BETWEEN_UPDATES_MS
#define SUSPEND_TIME_BETWEEN_UPDATES_MS
Definition: example_service_low_power_sensor_hibernate.c:49
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
MAX_DATA_ENTRY_LEN
#define MAX_DATA_ENTRY_LEN
Definition: example_service_low_power_sensor_hibernate.c:47
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.
cleanup
static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer)
Definition: example_service_low_power_sensor_hibernate.c:238
buffer
void * buffer
Definition: i2c_example_cargo.c:40
acc_version.h
set_config
static void set_config(acc_config_t *config)
Definition: example_service_low_power_sensor_hibernate.c:284
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.
SENSOR_TIMEOUT_MS
#define SENSOR_TIMEOUT_MS
Definition: example_service_low_power_sensor_hibernate.c:46
SENSOR_ID
#define SENSOR_ID
Definition: example_service_low_power_sensor_hibernate.c:45
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
print_data
static void print_data(acc_int16_complex_t *data, uint16_t data_length)
Definition: example_service_low_power_sensor_hibernate.c:264
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.
acconeer_main
int acconeer_main(int argc, char *argv[])
Assembly test example.
Definition: example_service_low_power_sensor_hibernate.c:59
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
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
acc_rss_hal_register
bool acc_rss_hal_register(const acc_hal_a121_t *hal)
Register an integration.
acc_integration_set_periodic_wakeup
void acc_integration_set_periodic_wakeup(uint32_t time_msec)
Set up a periodic timer used to wake up the system from sleep.
Definition: acc_integration_stm32.c:496
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_sensor_hibernate_off
bool acc_sensor_hibernate_off(const acc_sensor_t *sensor)
Restore sensor after exiting hibernation.
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
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_hibernate_on
bool acc_sensor_hibernate_on(acc_sensor_t *sensor)
Prepare sensor for entering hibernation.
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_integration_sleep_until_periodic_wakeup
void acc_integration_sleep_until_periodic_wakeup(void)
Put the system in sleep until the periodic timer triggers.
Definition: acc_integration_stm32.c:552
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
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.