example_service_low_power_sensor_disable.c
Go to the documentation of this file.
1 // Copyright (c) Acconeer AB, 2022-2023
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 
25 /** \example example_service_low_power_sensor_disable.c
26  * @brief This is an example on how to disable the sensor and put the system in a low power state between measurements
27  * @n
28  * The example executes as follows:
29  * - Create a configuration
30  * - Create a processing instance using the previously created configuration
31  * - Create a sensor instance
32  * - Loop forever:
33  * - Enable sensor
34  * - Prepare a sensor
35  * - Perform a sensor measurement and read out the data
36  * - Disable sensor
37  * - Process the measurement
38  * - Put the system in deep sleep for a specified amount of time
39  * - Destroy the sensor instance
40  * - Destroy the processing instance
41  * - Destroy the configuration
42  */
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 
54 static void print_data(acc_int16_complex_t *data, uint16_t data_length);
55 
56 
57 static void cleanup(acc_config_t *config, acc_processing_t *processing,
58  acc_sensor_t *sensor, void *buffer);
59 
60 
61 int acconeer_main(int argc, char *argv[]);
62 
63 
64 int acconeer_main(int argc, char *argv[])
65 {
66  (void)argc;
67  (void)argv;
68  acc_config_t *config = NULL;
69  acc_processing_t *processing = NULL;
70  acc_sensor_t *sensor = NULL;
71  void *buffer = NULL;
72  uint32_t buffer_size = 0;
73  acc_processing_metadata_t proc_meta;
74  acc_processing_result_t proc_result;
75 
76  printf("Acconeer software version %s\n", acc_version_get());
77 
80 
81  if (!acc_rss_hal_register(hal))
82  {
83  return EXIT_FAILURE;
84  }
85 
86  config = acc_config_create();
87  if (config == NULL)
88  {
89  printf("acc_config_create() failed\n");
90  cleanup(config, processing, sensor, buffer);
91  return EXIT_FAILURE;
92  }
93 
94  set_config(config);
95 
96  processing = acc_processing_create(config, &proc_meta);
97  if (processing == NULL)
98  {
99  printf("acc_processing_create() failed\n");
100  cleanup(config, processing, sensor, buffer);
101  return EXIT_FAILURE;
102  }
103 
104  if (!acc_rss_get_buffer_size(config, &buffer_size))
105  {
106  printf("acc_rss_get_buffer_size() failed\n");
107  cleanup(config, processing, sensor, buffer);
108  return EXIT_FAILURE;
109  }
110 
111  buffer = acc_integration_mem_alloc(buffer_size);
112  if (buffer == NULL)
113  {
114  printf("buffer allocation failed\n");
115  cleanup(config, processing, sensor, buffer);
116  return EXIT_FAILURE;
117  }
118 
121 
122  sensor = acc_sensor_create(SENSOR_ID);
123  if (sensor == NULL)
124  {
125  printf("acc_sensor_create() failed\n");
126  cleanup(config, processing, sensor, buffer);
127  return EXIT_FAILURE;
128  }
129 
130  bool status;
131  bool cal_complete = false;
132  acc_cal_result_t cal_result;
133 
134  do
135  {
136  status = acc_sensor_calibrate(sensor, &cal_complete, &cal_result, buffer, buffer_size);
137 
138  if (status && !cal_complete)
139  {
141  }
142  } while (status && !cal_complete);
143 
144  if (!status)
145  {
146  printf("acc_sensor_calibrate() failed\n");
147  acc_sensor_status(sensor);
148  cleanup(config, processing, sensor, buffer);
149  return EXIT_FAILURE;
150  }
151 
152  // Reset sensor after calibration by disabling it
154 
155  while (true)
156  {
158  if (!acc_sensor_prepare(sensor, config, &cal_result, buffer, buffer_size))
159  {
160  printf("acc_sensor_prepare() failed\n");
161  acc_sensor_status(sensor);
162  cleanup(config, processing, sensor, buffer);
163  return EXIT_FAILURE;
164  }
165 
166  if (!acc_sensor_measure(sensor))
167  {
168  printf("acc_sensor_measure failed\n");
169  acc_sensor_status(sensor);
170  cleanup(config, processing, sensor, buffer);
171  return EXIT_FAILURE;
172  }
173 
175  {
176  printf("Sensor interrupt timeout\n");
177  acc_sensor_status(sensor);
178  cleanup(config, processing, sensor, buffer);
179  return EXIT_FAILURE;
180  }
181 
182  if (!acc_sensor_read(sensor, buffer, buffer_size))
183  {
184  printf("acc_sensor_read failed\n");
185  acc_sensor_status(sensor);
186  cleanup(config, processing, sensor, buffer);
187  return EXIT_FAILURE;
188  }
189 
191 
192  acc_processing_execute(processing, buffer, &proc_result);
193 
194  print_data(proc_result.frame, proc_meta.frame_data_length);
195 
197  }
198 
199  cleanup(config, processing, sensor, buffer);
200 
201  printf("Application finished OK\n");
202 
203  return EXIT_SUCCESS;
204 }
205 
206 
207 static void cleanup(acc_config_t *config, acc_processing_t *processing,
208  acc_sensor_t *sensor, void *buffer)
209 {
212 
213  if (sensor != NULL)
214  {
215  acc_sensor_destroy(sensor);
216  }
217 
218  if (processing != NULL)
219  {
220  acc_processing_destroy(processing);
221  }
222 
223  if (config != NULL)
224  {
225  acc_config_destroy(config);
226  }
227 
228  if (buffer != NULL)
229  {
230  acc_integration_mem_free(buffer);
231  }
232 }
233 
234 
235 static void print_data(acc_int16_complex_t *data, uint16_t data_length)
236 {
237  printf("Processed data:\n");
238  char buffer[MAX_DATA_ENTRY_LEN];
239 
240  for (uint16_t i = 0; i < data_length; i++)
241  {
242  if ((i > 0) && ((i % 8) == 0))
243  {
244  printf("\n");
245  }
246 
247  snprintf(buffer, sizeof(buffer), "%" PRIi16 "+%" PRIi16 "i", data[i].real, data[i].imag);
248 
249  printf("%14s ", buffer);
250  }
251 
252  printf("\n");
253 }
254 
255 
256 static void set_config(acc_config_t *config)
257 {
258  // Add configuration of the sensor here
259 
260  acc_config_start_point_set(config, 80);
261  acc_config_num_points_set(config, 160);
262 }
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:113
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:107
SENSOR_ID
#define SENSOR_ID
Definition: example_service_low_power_sensor_disable.c:45
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:207
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_int16_complex_t
Data type for interger-based representation of complex numbers.
Definition: acc_definitions_common.h:43
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:49
acc_cal_result_t
Definition: acc_definitions_a121.h:19
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
acconeer_main
int acconeer_main(int argc, char *argv[])
Assembly test example.
Definition: example_service_low_power_sensor_disable.c:64
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:166
SENSOR_TIMEOUT_MS
#define SENSOR_TIMEOUT_MS
Definition: example_service_low_power_sensor_disable.c:46
acc_integration_mem_alloc
void * acc_integration_mem_alloc(size_t size)
Allocate dynamic memory.
Definition: acc_integration_stm32.c:632
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:531
acc_sensor.h
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:142
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
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:119
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:130
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:644
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:590
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:235
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:256
MAX_DATA_ENTRY_LEN
#define MAX_DATA_ENTRY_LEN
Definition: example_service_low_power_sensor_disable.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.