Algorithm runner APIs

Algorithm runner API. More...

Data Structures
struct	algorithm_runner_common_config
struct	algorithm_runner_algorithm

Typedefs
typedef void(*	algorithm_run_fn) (const struct zbus_channel *chan, const struct algorithm_runner_common_config *common, const void *args, void *data)
	Algorithm implementation.

Functions
void	algorithm_runner_init (void)
	Initialise the algorithm runner.
void	algorithm_runner_register (struct algorithm_runner_algorithm *algorithm)
	Register an algorithm with the runner.
bool	algorithm_runner_unregister (struct algorithm_runner_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.

Typedef Documentation

algorithm_run_fn

typedef void(* algorithm_run_fn) (const struct zbus_channel *chan, const struct algorithm_runner_common_config *common, const void *args, void *data)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/algorithm_runner/runner.h>

Algorithm implementation.

Warning

The algorithm implementation MUST release the channel reference via zbus_chan_finish before exiting. This should be done as soon as processing of the channel data has completed.

Parameters

chan	Channel pointer corresponding to zbus_channel in algorithm_runner_common_config. Value is NULL on the very first call to initialise data structures.
common	Pointer to common algorithm config
args	Pointer to algorithm specific arguments
data	Pointer to the mutable algorithm state

Function Documentation

algorithm_runner_init()

void algorithm_runner_init

(

void

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/algorithm_runner/runner.h>

Initialise the algorithm runner.

Can be called multiple times to clear the list of registered algorithms.

algorithm_runner_register()

void algorithm_runner_register

(

struct algorithm_runner_algorithm *

algorithm

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/algorithm_runner/runner.h>

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

algorithm_runner_tdf_log()

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 )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/algorithm_runner/runner.h>

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

algorithm_runner_unregister()

bool algorithm_runner_unregister

(

struct algorithm_runner_algorithm *

algorithm

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/algorithm_runner/runner.h>

Unregister an algorithm from the runner.

Parameters

algorithm

Algorithm to unregister

Return values

true	Algorithm was found and unregistered
false	Algorithm was not registered with the runner