i2c_ref_app_breathing.h
Go to the documentation of this file.
1 // Copyright (c) Acconeer AB, 2023
2 // All rights reserved
3
4 #ifndef I2C_REF_APP_BREATHING_H_
5 #define I2C_REF_APP_BREATHING_H_
6
7 #include <stdbool.h>
8 #include <stdint.h>
9
10 #include "ref_app_breathing.h"
11
12
13 /**
14 * @brief Get ref app breathing configuration handle
15 *
16 * @return ref app breathing configuration handle
17 */
18 ref_app_breathing_config_t *i2c_ref_app_breathing_get_config(void);
19
20
21 /**
22 * @brief Send command to be executed to i2c ref app breathing
23 *
24 * @param[in] command The command to be executed
25 * @return true if successful
26 */
27 bool i2c_ref_app_breathing_command(uint32_t command);
28
29
30 /**
31 * @brief Get ref app breathing status
32 *
33 * @return status from ref app breathing
34 */
35 uint32_t i2c_ref_app_breathing_get_status(void);
36
37
38 /**
39 * @brief Get ref app breathing result
40 *
41 * @return result from ref app breathing
42 */
43 uint32_t i2c_ref_app_breathing_get_result(void);
44
45
46 /**
47 * @brief Get breathing rate
48 *
49 * @return The breathing rate
50 */
51 float i2c_ref_app_breathing_get_breathing_rate(void);
52
53
54 /**
55 * @brief Get app state
56 *
57 * @return A state of the application
58 */
59 ref_app_breathing_app_state_t i2c_ref_app_breathing_get_app_state(void);
60
61
62 /**
63 * @brief Get measure counter
64 *
65 * The counter will be increased every time the application completes a measure
66 *
67 * @return measure counter from the application
68 */
69 uint32_t i2c_ref_app_breathing_get_counter(void);
70
71
72 /**
73 * @brief Get the actual frame rate for the current ref app breathing configuration
74 *
75 * @return The frame rate in mHz
76 */
77 uint32_t i2c_ref_app_breathing_get_frame_rate_mhz(void);
78
79
80 #endif
i2c_ref_app_breathing_get_status
uint32_t i2c_ref_app_breathing_get_status(void)
Get ref app breathing status.
Definition: i2c_ref_app_breathing.c:204
i2c_ref_app_breathing_get_config
ref_app_breathing_config_t * i2c_ref_app_breathing_get_config(void)
Get ref app breathing configuration handle.
Definition: i2c_ref_app_breathing.c:177
ref_app_breathing.h
i2c_ref_app_breathing_get_breathing_rate
float i2c_ref_app_breathing_get_breathing_rate(void)
Get breathing rate.
Definition: i2c_ref_app_breathing.c:245
i2c_ref_app_breathing_get_app_state
ref_app_breathing_app_state_t i2c_ref_app_breathing_get_app_state(void)
Get app state.
Definition: i2c_ref_app_breathing.c:257
i2c_ref_app_breathing_get_counter
uint32_t i2c_ref_app_breathing_get_counter(void)
Get measure counter.
Definition: i2c_ref_app_breathing.c:269
i2c_ref_app_breathing_command
bool i2c_ref_app_breathing_command(uint32_t command)
Send command to be executed to i2c ref app breathing.
Definition: i2c_ref_app_breathing.c:182
i2c_ref_app_breathing_get_frame_rate_mhz
uint32_t i2c_ref_app_breathing_get_frame_rate_mhz(void)
Get the actual frame rate for the current ref app breathing configuration.
Definition: i2c_ref_app_breathing.c:281
i2c_ref_app_breathing_get_result
uint32_t i2c_ref_app_breathing_get_result(void)
Get ref app breathing result.
Definition: i2c_ref_app_breathing.c:216
ref_app_breathing_config_t
Breathing application config container.
Definition: ref_app_breathing.h:25
ref_app_breathing_app_state_t
ref_app_breathing_app_state_t
State of the application.
Definition: ref_app_breathing.h:60