BssInfo.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * BssInfo.h - WiFi Basic Service Set Information
 *
 ****/

#pragma once

#include <WString.h>
#include <WVector.h>
#include <MacAddress.h>

#ifndef ARCH_ESP8266
enum WifiAuthMode {
    AUTH_OPEN = 0,
    AUTH_WEP,
    AUTH_WPA_PSK,
    AUTH_WPA2_PSK,
    AUTH_WPA_WPA2_PSK,
    AUTH_MAX,
};
#else
#include <esp_systemapi.h>
using WifiAuthMode = AUTH_MODE;
#endif

String toString(WifiAuthMode mode);

class BssInfo
{
public:
    bool isOpen() const
    {
        return authorization == AUTH_OPEN;
    }

    String getAuthorizationMethodName() const
    {
        return toString(authorization);
    }

    uint32_t getHashId() const
    {
        return bssid.getHash();
    }

public:
    String ssid;                
    MacAddress bssid;           
    WifiAuthMode authorization; 
    uint8_t channel;            
    int16_t rssi;               
    bool hidden;                
};

using BssList = Vector<BssInfo>;