Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Wi-Fi bibliothèque

Présentation de

La bibliothèque Wi-FiFreeRTOS extrait les implémentations Wi-Fi spécifiques aux ports dans une API commune qui simplifie le développement et le portage des applications pour toutes les cartes dotées de fonctionnalités. FreeRTOS-qualified Wi-Fi À l'aide de cette API courante, les applications peuvent communiquer avec leur pile sans fil de niveau inférieur via une interface commune.

Dépendances et exigences

La bibliothèque FreeRTOS nécessite le Wi-Fi noyau FreeRTOS+TCP.

Caractéristiques

La Wi-Fi bibliothèque inclut les fonctionnalités suivantes :

Pour plus d'informations sur les fonctionnalités de la Wi-Fi bibliothèque, voir ci-dessous.

Wi-Fi modes

Wi-Fi les appareils peuvent être dans l'un des trois modes suivants : station, point d'accès ou P2P. Vous pouvez obtenir le mode actuel d'un Wi-Fi appareil en appelantWIFI_GetMode. Vous pouvez définir le mode Wi-Fi d'un appareil Wi-Fi en appelant WIFI_SetMode. Le changement de mode en appelant WIFI_SetMode déconnecte l'appareil, s'il est déjà connecté à un réseau.

Sécurité

L' Wi-Fi API prend en charge les types de sécurité WEP, WPA, WPA2 et WPA3. Lorsqu'un appareil se trouve en mode Station, vous devez spécifier le type de sécurité réseau lors de l'appel de la fonction WIFI_ConnectAP. Lorsqu'un appareil est en mode AP, l'appareil peut être configuré pour utiliser n'importe lequel des types de sécurité pris en charge :

Analyse et connexion

Pour rechercher des points d'accès à proximité, configurez votre appareil en mode Station et appelez la fonction WIFI_Scan. Si vous trouvez un certain réseau dans l'analyse, vous pouvez vous y connecter en appelant WIFI_ConnectAP et en fournissant les informations d'identification du réseau. Vous pouvez déconnecter un Wi-Fi appareil du réseau en appelantWIFI_Disconnect. Pour plus d'informations sur l'analyse et la connexion, consultez Exemple d’utilisation et Référence des API.

Gestion de l'alimentation

Les différents Wi-Fi appareils ont des besoins en énergie différents, en fonction de l'application et des sources d'alimentation disponibles. Un appareil peut toujours être allumé pour réduire la latence ou il peut être connecté par intermittence et passer en mode basse consommation lorsque cela n' Wi-Fi est pas nécessaire. L'API d'interface prend en charge divers modes de gestion de l'alimentation, comme toujours activée, alimentation basse et mode normal. Vous définissez le mode d'alimentation d'un appareil à l'aide de la fonction WIFI_SetPMMode. Vous pouvez obtenir le mode d'alimentation en cours d'un appareil Wi-Fi en appelant la fonction WIFI_GetPMMode.

Profils réseau

La Wi-Fi bibliothèque vous permet d'enregistrer des profils réseau dans la mémoire non volatile de vos appareils. Cela vous permet d'enregistrer les paramètres réseau afin qu'ils puissent être récupérés lorsqu'un appareil se reconnecte à un Wi-Fi réseau, éliminant ainsi le besoin de réapprovisionner les appareils une fois qu'ils ont été connectés à un réseau. WIFI_NetworkAddajoute un profil réseau. WIFI_NetworkGetrécupère un profil réseau. WIFI_NetworkDelsupprime un profil réseau. Le nombre de profils que vous pouvez enregistrer dépend de la plateforme.

Configuration

Pour utiliser la Wi-Fi bibliothèque, vous devez définir plusieurs identifiants dans un fichier de configuration. Pour plus d'informations sur ces identifiants, consultez Référence des API.

Initialisation

Avant d'utiliser la Wi-Fi bibliothèque, vous devez initialiser certains composants spécifiques à la carte, en plus des composants FreeRTOS. En utilisant le fichier vendors/vendor/boards/board/aws_demos/application_code/main.c comme modèle pour l'initialisation, procédez de la façon suivante :

Référence des API

Pour une référence complète sur les API, consultez la section Référence des Wi-Fi API.

Exemple d’utilisation

Connexion à un point d'accès connu

#define clientcredentialWIFI_SSID    "MyNetwork"
#define clientcredentialWIFI_PASSWORD   "hunter2"

WIFINetworkParams_t xNetworkParams;
WIFIReturnCode_t xWifiStatus;

xWifiStatus = WIFI_On(); // Turn on Wi-Fi module

// Check that Wi-Fi initialization was successful
if( xWifiStatus == eWiFiSuccess )
{
    configPRINT( ( "WiFi library initialized.\n") );
}
else
{
    configPRINT( ( "WiFi library failed to initialize.\n" ) );
    // Handle module init failure
}

/* Setup parameters. */
xNetworkParams.pcSSID = clientcredentialWIFI_SSID;
xNetworkParams.ucSSIDLength = sizeof( clientcredentialWIFI_SSID );
xNetworkParams.pcPassword = clientcredentialWIFI_PASSWORD;
xNetworkParams.ucPasswordLength = sizeof( clientcredentialWIFI_PASSWORD );
xNetworkParams.xSecurity = eWiFiSecurityWPA2;

// Connect!
xWifiStatus = WIFI_ConnectAP( &( xNetworkParams ) );

if( xWifiStatus == eWiFiSuccess )
{
    configPRINT( ( "WiFi Connected to AP.\n" ) );
    // IP Stack will receive a network-up event on success
}
else
{
    configPRINT( ( "WiFi failed to connect to AP.\n" ) );
    // Handle connection failure
}

Recherche des points d'accès à proximité

WIFINetworkParams_t xNetworkParams;
WIFIReturnCode_t xWifiStatus;

configPRINT( ("Turning on wifi...\n") );
xWifiStatus = WIFI_On();

configPRINT( ("Checking status...\n") );
if( xWifiStatus == eWiFiSuccess )
{
    configPRINT( ("WiFi module initialized.\n") );
}
else
{
    configPRINTF( ("WiFi module failed to initialize.\n" ) );
    // Handle module init failure
}

WIFI_SetMode(eWiFiModeStation);

/* Some boards might require additional initialization steps to use the Wi-Fi library. */

while (1)
{
    configPRINT( ("Starting scan\n") );
    const uint8_t ucNumNetworks = 12; //Get 12 scan results
    WIFIScanResult_t xScanResults[ ucNumNetworks ];
    xWifiStatus = WIFI_Scan( xScanResults, ucNumNetworks ); // Initiate scan

    configPRINT( ("Scan started\n") );

    // For each scan result, print out the SSID and RSSI
    if ( xWifiStatus == eWiFiSuccess )
    {
        configPRINT( ("Scan success\n") );
        for ( uint8_t i=0; i<ucNumNetworks; i++ ) 
        {
            configPRINTF( ("%s : %d \n", xScanResults[i].cSSID, xScanResults[i].cRSSI) );
        }
    } else {
        configPRINTF( ("Scan failed, status code: %d\n", (int)xWifiStatus) );
    }
    
    vTaskDelay(200);
}

Portage

L'implémentation iot_wifi.c nécessite l'implémentation des fonctions définies dans iot_wifi.h. Au minimum, l'implémentation doit retourner eWiFiNotSupported pour toute fonction non essentielle ou non prise en charge.

Pour plus d'informations sur le portage de la Wi-Fi bibliothèque, voir Portage de la Wi-Fi bibliothèque dans le Guide de portage de FreeRTOS.