|
Zephyr API Documentation 4.3.0-rc1
A Scalable Open Source RTOS
|
Decodes a single raw data buffer. More...
#include <zephyr/drivers/sensor.h>
Data Fields | |
| int(* | get_frame_count )(const uint8_t *buffer, struct sensor_chan_spec chan_spec, uint16_t *frame_count) |
Get the frame_count for a specified chan_spec from the buffer. | |
| int(* | get_size_info )(struct sensor_chan_spec channel, size_t *base_size, size_t *frame_size) |
| Get the size required to decode a given channel. | |
| int(* | decode )(const uint8_t *buffer, struct sensor_chan_spec chan_spec, uint32_t *fit, uint16_t max_count, void *data_out) |
Decode up to max_count frames specified by chan_spec from the buffer. | |
| bool(* | has_trigger )(const uint8_t *buffer, enum sensor_trigger_type trigger) |
| Check if the given trigger type is present. | |
Decodes a single raw data buffer.
Data buffers are provided on the RTIO context that's supplied to sensor_read.
| int(* sensor_decoder_api::decode) (const uint8_t *buffer, struct sensor_chan_spec chan_spec, uint32_t *fit, uint16_t max_count, void *data_out) |
Decode up to max_count frames specified by chan_spec from the buffer.
Sample showing the process of decoding at most MAX_FRAMES for each distance sensor channel. The frame iterator is reset for each new channel to allow the full history of each channel to be decoded.
| [in] | buffer | Buffer provided on the RTIO context |
| [in] | chan_spec | Channel specification to decode |
| [in,out] | fit | Current frame iterator |
| [in] | max_count | Maximum number of frames to decode |
| [out] | data_out | Decoded data |
| -EINVAL | Invalid parameters or unsupported channel |
| -ENODATA | Requested data type not present in the frame |
| int(* sensor_decoder_api::get_frame_count) (const uint8_t *buffer, struct sensor_chan_spec chan_spec, uint16_t *frame_count) |
Get the frame_count for a specified chan_spec from the buffer.
| [in] | buffer | The buffer provided via the RTIO context |
| [in] | chan_spec | The channel specification to count |
| [out] | frame_count | The frame count for a specified chan_spec |
| 0 | On success |
| -EINVAL | Invalid channel specification |
| int(* sensor_decoder_api::get_size_info) (struct sensor_chan_spec channel, size_t *base_size, size_t *frame_size) |
Get the size required to decode a given channel.
When decoding a single frame, use base_size. For every additional frame, add another frame_size. As an example, to decode 3 frames use: 'base_size + 2 * frame_size'.
| [in] | channel | The channel to query |
| [out] | base_size | The size of decoding the first frame |
| [out] | frame_size | The additional size of every additional frame |
| bool(* sensor_decoder_api::has_trigger) (const uint8_t *buffer, enum sensor_trigger_type trigger) |
Check if the given trigger type is present.
| [in] | buffer | The buffer provided on the RTIO context |
| [in] | trigger | The trigger type in question |