ACU6 Device API
Data Structures | Enumerations | Enumerator | Functions
ipc_wifi

WiFi Service. More...

Data Structures

struct  a_ipc_dyn_array_enum_wifi_station_result
 Dynamic-length array of a_ipc_enum_wifi_station_result. More...
 
struct  a_ipc_dyn_array_enum_wifi_station_encryption_method
 Dynamic-length array of a_ipc_enum_wifi_station_encryption_method. More...
 
struct  a_ipc_dyn_array_enum_wifi_station_notification_type
 Dynamic-length array of a_ipc_enum_wifi_station_notification_type. More...
 
struct  a_ipc_dyn_array_enum_wifi_station_failure_type
 Dynamic-length array of a_ipc_enum_wifi_station_failure_type. More...
 
struct  a_ipc_dyn_array_enum_wifi_station_state
 Dynamic-length array of a_ipc_enum_wifi_station_state. More...
 
struct  a_ipc_dyn_array_enum_wifi_regulatory_domain_result
 Dynamic-length array of a_ipc_enum_wifi_regulatory_domain_result. More...
 
struct  a_ipc_dyn_array_enum_wifi_ap_result
 Dynamic-length array of a_ipc_enum_wifi_ap_result. More...
 
struct  a_ipc_msg_wifi_station_request_req
 Request the WiFi station service. More...
 
struct  a_ipc_msg_wifi_station_request_rsp
 WiFi station request response. More...
 
struct  a_ipc_msg_wifi_station_release_req_norsp
 Release WiFi station service for given user user. More...
 
struct  a_ipc_msg_wifi_station_search_reporting_req_norsp
 Set WiFi station search reporting state. More...
 
struct  a_ipc_msg_wifi_station_search_reporting_publish_ind
 WiFi station search reporting entry publish event. More...
 
struct  a_ipc_msg_wifi_station_connectivity_failure_publish_ind
 WiFi station connection failure publish event. More...
 
struct  a_ipc_msg_wifi_station_auto_connect_req_norsp
 Set WiFi station auto connect state. More...
 
struct  a_ipc_msg_wifi_station_connect_req
 WiFi station connect request. More...
 
struct  a_ipc_msg_wifi_station_connect_rsp
 WiFi station connect response. More...
 
struct  a_ipc_msg_wifi_station_status_req
 WiFi station status request. More...
 
struct  a_ipc_msg_wifi_station_status_rsp
 WiFi station status response. More...
 
struct  a_ipc_msg_wifi_station_status_publish_ind
 WiFi station status publish event. More...
 
struct  a_ipc_msg_wifi_station_add_known_network_req
 WiFi station add or update known network request. More...
 
struct  a_ipc_msg_wifi_station_add_known_network_rsp
 WiFi station add known network response. More...
 
struct  a_ipc_msg_wifi_station_list_known_networks_req_norsp
 WiFi station add known network request. More...
 
struct  a_ipc_msg_wifi_station_list_known_networks_publish_ind
 WiFi station known networks entry publish event. More...
 
struct  a_ipc_msg_wifi_station_delete_known_network_req
 WiFi station delete known network request. More...
 
struct  a_ipc_msg_wifi_station_delete_known_network_rsp
 WiFi station delete known network response. More...
 
struct  a_ipc_msg_wifi_regulatory_domain_set_req
 WiFi regulatory domain set request. More...
 
struct  a_ipc_msg_wifi_regulatory_domain_set_rsp
 WiFi regulatory domain set request. More...
 
struct  a_ipc_msg_wifi_regulatory_domain_get_req
 WiFi regulatory domain set request. More...
 
struct  a_ipc_msg_wifi_regulatory_domain_get_rsp
 WiFi regulatory domain set request. More...
 
struct  a_ipc_msg_wifi_ap_request_req
 Request the WiFi AP service. More...
 
struct  a_ipc_msg_wifi_ap_request_rsp
 WiFi AP request response. More...
 
struct  a_ipc_msg_wifi_ap_release_req_norsp
 Release AP station service for given user user. More...
 
struct  a_ipc_msg_wifi_ap_configure_req
 WiFi AP configuration request. More...
 
struct  a_ipc_msg_wifi_ap_configure_rsp
 WiFi AP configuration response. More...
 
struct  a_ipc_msg_wifi_station_search_reporting_unsubscribe_req_norsp
 Unsubscribe from updates for wifi_station_search_reporting. More...
 
struct  a_ipc_msg_wifi_station_connectivity_failure_unsubscribe_req_norsp
 Unsubscribe from updates for wifi_station_connectivity_failure. More...
 
struct  a_ipc_msg_wifi_station_status_unsubscribe_req_norsp
 Unsubscribe from updates for wifi_station_status. More...
 
struct  a_ipc_msg_wifi_station_list_known_networks_unsubscribe_req_norsp
 Unsubscribe from updates for wifi_station_list_known_networks. More...
 

Enumerations

enum  a_ipc_enum_wifi_station_result {
  A_IPC_ENUM_WIFI_STATION_RESULT_OK , A_IPC_ENUM_WIFI_STATION_RESULT_ERROR_INVALID_PARAMETER , A_IPC_ENUM_WIFI_STATION_RESULT_WRONG_STATE , A_IPC_ENUM_WIFI_STATION_RESULT_ERROR_UNKNOWN ,
  A_IPC_ENUM_WIFI_STATION_RESULT_NOT_REQUESTED , A_IPC_ENUM_WIFI_STATION_RESULT_TOO_MANY_NETWORKS
}
 WiFi station result codes. More...
 
enum  a_ipc_enum_wifi_station_encryption_method { A_IPC_ENUM_WIFI_STATION_ENCRYPTION_METHOD_WPA2 , A_IPC_ENUM_WIFI_STATION_ENCRYPTION_METHOD_UNKNOWN }
 WiFi station encryption methods. More...
 
enum  a_ipc_enum_wifi_station_notification_type { A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_SINGLE , A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_FIRST , A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_FOLLOW_UP , A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_LAST }
 WiFi station notification types. More...
 
enum  a_ipc_enum_wifi_station_failure_type { A_IPC_ENUM_WIFI_STATION_FAILURE_TYPE_WRONG_KEY }
 WiFi station failure types. More...
 
enum  a_ipc_enum_wifi_station_state { A_IPC_ENUM_WIFI_STATION_STATE_DISABLED , A_IPC_ENUM_WIFI_STATION_STATE_ENABLED }
 WiFi station states. More...
 
enum  a_ipc_enum_wifi_regulatory_domain_result { A_IPC_ENUM_WIFI_REGULATORY_DOMAIN_RESULT_OK , A_IPC_ENUM_WIFI_REGULATORY_DOMAIN_RESULT_INVALID_COUNTRY_CODE , A_IPC_ENUM_WIFI_REGULATORY_DOMAIN_RESULT_ERROR_UNKNOWN }
 WiFi regulatory domain result codes.
 
enum  a_ipc_enum_wifi_ap_result { A_IPC_ENUM_WIFI_AP_RESULT_OK , A_IPC_ENUM_WIFI_AP_RESULT_INCORRECT_INPUT , A_IPC_ENUM_WIFI_AP_RESULT_ERROR_UNKNOWN }
 WiFi AP result codes.
 

Functions

A_IPC_RESULT a_ipc_init_wifi_station_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_request_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_request_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_request_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_release_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_release_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_publish_ind (a_ipc_msg *msg, uint32_t ssid_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_publish_ind (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_auto_connect_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_auto_connect_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_connect_req (a_ipc_msg *msg, uint32_t ssid_maxlength, uint32_t passphrase_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_connect_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_connect_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_connect_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_status_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_status_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_status_rsp (a_ipc_msg *msg, uint32_t ssid_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_status_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_status_publish_ind (a_ipc_msg *msg, uint32_t ssid_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_status_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_add_known_network_req (a_ipc_msg *msg, uint32_t ssid_maxlength, uint32_t passphrase_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_add_known_network_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_add_known_network_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_add_known_network_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_publish_ind (a_ipc_msg *msg, uint32_t ssid_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_delete_known_network_req (a_ipc_msg *msg, uint32_t ssid_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_delete_known_network_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_delete_known_network_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_delete_known_network_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_set_req (a_ipc_msg *msg, uint32_t country_code_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_set_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_set_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_set_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_get_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_get_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_get_rsp (a_ipc_msg *msg, uint32_t country_code_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_get_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_ap_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_ap_request_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_ap_request_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_ap_request_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_ap_release_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_ap_release_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_ap_configure_req (a_ipc_msg *msg, uint32_t ssid_maxlength, uint32_t passphrase_maxlength)
 Initialize the message buffer to contain a_ipc_msg_wifi_ap_configure_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_ap_configure_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_ap_configure_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_unsubscribe_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_unsubscribe_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_status_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_status_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_status_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_status_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_status_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_status_unsubscribe_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_unsubscribe_req_norsp. More...
 

Detailed Description

WiFi Service.

This page contains documentation of the WiFi Service API.


Data Structure Documentation

◆ a_ipc_dyn_array_enum_wifi_station_result

struct a_ipc_dyn_array_enum_wifi_station_result

Dynamic-length array of a_ipc_enum_wifi_station_result.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_wifi_station_result * value The contents of the array.

◆ a_ipc_dyn_array_enum_wifi_station_encryption_method

struct a_ipc_dyn_array_enum_wifi_station_encryption_method

Dynamic-length array of a_ipc_enum_wifi_station_encryption_method.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_wifi_station_encryption_method * value The contents of the array.

◆ a_ipc_dyn_array_enum_wifi_station_notification_type

struct a_ipc_dyn_array_enum_wifi_station_notification_type

Dynamic-length array of a_ipc_enum_wifi_station_notification_type.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_wifi_station_notification_type * value The contents of the array.

◆ a_ipc_dyn_array_enum_wifi_station_failure_type

struct a_ipc_dyn_array_enum_wifi_station_failure_type

Dynamic-length array of a_ipc_enum_wifi_station_failure_type.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_wifi_station_failure_type * value The contents of the array.

◆ a_ipc_dyn_array_enum_wifi_station_state

struct a_ipc_dyn_array_enum_wifi_station_state

Dynamic-length array of a_ipc_enum_wifi_station_state.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_wifi_station_state * value The contents of the array.

◆ a_ipc_dyn_array_enum_wifi_regulatory_domain_result

struct a_ipc_dyn_array_enum_wifi_regulatory_domain_result

Dynamic-length array of a_ipc_enum_wifi_regulatory_domain_result.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_wifi_regulatory_domain_result * value The contents of the array.

◆ a_ipc_dyn_array_enum_wifi_ap_result

struct a_ipc_dyn_array_enum_wifi_ap_result

Dynamic-length array of a_ipc_enum_wifi_ap_result.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_wifi_ap_result * value The contents of the array.

◆ a_ipc_msg_wifi_station_request_req

struct a_ipc_msg_wifi_station_request_req

Request the WiFi station service.

Response is delivered in a_ipc_msg_wifi_station_request_rsp.

Create using a_ipc_init_wifi_station_request_req().

Message type is A_IPC_MSG_WIFI_STATION_REQUEST_REQ.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_wifi_station_request_rsp

struct a_ipc_msg_wifi_station_request_rsp

WiFi station request response.

Sent in response to a_ipc_msg_wifi_station_request_req.

Create using a_ipc_init_wifi_station_request_rsp().

Message type is A_IPC_MSG_WIFI_STATION_REQUEST_RSP.

Data Fields
a_ipc_enum_wifi_station_result result Result.

◆ a_ipc_msg_wifi_station_release_req_norsp

struct a_ipc_msg_wifi_station_release_req_norsp

Release WiFi station service for given user user.

Create using a_ipc_init_wifi_station_release_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_RELEASE_REQ_NORSP.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_wifi_station_search_reporting_req_norsp

struct a_ipc_msg_wifi_station_search_reporting_req_norsp

Set WiFi station search reporting state.

Create using a_ipc_init_wifi_station_search_reporting_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_REQ_NORSP.

Data Fields
uint8_t state 1 to enable and 0 to disable

◆ a_ipc_msg_wifi_station_search_reporting_publish_ind

struct a_ipc_msg_wifi_station_search_reporting_publish_ind

WiFi station search reporting entry publish event.

Sent periodically when search reporting is enabled.

Subscribe using a_ipc_msg_wifi_station_search_reporting_subscribe_req and unsubscribe using a_ipc_msg_wifi_station_search_reporting_unsubscribe_req_norsp.

Create using a_ipc_init_wifi_station_search_reporting_publish_ind().

Message type is A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_PUBLISH_IND.

Data Fields
uint64_t bssid BSSID of found station.
a_ipc_enum_wifi_station_encryption_method encryption_method Encryption method.
uint16_t frequency Frequency of found station.
a_ipc_enum_wifi_station_notification_type notification_type Type of notification.
uint8_t number Number in order.
int16_t rssi RSSI (in dBm)
a_ipc_dyn_string ssid SSID of found station.

◆ a_ipc_msg_wifi_station_connectivity_failure_publish_ind

struct a_ipc_msg_wifi_station_connectivity_failure_publish_ind

WiFi station connection failure publish event.

Sent when a manual connection to an AP failed, failure contains the failure reason.

Subscribe using a_ipc_msg_wifi_station_connectivity_failure_subscribe_req and unsubscribe using a_ipc_msg_wifi_station_connectivity_failure_unsubscribe_req_norsp.

Create using a_ipc_init_wifi_station_connectivity_failure_publish_ind().

Message type is A_IPC_MSG_WIFI_STATION_CONNECTIVITY_FAILURE_PUBLISH_IND.

Data Fields
a_ipc_enum_wifi_station_failure_type failure Type of failure.

◆ a_ipc_msg_wifi_station_auto_connect_req_norsp

struct a_ipc_msg_wifi_station_auto_connect_req_norsp

Set WiFi station auto connect state.

Create using a_ipc_init_wifi_station_auto_connect_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_AUTO_CONNECT_REQ_NORSP.

Data Fields
uint8_t state 0: Disabled, 1: Enabled

◆ a_ipc_msg_wifi_station_connect_req

struct a_ipc_msg_wifi_station_connect_req

WiFi station connect request.

Use this to manually connect to an AP.

When using known_network passphrase and hidden_ssid shall be skipped, if the ssid is not a known network and known_network is set connect will fail with ERROR_INVALID_PARAMETER.

Sending a connect request before requesting WiFi station will fail with NOT_REQUESTED.

A successful connect to an AP will automatically save the connection as a known network.

Note: This will override autoconnect to other stations.

Response is delivered in a_ipc_msg_wifi_station_connect_rsp.

Create using a_ipc_init_wifi_station_connect_req().

Message type is A_IPC_MSG_WIFI_STATION_CONNECT_REQ.

Data Fields
a_ipc_enum_wifi_station_encryption_method encryption_method Encryption method of station.
a_ipc_enum_wifi_station_failure_type failure Unused.
uint8_t hidden_ssid 0: visible, 1: hidden
uint8_t known_network 0: Unknown, 1: Known
a_ipc_dyn_string passphrase Passphrase of station.
a_ipc_dyn_string ssid SSID of station.

◆ a_ipc_msg_wifi_station_connect_rsp

struct a_ipc_msg_wifi_station_connect_rsp

WiFi station connect response.

Sent in response to a_ipc_msg_wifi_station_connect_req.

Create using a_ipc_init_wifi_station_connect_rsp().

Message type is A_IPC_MSG_WIFI_STATION_CONNECT_RSP.

Data Fields
a_ipc_enum_wifi_station_result result Result of connection attempt.

◆ a_ipc_msg_wifi_station_status_req

struct a_ipc_msg_wifi_station_status_req

WiFi station status request.

Response is delivered in a_ipc_msg_wifi_station_status_rsp.

Create using a_ipc_init_wifi_station_status_req().

Message type is A_IPC_MSG_WIFI_STATION_STATUS_REQ.

◆ a_ipc_msg_wifi_station_status_rsp

struct a_ipc_msg_wifi_station_status_rsp

WiFi station status response.

Sent in response to a_ipc_msg_wifi_station_status_req.

Create using a_ipc_init_wifi_station_status_rsp().

Message type is A_IPC_MSG_WIFI_STATION_STATUS_RSP.

Data Fields
a_ipc_enum_wifi_station_state auto_connect_state Auto connect enabled?
uint64_t bssid BSSID of station.
uint8_t connection_status 0: Disconnected, 1: Connected
a_ipc_enum_wifi_station_encryption_method encryption_method Station's encryption method.
uint16_t frequency Frequency of station.
uint32_t ipv4_dns0 ipv4 dns0 of station
uint32_t ipv4_dns1 ipv4 dns1 of station
uint32_t ipv4_ip ipv4 ip of station
uint32_t ipv4_netmask ipv4 netmask of station
uint32_t ipv4_router ipv4 router of station
a_ipc_enum_wifi_station_result result Result of the status query.
int16_t rssi RSSI (in dBm)
a_ipc_enum_wifi_station_state search_reporting_state Searching enabled?
a_ipc_dyn_string ssid SSID of station.

◆ a_ipc_msg_wifi_station_status_publish_ind

struct a_ipc_msg_wifi_station_status_publish_ind

WiFi station status publish event.

Sent periodically.

Subscribe using a_ipc_msg_wifi_station_status_subscribe_req and unsubscribe using a_ipc_msg_wifi_station_status_unsubscribe_req_norsp.

Create using a_ipc_init_wifi_station_status_publish_ind().

Message type is A_IPC_MSG_WIFI_STATION_STATUS_PUBLISH_IND.

Data Fields
a_ipc_enum_wifi_station_state auto_connect_state Auto connect reporting enabled?
uint64_t bssid BSSID of station.
uint8_t connection_status Disconnected, 1: Connected.
a_ipc_enum_wifi_station_encryption_method encryption_method Station's encryption method.
uint16_t frequency Frequency of station.
uint32_t ipv4_dns0 ipv4 dns0 of station
uint32_t ipv4_dns1 ipv4 dns1 of station
uint32_t ipv4_ip ipv4 ip of station
uint32_t ipv4_netmask ipv4 netmask of station
uint32_t ipv4_router ipv4 router of station
int16_t rssi RSSI (in dBm)
a_ipc_enum_wifi_station_state search_reporting_state Search reporting enabled?
a_ipc_dyn_string ssid SSID of station.

◆ a_ipc_msg_wifi_station_add_known_network_req

struct a_ipc_msg_wifi_station_add_known_network_req

WiFi station add or update known network request.

If ssid points to an already known network this will update the entry.

Only 256 networks can be stored, if the limit is exceeded add known network will fail with TOO_MANY_NETWORKS.

Response is delivered in a_ipc_msg_wifi_station_add_known_network_rsp.

Create using a_ipc_init_wifi_station_add_known_network_req().

Message type is A_IPC_MSG_WIFI_STATION_ADD_KNOWN_NETWORK_REQ.

Data Fields
a_ipc_enum_wifi_station_encryption_method encryption_method Station's encryption method.
uint8_t hidden_ssid 0: visible, 1: hidden
a_ipc_dyn_string passphrase Passphrase of station.
a_ipc_dyn_string ssid SSID of station.

◆ a_ipc_msg_wifi_station_add_known_network_rsp

struct a_ipc_msg_wifi_station_add_known_network_rsp

WiFi station add known network response.

Sent in response to a_ipc_msg_wifi_station_add_known_network_req.

Create using a_ipc_init_wifi_station_add_known_network_rsp().

Message type is A_IPC_MSG_WIFI_STATION_ADD_KNOWN_NETWORK_RSP.

Data Fields
a_ipc_enum_wifi_station_result result Result of adding network.

◆ a_ipc_msg_wifi_station_list_known_networks_req_norsp

struct a_ipc_msg_wifi_station_list_known_networks_req_norsp

WiFi station add known network request.

Create using a_ipc_init_wifi_station_list_known_networks_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_REQ_NORSP.

◆ a_ipc_msg_wifi_station_list_known_networks_publish_ind

struct a_ipc_msg_wifi_station_list_known_networks_publish_ind

WiFi station known networks entry publish event.

Sent when list known networks has been requested.

Subscribe using a_ipc_msg_wifi_station_list_known_networks_subscribe_req and unsubscribe using a_ipc_msg_wifi_station_list_known_networks_unsubscribe_req_norsp.

Create using a_ipc_init_wifi_station_list_known_networks_publish_ind().

Message type is A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_PUBLISH_IND.

Data Fields
a_ipc_enum_wifi_station_notification_type notification_type Notification type.
uint8_t number Number in order.
a_ipc_dyn_string ssid SSID of station.

◆ a_ipc_msg_wifi_station_delete_known_network_req

struct a_ipc_msg_wifi_station_delete_known_network_req

WiFi station delete known network request.

Response is delivered in a_ipc_msg_wifi_station_delete_known_network_rsp.

Create using a_ipc_init_wifi_station_delete_known_network_req().

Message type is A_IPC_MSG_WIFI_STATION_DELETE_KNOWN_NETWORK_REQ.

Data Fields
a_ipc_dyn_string ssid SSID of station.

◆ a_ipc_msg_wifi_station_delete_known_network_rsp

struct a_ipc_msg_wifi_station_delete_known_network_rsp

WiFi station delete known network response.

Sent in response to a_ipc_msg_wifi_station_delete_known_network_req.

Create using a_ipc_init_wifi_station_delete_known_network_rsp().

Message type is A_IPC_MSG_WIFI_STATION_DELETE_KNOWN_NETWORK_RSP.

Data Fields
a_ipc_enum_wifi_station_result result Result of deletion.

◆ a_ipc_msg_wifi_regulatory_domain_set_req

struct a_ipc_msg_wifi_regulatory_domain_set_req

WiFi regulatory domain set request.

The regulatory domain must be set before starting the WiFi STA.

Deprecated:
This API is deprecated due to being replaced with automatic country selection.

Response is delivered in a_ipc_msg_wifi_regulatory_domain_set_rsp.

Create using a_ipc_init_wifi_regulatory_domain_set_req().

Message type is A_IPC_MSG_WIFI_REGULATORY_DOMAIN_SET_REQ.

Data Fields
a_ipc_dyn_string country_code Country code: ISO/IEC 3166-1 alpha2.

◆ a_ipc_msg_wifi_regulatory_domain_set_rsp

struct a_ipc_msg_wifi_regulatory_domain_set_rsp

WiFi regulatory domain set request.

Sent in response to a_ipc_msg_wifi_regulatory_domain_set_req.

Create using a_ipc_init_wifi_regulatory_domain_set_rsp().

Message type is A_IPC_MSG_WIFI_REGULATORY_DOMAIN_SET_RSP.

Data Fields
a_ipc_enum_wifi_regulatory_domain_result result Result of set.

◆ a_ipc_msg_wifi_regulatory_domain_get_req

struct a_ipc_msg_wifi_regulatory_domain_get_req

WiFi regulatory domain set request.

Deprecated:
This API is deprecated due to being replaced with automatic country selection.

Response is delivered in a_ipc_msg_wifi_regulatory_domain_get_rsp.

Create using a_ipc_init_wifi_regulatory_domain_get_req().

Message type is A_IPC_MSG_WIFI_REGULATORY_DOMAIN_GET_REQ.

◆ a_ipc_msg_wifi_regulatory_domain_get_rsp

struct a_ipc_msg_wifi_regulatory_domain_get_rsp

WiFi regulatory domain set request.

Sent in response to a_ipc_msg_wifi_regulatory_domain_get_req.

Create using a_ipc_init_wifi_regulatory_domain_get_rsp().

Message type is A_IPC_MSG_WIFI_REGULATORY_DOMAIN_GET_RSP.

Data Fields
a_ipc_dyn_string country_code Country_code: ISO/IEC 3166-1 alpha2.
a_ipc_enum_wifi_regulatory_domain_result result Result of get.

◆ a_ipc_msg_wifi_ap_request_req

struct a_ipc_msg_wifi_ap_request_req

Request the WiFi AP service.

The service will be turned on once requested and configured. Request and configuration can be done in any order.

Response is delivered in a_ipc_msg_wifi_ap_request_rsp.

Create using a_ipc_init_wifi_ap_request_req().

Message type is A_IPC_MSG_WIFI_AP_REQUEST_REQ.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_wifi_ap_request_rsp

struct a_ipc_msg_wifi_ap_request_rsp

WiFi AP request response.

Sent in response to a_ipc_msg_wifi_ap_request_req.

Create using a_ipc_init_wifi_ap_request_rsp().

Message type is A_IPC_MSG_WIFI_AP_REQUEST_RSP.

Data Fields
a_ipc_enum_wifi_ap_result result Result.

◆ a_ipc_msg_wifi_ap_release_req_norsp

struct a_ipc_msg_wifi_ap_release_req_norsp

Release AP station service for given user user.

Create using a_ipc_init_wifi_ap_release_req_norsp().

Message type is A_IPC_MSG_WIFI_AP_RELEASE_REQ_NORSP.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_wifi_ap_configure_req

struct a_ipc_msg_wifi_ap_configure_req

WiFi AP configuration request.

The service will be turned on once requested and configured. Request and configuration can be done in any order.

If the ssid is longer than 32 chars or passphrase is shorter than 8 chars, configuration fails with INCORRECT_INPUT.

Response is delivered in a_ipc_msg_wifi_ap_configure_rsp.

Create using a_ipc_init_wifi_ap_configure_req().

Message type is A_IPC_MSG_WIFI_AP_CONFIGURE_REQ.

Data Fields
a_ipc_dyn_string passphrase WPA2 passphrase.
a_ipc_dyn_string ssid SSID.

◆ a_ipc_msg_wifi_ap_configure_rsp

struct a_ipc_msg_wifi_ap_configure_rsp

WiFi AP configuration response.

Sent in response to a_ipc_msg_wifi_ap_configure_req.

Create using a_ipc_init_wifi_ap_configure_rsp().

Message type is A_IPC_MSG_WIFI_AP_CONFIGURE_RSP.

Data Fields
a_ipc_enum_wifi_ap_result result Result of the operation.

◆ a_ipc_msg_wifi_station_search_reporting_subscribe_req

struct a_ipc_msg_wifi_station_search_reporting_subscribe_req

◆ a_ipc_msg_wifi_station_search_reporting_subscribe_rsp

struct a_ipc_msg_wifi_station_search_reporting_subscribe_rsp

◆ a_ipc_msg_wifi_station_search_reporting_unsubscribe_req_norsp

struct a_ipc_msg_wifi_station_search_reporting_unsubscribe_req_norsp

Unsubscribe from updates for wifi_station_search_reporting.

a_ipc_msg_wifi_station_search_reporting_publish_ind will no longer be received.

Create using a_ipc_init_wifi_station_search_reporting_unsubscribe_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_UNSUBSCRIBE_REQ_NORSP.

◆ a_ipc_msg_wifi_station_connectivity_failure_subscribe_req

struct a_ipc_msg_wifi_station_connectivity_failure_subscribe_req

◆ a_ipc_msg_wifi_station_connectivity_failure_subscribe_rsp

struct a_ipc_msg_wifi_station_connectivity_failure_subscribe_rsp

◆ a_ipc_msg_wifi_station_connectivity_failure_unsubscribe_req_norsp

struct a_ipc_msg_wifi_station_connectivity_failure_unsubscribe_req_norsp

Unsubscribe from updates for wifi_station_connectivity_failure.

a_ipc_msg_wifi_station_connectivity_failure_publish_ind will no longer be received.

Create using a_ipc_init_wifi_station_connectivity_failure_unsubscribe_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_CONNECTIVITY_FAILURE_UNSUBSCRIBE_REQ_NORSP.

◆ a_ipc_msg_wifi_station_status_subscribe_req

struct a_ipc_msg_wifi_station_status_subscribe_req

◆ a_ipc_msg_wifi_station_status_subscribe_rsp

struct a_ipc_msg_wifi_station_status_subscribe_rsp
Data Fields
a_ipc_enum_ipc_subscribe_result result The result of the subscription request.

◆ a_ipc_msg_wifi_station_status_unsubscribe_req_norsp

struct a_ipc_msg_wifi_station_status_unsubscribe_req_norsp

Unsubscribe from updates for wifi_station_status.

a_ipc_msg_wifi_station_status_publish_ind will no longer be received.

Create using a_ipc_init_wifi_station_status_unsubscribe_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_STATUS_UNSUBSCRIBE_REQ_NORSP.

◆ a_ipc_msg_wifi_station_list_known_networks_subscribe_req

struct a_ipc_msg_wifi_station_list_known_networks_subscribe_req

◆ a_ipc_msg_wifi_station_list_known_networks_subscribe_rsp

struct a_ipc_msg_wifi_station_list_known_networks_subscribe_rsp

◆ a_ipc_msg_wifi_station_list_known_networks_unsubscribe_req_norsp

struct a_ipc_msg_wifi_station_list_known_networks_unsubscribe_req_norsp

Unsubscribe from updates for wifi_station_list_known_networks.

a_ipc_msg_wifi_station_list_known_networks_publish_ind will no longer be received.

Create using a_ipc_init_wifi_station_list_known_networks_unsubscribe_req_norsp().

Message type is A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_UNSUBSCRIBE_REQ_NORSP.

Enumeration Type Documentation

◆ a_ipc_enum_wifi_station_encryption_method

WiFi station encryption methods.

Enumerator
A_IPC_ENUM_WIFI_STATION_ENCRYPTION_METHOD_WPA2 

WPA2.

A_IPC_ENUM_WIFI_STATION_ENCRYPTION_METHOD_UNKNOWN 

Unknown.

◆ a_ipc_enum_wifi_station_failure_type

WiFi station failure types.

Enumerator
A_IPC_ENUM_WIFI_STATION_FAILURE_TYPE_WRONG_KEY 

Wrong key.

◆ a_ipc_enum_wifi_station_notification_type

WiFi station notification types.

Enumerator
A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_SINGLE 

Single entry notification type - if received with an otherwise empty message it means no results.

A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_FIRST 

First: one or more FOLLOW_UP or a LAST should follow.

A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_FOLLOW_UP 

Follow up to a FIRST.

A_IPC_ENUM_WIFI_STATION_NOTIFICATION_TYPE_LAST 

Last entry, if empty (outside of a counter) it means unexpected termination of the list.

◆ a_ipc_enum_wifi_station_result

WiFi station result codes.

Enumerator
A_IPC_ENUM_WIFI_STATION_RESULT_OK 

OK.

A_IPC_ENUM_WIFI_STATION_RESULT_ERROR_INVALID_PARAMETER 

Invalid parameter.

A_IPC_ENUM_WIFI_STATION_RESULT_WRONG_STATE 

Wrong state.

A_IPC_ENUM_WIFI_STATION_RESULT_ERROR_UNKNOWN 

Error unknown.

A_IPC_ENUM_WIFI_STATION_RESULT_NOT_REQUESTED 

Not requested.

A_IPC_ENUM_WIFI_STATION_RESULT_TOO_MANY_NETWORKS 

Too many networks.

◆ a_ipc_enum_wifi_station_state

WiFi station states.

Enumerator
A_IPC_ENUM_WIFI_STATION_STATE_DISABLED 

Disabled.

A_IPC_ENUM_WIFI_STATION_STATE_ENABLED 

Enabled.

Function Documentation

◆ a_ipc_init_wifi_ap_configure_req()

A_IPC_RESULT a_ipc_init_wifi_ap_configure_req ( a_ipc_msg msg,
uint32_t  ssid_maxlength,
uint32_t  passphrase_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_ap_configure_req.

msg->info.type will be A_IPC_MSG_WIFI_AP_CONFIGURE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.
passphrase_maxlengthThe maximum string length for passphrase in the message.

◆ a_ipc_init_wifi_ap_configure_rsp()

A_IPC_RESULT a_ipc_init_wifi_ap_configure_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_ap_configure_rsp.

msg->info.type will be A_IPC_MSG_WIFI_AP_CONFIGURE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_ap_release_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_ap_release_req_norsp ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_ap_release_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_AP_RELEASE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_wifi_ap_request_req()

A_IPC_RESULT a_ipc_init_wifi_ap_request_req ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_ap_request_req.

msg->info.type will be A_IPC_MSG_WIFI_AP_REQUEST_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_wifi_ap_request_rsp()

A_IPC_RESULT a_ipc_init_wifi_ap_request_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_ap_request_rsp.

msg->info.type will be A_IPC_MSG_WIFI_AP_REQUEST_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_regulatory_domain_get_req()

A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_get_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_get_req.

msg->info.type will be A_IPC_MSG_WIFI_REGULATORY_DOMAIN_GET_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_regulatory_domain_get_rsp()

A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_get_rsp ( a_ipc_msg msg,
uint32_t  country_code_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_get_rsp.

msg->info.type will be A_IPC_MSG_WIFI_REGULATORY_DOMAIN_GET_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
country_code_maxlengthThe maximum string length for country_code in the message.

◆ a_ipc_init_wifi_regulatory_domain_set_req()

A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_set_req ( a_ipc_msg msg,
uint32_t  country_code_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_set_req.

msg->info.type will be A_IPC_MSG_WIFI_REGULATORY_DOMAIN_SET_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
country_code_maxlengthThe maximum string length for country_code in the message.

◆ a_ipc_init_wifi_regulatory_domain_set_rsp()

A_IPC_RESULT a_ipc_init_wifi_regulatory_domain_set_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_regulatory_domain_set_rsp.

msg->info.type will be A_IPC_MSG_WIFI_REGULATORY_DOMAIN_SET_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_add_known_network_req()

A_IPC_RESULT a_ipc_init_wifi_station_add_known_network_req ( a_ipc_msg msg,
uint32_t  ssid_maxlength,
uint32_t  passphrase_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_add_known_network_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_ADD_KNOWN_NETWORK_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.
passphrase_maxlengthThe maximum string length for passphrase in the message.

◆ a_ipc_init_wifi_station_add_known_network_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_add_known_network_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_add_known_network_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_ADD_KNOWN_NETWORK_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_auto_connect_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_auto_connect_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_auto_connect_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_AUTO_CONNECT_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_connect_req()

A_IPC_RESULT a_ipc_init_wifi_station_connect_req ( a_ipc_msg msg,
uint32_t  ssid_maxlength,
uint32_t  passphrase_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_connect_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_CONNECT_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.
passphrase_maxlengthThe maximum string length for passphrase in the message.

◆ a_ipc_init_wifi_station_connect_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_connect_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_connect_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_CONNECT_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_connectivity_failure_publish_ind()

A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_publish_ind ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_publish_ind.

msg->info.type will be A_IPC_MSG_WIFI_STATION_CONNECTIVITY_FAILURE_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_connectivity_failure_subscribe_req()

A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_subscribe_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_CONNECTIVITY_FAILURE_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_connectivity_failure_subscribe_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_subscribe_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_CONNECTIVITY_FAILURE_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_connectivity_failure_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_connectivity_failure_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_connectivity_failure_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_CONNECTIVITY_FAILURE_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_delete_known_network_req()

A_IPC_RESULT a_ipc_init_wifi_station_delete_known_network_req ( a_ipc_msg msg,
uint32_t  ssid_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_delete_known_network_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_DELETE_KNOWN_NETWORK_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.

◆ a_ipc_init_wifi_station_delete_known_network_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_delete_known_network_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_delete_known_network_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_DELETE_KNOWN_NETWORK_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_list_known_networks_publish_ind()

A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_publish_ind ( a_ipc_msg msg,
uint32_t  ssid_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_publish_ind.

msg->info.type will be A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.

◆ a_ipc_init_wifi_station_list_known_networks_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_list_known_networks_subscribe_req()

A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_subscribe_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_list_known_networks_subscribe_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_subscribe_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_list_known_networks_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_list_known_networks_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_list_known_networks_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_LIST_KNOWN_NETWORKS_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_release_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_release_req_norsp ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_release_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_RELEASE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_wifi_station_request_req()

A_IPC_RESULT a_ipc_init_wifi_station_request_req ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_request_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_REQUEST_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_wifi_station_request_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_request_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_request_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_REQUEST_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_search_reporting_publish_ind()

A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_publish_ind ( a_ipc_msg msg,
uint32_t  ssid_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_publish_ind.

msg->info.type will be A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.

◆ a_ipc_init_wifi_station_search_reporting_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_search_reporting_subscribe_req()

A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_subscribe_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_search_reporting_subscribe_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_subscribe_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_search_reporting_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_search_reporting_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_search_reporting_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_SEARCH_REPORTING_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_status_publish_ind()

A_IPC_RESULT a_ipc_init_wifi_station_status_publish_ind ( a_ipc_msg msg,
uint32_t  ssid_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_status_publish_ind.

msg->info.type will be A_IPC_MSG_WIFI_STATION_STATUS_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.

◆ a_ipc_init_wifi_station_status_req()

A_IPC_RESULT a_ipc_init_wifi_station_status_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_status_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_STATUS_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_status_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_status_rsp ( a_ipc_msg msg,
uint32_t  ssid_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_wifi_station_status_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_STATUS_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
ssid_maxlengthThe maximum string length for ssid in the message.

◆ a_ipc_init_wifi_station_status_subscribe_req()

A_IPC_RESULT a_ipc_init_wifi_station_status_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_status_subscribe_req.

msg->info.type will be A_IPC_MSG_WIFI_STATION_STATUS_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_status_subscribe_rsp()

A_IPC_RESULT a_ipc_init_wifi_station_status_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_status_subscribe_rsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_STATUS_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_wifi_station_status_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_wifi_station_status_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_wifi_station_status_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_WIFI_STATION_STATUS_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

Variable Documentation

◆ auto_connect_state [1/2]

a_ipc_enum_wifi_station_state a_ipc_msg_wifi_station_status_rsp::auto_connect_state

Auto connect enabled?

◆ auto_connect_state [2/2]

a_ipc_enum_wifi_station_state a_ipc_msg_wifi_station_status_publish_ind::auto_connect_state

Auto connect reporting enabled?

◆ bssid [1/3]

uint64_t a_ipc_msg_wifi_station_search_reporting_publish_ind::bssid

BSSID of found station.

◆ bssid [2/3]

uint64_t a_ipc_msg_wifi_station_status_rsp::bssid

BSSID of station.

◆ bssid [3/3]

uint64_t a_ipc_msg_wifi_station_status_publish_ind::bssid

BSSID of station.

◆ connection_status [1/2]

uint8_t a_ipc_msg_wifi_station_status_rsp::connection_status

0: Disconnected, 1: Connected

◆ connection_status [2/2]

uint8_t a_ipc_msg_wifi_station_status_publish_ind::connection_status

Disconnected, 1: Connected.

◆ country_code [1/2]

a_ipc_dyn_string a_ipc_msg_wifi_regulatory_domain_set_req::country_code

Country code: ISO/IEC 3166-1 alpha2.

◆ country_code [2/2]

a_ipc_dyn_string a_ipc_msg_wifi_regulatory_domain_get_rsp::country_code

Country_code: ISO/IEC 3166-1 alpha2.

◆ encryption_method [1/5]

a_ipc_enum_wifi_station_encryption_method a_ipc_msg_wifi_station_search_reporting_publish_ind::encryption_method

Encryption method.

◆ encryption_method [2/5]

a_ipc_enum_wifi_station_encryption_method a_ipc_msg_wifi_station_connect_req::encryption_method

Encryption method of station.

◆ encryption_method [3/5]

a_ipc_enum_wifi_station_encryption_method a_ipc_msg_wifi_station_status_rsp::encryption_method

Station's encryption method.

◆ encryption_method [4/5]

a_ipc_enum_wifi_station_encryption_method a_ipc_msg_wifi_station_status_publish_ind::encryption_method

Station's encryption method.

◆ encryption_method [5/5]

a_ipc_enum_wifi_station_encryption_method a_ipc_msg_wifi_station_add_known_network_req::encryption_method

Station's encryption method.

◆ failure [1/2]

a_ipc_enum_wifi_station_failure_type a_ipc_msg_wifi_station_connectivity_failure_publish_ind::failure

Type of failure.

◆ failure [2/2]

a_ipc_enum_wifi_station_failure_type a_ipc_msg_wifi_station_connect_req::failure

Unused.

◆ frequency [1/3]

uint16_t a_ipc_msg_wifi_station_search_reporting_publish_ind::frequency

Frequency of found station.

◆ frequency [2/3]

uint16_t a_ipc_msg_wifi_station_status_rsp::frequency

Frequency of station.

◆ frequency [3/3]

uint16_t a_ipc_msg_wifi_station_status_publish_ind::frequency

Frequency of station.

◆ hidden_ssid [1/2]

uint8_t a_ipc_msg_wifi_station_connect_req::hidden_ssid

0: visible, 1: hidden

◆ hidden_ssid [2/2]

uint8_t a_ipc_msg_wifi_station_add_known_network_req::hidden_ssid

0: visible, 1: hidden

◆ ipv4_dns0 [1/2]

uint32_t a_ipc_msg_wifi_station_status_rsp::ipv4_dns0

ipv4 dns0 of station

◆ ipv4_dns0 [2/2]

uint32_t a_ipc_msg_wifi_station_status_publish_ind::ipv4_dns0

ipv4 dns0 of station

◆ ipv4_dns1 [1/2]

uint32_t a_ipc_msg_wifi_station_status_rsp::ipv4_dns1

ipv4 dns1 of station

◆ ipv4_dns1 [2/2]

uint32_t a_ipc_msg_wifi_station_status_publish_ind::ipv4_dns1

ipv4 dns1 of station

◆ ipv4_ip [1/2]

uint32_t a_ipc_msg_wifi_station_status_rsp::ipv4_ip

ipv4 ip of station

◆ ipv4_ip [2/2]

uint32_t a_ipc_msg_wifi_station_status_publish_ind::ipv4_ip

ipv4 ip of station

◆ ipv4_netmask [1/2]

uint32_t a_ipc_msg_wifi_station_status_rsp::ipv4_netmask

ipv4 netmask of station

◆ ipv4_netmask [2/2]

uint32_t a_ipc_msg_wifi_station_status_publish_ind::ipv4_netmask

ipv4 netmask of station

◆ ipv4_router [1/2]

uint32_t a_ipc_msg_wifi_station_status_rsp::ipv4_router

ipv4 router of station

◆ ipv4_router [2/2]

uint32_t a_ipc_msg_wifi_station_status_publish_ind::ipv4_router

ipv4 router of station

◆ known_network

uint8_t a_ipc_msg_wifi_station_connect_req::known_network

0: Unknown, 1: Known

◆ notification_type [1/2]

a_ipc_enum_wifi_station_notification_type a_ipc_msg_wifi_station_search_reporting_publish_ind::notification_type

Type of notification.

◆ notification_type [2/2]

a_ipc_enum_wifi_station_notification_type a_ipc_msg_wifi_station_list_known_networks_publish_ind::notification_type

Notification type.

◆ number [1/2]

uint8_t a_ipc_msg_wifi_station_search_reporting_publish_ind::number

Number in order.

◆ number [2/2]

uint8_t a_ipc_msg_wifi_station_list_known_networks_publish_ind::number

Number in order.

◆ passphrase [1/3]

a_ipc_dyn_string a_ipc_msg_wifi_station_connect_req::passphrase

Passphrase of station.

◆ passphrase [2/3]

a_ipc_dyn_string a_ipc_msg_wifi_station_add_known_network_req::passphrase

Passphrase of station.

◆ passphrase [3/3]

a_ipc_dyn_string a_ipc_msg_wifi_ap_configure_req::passphrase

WPA2 passphrase.

◆ result [1/13]

a_ipc_enum_wifi_station_result a_ipc_msg_wifi_station_request_rsp::result

Result.

◆ result [2/13]

a_ipc_enum_wifi_station_result a_ipc_msg_wifi_station_connect_rsp::result

Result of connection attempt.

◆ result [3/13]

a_ipc_enum_wifi_station_result a_ipc_msg_wifi_station_status_rsp::result

Result of the status query.

◆ result [4/13]

a_ipc_enum_wifi_station_result a_ipc_msg_wifi_station_add_known_network_rsp::result

Result of adding network.

◆ result [5/13]

a_ipc_enum_wifi_station_result a_ipc_msg_wifi_station_delete_known_network_rsp::result

Result of deletion.

◆ result [6/13]

a_ipc_enum_wifi_regulatory_domain_result a_ipc_msg_wifi_regulatory_domain_set_rsp::result

Result of set.

◆ result [7/13]

a_ipc_enum_wifi_regulatory_domain_result a_ipc_msg_wifi_regulatory_domain_get_rsp::result

Result of get.

◆ result [8/13]

a_ipc_enum_wifi_ap_result a_ipc_msg_wifi_ap_request_rsp::result

Result.

◆ result [9/13]

a_ipc_enum_wifi_ap_result a_ipc_msg_wifi_ap_configure_rsp::result

Result of the operation.

◆ result [10/13]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_wifi_station_search_reporting_subscribe_rsp::result

The result of the subscription request.

◆ result [11/13]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_wifi_station_connectivity_failure_subscribe_rsp::result

The result of the subscription request.

◆ result [12/13]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_wifi_station_status_subscribe_rsp::result

The result of the subscription request.

◆ result [13/13]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_wifi_station_list_known_networks_subscribe_rsp::result

The result of the subscription request.

◆ rssi [1/3]

int16_t a_ipc_msg_wifi_station_search_reporting_publish_ind::rssi

RSSI (in dBm)

◆ rssi [2/3]

int16_t a_ipc_msg_wifi_station_status_rsp::rssi

RSSI (in dBm)

◆ rssi [3/3]

int16_t a_ipc_msg_wifi_station_status_publish_ind::rssi

RSSI (in dBm)

◆ search_reporting_state [1/2]

a_ipc_enum_wifi_station_state a_ipc_msg_wifi_station_status_rsp::search_reporting_state

Searching enabled?

◆ search_reporting_state [2/2]

a_ipc_enum_wifi_station_state a_ipc_msg_wifi_station_status_publish_ind::search_reporting_state

Search reporting enabled?

◆ ssid [1/8]

a_ipc_dyn_string a_ipc_msg_wifi_station_search_reporting_publish_ind::ssid

SSID of found station.

◆ ssid [2/8]

a_ipc_dyn_string a_ipc_msg_wifi_station_connect_req::ssid

SSID of station.

◆ ssid [3/8]

a_ipc_dyn_string a_ipc_msg_wifi_station_status_rsp::ssid

SSID of station.

◆ ssid [4/8]

a_ipc_dyn_string a_ipc_msg_wifi_station_status_publish_ind::ssid

SSID of station.

◆ ssid [5/8]

a_ipc_dyn_string a_ipc_msg_wifi_station_add_known_network_req::ssid

SSID of station.

◆ ssid [6/8]

a_ipc_dyn_string a_ipc_msg_wifi_station_list_known_networks_publish_ind::ssid

SSID of station.

◆ ssid [7/8]

a_ipc_dyn_string a_ipc_msg_wifi_station_delete_known_network_req::ssid

SSID of station.

◆ ssid [8/8]

a_ipc_dyn_string a_ipc_msg_wifi_ap_configure_req::ssid

SSID.

◆ state [1/2]

uint8_t a_ipc_msg_wifi_station_search_reporting_req_norsp::state

1 to enable and 0 to disable

◆ state [2/2]

uint8_t a_ipc_msg_wifi_station_auto_connect_req_norsp::state

0: Disabled, 1: Enabled

◆ user [1/4]

a_ipc_dyn_string a_ipc_msg_wifi_station_request_req::user

User identifier, max 15 characters long.

◆ user [2/4]

a_ipc_dyn_string a_ipc_msg_wifi_station_release_req_norsp::user

User identifier, max 15 characters long.

◆ user [3/4]

a_ipc_dyn_string a_ipc_msg_wifi_ap_request_req::user

User identifier, max 15 characters long.

◆ user [4/4]

a_ipc_dyn_string a_ipc_msg_wifi_ap_release_req_norsp::user

User identifier, max 15 characters long.