example_service_sensor_hibernate.c

This is an example on how hibernation can be used in the Service API
The example executes as follows:

- Create a configuration
- Create a processing instance using the previously created configuration
- Create a sensor instance
- Prepare sensor
- Put sensor in hibernation
- Wake up sensor from hibernation
- Perform a sensor measurement and read out the data
- Process the measurement
- Destroy the sensor instance
- Destroy the processing instance
- Destroy the configuration

// Copyright (c) Acconeer AB, 2022-2023
// All rights reserved
// This file is subject to the terms and conditions defined in the file
// 'LICENSES/license_acconeer.txt', (BSD 3-Clause License) which is part
// of this source code package.
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include "acc_config.h"
#include "acc_definitions_a121.h"
#include "acc_definitions_common.h"
#include "acc_hal_definitions_a121.h"
#include "acc_hal_integration_a121.h"
#include "acc_integration.h"
#include "acc_processing.h"
#include "acc_rss_a121.h"
#include "acc_sensor.h"
#include "acc_version.h"
/** \example example_service_sensor_hibernate.c
* @brief This is an example on how hibernation can be used in the Service API
* @n
* The example executes as follows:
* - Create a configuration
* - Create a processing instance using the previously created configuration
* - Create a sensor instance
* - Prepare sensor
* - Put sensor in hibernation
* - Wake up sensor from hibernation
* - Perform a sensor measurement and read out the data
* - Process the measurement
* - Destroy the sensor instance
* - Destroy the processing instance
* - Destroy the configuration
*/
#define SENSOR_ID (1U)
#define SENSOR_TIMEOUT_MS (1000U)
#define MAX_DATA_ENTRY_LEN 15 // "-32000+-32000i" + zero termination
static void set_config(acc_config_t *config);
static void print_data(acc_int16_complex_t *data, uint16_t data_length);
static void cleanup(acc_config_t *config, acc_processing_t *processing,
acc_sensor_t *sensor, void *buffer);
int acconeer_main(int argc, char *argv[]);
int acconeer_main(int argc, char *argv[])
{
(void)argc;
(void)argv;
acc_config_t *config = NULL;
acc_processing_t *processing = NULL;
acc_sensor_t *sensor = NULL;
void *buffer = NULL;
uint32_t buffer_size = 0;
acc_processing_metadata_t proc_meta;
acc_processing_result_t proc_result;
printf("Acconeer software version %s\n", acc_version_get());
const acc_hal_a121_t *hal = acc_hal_rss_integration_get_implementation();
if (!acc_rss_hal_register(hal))
{
return EXIT_FAILURE;
}
config = acc_config_create();
if (config == NULL)
{
printf("acc_config_create() failed\n");
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
set_config(config);
processing = acc_processing_create(config, &proc_meta);
if (processing == NULL)
{
printf("acc_processing_create() failed\n");
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
if (!acc_rss_get_buffer_size(config, &buffer_size))
{
printf("acc_rss_get_buffer_size() failed\n");
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
buffer = acc_integration_mem_alloc(buffer_size);
if (buffer == NULL)
{
printf("buffer allocation failed\n");
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
acc_hal_integration_sensor_supply_on(SENSOR_ID);
acc_hal_integration_sensor_enable(SENSOR_ID);
sensor = acc_sensor_create(SENSOR_ID);
if (sensor == NULL)
{
printf("acc_sensor_create() failed\n");
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
bool status;
bool cal_complete = false;
acc_cal_result_t cal_result;
do
{
status = acc_sensor_calibrate(sensor, &cal_complete, &cal_result, buffer, buffer_size);
if (status && !cal_complete)
{
status = acc_hal_integration_wait_for_sensor_interrupt(SENSOR_ID, SENSOR_TIMEOUT_MS);
}
} while (status && !cal_complete);
if (!status)
{
printf("acc_sensor_calibrate() failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
// Reset sensor after calibration by disabling it
acc_hal_integration_sensor_disable(SENSOR_ID);
acc_hal_integration_sensor_enable(SENSOR_ID);
if (!acc_sensor_prepare(sensor, config, &cal_result, buffer, buffer_size))
{
printf("acc_sensor_prepare() failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
if (!acc_sensor_hibernate_on(sensor))
{
printf("acc_sensor_hibernate_on failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
acc_hal_integration_sensor_disable(SENSOR_ID);
for (uint32_t i = 0U; i < 5U; i++)
{
acc_hal_integration_sensor_enable(SENSOR_ID);
if (!acc_sensor_hibernate_off(sensor))
{
printf("acc_sensor_hibernate_off failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
if (!acc_sensor_measure(sensor))
{
printf("acc_sensor_measure failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
if (!acc_hal_integration_wait_for_sensor_interrupt(SENSOR_ID, SENSOR_TIMEOUT_MS))
{
printf("Sensor interrupt timeout\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
if (!acc_sensor_read(sensor, buffer, buffer_size))
{
printf("acc_sensor_read failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
if (!acc_sensor_hibernate_on(sensor))
{
printf("acc_sensor_hibernate_on failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
acc_hal_integration_sensor_disable(SENSOR_ID);
acc_processing_execute(processing, buffer, &proc_result);
print_data(proc_result.frame, proc_meta.frame_data_length);
/*
* Here the system can be put into low power mode until
* requesting the next frame.
*/
}
acc_hal_integration_sensor_enable(SENSOR_ID);
if (!acc_sensor_hibernate_off(sensor))
{
printf("acc_sensor_hibernate_off failed\n");
acc_sensor_status(sensor);
cleanup(config, processing, sensor, buffer);
return EXIT_FAILURE;
}
cleanup(config, processing, sensor, buffer);
printf("Application finished OK\n");
return EXIT_SUCCESS;
}
static void cleanup(acc_config_t *config, acc_processing_t *processing,
acc_sensor_t *sensor, void *buffer)
{
acc_hal_integration_sensor_disable(SENSOR_ID);
acc_hal_integration_sensor_supply_off(SENSOR_ID);
if (sensor != NULL)
{
acc_sensor_destroy(sensor);
}
if (processing != NULL)
{
acc_processing_destroy(processing);
}
if (config != NULL)
{
acc_config_destroy(config);
}
if (buffer != NULL)
{
acc_integration_mem_free(buffer);
}
}
static void print_data(acc_int16_complex_t *data, uint16_t data_length)
{
printf("Processed data:\n");
char buffer[MAX_DATA_ENTRY_LEN];
for (uint16_t i = 0; i < data_length; i++)
{
if ((i > 0) && ((i % 8) == 0))
{
printf("\n");
}
snprintf(buffer, sizeof(buffer), "%" PRIi16 "+%" PRIi16 "i", data[i].real, data[i].imag);
printf("%14s ", buffer);
}
printf("\n");
}
static void set_config(acc_config_t *config)
{
// Add configuration of the sensor here
acc_config_start_point_set(config, 80);
acc_config_num_points_set(config, 160);
}
SENSOR_ID
#define SENSOR_ID
Definition: example_service_sensor_hibernate.c:43
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
set_config
static void set_config(acc_config_t *config)
Definition: example_service_sensor_hibernate.c:292
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
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.
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.
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.
cleanup
static void cleanup(acc_config_t *config, acc_processing_t *processing, acc_sensor_t *sensor, void *buffer)
Definition: example_service_sensor_hibernate.c:243
acc_config_create
acc_config_t * acc_config_create(void)
Create a configuration.
acc_integration.h
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
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_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_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: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_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.
print_data
static void print_data(acc_int16_complex_t *data, uint16_t data_length)
Definition: example_service_sensor_hibernate.c:271
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_definitions_common.h
MAX_DATA_ENTRY_LEN
#define MAX_DATA_ENTRY_LEN
Definition: example_service_sensor_hibernate.c:45
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.
SENSOR_TIMEOUT_MS
#define SENSOR_TIMEOUT_MS
Definition: example_service_sensor_hibernate.c:44
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.
acconeer_main
int acconeer_main(int argc, char *argv[])
Assembly test example.
Definition: example_service_sensor_hibernate.c:61
acc_definitions_a121.h
acc_sensor_create
acc_sensor_t * acc_sensor_create(acc_sensor_id_t sensor_id)
Create a sensor instance.