1.7.0.0R16
Software Development Kit
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules
Network

Modules

 DNS client
 
 IP
 
 Protocols
 
 TCP
 
 UDP
 

Data Structures

struct  ltrx_scan_result
 Contains network information acquired from network scan. More...
 

Macros

#define LTRX_SCAN_ENCR_FLAGS__CCMP   0x02
 CCMP encryption protocol. More...
 
#define LTRX_SCAN_ENCR_FLAGS__TKIP   0x04
 TKIP encryption protocol. More...
 
#define LTRX_SCAN_ENCR_FLAGS__WEP   0x01
 WEP security level. More...
 
#define LTRX_SCAN_SECURITY_SUITE__OPEN   0x00
 Open security protocol. More...
 
#define LTRX_SCAN_SECURITY_SUITE__WEP   0x01
 WEP security protocol. More...
 
#define LTRX_SCAN_SECURITY_SUITE__WPA   0x02
 WPA security protocol. More...
 
#define LTRX_SCAN_SECURITY_SUITE__WPA2   0x04
 WPA2 security protocol. More...
 
#define LTRX_WLAN_MAC_ADDRESS__LENGTH   6
 Max mac address length. More...
 
#define LTRX_WLAN_SSID_LEN   32
 Max ssid length. More...
 

Functions

bool ltrx_network_get_mac_address (uint8_t zeroBasedInterface, void *mac, size_t size)
 Get MAC address. More...
 
uint16_t ltrx_network_interface_get_mss (uint8_t zeroBasedInterface)
 Get Interface Maximum Segment Size (MSS). More...
 
const char * ltrx_network_interface_get_name (uint8_t zeroBasedInterface)
 Get Interface name. More...
 

Detailed Description

Network contains the definitions related to networking.

Macro Definition Documentation

#define LTRX_SCAN_ENCR_FLAGS__CCMP   0x02

CCMP encryption protocol.

CCMP encryption protocol

#define LTRX_SCAN_ENCR_FLAGS__TKIP   0x04

TKIP encryption protocol.

TKIP encryption protocol

#define LTRX_SCAN_ENCR_FLAGS__WEP   0x01

WEP security level.

WEP security level

#define LTRX_SCAN_SECURITY_SUITE__OPEN   0x00

Open security protocol.

Open security protocol

#define LTRX_SCAN_SECURITY_SUITE__WEP   0x01

WEP security protocol.

WEP security protocol

#define LTRX_SCAN_SECURITY_SUITE__WPA   0x02

WPA security protocol.

WPA security protocol

#define LTRX_SCAN_SECURITY_SUITE__WPA2   0x04

WPA2 security protocol.

WPA2 security protocol

#define LTRX_WLAN_MAC_ADDRESS__LENGTH   6

Max mac address length.

Max length of mac address

#define LTRX_WLAN_SSID_LEN   32

Max ssid length.

Max length of ssid

Function Documentation

bool ltrx_network_get_mac_address ( uint8_t  zeroBasedInterface,
void *  mac,
size_t  size 
)

Get MAC address.

Return values
trueSuccess.
falseFailed.
Parameters
[in]zeroBasedInterfaceSpecifies interface to get the MAC for.
  • NETS_SOFTAP_START for ap0.
  • NETS_WLAN_START for wlan0.
[out]macReceives the binary MAC address.
[in]sizeSize of mac to be filled in.
uint16_t ltrx_network_interface_get_mss ( uint8_t  zeroBasedInterface)

Get Interface Maximum Segment Size (MSS).

Returns
Maximum Segment Size (MSS) in bytes.
Parameters
[in]zeroBasedInterfaceSpecifies interface to check.
  • NETS_SOFTAP_START for ap0.
  • NETS_WLAN_START for wlan0.
const char* ltrx_network_interface_get_name ( uint8_t  zeroBasedInterface)

Get Interface name.

Returns
Interface name.
Parameters
[in]zeroBasedInterfaceSpecifies interface to check.
  • NETS_SOFTAP_START for ap0.
  • NETS_WLAN_START for wlan0.