Station.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.
 *
 * Station.h
 *
 ****/

#pragma once

#include <WString.h>
#include <WVector.h>
#include <IpAddress.h>
#include <MacAddress.h>
#include "BssInfo.h"

enum StationConnectionStatus {
    eSCS_Idle,                
    eSCS_Connecting,          
    eSCS_WrongPassword,       
    eSCS_AccessPointNotFound, 
    eSCS_ConnectionFailed,  
    eSCS_GotIP                
};

enum SmartConfigType {
    SCT_None = -1,
    SCT_EspTouch,         
    SCT_AirKiss,          
    SCT_EspTouch_AirKiss, 
    SCT_EspTouch_V2,      
};

enum SmartConfigEvent {
    SCE_Wait,        
    SCE_FindChannel, 
    SCE_GettingSsid, 
    SCE_Link,        
    SCE_LinkOver,   
};

struct SmartConfigEventInfo {
    SmartConfigType type = SCT_None; 
    String ssid;                     
    String password;                 
    bool bssidSet = false;           
    MacAddress bssid;                
};

#define WPS_STATUS_MAP(XX)                                                                                             \
    XX(Success)                                                                                                        \
    XX(Failed)                                                                                                         \
    XX(Timeout)                                                                                                        \
    XX(WEP)

enum class WpsStatus {
#define XX(name) name,
    WPS_STATUS_MAP(XX)
#undef XX
};

#define XX(name) constexpr WpsStatus eWPS_##name{WpsStatus::name};
WPS_STATUS_MAP(XX)
#undef XX

String toString(WpsStatus status);

using ScanCompletedDelegate = Delegate<void(bool success, BssList& list)>;

using SmartConfigDelegate = Delegate<bool(SmartConfigEvent event, const SmartConfigEventInfo& info)>;

using WPSConfigDelegate = Delegate<bool(WpsStatus status)>;

class StationClass
{
public:
    struct Config {
        String ssid;                      
        String password;                  
        MacAddress bssid;                 
        bool autoConnectOnStartup = true; 
        bool save = true;                 
    };

    virtual ~StationClass()
    {
    }

    virtual void enable(bool enabled, bool save = false) = 0;

    virtual bool isEnabled() const = 0;

    virtual bool config(const Config& config) = 0;

    bool config(const String& ssid, const String& password, bool autoConnectOnStartup = true, bool save = true)
    {
        Config cfg{
            .ssid = ssid,
            .password = password,
            .autoConnectOnStartup = autoConnectOnStartup,
            .save = save,
        };
        return config(cfg);
    }

    virtual bool connect() = 0;

    virtual bool disconnect() = 0;

    bool isConnected() const;

    bool isConnectionFailed() const;

    virtual StationConnectionStatus getConnectionStatus() const = 0;

    String getConnectionStatusName() const;

    virtual bool isEnabledDHCP() const = 0;

    virtual void enableDHCP(bool enable) = 0;

    virtual void setHostname(const String& hostname) = 0;

    virtual String getHostname() const = 0;

    virtual IpAddress getIP() const = 0;

    virtual MacAddress getMacAddress() const = 0;

    String getMAC(char sep = '\0') const;

    virtual bool setMacAddress(const MacAddress& addr) const = 0;

    virtual IpAddress getNetworkMask() const = 0;

    virtual IpAddress getNetworkGateway() const = 0;

    virtual IpAddress getNetworkBroadcast() const = 0;

    bool isLocal(IpAddress address)
    {
        return address.compare(getIP(), getNetworkMask());
    }

    bool setIP(IpAddress address);

    virtual bool setIP(IpAddress address, IpAddress netmask, IpAddress gateway) = 0;

    virtual String getSSID() const = 0;

    virtual MacAddress getBSSID() const = 0;

    virtual String getPassword() const = 0;

    virtual int8_t getRssi() const = 0;

    virtual uint8_t getChannel() const = 0;

    virtual bool startScan(ScanCompletedDelegate scanCompleted) = 0;

#ifdef ENABLE_SMART_CONFIG

    virtual bool smartConfigStart(SmartConfigType sctype, SmartConfigDelegate callback = nullptr) = 0;

    virtual void smartConfigStop() = 0;
#endif

#ifdef ENABLE_WPS

    virtual bool wpsConfigStart(WPSConfigDelegate callback = nullptr) = 0;

    virtual void wpsConfigStop() = 0;
#endif

protected:
    ScanCompletedDelegate scanCompletedCallback = nullptr;
#ifdef ENABLE_SMART_CONFIG
    SmartConfigDelegate smartConfigCallback = nullptr;
#endif
#ifdef ENABLE_WPS
    WPSConfigDelegate wpsConfigCallback = nullptr;
#endif
};

extern StationClass& WifiStation;