Module mynewt::hw::sensor

Contains the Mynewt Sensor API for Rust, including the safe version of the API. Auto-generated Rust bindings are in the bindings module.

Modules

bindings

Contains the auto-generated Rust bindings for the Mynewt Sensor API

Structs

SensorValue	Represents a decoded sensor data value. Since temperature may be integer (raw) or float (computed), we use the struct to return both integer and float values.
__BindgenBitfieldUnit
__BindgenUnionField
_bindgen_ty_1
_bindgen_ty_1__bindgen_ty_1
os_callout__bindgen_ty_1
os_dev__bindgen_ty_1
os_event__bindgen_ty_1
os_eventq__bindgen_ty_1
os_memblock__bindgen_ty_1
os_mempool__bindgen_ty_1
os_mempool__bindgen_ty_2
os_mutex__bindgen_ty_1
os_sanity_check__bindgen_ty_1
os_task__bindgen_ty_1
os_task__bindgen_ty_2
os_task__bindgen_ty_3
sensor
sensor__bindgen_ty_1
sensor__bindgen_ty_2
sensor__bindgen_ty_3
sensor__bindgen_ty_4
sensor_accel_data
sensor_cfg	Configuration structure, describing a specific sensor type off of an existing sensor.
sensor_color_data
sensor_data_t
sensor_driver
sensor_euler_data
sensor_geolocation_data	Represents a GPS Geolocation. TODO: Must sync with libs/custom_sensor/include/custom_sensor/custom_sensor.h
sensor_gyro_data
sensor_humid_data
sensor_int
sensor_itf
sensor_light_data
sensor_listener
sensor_listener__bindgen_ty_1
sensor_listener_info	Define the info needed for converting sensor data into sensor value and calling a listener function
sensor_mag_data
sensor_notifier	Registration for sensor event notifications
sensor_notifier__bindgen_ty_1
sensor_notify_ev_ctx
sensor_notify_os_ev
sensor_press_data
sensor_quat_data
sensor_read_ctx	Read context for calling user function with argument
sensor_read_ev_ctx	Context for sensor read events
sensor_temp_data
sensor_temp_raw_data	Represents a single temperature sensor raw value. TODO: Must sync with libs/custom_sensor/include/custom_sensor/custom_sensor.h
sensor_timestamp
sensor_type_traits	Sensor type traits list
sensor_type_traits__bindgen_ty_1

Enums

SensorValueType

Represents the type and value of a sensor data value.

Constants

MAX_SENSOR_LISTENERS	List of wrapped sensor listeners
SENSOR_IGN_LISTENER
SENSOR_ITF_I2C
SENSOR_ITF_SPI
SENSOR_ITF_UART
SENSOR_THRESH_ALGO_USERDEF
SENSOR_THRESH_ALGO_WATERMARK
SENSOR_THRESH_ALGO_WINDOW
SENSOR_TYPE_AMBIENT_TEMPERATURE_RAW	Sensor type for raw temperature sensor and geolocation. Must sync with libs/custom_sensor/include/custom_sensor/custom_sensor.h
SENSOR_TYPE_GEOLOCATION
SENSOR_VALUE_TYPE_FLOAT
SENSOR_VALUE_TYPE_FLOAT_TRIPLET
SENSOR_VALUE_TYPE_INT32
SENSOR_VALUE_TYPE_INT32_TRIPLET
SENSOR_VALUE_TYPE_OPAQUE
sensor_event_type_t_SENSOR_EVENT_TYPE_DOUBLE_TAP
sensor_event_type_t_SENSOR_EVENT_TYPE_FREE_FALL
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_X_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_X_H_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_X_L_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_Y_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_Y_H_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_Y_L_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_Z_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_Z_H_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_ORIENT_Z_L_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_SINGLE_TAP
sensor_event_type_t_SENSOR_EVENT_TYPE_SLEEP
sensor_event_type_t_SENSOR_EVENT_TYPE_SLEEP_CHANGE
sensor_event_type_t_SENSOR_EVENT_TYPE_WAKEUP
sensor_type_t_SENSOR_TYPE_ACCELEROMETER
sensor_type_t_SENSOR_TYPE_ALL
sensor_type_t_SENSOR_TYPE_ALTITUDE
sensor_type_t_SENSOR_TYPE_AMBIENT_TEMPERATURE
sensor_type_t_SENSOR_TYPE_COLOR
sensor_type_t_SENSOR_TYPE_EULER
sensor_type_t_SENSOR_TYPE_GRAVITY
sensor_type_t_SENSOR_TYPE_GYROSCOPE
sensor_type_t_SENSOR_TYPE_LIGHT
sensor_type_t_SENSOR_TYPE_LINEAR_ACCEL
sensor_type_t_SENSOR_TYPE_MAGNETIC_FIELD
sensor_type_t_SENSOR_TYPE_NONE
sensor_type_t_SENSOR_TYPE_PRESSURE
sensor_type_t_SENSOR_TYPE_PROXIMITY
sensor_type_t_SENSOR_TYPE_RELATIVE_HUMIDITY
sensor_type_t_SENSOR_TYPE_ROTATION_VECTOR
sensor_type_t_SENSOR_TYPE_TEMPERATURE
sensor_type_t_SENSOR_TYPE_USER_DEFINED_1
sensor_type_t_SENSOR_TYPE_USER_DEFINED_2
sensor_type_t_SENSOR_TYPE_USER_DEFINED_3
sensor_type_t_SENSOR_TYPE_USER_DEFINED_4
sensor_type_t_SENSOR_TYPE_USER_DEFINED_5
sensor_type_t_SENSOR_TYPE_USER_DEFINED_6
sensor_type_t_SENSOR_TYPE_WEIGHT

Statics

LISTENER_INTERNAL	Define the listener function to be called after polling the sensor. This is a static mutable copy of the listener passed in through register_listener. Must be static so it won't go out of scope. Must be mutable so that Rust won't move it while Mynewt is using it.
SENSOR_LISTENERS
sensor_base_ts
sensor_mgr
sensor_notify_evt_area
sensor_notify_evt_pool
sensor_read_event

Functions

as_untyped	Cast sensor data function from typed to untyped
convert_sensor_data	Convert the sensor data received from Mynewt into a SensorValue for transmission, which includes the sensor data key. sensor_type indicates the type of data in sensor_data.
get_geolocation_data⚠	Interpret sensor_data as a sensor_geolocation_data struct that contains geolocation. Copy the sensor data into dest. Return 0 if successful. C API: int get_geolocation_data(void *sensor_data, struct sensor_geolocation_data *dest)
get_temp_data⚠	Interpret sensor_data as a sensor_temp_data struct that contains computed temp. Copy the sensor data into dest. Return 0 if successful. C API: int get_temp_data(void *sensor_data, struct sensor_temp_data *dest)
get_temp_raw_data⚠	Interpret sensor_data as a sensor_temp_raw_data struct that contains raw temp. Copy the sensor data into dest. Return 0 if successful. C API: int get_temp_raw_data(void *sensor_data, struct sensor_temp_raw_data *dest)
is_null_sensor⚠	Return non-zero if sensor is NULL. C API: int is_null_sensor(struct sensor *p)
is_null_sensor_data⚠	Return non-zero if sensor data is NULL. C API: int is_null_sensor_data(void *p)
mgr_find_next_bydevname	Search the sensor list and find the next sensor that corresponds to a given device name.
new_sensor_listener	Return a new sensor_listener with the sensor type and sensor value function. Called by Visual Embedded Rust.
null_sensor⚠	Return the NULL sensor. C API: struct sensor *null_sensor(void)
null_sensor_data_func	Define a default sensor data function in case there is none.
null_sensor_value_func	Define a default sensor value function in case there is none.
read	Read the data for sensor type "type," from the given sensor and return the result into the "value" parameter.
register_listener	Register a sensor listener. This allows a calling application to receive callbacks for data from a given sensor object. This is the safe version of sensor_register_listener() that copies the listener locally before passing to Mynewt. For more information on the type of callbacks available, see the documentation for the sensor listener structure. sensor: The sensor to register a listener on. listener: The listener to register onto the sensor. Returns Ok() on success, Err() containing MynewtError error code on failure.
sensor_clear_high_thresh⚠	Clears the high threshold for a sensor
sensor_clear_low_thresh⚠	Clears the low threshold for a sensor
sensor_get_device⚠	Return the Mynewt device for the Mynewt sensor. C API: struct os_dev *sensor_get_device(struct sensor *s)
sensor_get_type_traits_byname⚠	Get the type traits for a sensor
sensor_get_type_traits_bytype⚠	Search the sensor type traits list for specific type of sensor
sensor_init⚠	Initialize a sensor
sensor_itf_lock⚠	Lock access to the sensor_itf specified by si. Blocks until lock acquired.
sensor_itf_unlock⚠	Unlock access to the sensor_itf specified by si.
sensor_lock⚠	Lock access to the sensor specified by sensor. Blocks until lock acquired.
sensor_mgr_evq_get⚠	Get the current eventq, the system is misconfigured if there is still no parent eventq.
sensor_mgr_find_next⚠	The sensor manager contains a list of sensors, this function returns the next sensor in that list, for which compare_func() returns successful (one). If prev_cursor is provided, the function starts at that point in the sensor list.
sensor_mgr_find_next_bytype⚠	Find the "next" sensor available for a given sensor type.
sensor_mgr_lock⚠	Lock sensor manager to access the list of sensors
sensor_mgr_match_bytype⚠	Check if sensor type matches
sensor_mgr_put_interrupt_evt⚠	Puts a interrupt event on the sensor manager evq
sensor_mgr_put_notify_evt⚠	Puts a notification event on the sensor manager evq
sensor_mgr_put_read_evt⚠	Puts read event on the sensor manager evq
sensor_mgr_register⚠	Register the sensor with the global sensor list. This makes the sensor searchable by other packages, who may want to look it up by type.
sensor_mgr_unlock⚠	Unlock sensor manager once the list of sensors has been accessed
sensor_oic_tx_trigger⚠	Transmit OIC trigger
sensor_pkg_init⚠	Package init function. Remove when we have post-kernel init stages.
sensor_register_err_func⚠	Register a sensor error callback. The callback is executed when the sensor manager fails to read from the given sensor.
sensor_register_listener⚠	Register a sensor listener. This allows a calling application to receive callbacks for data from a given sensor object.
sensor_register_notifier⚠	Register a sensor notifier. This allows a calling application to receive callbacks any time a requested event is observed.
sensor_reset⚠	Resets the sensor
sensor_set_n_poll_rate⚠	Set the sensor poll rate multiple based on the device name, sensor type
sensor_set_thresh⚠	Set the thresholds along with the comparison algo for a sensor
sensor_trigger_init⚠	Sensor trigger initialization
sensor_unlock⚠	Unlock access to the sensor specified by sensor.
sensor_unregister_listener⚠	Un-register a sensor listener. This allows a calling application to clear callbacks for a given sensor object.
sensor_unregister_notifier⚠	Un-register a sensor notifier. This allows a calling application to stop receiving callbacks for events on the sensor object.
set_poll_rate_ms	Set the sensor poll rate
wrap_sensor_listener	Wrapped Sensor Listener that converts Mynewt sensor_data into our sensor_value format and calls the application's Listener Function

Type Definitions

SensorValueFunc	Wrapped version of sensor_data_func used by Visual Embedded Rust
__int16_t
__int32_t
__int64_t
__uint8_t
__uint16_t
__uint32_t
os_dev_close_func_t
os_dev_init_func_t	Initialize a device.
os_dev_open_func_t
os_dev_resume_func_t
os_dev_suspend_func_t
os_event_fn
os_membuf_t
os_sanity_check_func_t
os_stack_t
os_task_func_t
os_time_t
sensor_arg	Points to sensor arg passed by Mynewt to sensor listener
sensor_clear_trigger_thresh_t	Clear the high/low threshold values for a specific sensor for the sensor type.
sensor_data_func	Sensor data function that returns MynewtError instead of i32
sensor_data_func_t	Callback for handling sensor data, specified in a sensor listener.
sensor_data_func_untyped	Sensor data function that returns i32 instead of MynewtError
sensor_data_ptr	Points to sensor data passed by Mynewt to sensor listener
sensor_error_func_t	Callback for reporting a sensor read error.
sensor_event_type_t
sensor_get_config_func_t	Get the configuration of the sensor for the sensor type. This includes the value type of the sensor.
sensor_handle_interrupt_t	Let driver handle interrupt in the sensor context
sensor_mgr_compare_func_t
sensor_notifier_func_t	Callback for event notifications.
sensor_ptr	Points to a sensor. Needed because sensor also refers to a namespace.
sensor_read_func_t	Read a single value from a sensor, given a specific sensor type (e.g. SENSOR_TYPE_PROXIMITY).
sensor_reset_t	Reset Sensor function Ptr
sensor_set_config_func_t	Send a new configuration register set to the sensor.
sensor_set_notification_t	Set the notification expectation for a targeted set of events for the specific sensor. After this function returns successfully, the implementer shall post corresponding event notifications to the sensor manager.
sensor_set_trigger_thresh_t	Set the trigger and threshold values for a specific sensor for the sensor type.
sensor_trigger_cmp_func_t	Callback for trigger compare functions.
sensor_trigger_notify_func_t	Callback for sending trigger notification.
sensor_type_t
sensor_unset_notification_t	Unset the notification expectation for a targeted set of events for the specific sensor.