MeshNet  1.0.0
Public Member Functions | Data Fields
MeshNetScanResult Struct Reference

Structure, which holds network scan result. More...

#include <meshPacketFlags.h>

Collaboration diagram for MeshNetScanResult:
Collaboration graph
[legend]

Public Member Functions

bool IsValid () const
 Checks if result is valid. More...
 
bool IsGateway () const
 Checks if node which responsed is gateway. More...
 
bool IsConneted () const
 Checks if node which responsed is connected to any network. More...
 

Data Fields

MeshMAC BSSID
 BSSID of network, the node which responsed is connected to. If node is not connected to any network (Address == 253) BSSID is MAC address of node. More...
 
uint8_t Address = 0
 Address of node. More...
 
MeshVersion Version
 MeshNet version, the node is using. More...
 
MeshNodeDescFlags Flags
 Mesh node description flags, which describes every node. More...
 
uint8_t HopsToGateway = 0
 Hops from current node to gateway. If node is gateway (Address == 0) 0 is set. More...
 
char * SSID_ptr = NULL
 Pointer to network name (SSID). If node is not connected to any network, NULL is set. More...
 
uint8_t SSID_length = 0
 Length of SSID without null terminator. If node is not connected to any network, 0 is set. More...
 
int8_t RSSI = 0
 RSSI of scan response in dBm. More...
 

Detailed Description

Structure, which holds network scan result.

Member Function Documentation

◆ IsConneted()

bool MeshNetScanResult::IsConneted ( ) const
inline

Checks if node which responsed is connected to any network.

◆ IsGateway()

bool MeshNetScanResult::IsGateway ( ) const
inline

Checks if node which responsed is gateway.

◆ IsValid()

bool MeshNetScanResult::IsValid ( ) const
inline

Checks if result is valid.

Field Documentation

◆ Address

uint8_t MeshNetScanResult::Address = 0

Address of node.

◆ BSSID

MeshMAC MeshNetScanResult::BSSID

BSSID of network, the node which responsed is connected to. If node is not connected to any network (Address == 253) BSSID is MAC address of node.

◆ Flags

MeshNodeDescFlags MeshNetScanResult::Flags

Mesh node description flags, which describes every node.

◆ HopsToGateway

uint8_t MeshNetScanResult::HopsToGateway = 0

Hops from current node to gateway. If node is gateway (Address == 0) 0 is set.

◆ RSSI

int8_t MeshNetScanResult::RSSI = 0

RSSI of scan response in dBm.

◆ SSID_length

uint8_t MeshNetScanResult::SSID_length = 0

Length of SSID without null terminator. If node is not connected to any network, 0 is set.

◆ SSID_ptr

char* MeshNetScanResult::SSID_ptr = NULL

Pointer to network name (SSID). If node is not connected to any network, NULL is set.

Warning
SSID has no null terminator.

◆ Version

MeshVersion MeshNetScanResult::Version

MeshNet version, the node is using.


The documentation for this struct was generated from the following file: