Wifi Nodes
Use these nodes to utilize the wifi functionality of your micro controller.
Config Nodes
wifi
Enables internet connection using WiFi. Configure wifi settings using this node
Inputs
- mode : Select operating mode for Wifi interface
- sta channel : Specify the primary channel
- listen interval : Specify the listen interval
- pmf capable : Specify if the device supports pmf (protected management frames)
- pmf required : Specify if the device requires pmf (protected management frames)
- scan method : Select scan method
- failure retry count : Specify retry count
- sort method : Select sort method
- auth mode : Select auth mode
- wpa3 settings : Select type of WPA3 configuration
- transition disable : Specify whether to disable trnasition
- sae pwe h2e : Specify SAE PWE H2E
- sae pk mode : Select PK mode
- sae h2e identifier : Specify H2E identifier
- rssi limit : Select RSSI limit
- rssi : Specify RSSI
- radio settings : Select type of radio settings
- rm enabled : Specify if rm is enabled
- btm enabled : Specify is btm is enabled
- mbo enabled : Specify if mbo is enabled
- ft enabled : Specify if FT is enabled
- owe enabled : Specify if OWE is enabled
- phy modulation settings : Select type of phy modulation settings
- he dcm max constellation rx : Select constellation type for RX
- he dcm max constellation tx : Select constellation type for TX
- he dcm set : Specify if DCM is set
- he mcs9 enabled : Specify if cms9 is enabled
- he su beamformee disabled : Specify is SU beanformee is disabled
- he trig cqi feedback disabled : Specify if CQI feedback is disabled
- he trig mu bmforming partial feedback disabled : Specify is partial feedback for beam forming is disabled
- he trig su bmforming feedback disabled : Specify if beam forming feedback is disabled
- ap auth mode : Select auth mode as access point
- ap ssid : Specify ssid for ap
- ap password : Specify password for ap
- ap beacon interval : Specify beacon interval for ap
- ap channel : Specify primary channel for ap
- ftm responder enabled : Specify if FTM responder is enabled in ap
- ap max connections : Specify maximum number of connections ap can have
- ap pairwise cipher : Select pairwise cipher for ap
- ap pmf capable : Specify if the ap supports pmf (protected management frames)
- ap pmf required : Specify if the ap requires pmf (protected management frames)
- hide ssid : Specify if ap ssid should be hidden
- ap sae pwe h2e : Select PWE H2E for ap
- Initialise the wifi interface automatically : Whether to initialise the wifi interface automatically
- Initialise NETIF & EVT-LOOP : Whether to initialise netif & event loop
- Initialise NVS : whether to initialise nvs
Proc Nodes
wifi start
Connects to wifi using the specified credentials. Use this to manually connecting Wifi inside a flow in your own code sequence. Sends out success_code = 0 if successfully connected.
Inputs
- Wifi Config : Select the wifi config
- SSID : Specify ssid
- Password : Specify password
- Wifi retry : Specify number of retries
Outputs
- Success Code : Checks if the device connected to the access point successfully
wifi reconnect
Reconnects the wifi after it got disconnected. before using wifi reconnect wifi start should be used
Inputs
- Wifi Config : Select the wifi config
wifi init
Initialise the Wifi interface
Inputs
- wifi config : Select the wifi config
wifi deinit
Deinitialise the Wifi interface
Inputs
- wifi config : Select the wifi config
wifi start interface
Start the Wifi interface
Inputs
- wifi config : Select the wifi config
wifi stop interface
Stop the Wifi interface
Inputs
- wifi config : Select the wifi config
wifi sta disconnect from ap
Disconnect from the connected Access Point
Inputs
- wifi config : Select the wifi config
wifi restore default settings
Restores the wifi interface to default settings
Inputs
- wifi config : Select the wifi config
wifi sta clear all ap records
Clear all records from the previous ap scan
Inputs
- wifi config : Select the wifi config
wifi dump info
Dump all information regarding the wifi interface
Inputs
- wifi config : Select the wifi config
wifi sta stop ap scan
Stop searching for access points
Inputs
- wifi config : Select the wifi config
wifi set mode
Set a mode for the wifi interface
Inputs
- wifi config : Select the wifi config
- mode : Select operating mode for Wifi interface
wifi get mode
Get the active mode for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- mode : Active mode for the wifi interface
wifi sta connect to ap
attempt to connect to an access point
Inputs
- wifi config : Select the wifi config
- ssid : Specify ssid
- password : Specify password
- failure retry count : Specify retry count
Outputs
- connected : Checks if the device connected to the access point successfully
- rssi : RSSI (Received Signal Strength Indicator)
- assoc_id : Associated ID after connection
- phy_mode : Negotiated PHY mode
wifi sta reconnect to ap
attempt to reconnect to the previously connected access point
Inputs
- wifi config : Select the wifi config
Outputs
- connected : Checks if the device connected to the access point successfully
- rssi : RSSI (Received Signal Strength Indicator)
- assoc_id : Associated ID after connection
- phy_mode : Negotiated PHY mode
wifi sta start ap scan
Start scanning for available access points
Inputs
- wifi config : Select the wifi config
- channel : Specify channel to search
- ssid : Specify SSID if required
- ap mac id : Specify mac address of ap if needed
- show hidden ap : Choose to show hidden access points
- scan type : Select scan type
- min active scan time (ms) : Specify minimum active scan time in ms
- max active scan time (ms) : Specify maximum active scan time in ms
- passive scan time (ms) : Specify
wifi sta get ap num
Get number of discovered access points
Inputs
- wifi config : Select the wifi config
Outputs
- number of discovered ap : number of discovered access points
wifi sta get ap record
Get a single record from the list of discovered access points
Inputs
- wifi config : Select the wifi config
Outputs
- mac : mac address of ap
- ssid : ssid of ap
- rssi : rssi
- primary channel : primary channel of ap
- secondary channel type : secondary channel type of ap
- auth mode : authentication mode of ap
- pairwise cipher : pairwise cipher used by ap
- group cipher : group cipher used by ap
- antenna type : type of antenna used by ap
- mode 11b enabled : is 11b enabled by ap
- mode 11g enabled : is 11g enabled by ap
- mode 11n enabled : is 11n enabled by ap
- lr enabled : is lr enabled by ap
- mode 11ax enabled : is 11ax enabled by ap
- wps enabled : is wps enabled on ap
- ftm supported in responder mode : is ftm responder mode supported by ap
- ftm support in initiator mode : is ftm initiator mode supported by ap
- start channel : start channel for ap
- total channel number : total channel number for ap
- max transmission power : maximum transmission power of ap
- country policy : country policy of ap
wifi sta get all ap records
Get a list of all discovered access points
Inputs
- wifi config : Select the wifi config
- max records : Specify the maximum number of records to search
Outputs
- mac : mac address of ap
- ssid : ssid of ap
- rssi : rssi
- primary channel : primary channel of ap
- secondary channel type : secondary channel type of ap
- auth mode : authentication mode of ap
- pairwise cipher : pairwise cipher used by ap
- group cipher : group cipher used by ap
- antenna type : type of antenna used by ap
- mode 11b enabled : is 11b enabled by ap
- mode 11g enabled : is 11g enabled by ap
- mode 11n enabled : is 11n enabled by ap
- lr enabled : is lr enabled by ap
- mode 11ax enabled : is 11ax enabled by ap
- wps enabled : is wps enabled on ap
- ftm supported in responder mode : is ftm responder mode supported by ap
- ftm support in initiator mode : is ftm initiator mode supported by ap
- start channel : start channel for ap
- total channel number : total channel number for ap
- max transmission power : maximum transmission power of ap
- country policy : country policy of ap
wifi set power saving mode
Set a power saving mode for the wifi interface
Inputs
- wifi config : Select the wifi config
- power saving mode : Select power saving mode
wifi get power saving mode
Get current power saving mode of the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- power saving mode : power saving type
wifi set protocol
Set communication protocol for the wifi interface
Inputs
- wifi config : Select the wifi config
- protocol 11b enabled : Specify if 11B is enabled
- protocol 11g enabled : Specify if 11G is enabled
- protocol 11n enabled : Specify if 11N is enabled
- protocol lr enabled : Specify if LR is enabled
- protocol 11ax enabled : Specify if 11AX is enabled
wifi get protocol
Get current communication protocol settings of the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- protocol 11b enabled : is 11b enabled
- protocol 11g enabled : is 11g enabled
- protocol 11n enabled : is 11n enabled
- protocol low rate enabled : is lr enabled
- protocol 11ax enabled : is 11ax enabled
wifi set bandwidth
Set a bandwidth for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
- bandwidth : Select bandwidth
wifi get bandwidth
Get bandwidth of the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
Outputs
- bandwidth : bandwidth
wifi set channel
Set a channel for the wifi interface
Inputs
- wifi config : Select the wifi config
- primary channel : The primary channel to be used by the wifi interface
- secondary channel : Select secondary channel type
wifi get channel
Get channel information for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- primary channel : Primary Channel
- secondary channel : Secondary Channel Type
wifi set country
Set a country for the wifi interface
Inputs
- wifi config : Select the wifi config
- country code : Specify the country code (01 means universal)
- start channel : Specify the start channel
- total channel number : Specify the total channel number
- max transmission power : Specify the maximum transmission power
- country policy : Select method of using country policy
wifi get country
Get country information for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- country code : Country Code
- start channel : Start Channel
- total channel number : Total Channel Number
- max transmission power : Maximum Transmission Power
- country policy : Country Policy
wifi set mac
Assign a MAC address to the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
Outputs
- mac : mac address of the device
wifi enable promiscuous mode
Enable promiscuous mode the wifi interface
Inputs
- wifi config : Select the wifi config
wifi disable promiscuous mode
Disable promiscuous mode the wifi interface
Inputs
- wifi config : Select the wifi config
wifi get promiscuous mode status
Get promiscuous mode status the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- enabled : Checks if promiscuous mode is enabled
wifi set promiscuous mode filter
Set a filter mask for promiscuous mode of the wifi interface
Inputs
- wifi config : Select the wifi config
- filter mask : Specify a filter mask
wifi set promiscuous mode ctrl filter
Set a filter mask for promiscuous mode for control frame packets
Inputs
- wifi config : Select the wifi config
- filter mask : Specify a filter mask
wifi get promiscuous mode filter
Get the filter mask for promiscuous mode
Inputs
- wifi config : Select the wifi config
Outputs
- filter mask : Specify a filter mask
wifi get promiscuous mode ctrl filter
Get the filter mask for promiscuous mode for control frame packets
Inputs
- wifi config : Select the wifi config
Outputs
- filter mask : Specify a filter mask
wifi ap disconnect from sta
Disconnect from a connected station/s
Inputs
- wifi config : Select the wifi config
- disconnect sta : Select device to disconnect from
- assoc id : Specify the association id of a connected station
wifi sta get connected ap info
Get information about the connected access point
Inputs
- wifi config : Select the wifi config
Outputs
- mac address : mac address of ap
- ssid : ssid of ap
- primary channel : primary channel of ap
- secondary channel type : secondary channel type of ap
- rssi : rssi
- auth mode : authentication mode of ap
- pairwise cipher : pairwise cipher used by ap
- group cipher : group cipher used by ap
- antenna used : type of antenna used by ap
- phy 11b mode enabled : is 11b enabled by ap
- phy 11g mode enabled : is 11g enabled by ap
- phy 11n mode enabled : is 11n enabled by ap
- phy lr enabled : is lr enabled by ap
- phy 11ax mode enabled : is 11ax enabled by ap
- wps supported : is wps enabled on ap
- ftm responder mode supported : is ftm responder mode supported by ap
- ftm initiator mode supported : is ftm initiator mode supported by ap
wifi ap get connected sta list
Get a list of connected stations
Inputs
- wifi config : Select the wifi config
Outputs
- connected devices : number of connected devices
- mac address : list of mac address of the devices
- rssi : list of rssi
- phy 11b mode enabled : is 11b enabled for the devices
- phy 11g mode enabled : is 11g enabled for the devices
- phy 11n mode enabled : is 11n enabled for the devices
- phy low rate enabled : is low rate enabled for the devices
- phy 11ax enabled : is 11ax enabled for the devices
- is mesh child : is device a mesh child
wifi ap get connected sta assoc id
Get association id of a connected station
Inputs
- wifi config : Select the wifi config
- mac address : Specify the mac address of the connected device
Outputs
- assoc id : Association id of the connected device
- ssid : ssid of the connected device
- primary channel : primary channel of the connected device
- secondary channel type : secondary channel type of connected device
- rssi : rssi
- auth mode : authentication mode of connected device
- pairwise cipher : pairwise cipher used by connected device
- group cipher : group cipher used by connected device
- antenna used : type of antenna used by connected device
- phy 11b mode enabled : is 11b enabled for the device
- phy 11g mode enabled : is 11g enabled for the device
- phy 11n mode enabled : is 11n enabled for the device
- phy lr enabled : is low rate enabled for the device
- phy 11ax mode enabled : is 11ax enabled for the device
- wps supported : is wps enabled for the device
- ftm responder mode supported : is ftm responder mode supported by the connected device
- ftm initiator mode supported : is ftm initiator mode supported by the connected device
wifi set storage
Set storage type for the wifi interface
Inputs
- wifi config : Select the wifi config
- storage type : Select type of storage
wifi get storage
Get the storage type for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- storage type : Type of storage
wifi set maximum transmission power
Set maximum transmission power for the wifi interface
Inputs
- wifi config : Select the wifi config
- power (in dBm) : Specify the maximum transmission power to be used by the device (in dBm)
wifi get maximum transmission power
Get the maximum transmission power for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- maximum transmission power : Maximum Transmission Power
wifi set event mask
Set event mask for the wifi interface
Inputs
- wifi config : Select the wifi config
- event mask : Specify an event mask
wifi get event mask
Get the event mask for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- event mask : event mask
wifi set inactive time
Set inactive time for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
- inactive time (s) : Specify the inactive time
wifi get inactive time
Get the inactive time for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
Outputs
- inactive time : inactive time
wifi set rssi threshold
Set rssi threshold for the wifi interface
Inputs
- wifi config : Select the wifi config
- rssi : Specify the RSSI threshold
wifi get rssi threshold
Get the inactive time for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- rssi : rssi threshold
wifi set 11b rate
Set 11b rate for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
- enable : Specify if 11B is enabled
wifi get 11b rate
Get the status of 11b rate for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
Outputs
- enabled : is 11b enabled
wifi set wake interval
Set wake interval for the wifi interface
Inputs
- wifi config : Select the wifi config
- wake interval : Specify wake interval
wifi get wake interval
Get the wake interval for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- wake interval : Wake Interval
wifi set country code
Set country code for the wifi interface
Inputs
- wifi config : Select the wifi config
- country code : Specify the country code (01 means universal)
- get country code from ap : Specify if country code should be taken from ap
wifi get country code
Get country code for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- country code : Country Code
wifi set 80211 transmission rate
Set transmission rate for raw 80211 packets for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
- transmission rate : Specify the tranmission rate
wifi get 80211 transmission rate
Get transmission rate for raw 80211 packets for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
Outputs
- fixed transmission rate : Checks if transmission rate is fixed
- transmission rate : Transmission Rate
wifi enable dynamic carrier sense
Enable dynamic carrier sense for the wifi interface
Inputs
- wifi config : Select the wifi config
wifi disable dynamic carrier sense
Disable dynamic carrier sense for the wifi interface
Inputs
- wifi config : Select the wifi config
wifi get dynamic carrier sense status
Get status of dynamic carrier sense for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- enabled : Checks if dynamic carrier sense is enabled
wifi disable pmf config
Disable pmf configuration for the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
wifi sta get assoc id
Get association id for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- aid : Get the association id from ap
wifi sta get negotiated phy mode
Get negotiated phy mode for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- phy mode : Negotiated PHY mode
wifi sta get rssi of ap
Get rssi of ap for the wifi interface
Inputs
- wifi config : Select the wifi config
Outputs
- rssi : RSSI
wifi set vendor ie
Set vendor ie for the wifi interface
Inputs
- wifi config : Select the wifi config
- enable vendor ie : Select if vendor ie should be enabled or not
- ie type : Select the IE Type
- vendor ie idx : Select the vendor ie index
- element id : Specify the element id
- vendor oui type : Specify the vendor oui type
- vendor oui : Specufy the vendor oui
- payload length : Specify the payload length
- payload : Provide the payload
wifi transmit raw 80211 packet
Transmit a raw 802.11 packet via the wifi interface
Inputs
- wifi config : Select the wifi config
- interface : Select the wifi interface mode
- enable system sequence number : Specify if system generated sequence number is to be used
- buffer length : Specify the buffer length
- buffer : Provide a buffer to transmit
wifi set csi config
Set configuration parameters for Channel State Information.
Inputs
- wifi config : Select the wifi config
- Enable CSI : Enable CSI
- Allow receiving LLTA data : Allow receiving LLTA data
- Allow receiving HTLTF data : Allow receiving HTLTF data
- Allow receiving HTLTF2 data : Allow receiving HTLTF2 data
- Generate HLTF data : Generate HLTF data
- Enable channel filter : Enable channel filter
- Manually scale csi data : Manually scale csi data
- CSI bit shifts : CSI bit shifts
- Dump ACK frames : Dump ACK frames
wifi get csi config
Get the configuration for Channel State Information for the wifi interface
Inputs
- config : Select the wifi config
Outputs
- csi enabled : csi enabled
- receive lltf data : receive lltf data
- recieve htltf data : recieve htltf data
- recieve stbc htltf2 data : recieve stbc htltf2 data
- generate hltf data : generate hltf data
- enable channel filter : enable channel filter
- manually scale csi data : manually scale csi data
- manual scale csi bit shifts : manual scale csi bit shifts
- dump ack frames : dump ack frames
wifi set antenna config
Set the antenna configuration for the wifi interface
Inputs
- config : Select the wifi config
- receiver antenna mode : Reciever Antenna Mode
- receiver antenna default : Default Reciever Antenna
- transmitter antenna mode : Reciever Antenna Mode
- index enabled ant0 : Index enabled for ANT0
- index enabled ant1 : Index enabled for ANT1
wifi get antenna config
Get the antenna configuration for the wifi interface
Inputs
- config : Select the wifi config
Outputs
- receiver antenna mode : receiver antenna mode
- receiver antenna default : default receiver antenna
- transmitter antenna mode : transmitter antenna mode
- index enabled ant0 : index enabled for ant0
- index enabled ant1 : index enabled for ant1
wifi set antenna gpio config
Set the antenna gpio configuration for the wifi interface
Inputs
- config : Select the wifi config
- ant 0 connected : antenna gpio 0 connected
- ant 0 gpio pin : antenna gpio 0 pin number
- ant 1 connected : antenna gpio 1 connected
- ant 1 gpio pin : antenna gpio 1 pin number
- ant 2 connected : antenna gpio 2 connected
- ant 2 gpio pin : antenna gpio 2 pin number
- ant 3 connected : antenna gpio 3 connected
- ant 3 gpio pin : antenna gpio 3 pin number
wifi get antenna gpio config
Get the antenna gpio configuration for the wifi interface
Inputs
- config : Select the wifi config
Outputs
- ant 0 connected : antenna gpio 0 connected
- ant 0 gpio pin : antenna gpio 0 pin number
- ant 1 connected : antenna gpio 1 connected
- ant 1 gpio pin : antenna gpio 1 pin number
- ant 2 connected : antenna gpio 2 connected
- ant 2 gpio pin : antenna gpio 2 pin number
- ant 3 connected : antenna gpio 3 connected
- ant 3 gpio pin : antenna gpio 3 pin number
wifi get tsf time
Get the TSF time for wifi interface
Inputs
- config : Select the wifi config
- interface : wifi interface
Outputs
- tsf time : TSF (Timing Synchronization Function) time
wifi ftm initiate session
Initate a FTM session
Inputs
- config : Select the wifi config
- responder mac : MAC address of FTM Responder
- responder primary channel : Primary channel of the responder
- requested frame counts : Requested frame counts
- burst period : Burst Period
- use get report api : Use the get report api instead of relying the ftm wifi event
wifi ftm end session
End a FTM session
Inputs
- config : Select the wifi config
wifi ftm resp set offset
Set offset as a FTM Responder
Inputs
- config : Select the wifi config
- offset cm : Offset distance (in cm)
wifi force wakeup acquire
Acquire force wakeup of the wifi interface
Inputs
- config : Select the wifi config
wifi force wakeup release
Release force wakeup of the wifi interface
Inputs
- config : Select the wifi config
Event Nodes
on wifi status change
Sends event when wifi gets changed.
Inputs
- Wifi Config : Select the wifi config
- Event Type : Select the wifi event
wifi on network packet received
When a network packet is recieved by the wifi interface in promiscuous mode
Inputs
- config : Select the wifi config
Outputs
- pkt type : Network Packet Type
- pkt len : Buffer Length
- fctl : Frame Control Number
- duration : Duration
- destination address : Destination MAC address
- source address : Source MAC Address
- bssid : Sender MAC Address
- seqctl : Sequence Control Number
- payload : Received Raw Buffer
wifi on vendor ie data received
When a vendor ie packet is recieved by the wifi interface
Inputs
- config : Select the wifi config
Outputs
- source mac address : Source MAC address
- rssi : RSSI
- ie type : IE Type
- element id : Element ID
- vendor oui : Vendor OUI
- vendor oui type : Vendor OUI Type
- payload length : Buffer Length
- payload : Received Raw Buffer
wifi on csi data received
When a csi data packet is recieved by the wifi interface
Inputs
- config : Select the wifi config
Outputs
- source mac : Source MAC address
- destination mac : Destination MAC address
- first word invalid : Checks if first word is invalid
- buf : Received Raw Buffer
- len : Buffer Length
wifi on ftm report received
When a ftm report is recieved by the wifi interface
Inputs
- config : Select the wifi config
Outputs
- dialog token : Dialog Token
- rssi : RSSI
- rtt : Round Trip Time
- t1 : Time of departure of FTM frame from FTM Responder in pSec
- t2 : Time of arrival of FTM frame at FTM Initiator in pSec
- t3 : Time of departure of ACK from FTM Initiator in pSec
- t4 : Time of arrival of ACK at FTM Responder in pSec
Glossary
Promiscuous mode : Promiscuous mode is a network setting that allows a device to read and capture all network traffic, not just the traffic addressed to it.