blob: 21bf90941b4772700feea3807d4dcc36bbdb0bc0 [file] [log] [blame]
/*
*
* Copyright (c) 2023 Project CHIP Authors
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
//*****************************************************************************
// Includes
//*****************************************************************************
#pragma once
//*****************************************************************************
// WIFI IF INTRODUCTION
//*****************************************************************************
/* This module enables an easy integration of Wi-Fi to a SimpleLink Networking
* framework.
* It was designed for applications that use the Wi-Fi Station role only.
* The simple API and settings enables the user to initiate the Wi-Fi and
* configure the provisioning method that will be used upon first connection
* attempt.
* Upon successful init (WIFI_IF_init()), the system enables the NWP for any
* SL commands.
* The NWP will be in a low power state (AUTO-CONNECT will be disabled) waiting
* for connection request (SlNetConn_Start()).
* User should not call sl_Start/sl_Stop when using this module. Please use
* WIFI_IF_restart() (for reseting the NWP) or WIFI_IF_deinit() instead.
*/
//*****************************************************************************
// WIFI IF USER SETTINGS
//*****************************************************************************
/*
* Defines the minimum severity level allowed.
* Use E_DEBUG to enable Wifi internal messages
* Options: E_TRACE, E_DEBUG, E_INFO, E_WARNING, E_ERROR, E_FATAL
*/
#define WIFI_IF_DEBUG_LEVEL E_INFO
/*
* Defines Provisioning (initial) Parameters:
* Mode can be: WifiProvMode_OFF, WifiProvMode_ON, WifiProvMode_ONE_SHOT
* Command can be one of the following:
* SL_WLAN_PROVISIONING_CMD_START_MODE_AP,
* SL_WLAN_PROVISIONING_CMD_START_MODE_SC,
* SL_WLAN_PROVISIONING_CMD_START_MODE_APSC,
* SL_WLAN_PROVISIONING_CMD_START_MODE_APSC_EXTERNAL_CONFIGURATION,
* SL_WLAN_PROVISIONING_CMD_START_MODE_EXTERNAL_CONFIGURATION
*/
#define PROVISIONING_MODE WifiProvMode_ONE_SHOT
#define PROVISIONING_CMD SL_WLAN_PROVISIONING_CMD_START_MODE_APSC
/*
* Defines Provisioning AP /SC Parameters:
*/
#define PROVISIONING_TIMEOUT 0 // 0 - use default
#define PROVISIONING_AP_PASSWORD "1234567890" // NULL - use default (OPEN)
#define PROVISIONING_SC_KEY "1234567890123456" // NULL - use defaults
/* Force provisioning by deleting existing profiles.
* To be used for testing during development only.
* Note: When FORCE_PROVSIONING is enabled - the following static profile
* configurations are ignored
*/
#define FORCE_PROVISIONING (0)
/* Static Profile setting - Method 1: Hard coded
* Define AP_SSID and optionally AP_PASSWORD - to connect to local network
* Hard-Coded Definition: update AP_SSID and AP_PASSWORD (NULL means OPEN, else is WPA2)
*/
#define AP_SSID NULL // "network-name"
#define AP_PASSWORD NULL // "network-password"
/* Static Profile setting - Method 2: Configuration file
* File format should be:
* "<network-name>' '<network-password>"
* i.e. ssid and password with one space character between them
* Do not use newline, extra space symbols or quotation mark
*/
#define AP_CFG_FILENAME "network.cfg" // config file name
#define AP_CFG_TOKEN 12345678 // config file read access token
#define AP_CFG_MAX_SIZE 100 // config file Maximum file length
/* Define (if needed) the external handle for TI Driver's LED for wi-fi status:
* off: disconnected, blinking: provisionig, on: connected
* Comment the definition in case the auto control is not required */
#define WIFI_LED_HANDLE gLedBlueHandle