Functions for controlling a MblMwDataSignal. More...

#include "data.h"
#include "datasignal_fwd.h"
#include "logging_fwd.h"
#include "metawear/platform/dllmarker.h"

Functions
METAWEAR_API MblMwDataSignal *	mbl_mw_datasignal_get_component (const MblMwDataSignal *signal, uint8_t index)
	Retrieves an individual value from a multi-valued datasignal i.e. More...

METAWEAR_API void	mbl_mw_datasignal_subscribe (MblMwDataSignal signal, void context, MblMwFnData received_data)
	Subscribes to a data stream, processing messages with the given handler. More...

METAWEAR_API void	mbl_mw_datasignal_unsubscribe (MblMwDataSignal *signal)
	Unsubscribes from a data stream. More...

METAWEAR_API int32_t	mbl_mw_datasignal_is_readable (const MblMwDataSignal *signal)
	Check if the data signal can be explicitly read. More...

METAWEAR_API void	mbl_mw_datasignal_read (const MblMwDataSignal *signal)
	Reads data from sensor represented by the data signal. More...

METAWEAR_API void	mbl_mw_datasignal_read_with_parameters (const MblMwDataSignal signal, const void parameters)
	Reads data from sensor represented by the data signal. More...

METAWEAR_API void	mbl_mw_datasignal_log (MblMwDataSignal signal, void context, MblMwFnDataLoggerPtr logger_ready)
	Creates an MblMwDataLogger for the signal. More...

Detailed Description

Functions for controlling a MblMwDataSignal.

Copyright: MbientLab License

Function Documentation

◆ mbl_mw_datasignal_get_component()

METAWEAR_API MblMwDataSignal* mbl_mw_datasignal_get_component	(	const MblMwDataSignal *	signal,
		uint8_t	index
	)

Retrieves an individual value from a multi-valued datasignal i.e.

MblMwCartesianFloat datasignal is 3 float values.
For example, the x component for the acc x,y,z can be retrieved with this function These individual signals can use the full suite of

Parameters

signal	Data signal to lookup
index	Index of the component to return

Returns: Signal component, null if signal is signle valued

◆ mbl_mw_datasignal_is_readable()

METAWEAR_API int32_t mbl_mw_datasignal_is_readable ( const MblMwDataSignal * signal )

Check if the data signal can be explicitly read.

Parameters

signal Data signal to check

Returns: Zero if not readable, non-zero if it is

◆ mbl_mw_datasignal_log()

METAWEAR_API void mbl_mw_datasignal_log	(	MblMwDataSignal *	signal,
		void *	context,
		MblMwFnDataLoggerPtr	logger_ready
	)

Creates an MblMwDataLogger for the signal.

Parameters

signal	Data signal to log
context	Pointer to additional data for the callback function
logger_ready	Callback function to be executed when the logger is created

◆ mbl_mw_datasignal_read()

METAWEAR_API void mbl_mw_datasignal_read ( const MblMwDataSignal * signal )

Reads data from sensor represented by the data signal.

Data is forwarded to the callback function assigned by the mbl_mw_datasignal_subscribe function

Parameters

signal Data signal to read from

◆ mbl_mw_datasignal_read_with_parameters()

METAWEAR_API void mbl_mw_datasignal_read_with_parameters	(	const MblMwDataSignal *	signal,
		const void *	parameters
	)

Reads data from sensor represented by the data signal.

Data is forwarded to the callback function assigned by the mbl_mw_datasignal_subscribe function.
This variant is for reads that require additional parameters.

Parameters

signal	Data signal to read from
parameters	Additional parameters required for the read operation

◆ mbl_mw_datasignal_subscribe()

METAWEAR_API void mbl_mw_datasignal_subscribe	(	MblMwDataSignal *	signal,
		void *	context,
		MblMwFnData	received_data
	)

Subscribes to a data stream, processing messages with the given handler.

Parameters

signal	Data signal to subscribe to
context	Pointer to additional data for the callback function
received_data	Callback function to handle data received from the signal

◆ mbl_mw_datasignal_unsubscribe()

METAWEAR_API void mbl_mw_datasignal_unsubscribe ( MblMwDataSignal * signal )

Unsubscribes from a data stream.

Parameters

signal Data signal to unsubscribe from