gnss_publish.h File Reference

GNSS driver backend helpers for publishing data and satellite information. More...

#include <zephyr/drivers/gnss.h>

Go to the source code of this file.

Functions
void	gnss_publish_data (const struct device *dev, const struct gnss_data *data)
	@in_driverbackendgroup{gnss_interface}
void	gnss_publish_satellites (const struct device *dev, const struct gnss_satellite *satellites, uint16_t size)
	Publish GNSS satellite information to registered callbacks.

Detailed Description

GNSS driver backend helpers for publishing data and satellite information.

@in_driverbackendgroup{gnss_interface}

Function Documentation

gnss_publish_data()

void gnss_publish_data	(	const struct device *	dev,
		const struct gnss_data *	data )

@in_driverbackendgroup{gnss_interface}

Publish GNSS data to registered callbacks.

Invokes all callbacks registered with GNSS_DATA_CALLBACK_DEFINE() and GNSS_DT_DATA_CALLBACK_DEFINE() that match dev.

GNSS drivers should call this function whenever new navigation data is available from the receiver.

Parameters

dev	GNSS device instance publishing the data.
data	Navigation data, fix information, and UTC time to publish.

See also

GNSS_DATA_CALLBACK_DEFINE()

GNSS_DT_DATA_CALLBACK_DEFINE()

gnss_publish_satellites()

void gnss_publish_satellites	(	const struct device *	dev,
		const struct gnss_satellite *	satellites,
		uint16_t	size )

Publish GNSS satellite information to registered callbacks.

Invokes all callbacks registered with GNSS_SATELLITES_CALLBACK_DEFINE() and GNSS_DT_SATELLITES_CALLBACK_DEFINE() that match dev.

GNSS drivers should call this function whenever updated satellite tracking information is available from the receiver.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_GNSS_SATELLITES 

.

Parameters

dev	GNSS device instance publishing the satellite data.
satellites	Array of satellite tracking data.
size	Number of elements in satellites.

See also

GNSS_SATELLITES_CALLBACK_DEFINE()

GNSS_DT_SATELLITES_CALLBACK_DEFINE()