Infuse zbus channels APIs

Infuse zbus channels API . More...

Data Structures
struct	infuse_zbus_chan_movement_std_dev
	Data type for INFUSE_ZBUS_CHAN_MOVEMENT_STD_DEV. More...
struct	infuse_zbus_chan_tilt
	Data type for INFUSE_ZBUS_CHAN_TILT. More...

Macros
#define	INFUSE_ZBUS_TYPE(channel)
	Get the type associated with an Infuse zbus channel.
#define	INFUSE_ZBUS_NAME(channel)
	Get the channel name associated with an Infuse zbus channel.
#define	INFUSE_ZBUS_CHAN_DEFINE(channel)
	Define an Infuse zbus channel with default parameters.
#define	INFUSE_ZBUS_CHAN_DECLARE(...)
	Like ZBUS_CHAN_DECLARE for Infuse channels.
#define	INFUSE_ZBUS_CHAN_GET(channel)
	Statically get pointer to Infuse channel.

Enumerations
enum	infuse_zbus_channel_id {   INFUSE_ZBUS_CHAN_BASE = 0x43210000 , INFUSE_ZBUS_CHAN_BATTERY = INFUSE_ZBUS_CHAN_BASE + 0 , INFUSE_ZBUS_CHAN_AMBIENT_ENV = INFUSE_ZBUS_CHAN_BASE + 1 , INFUSE_ZBUS_CHAN_IMU = INFUSE_ZBUS_CHAN_BASE + 2 ,   INFUSE_ZBUS_CHAN_IMU_ACC_MAG = INFUSE_ZBUS_CHAN_BASE + 3 , INFUSE_ZBUS_CHAN_LOCATION = INFUSE_ZBUS_CHAN_BASE + 4 , INFUSE_ZBUS_CHAN_MOVEMENT_STD_DEV = INFUSE_ZBUS_CHAN_BASE + 5 , INFUSE_ZBUS_CHAN_TILT = INFUSE_ZBUS_CHAN_BASE + 6 ,   INFUSE_ZBUS_CHAN_UBX_NAV_PVT = INFUSE_ZBUS_CHAN_BASE + 7 , INFUSE_ZBUS_CHAN_NRF9X_NAV_PVT = INFUSE_ZBUS_CHAN_BASE + 8 }

Functions
static uint64_t	infuse_zbus_channel_data_age (const struct zbus_channel *chan)
	Retrieve the age of the data in the zbus channel.

Detailed Description

Infuse zbus channels API .

Macro Definition Documentation

INFUSE_ZBUS_CHAN_DECLARE

#define INFUSE_ZBUS_CHAN_DECLARE

(

...

)

#include <infuse/zbus/channels.h>

Value:

FOR_EACH(_INFUSE_ZBUS_CHAN_EXTERN, (;), __VA_ARGS__)

Like ZBUS_CHAN_DECLARE for Infuse channels.

INFUSE_ZBUS_CHAN_DEFINE

#define INFUSE_ZBUS_CHAN_DEFINE

(

channel

)

#include <infuse/zbus/channels.h>

Value:

        ZBUS_CHAN_DEFINE_WITH_ID(INFUSE_ZBUS_NAME(channel), channel, INFUSE_ZBUS_TYPE(channel),    \
                                 NULL, NULL, ZBUS_OBSERVERS_EMPTY, ZBUS_MSG_INIT(0));

Define an Infuse zbus channel with default parameters.

Parameters

channel

Infuse channel identifier (infuse_zbus_channel_id)

INFUSE_ZBUS_CHAN_GET

#define INFUSE_ZBUS_CHAN_GET

(

channel

)

#include <infuse/zbus/channels.h>

Value:

(&INFUSE_ZBUS_NAME(channel))

Statically get pointer to Infuse channel.

Parameters

channel

Infuse channel identifier (infuse_zbus_channel_id)

INFUSE_ZBUS_NAME

#define INFUSE_ZBUS_NAME

(

channel

)

#include <infuse/zbus/channels.h>

Value:

_##channel##_NAME

Get the channel name associated with an Infuse zbus channel.

INFUSE_ZBUS_TYPE

#define INFUSE_ZBUS_TYPE

(

channel

)

#include <infuse/zbus/channels.h>

Value:

_##channel##_TYPE

Get the type associated with an Infuse zbus channel.

Enumeration Type Documentation

infuse_zbus_channel_id

enum infuse_zbus_channel_id

#include <infuse/zbus/channels.h>

Enumerator
INFUSE_ZBUS_CHAN_BASE
INFUSE_ZBUS_CHAN_BATTERY	Data type: tdf_battery_state.
INFUSE_ZBUS_CHAN_AMBIENT_ENV	Data type: tdf_ambient_temp_pres_hum.
INFUSE_ZBUS_CHAN_IMU	Data type: imu_sample_array.
INFUSE_ZBUS_CHAN_IMU_ACC_MAG	Data type: imu_magnitude_array.
INFUSE_ZBUS_CHAN_LOCATION	Data type: tdf_gcs_wgs84_llha.
INFUSE_ZBUS_CHAN_MOVEMENT_STD_DEV	Data type: infuse_zbus_chan_movement_std_dev.
INFUSE_ZBUS_CHAN_TILT	Data type: infuse_zbus_chan_tilt.
INFUSE_ZBUS_CHAN_UBX_NAV_PVT	Data type: tdf_ubx_nav_pvt.
INFUSE_ZBUS_CHAN_NRF9X_NAV_PVT	Data type: tdf_nrf9x_gnss_pvt.

Function Documentation

infuse_zbus_channel_data_age()

static uint64_t infuse_zbus_channel_data_age ( const struct zbus_channel * chan )

inlinestatic

#include <infuse/zbus/channels.h>

Retrieve the age of the data in the zbus channel.

Parameters

chan	Channel to query

Return values

UINT64_MAX	if channel has never been published to
age_ms	Data age in milliseconds otherwise