Zephyr API Documentation 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
sensing.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022-2023 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_SENSING_H_
8#define ZEPHYR_INCLUDE_SENSING_H_
9
21
24#include <zephyr/device.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
44
54#define SENSING_SENSOR_VERSION(_major, _minor, _hotfix, _build) \
55 (FIELD_PREP(GENMASK(31, 24), _major) | \
56 FIELD_PREP(GENMASK(23, 16), _minor) | \
57 FIELD_PREP(GENMASK(15, 8), _hotfix) | \
58 FIELD_PREP(GENMASK(7, 0), _build))
59
64
73#define SENSING_SENSOR_FLAG_REPORT_ON_EVENT BIT(0)
74
82#define SENSING_SENSOR_FLAG_REPORT_ON_CHANGE BIT(1)
83
85
91#define SENSING_SENSITIVITY_INDEX_ALL -1
92
102
133
141
152typedef void (*sensing_data_event_t)(
154 const void *buf,
155 void *context);
156
162 const char *name;
163
165 const char *friendly_name;
166
168 const char *vendor;
169
171 const char *model;
172
175
178};
179
185
193
224
236int sensing_get_sensors(int *num_sensors, const struct sensing_sensor_info **info);
237
253 const struct sensing_sensor_info *info,
254 struct sensing_callback_list *cb_list,
256
272 const struct device *dev, struct sensing_callback_list *cb_list,
274
283
294 struct sensing_sensor_config *configs, int count);
295
306 struct sensing_sensor_config *configs, int count);
307
316
317#ifdef __cplusplus
318}
319#endif
320
324
325#endif /*ZEPHYR_INCLUDE_SENSING_H_*/
int sensing_open_sensor_by_dt(const struct device *dev, struct sensing_callback_list *cb_list, sensing_sensor_handle_t *handle)
Open sensor instance by device.
const struct sensing_sensor_info * sensing_get_sensor_info(sensing_sensor_handle_t handle)
Get sensor information from sensor instance handle.
int sensing_set_config(sensing_sensor_handle_t handle, struct sensing_sensor_config *configs, int count)
Set current config items to Sensing subsystem.
void(* sensing_data_event_t)(sensing_sensor_handle_t handle, const void *buf, void *context)
Data event callback signature.
Definition sensing.h:152
sensing_sensor_attribute
Sensor configuration attribute.
Definition sensing.h:108
int sensing_open_sensor(const struct sensing_sensor_info *info, struct sensing_callback_list *cb_list, sensing_sensor_handle_t *handle)
Open sensor instance by sensing sensor info.
int sensing_close_sensor(sensing_sensor_handle_t *handle)
Close sensor instance.
sensing_sensor_state
Sensor state.
Definition sensing.h:98
void * sensing_sensor_handle_t
Opaque handle to an opened sensor instance.
Definition sensing.h:140
int sensing_get_sensors(int *num_sensors, const struct sensing_sensor_info **info)
Get all supported sensor instances' information.
int sensing_get_config(sensing_sensor_handle_t handle, struct sensing_sensor_config *configs, int count)
Get current config items from Sensing subsystem.
@ SENSING_SENSOR_ATTRIBUTE_MAX
Number of supported attributes.
Definition sensing.h:131
@ SENSING_SENSOR_ATTRIBUTE_LATENCY
Maximum batching latency, in microseconds (us).
Definition sensing.h:128
@ SENSING_SENSOR_ATTRIBUTE_INTERVAL
Reporting interval between samples, in microseconds (us).
Definition sensing.h:114
@ SENSING_SENSOR_ATTRIBUTE_SENSITIVITY
Per-field sensitivity threshold.
Definition sensing.h:121
@ SENSING_SENSOR_STATE_READY
The sensor is ready.
Definition sensing.h:99
@ SENSING_SENSOR_STATE_OFFLINE
The sensor is offline.
Definition sensing.h:100
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__INT8_TYPE__ int8_t
Definition stdint.h:72
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
Callback registration for a sensor instance.
Definition sensing.h:189
void * context
Context that will be passed to the callback.
Definition sensing.h:191
sensing_data_event_t on_data_event
Callback function for a sensor data event.
Definition sensing.h:190
Sensing subsystem sensor configure, including interval, sensitivity, latency.
Definition sensing.h:199
uint32_t interval
Interval between two sensor samples in microseconds (us).
Definition sensing.h:207
enum sensing_sensor_attribute attri
Attribute of the sensor configuration.
Definition sensing.h:200
int8_t data_field
SENSING_SENSITIVITY_INDEX_ALL
Definition sensing.h:203
uint32_t sensitivity
Sensitivity threshold for reporting new data.
Definition sensing.h:214
uint64_t latency
Maximum duration for batching sensor samples before reporting in microseconds (us).
Definition sensing.h:221
Read-only description of a sensor instance.
Definition sensing.h:160
const char * vendor
Vendor name of the sensor instance.
Definition sensing.h:168
const uint32_t minimal_interval
Minimal report interval in micro seconds.
Definition sensing.h:177
const int32_t type
Sensor type.
Definition sensing.h:174
const char * friendly_name
Friendly name of the sensor instance.
Definition sensing.h:165
const char * name
Name of the sensor instance.
Definition sensing.h:162
const char * model
Model name of the sensor instance.
Definition sensing.h:171
Sensor Version.
Definition sensing.h:33
uint32_t value
The version represented as a 32-bit value.
Definition sensing.h:35
uint8_t hotfix
The hotfix version number.
Definition sensing.h:39
uint8_t build
The build version number.
Definition sensing.h:40
uint8_t minor
The minor version number.
Definition sensing.h:38
uint8_t major
The major version number.
Definition sensing.h:37