iot_ble_wifi_provisioning.h

Go to the documentation of this file.

/*
 * FreeRTOS BLE V2.1.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */
 
#ifndef IOT_BLE_WIFI_PROVISIONING_H_
#define IOT_BLE_WIFI_PROVISIONING_H_
 
#include "iot_ble.h"
#include "iot_ble_data_transfer.h"
#include "iot_wifi.h"
#include "platform/iot_threads.h"
 
 
typedef struct IotBleListNetworkRequest
{
    int16_t maxNetworks; 
    int16_t timeoutMs;   
} IotBleListNetworkRequest_t;
 
typedef struct IotBleAddNetworkRequest
{
    WIFINetworkProfile_t network; 
    int16_t savedIdx;             
    bool connect;                 
} IotBleAddNetworkRequest_t;
 
typedef struct IotBleEditNetworkRequest
{
    int16_t curIdx; 
    int16_t newIdx; 
} IotBleEditNetworkRequest_t;
 
typedef struct IotBleDeleteNetworkRequest
{
    int16_t idx; 
} IotBleDeleteNetworkRequest_t;
 
typedef struct IotBleWifiNetworkInfo
{
    const char * pSSID;      
    size_t SSIDLength;       
    const uint8_t * pBSSID;  
    size_t BSSIDLength;      
    int32_t savedIdx;        
    int8_t RSSI;             
    WIFISecurity_t security; 
    WIFIReturnCode_t status; 
    bool hidden;             
    bool connected;          
} IotBleWifiNetworkInfo_t;
 
typedef enum
{
    IOT_BLE_WIFI_PROV_CONNECT = 0x01,    
    IOT_BLE_WIFI_PROV_CONNECTED = 0x02,                                  
    IOT_BLE_WIFI_PROV_DELETED = 0x4,                                                              
    IOT_BLE_WIFI_PROV_FAILED = 0x8                                                               
} IotBleWifiProvEvent_t;
 
typedef struct IotBleWifiProvService
{
    IotBleDataTransferChannel_t * pChannel; 
    IotSemaphore_t lock;                    
    uint16_t numNetworks;                   
    int16_t connectedIdx;                   
    IotBleListNetworkRequest_t listNetworkRequest;
    IotBleAddNetworkRequest_t addNetworkRequest;
    IotBleEditNetworkRequest_t editNetworkRequest;
    IotBleDeleteNetworkRequest_t deleteNetworkRequest;
} IotBleWifiProvService_t;
 
/* @[declare_iotblewifiprov_init] */
bool IotBleWifiProv_Init( void );
/* @[declare_iotblewifiprov_init] */
 
/* @[declare_iotblewifiprov_getnumnetworks] */
uint32_t IotBleWifiProv_GetNumNetworks( void );
/* @[declare_iotblewifiprov_getnumnetworks] */
 
/* @[declare_iotblewifiprov_connect] */
bool IotBleWifiProv_Connect( uint32_t networkIndex );
/* @[declare_iotblewifiprov_connect] */
 
/* @[declare_iotblewifiprov_eraseallnetworks] */
bool IotBleWifiProv_EraseAllNetworks( void );
/* @[declare_iotblewifiprov_eraseallnetworks] */
 
/* @[declare_iotblewifiprov_delete] */
void IotBleWifiProv_Deinit( void );
/* @[declare_iotblewifiprov_delete] */
 
#endif /* _AWS_BLE_WIFI_PROVISIONING_H_ */