IPC Module - Connectivity Service

This page contains documentation of the Connectivity Management API.

Messages

message connectivity_configure_consumer_req

Parameters:

consumer (enum connectivity_consumers) – The connectivity consumer to configure
modem1 (struct connectivity_provider_config_s) – Configuration for modem 1 provider
modem2 (struct connectivity_provider_config_s) – Configuration for modem 2 provider
wifi_station (struct connectivity_provider_config_s) – Configuration for wifi station provider

Return message:

connectivity_configure_consumer_rsp

Configure settings related to a connectivity consumer

message connectivity_configure_consumer_rsp

Parameters:

consumer (enum connectivity_consumers) – The connectivity consumer to configure
result (enum connectivity_result) – Result of the configure request

message connectivity_consumer_status_publish_ind

Parameters:

consumer (enum connectivity_consumers) – The consumer
active_provider (enum connectivity_providers) – The currently selected provider for the given consumer
has_internet_connection (uint8) – If the consumer has internet connection, ie connectivity test either successful or the connectivity test has been ignored in the configuration

Reports the status for each connectivity consumer

message connectivity_consumer_status_subscribe_req: Subscribe to connectivity_consumer_status_publish_ind messages

message connectivity_consumer_status_subscribe_rsp

Result from connectivity_consumer_status_subscribe_req

message connectivity_consumer_status_unsubscribe_req_norsp: Unsubscribe from connectivity_consumer_status_publish_ind messages

enum connectivity_result

Result of a connectivity service operations

Constant	Value	Description
OK	0	Operation completed successfully
FAILED	1	Operation failed in some unspecified way
INVALID_CONFIG	2	An invalid config was provided

enum connectivity_consumers

Consumers of connectivity within the system

Constant	Value	Description
INVALID	0
BASE_SYSTEM	1	The ACU6 base system and services
USERVM	2	The user VM internet bridge interface
WIFI_AP	3	The devices connected to WiFi AP

enum connectivity_providers

Providers of connectivity within the system

Constant	Value	Description
INVALID	0
MODEM1	1	NAD primary or only apn/connection
MODEM2	2	NAD secondary apn/connection
WIFI_STATION	3	WiFi station
NO_PROVIDER	255	Empty provider/no provider

struct connectivity_provider_config_s

Parameters:

is_enabled (uint8) – Should the provider at all be enabled and selectable for the consumer
priority (uint8) – Priority of the provider relative to other providers. 0 highest priority
flags (uint32) – Flags. Reserved for future use. Ensure it is set to 0 for now

Internal helper struct for connectivity_configure_consumer_req

Represents configuration of a single connectivity provider