Algorithm runner API. More...

Functions
void	algorithm_runner_init (void)
	Initialise the algorithm runner.
int	algorithm_runner_register (const struct infuse_algorithm *algorithm)
	Register an algorithm with the runner.
int	algorithm_runner_unregister (const struct infuse_algorithm *algorithm)
	Unregister an algorithm from the runner.
void	algorithm_runner_tdf_log (const struct kv_algorithm_logging logging, uint8_t tdf_mask, uint16_t tdf_id, uint8_t tdf_len, uint64_t time, const void data)
	Log a single TDF as requested by algorithm configuration.

Detailed Description

Algorithm runner API.

Function Documentation

void algorithm_runner_init ( void )

Initialise the algorithm runner.

int algorithm_runner_register ( const struct infuse_algorithm * algorithm )

Register an algorithm with the runner.

Note: Registering the algorithm will immediately call the implementation with chan == NULL to provide an opportunity to initialise runtime state.

Parameters

algorithm Algorithm to register

Return values

0	Algorithm registered
-EINVAL	Invalid algorithm configuration
-EALREADY	Algorithm is already registered
-ENOMEM	No free algorithm registration slots

void algorithm_runner_tdf_log	(	const struct kv_algorithm_logging *	logging,
		uint8_t	tdf_mask,
		uint16_t	tdf_id,
		uint8_t	tdf_len,
		uint64_t	time,
		const void *	data )

Log a single TDF as requested by algorithm configuration.

Parameters

logging	Algorithm logging configuration
tdf_mask	Single TDF mask that corresponds to tdf_id
tdf_id	TDF sensor ID
tdf_len	Length of a single TDF
time	Epoch time associated with the TDF. 0 for no timestamp.
data	TDF data array

int algorithm_runner_unregister ( const struct infuse_algorithm * algorithm )

Unregister an algorithm from the runner.

Parameters

algorithm Algorithm to unregister

Return values

0	Algorithm was found and unregistered
-EINVAL	Invalid algorithm configuration
-ENOENT	Algorithm was not registered with the runner