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