edgehog_cellular_connection.h File Reference

Edgehog device cellular connection API. More...

#include "edgehog_device.h"

Include dependency graph for edgehog_cellular_connection.h:

Go to the source code of this file.

Enumerations
enum	edgehog_registration_status {   INVALID_REGISTRATION_STATUS = 0 , NOT_REGISTERED , REGISTERED , SEARCHING_OPERATOR ,   REGISTRATION_DENIED , UNKNOWN , REGISTERED_ROAMING }
	Edgehog Registration Status Codes.
enum	edgehog_connection_technology {   INVALID_CONNECTION_TECHNOLOGY = 0 , GSM , GSM_COMPACT , UTRAN ,   GSM_WITH_EGPRS , UTRAN_WITH_HSDPA , UTRAN_WITH_HSUPA , UTRAN_WITH_HSDPA_AND_HSUPA ,   E_UTRAN }
	Edgehog Connection Technology codes.

Functions
void	edgehog_connection_status_publish (edgehog_device_handle_t edgehog_device, char *modem_id, const char *carrier, edgehog_connection_technology technology, edgehog_registration_status registration_status, double rssi, int64_t cell_id, int local_area_code, int mobile_country_code, int mobile_network_code)
	Publish Connection status telemetry data.
void	edgehog_connection_properties_publish (edgehog_device_handle_t edgehog_device, const char *modem_id, const char *imei, const char *imsi, const char *apn)
	Publish connection properties.

Variables
const astarte_interface_t	cellular_connection_status_interface
const astarte_interface_t	cellular_connection_properties_interface

Detailed Description

Edgehog device cellular connection API.

Function Documentation

edgehog_connection_properties_publish()

void edgehog_connection_properties_publish	(	edgehog_device_handle_t	edgehog_device,
		const char *	modem_id,
		const char *	imei,
		const char *	imsi,
		const char *	apn )

Publish connection properties.

This function publishes the GSM/LTE modem info on Astarte

Parameters

edgehog_device	A valid Edgehog device handle.
modem_id	Identifier of the modem which the data belongs to
imei	Modem unique identifier
imsi	SIM unique identifier
apn	Access point name configured for the modem

edgehog_connection_status_publish()

void edgehog_connection_status_publish	(	edgehog_device_handle_t	edgehog_device,
		char *	modem_id,
		const char *	carrier,
		edgehog_connection_technology	technology,
		edgehog_registration_status	registration_status,
		double	rssi,
		int64_t	cell_id,
		int	local_area_code,
		int	mobile_country_code,
		int	mobile_network_code )

Publish Connection status telemetry data.

This function publishes the connection status telemetry data to Astarte

Parameters

edgehog_device	A valid Edgehog device handle.
modem_id	Identifier of the modem which the data belongs to
carrier	Name or code of the network operator
technology	Network technology
registration_status	Connection status on the network
rssi	Connection signal strength
cell_id	Identifier of the network cell
local_area_code	Identifier of the area
mobile_country_code	The mobile country code (MCC) for the device's home network
mobile_network_code	The Mobile Network Code for the device's home network