Infuse-IoT SDK API 0.0.1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Infuse-IoT Algorithm implementation API

Infuse-IoT Algorithm implementation API. More...

Data Structures

struct  infuse_algorithm
 Algorithm definition. More...

Macros

#define ALGORITHM_EXPORT(symbol)
 Export algorithm implementation.

Typedefs

typedef void(* algorithm_run_fn) (const struct zbus_channel *chan, const struct infuse_algorithm *algorithm, const void *args)
 Algorithm implementation.

Detailed Description

Infuse-IoT Algorithm implementation API.

Macro Definition Documentation

◆ ALGORITHM_EXPORT

#define ALGORITHM_EXPORT ( symbol)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/algorithms/implementation.h>

Value:
EXPORT_GROUP_SYMBOL_NAMED(INFUSE_ALG, symbol, algorithm_config);

Export algorithm implementation.

Parameters
symbolInstance of infuse_algorithm to export

Typedef Documentation

◆ algorithm_run_fn

typedef void(* algorithm_run_fn) (const struct zbus_channel *chan, const struct infuse_algorithm *algorithm, const void *args)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/algorithms/implementation.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
chanChannel pointer corresponding to zbus_channel in infuse_algorithm. Value is NULL on the very first call to initialise data structures.
algorithmPointer to algorithm config
argsPointer to algorithm specific arguments