CMSIS-Driver  
Peripheral Interface for Middleware and Application Code
 
Loading...
Searching...
No Matches
Macros
WiFi Option Codes
WiFi Interface » WiFi Management

WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. More...

Macros

#define ARM_WIFI_BSSID   1U
 Station/AP Set/Get BSSID of AP to connect or of AP; data = &bssid, len = 6, uint8_t[6].
 
#define ARM_WIFI_TX_POWER   2U
 Station/AP Set/Get transmit power; data = &power, len = 4, uint32_t: 0 .. 20 [dBm].
 
#define ARM_WIFI_LP_TIMER   3U
 Station Set/Get low-power deep-sleep time; data = &time, len = 4, uint32_t [seconds]: 0 = disable (default)
 
#define ARM_WIFI_DTIM   4U
 Station/AP Set/Get DTIM interval; data = &dtim, len = 4, uint32_t [beacons].
 
#define ARM_WIFI_BEACON   5U
 AP Set/Get beacon interval; data = &interval, len = 4, uint32_t [ms].
 
#define ARM_WIFI_MAC   6U
 Station/AP Set/Get MAC; data = &mac, len = 6, uint8_t[6].
 
#define ARM_WIFI_IP   7U
 Station/AP Set/Get IPv4 static/assigned address; data = &ip, len = 4, uint8_t[4].
 
#define ARM_WIFI_IP_SUBNET_MASK   8U
 Station/AP Set/Get IPv4 subnet mask; data = &mask, len = 4, uint8_t[4].
 
#define ARM_WIFI_IP_GATEWAY   9U
 Station/AP Set/Get IPv4 gateway address; data = &ip, len = 4, uint8_t[4].
 
#define ARM_WIFI_IP_DNS1   10U
 Station/AP Set/Get IPv4 primary DNS address; data = &ip, len = 4, uint8_t[4].
 
#define ARM_WIFI_IP_DNS2   11U
 Station/AP Set/Get IPv4 secondary DNS address; data = &ip, len = 4, uint8_t[4].
 
#define ARM_WIFI_IP_DHCP   12U
 Station/AP Set/Get IPv4 DHCP client/server enable/disable; data = &dhcp, len = 4, uint32_t: 0 = disable, non-zero = enable (default)
 
#define ARM_WIFI_IP_DHCP_POOL_BEGIN   13U
 AP Set/Get IPv4 DHCP pool begin address; data = &ip, len = 4, uint8_t[4].
 
#define ARM_WIFI_IP_DHCP_POOL_END   14U
 AP Set/Get IPv4 DHCP pool end address; data = &ip, len = 4, uint8_t[4].
 
#define ARM_WIFI_IP_DHCP_LEASE_TIME   15U
 AP Set/Get IPv4 DHCP lease time; data = &time, len = 4, uint32_t [seconds].
 
#define ARM_WIFI_IP6_GLOBAL   16U
 Station/AP Set/Get IPv6 global address; data = &ip6, len = 16, uint8_t[16].
 
#define ARM_WIFI_IP6_LINK_LOCAL   17U
 Station/AP Set/Get IPv6 link local address; data = &ip6, len = 16, uint8_t[16].
 
#define ARM_WIFI_IP6_SUBNET_PREFIX_LEN   18U
 Station/AP Set/Get IPv6 subnet prefix length; data = &len, len = 4, uint32_t: 1 .. 127.
 
#define ARM_WIFI_IP6_GATEWAY   19U
 Station/AP Set/Get IPv6 gateway address; data = &ip6, len = 16, uint8_t[16].
 
#define ARM_WIFI_IP6_DNS1   20U
 Station/AP Set/Get IPv6 primary DNS address; data = &ip6, len = 16, uint8_t[16].
 
#define ARM_WIFI_IP6_DNS2   21U
 Station/AP Set/Get IPv6 secondary DNS address; data = &ip6, len = 16, uint8_t[16].
 
#define ARM_WIFI_IP6_DHCP_MODE   22U
 Station/AP Set/Get IPv6 DHCPv6 client mode; data = &mode, len = 4, uint32_t: ARM_WIFI_IP6_DHCP_xxx (default Off)
 

Description

WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function.

Many parameters of the WiFi module are configured using the ARM_WIFI_SetOption or ARM_WIFI_GetOption function.

Macro Definition Documentation

◆ ARM_WIFI_BSSID

#define ARM_WIFI_BSSID   1U

Station/AP Set/Get BSSID of AP to connect or of AP; data = &bssid, len = 6, uint8_t[6].

Specifies the BSSID of the access point to connect or the access point itself.

See also
WiFi Option Codes

◆ ARM_WIFI_TX_POWER

#define ARM_WIFI_TX_POWER   2U

Station/AP Set/Get transmit power; data = &power, len = 4, uint32_t: 0 .. 20 [dBm].

Specifies the transmit power in dBm.

See also
WiFi Option Codes

◆ ARM_WIFI_LP_TIMER

#define ARM_WIFI_LP_TIMER   3U

Station Set/Get low-power deep-sleep time; data = &time, len = 4, uint32_t [seconds]: 0 = disable (default)

Specifies the low-power deep-sleep time in seconds for station (disabled when 0 - default).

See also
WiFi Option Codes

◆ ARM_WIFI_DTIM

#define ARM_WIFI_DTIM   4U

Station/AP Set/Get DTIM interval; data = &dtim, len = 4, uint32_t [beacons].

Specifies the DTIM interval in number of beacons.

See also
WiFi Option Codes

◆ ARM_WIFI_BEACON

#define ARM_WIFI_BEACON   5U

AP Set/Get beacon interval; data = &interval, len = 4, uint32_t [ms].

Specifies the beacon interval in milliseconds for access point.

See also
WiFi Option Codes

◆ ARM_WIFI_MAC

#define ARM_WIFI_MAC   6U

Station/AP Set/Get MAC; data = &mac, len = 6, uint8_t[6].

Specifies the MAC address.

See also
WiFi Option Codes

◆ ARM_WIFI_IP

#define ARM_WIFI_IP   7U

Station/AP Set/Get IPv4 static/assigned address; data = &ip, len = 4, uint8_t[4].

Specifies the IP address.

See also
WiFi Option Codes

◆ ARM_WIFI_IP_SUBNET_MASK

#define ARM_WIFI_IP_SUBNET_MASK   8U

Station/AP Set/Get IPv4 subnet mask; data = &mask, len = 4, uint8_t[4].

Specifies the subnet mask.

See also
WiFi Option Codes

◆ ARM_WIFI_IP_GATEWAY

#define ARM_WIFI_IP_GATEWAY   9U

Station/AP Set/Get IPv4 gateway address; data = &ip, len = 4, uint8_t[4].

Specifies the gateway IP address.

See also
WiFi Option Codes

◆ ARM_WIFI_IP_DNS1

#define ARM_WIFI_IP_DNS1   10U

Station/AP Set/Get IPv4 primary DNS address; data = &ip, len = 4, uint8_t[4].

Specifies the IP address of the primary DNS server.

See also
WiFi Option Codes

◆ ARM_WIFI_IP_DNS2

#define ARM_WIFI_IP_DNS2   11U

Station/AP Set/Get IPv4 secondary DNS address; data = &ip, len = 4, uint8_t[4].

Specifies the IP address of the secondary DNS server.

See also
WiFi Option Codes

◆ ARM_WIFI_IP_DHCP

#define ARM_WIFI_IP_DHCP   12U

Station/AP Set/Get IPv4 DHCP client/server enable/disable; data = &dhcp, len = 4, uint32_t: 0 = disable, non-zero = enable (default)

Enables or disables the DHCP client for station or DHCP server for access point.

See also
WiFi Option Codes

◆ ARM_WIFI_IP_DHCP_POOL_BEGIN

#define ARM_WIFI_IP_DHCP_POOL_BEGIN   13U

AP Set/Get IPv4 DHCP pool begin address; data = &ip, len = 4, uint8_t[4].

Specifies the start IP address for DHCP server (access point).

See also
WiFi Option Codes

◆ ARM_WIFI_IP_DHCP_POOL_END

#define ARM_WIFI_IP_DHCP_POOL_END   14U

AP Set/Get IPv4 DHCP pool end address; data = &ip, len = 4, uint8_t[4].

Specifies the end IP address for DHCP server (access point).

See also
WiFi Option Codes

◆ ARM_WIFI_IP_DHCP_LEASE_TIME

#define ARM_WIFI_IP_DHCP_LEASE_TIME   15U

AP Set/Get IPv4 DHCP lease time; data = &time, len = 4, uint32_t [seconds].

Specifies the lease time for DHCP server (access point).

See also
WiFi Option Codes

◆ ARM_WIFI_IP6_GLOBAL

#define ARM_WIFI_IP6_GLOBAL   16U

Station/AP Set/Get IPv6 global address; data = &ip6, len = 16, uint8_t[16].

Specifies the global IPv6 address.

See also
WiFi Option Codes

◆ ARM_WIFI_IP6_LINK_LOCAL

#define ARM_WIFI_IP6_LINK_LOCAL   17U

Station/AP Set/Get IPv6 link local address; data = &ip6, len = 16, uint8_t[16].

Specifies the link-local IPv6 address.

See also
WiFi Option Codes

◆ ARM_WIFI_IP6_SUBNET_PREFIX_LEN

#define ARM_WIFI_IP6_SUBNET_PREFIX_LEN   18U

Station/AP Set/Get IPv6 subnet prefix length; data = &len, len = 4, uint32_t: 1 .. 127.

Specifies the address prefix length.

See also
WiFi Option Codes

◆ ARM_WIFI_IP6_GATEWAY

#define ARM_WIFI_IP6_GATEWAY   19U

Station/AP Set/Get IPv6 gateway address; data = &ip6, len = 16, uint8_t[16].

Specifies the gateway IPv6 address.

See also
WiFi Option Codes

◆ ARM_WIFI_IP6_DNS1

#define ARM_WIFI_IP6_DNS1   20U

Station/AP Set/Get IPv6 primary DNS address; data = &ip6, len = 16, uint8_t[16].

Specifies the IPv6 address of the primary DNS server.

See also
WiFi Option Codes

◆ ARM_WIFI_IP6_DNS2

#define ARM_WIFI_IP6_DNS2   21U

Station/AP Set/Get IPv6 secondary DNS address; data = &ip6, len = 16, uint8_t[16].

Specifies the IPv6 address of the secondary DNS server.

See also
WiFi Option Codes

◆ ARM_WIFI_IP6_DHCP_MODE

#define ARM_WIFI_IP6_DHCP_MODE   22U

Station/AP Set/Get IPv6 DHCPv6 client mode; data = &mode, len = 4, uint32_t: ARM_WIFI_IP6_DHCP_xxx (default Off)

Specifies the operation mode of the DHCPv6 client.

See also
WiFi Option Codes