FreeRTOS: BLE
BLE
Return to main page ↑
IotBleWifiProvAddNetworkRequest_t Struct Reference

Defines add wifi network request message structure sent from the provisioining app to the device. The request is used to provision a new access point with the credentials or to connect to an already provisioned access point. Inorder to connect to an already provisioned access point, a valid accessPointStoredIndex needs to be provided. Setting flag connectToAccessPoint to true results in the device first connecting to access point successfully before provisioning it in the flash. More...

#include <iot_ble_wifi_provisioning.h>

Data Fields

union {
   WIFINetworkProfile_t   network
 
   int16_t   index
 
info
 
bool isProvisioned: 1
 
bool shouldConnect: 1
 

Detailed Description

Defines add wifi network request message structure sent from the provisioining app to the device. The request is used to provision a new access point with the credentials or to connect to an already provisioned access point. Inorder to connect to an already provisioned access point, a valid accessPointStoredIndex needs to be provided. Setting flag connectToAccessPoint to true results in the device first connecting to access point successfully before provisioning it in the flash.

Field Documentation

◆ network

WIFINetworkProfile_t IotBleWifiProvAddNetworkRequest_t::network

The configuration for the new WIFI access point.

◆ index

int16_t IotBleWifiProvAddNetworkRequest_t::index

Prirority index of an already provisioned WiFi access point.

◆ isProvisioned

bool IotBleWifiProvAddNetworkRequest_t::isProvisioned

true if the newtwork is already provisioned, a valid pirority index should be provided.

◆ shouldConnect

bool IotBleWifiProvAddNetworkRequest_t::shouldConnect

true if the access point needs to be connected before provisioning.


The documentation for this struct was generated from the following file: