iot_ble_wifi_provisioning.h

Go to the documentation of this file.

/*
 * FreeRTOS BLE V2.2.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_wifi.h"

typedef enum
{
    IotBleWiFiProvRequestInvalid = 0,       
    IotBleWiFiProvRequestListNetwork = 1,   
    IotBleWiFiProvRequestAddNetwork = 2,    
    IotBleWiFiProvRequestEditNetwork = 3,   
    IotBleWiFiProvRequestDeleteNetwork = 4, 
    IotBleWiFiProvRequestStop = 5           
} IotBleWiFiProvRequest_t;

typedef struct
{
    int16_t scanSize;      
    int16_t scanTimeoutMS; 
} IotBleWifiProvListNetworksRequest_t;

typedef struct
{
    union
    {
        WIFINetworkProfile_t network; 
        int16_t index;                
    } info;
    bool isProvisioned : 1;           
    bool shouldConnect : 1;           
} IotBleWifiProvAddNetworkRequest_t;

typedef struct
{
    int16_t currentPriorityIndex; 
    int16_t newPriorityIndex;     
} IotBleWifiProvEditNetworkRequest_t;

typedef struct
{
    int16_t priorityIndex; 
} IotBleWifiProvDeleteNetworkRequest_t;

typedef struct
{
    union
    {
        WIFIScanResult_t * pScannedNetwork;   
        WIFINetworkProfile_t * pSavedNetwork; 
    } info;
    uint16_t index;                           
    bool isSavedNetwork : 1;                  
    bool isConnected : 1;                     
    bool isHidden : 1;                        
} IotBleWifiProvNetworkInfo_t;

typedef struct IotBleWifiProvResponse
{
    IotBleWiFiProvRequest_t requestType;     
    WIFIReturnCode_t status;                 
    IotBleWifiProvNetworkInfo_t networkInfo; 
    bool statusOnly : 1;                     
} IotBleWifiProvResponse_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
{
    bool ( * getRequestType )( const uint8_t * pMessage,
                               size_t length,
                               IotBleWiFiProvRequest_t * pRequeustType );

    bool ( * deserializeListNetworkRequest )( const uint8_t * pData,
                                              size_t length,
                                              IotBleWifiProvListNetworksRequest_t * pListNetworksRequest );

    bool ( * deserializeAddNetworkRequest )( const uint8_t * pData,
                                             size_t length,
                                             IotBleWifiProvAddNetworkRequest_t * pAddNetworkRequest );

    bool ( * deserializeEditNetworkRequest )( const uint8_t * pData,
                                              size_t length,
                                              IotBleWifiProvEditNetworkRequest_t * pEditNetworkRequest );

    bool ( * deserializeDeleteNetworkRequest )( const uint8_t * pData,
                                                size_t length,
                                                IotBleWifiProvDeleteNetworkRequest_t * pDeleteNetworkRequest );

    bool ( * getSerializedSizeForResponse )( const IotBleWifiProvResponse_t * pResponse,
                                             size_t * length );

    bool ( * serializeResponse )( const IotBleWifiProvResponse_t * pResponse,
                                  uint8_t * pBuffer,
                                  size_t length );
} IotBleWifiProvSerializer_t;

/* @[declare_iotblewifiprov_init] */
bool IotBleWifiProv_Init( void );
/* @[declare_iotblewifiprov_init] */

/* @[declare_iotblewifiprov_init] */
bool IotBleWifiProv_RunProcessLoop( void );

/* @[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_stop] */
bool IotBleWifiProv_Stop( void );

/* @[declare_iotblewifiprov_eraseallnetworks] */
bool IotBleWifiProv_EraseAllNetworks( void );
/* @[declare_iotblewifiprov_eraseallnetworks] */

/* @[declare_iotblewifiprov_delete] */
void IotBleWifiProv_Deinit( void );
/* @[declare_iotblewifiprov_delete] */

/* @[declare_iotblewifiprov_getserializer] */
IotBleWifiProvSerializer_t * IotBleWifiProv_GetSerializer( void );
/* @[declare_iotblewifiprov_getserializer] */

#endif /* _AWS_BLE_WIFI_PROVISIONING_H_ */