iot_wifi.h

Go to the documentation of this file.

/*
 * FreeRTOS WiFi V1.0.6
 * 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 _AWS_WIFI_H_
#define _AWS_WIFI_H_
 
#include <stdint.h>
 
/* FreeRTOS include for BaseType_t. */
#include "portmacro.h"
 
/* Wi-Fi configuration includes. */
#include "aws_wifi_config.h"
#include "types/iot_network_types.h"
 
typedef enum
{
    eWiFiSuccess = 0,      
    eWiFiFailure = 1,      
    eWiFiTimeout = 2,      
    eWiFiNotSupported = 3, 
} WIFIReturnCode_t;
 
typedef enum
{
    eWiFiSecurityOpen = 0,    
    eWiFiSecurityWEP,         
    eWiFiSecurityWPA,         
    eWiFiSecurityWPA2,        
    eWiFiSecurityWPA2_ent,    
    eWiFiSecurityNotSupported 
} WIFISecurity_t;
 
typedef enum
{
    eWiFiModeStation = 0, 
    eWiFiModeAP,          
    eWiFiModeP2P,         
    eWiFiModeNotSupported 
} WIFIDeviceMode_t;
 
typedef enum
{
    eWiFiPMNormal = 0,  
    eWiFiPMLowPower,    
    eWiFiPMAlwaysOn,    
    eWiFiPMNotSupported 
} WIFIPMMode_t;
 
typedef struct
{
    const char * pcSSID;      
    uint8_t ucSSIDLength;     
    const char * pcPassword;  
    uint8_t ucPasswordLength; 
    WIFISecurity_t xSecurity; 
    int8_t cChannel;          
} WIFINetworkParams_t;
 
typedef struct
{
    char cSSID[ wificonfigMAX_SSID_LEN + 1 ];   
    uint8_t ucBSSID[ wificonfigMAX_BSSID_LEN ]; 
    WIFISecurity_t xSecurity;                   
    int8_t cRSSI;                               
    int8_t cChannel;                            
    uint8_t ucHidden;                           
} WIFIScanResult_t;
 
typedef struct
{
    char cSSID[ wificonfigMAX_SSID_LEN + 1 ];           
    uint8_t ucSSIDLength;                               
    uint8_t ucBSSID[ wificonfigMAX_BSSID_LEN ];         
    char cPassword[ wificonfigMAX_PASSPHRASE_LEN + 1 ]; 
    uint8_t ucPasswordLength;                           
    WIFISecurity_t xSecurity;                           
} WIFINetworkProfile_t;
 
/* @[declare_wifi_wifi_on] */
WIFIReturnCode_t WIFI_On( void );
/* @[declare_wifi_wifi_on] */
 
/* @[declare_wifi_wifi_off] */
WIFIReturnCode_t WIFI_Off( void );
/* @[declare_wifi_wifi_off] */
 
/* @[declare_wifi_wifi_connectap] */
WIFIReturnCode_t WIFI_ConnectAP( const WIFINetworkParams_t * const pxNetworkParams );
/* @[declare_wifi_wifi_connectap] */
 
/* @[declare_wifi_wifi_disconnect] */
WIFIReturnCode_t WIFI_Disconnect( void );
/* @[declare_wifi_wifi_disconnect] */
 
/* @[declare_wifi_wifi_reset] */
WIFIReturnCode_t WIFI_Reset( void );
/* @[declare_wifi_wifi_reset] */
 
/* @[declare_wifi_wifi_setmode] */
WIFIReturnCode_t WIFI_SetMode( WIFIDeviceMode_t xDeviceMode );
/* @[declare_wifi_wifi_setmode] */
 
/* @[declare_wifi_wifi_getmode] */
WIFIReturnCode_t WIFI_GetMode( WIFIDeviceMode_t * pxDeviceMode );
/* @[declare_wifi_wifi_getmode] */
 
/* @[declare_wifi_wifi_networkadd] */
WIFIReturnCode_t WIFI_NetworkAdd( const WIFINetworkProfile_t * const pxNetworkProfile,
                                  uint16_t * pusIndex );
/* @[declare_wifi_wifi_networkadd] */
 
 
/* @[declare_wifi_wifi_networkget] */
WIFIReturnCode_t WIFI_NetworkGet( WIFINetworkProfile_t * pxNetworkProfile,
                                  uint16_t usIndex );
/* @[declare_wifi_wifi_networkget] */
 
/* @[declare_wifi_wifi_networkdelete] */
WIFIReturnCode_t WIFI_NetworkDelete( uint16_t usIndex );
/* @[declare_wifi_wifi_networkdelete] */
 
/* @[declare_wifi_wifi_ping] */
WIFIReturnCode_t WIFI_Ping( uint8_t * pucIPAddr,
                            uint16_t usCount,
                            uint32_t ulIntervalMS );
/* @[declare_wifi_wifi_ping] */
 
/* @[declare_wifi_wifi_getip] */
WIFIReturnCode_t WIFI_GetIP( uint8_t * pucIPAddr );
/* @[declare_wifi_wifi_getip] */
 
/* @[declare_wifi_wifi_getmac] */
WIFIReturnCode_t WIFI_GetMAC( uint8_t * pucMac );
/* @[declare_wifi_wifi_getmac] */
 
/* @[declare_wifi_wifi_gethostip] */
WIFIReturnCode_t WIFI_GetHostIP( char * pcHost,
                                 uint8_t * pucIPAddr );
/* @[declare_wifi_wifi_gethostip] */
 
/* @[declare_wifi_wifi_scan] */
WIFIReturnCode_t WIFI_Scan( WIFIScanResult_t * pxBuffer,
                            uint8_t ucNumNetworks );
/* @[declare_wifi_wifi_scan] */
 
/* @[declare_wifi_wifi_startap] */
WIFIReturnCode_t WIFI_StartAP( void );
/* @[declare_wifi_wifi_startap] */
 
/* @[declare_wifi_wifi_stopap] */
WIFIReturnCode_t WIFI_StopAP( void );
/* @[declare_wifi_wifi_stopap] */
 
/* @[declare_wifi_wifi_configureap] */
WIFIReturnCode_t WIFI_ConfigureAP( const WIFINetworkParams_t * const pxNetworkParams );
/* @[declare_wifi_wifi_configureap] */
 
/* @[declare_wifi_wifi_setpmmode] */
WIFIReturnCode_t WIFI_SetPMMode( WIFIPMMode_t xPMModeType,
                                 const void * pvOptionValue );
/* @[declare_wifi_wifi_setpmmode] */
 
/* @[declare_wifi_wifi_getpmmode] */
WIFIReturnCode_t WIFI_GetPMMode( WIFIPMMode_t * pxPMModeType,
                                 void * pvOptionValue );
/* @[declare_wifi_wifi_getpmmode] */
 
 
/* @[declare_wifi_wifi_registernetworkstatechangeeventcallback] */
WIFIReturnCode_t WIFI_RegisterNetworkStateChangeEventCallback( IotNetworkStateChangeEventCallback_t xCallback );
/* @[declare_wifi_wifi_registernetworkstatechangeeventcallback] */
 
/* @[declare_wifi_wifi_isconnected] */
BaseType_t WIFI_IsConnected( void );
/* @[declare_wifi_wifi_isconnected] */
 
 
#endif /* _AWS_WIFI_H_ */