mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-27 21:16:50 +03:00
fad056442d
* Make DNS resolution order selectable during runtime or compile time (only in dual stack mode). * Extend IPv6 example to show usage of new hostByName function with selectable resolving order * Fix function definition of fqdn_rt in IPv6.ino. * Fix function call. * Fix missing bracket... * Only run if built with dual stack support * Make DNS resolution order selectable during runtime or compile time (only in dual stack mode). * Extend IPv6 example to show usage of new hostByName function with selectable resolving order * Fix function definition of fqdn_rt in IPv6 example. * Implement enum class for resolve type * Fix example IPv6.ino * Fix typedef in ESP8266WiFiGeneric.h function call * Change enum class definition to not depend on lwip/dns.h * Move err_t err definition outside switch. Fix typecast. * Always define DNSResolveType as pio test otherwise failes even if the enum class isn't used. Co-authored-by: altelch <heiko.krupp@rhrk.uni-kl.de> Co-authored-by: david gauchard <gauchard@laas.fr>
136 lines
5.6 KiB
C++
136 lines
5.6 KiB
C++
/*
|
|
ESP8266WiFiGeneric.h - esp8266 Wifi support.
|
|
Based on WiFi.h from Ardiono WiFi shield library.
|
|
Copyright (c) 2011-2014 Arduino. All right reserved.
|
|
Modified by Ivan Grokhotkov, December 2014
|
|
Reworked by Markus Sattler, December 2015
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef ESP8266WIFIGENERIC_H_
|
|
#define ESP8266WIFIGENERIC_H_
|
|
|
|
#include "ESP8266WiFiType.h"
|
|
#include <functional>
|
|
#include <memory>
|
|
|
|
#ifdef DEBUG_ESP_WIFI
|
|
#ifdef DEBUG_ESP_PORT
|
|
#define DEBUG_WIFI_GENERIC(fmt, ...) DEBUG_ESP_PORT.printf_P( (PGM_P)PSTR(fmt), ##__VA_ARGS__ )
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef DEBUG_WIFI_GENERIC
|
|
#define DEBUG_WIFI_GENERIC(...) do { (void)0; } while (0)
|
|
#endif
|
|
|
|
struct WiFiEventHandlerOpaque;
|
|
typedef std::shared_ptr<WiFiEventHandlerOpaque> WiFiEventHandler;
|
|
|
|
typedef void (*WiFiEventCb)(WiFiEvent_t);
|
|
|
|
enum class DNSResolveType: uint8_t
|
|
{
|
|
DNS_AddrType_IPv4 = 0, // LWIP_DNS_ADDRTYPE_IPV4 = 0
|
|
DNS_AddrType_IPv6, // LWIP_DNS_ADDRTYPE_IPV6 = 1
|
|
DNS_AddrType_IPv4_IPv6, // LWIP_DNS_ADDRTYPE_IPV4_IPV6 = 2
|
|
DNS_AddrType_IPv6_IPv4 // LWIP_DNS_ADDRTYPE_IPV6_IPV4 = 3
|
|
};
|
|
|
|
struct WiFiState;
|
|
|
|
class ESP8266WiFiGenericClass {
|
|
// ----------------------------------------------------------------------------------------------
|
|
// -------------------------------------- Generic WiFi function ---------------------------------
|
|
// ----------------------------------------------------------------------------------------------
|
|
|
|
public:
|
|
ESP8266WiFiGenericClass();
|
|
|
|
// Note: this function is deprecated. Use one of the functions below instead.
|
|
void onEvent(WiFiEventCb cb, WiFiEvent_t event = WIFI_EVENT_ANY) __attribute__((deprecated));
|
|
|
|
// Subscribe to specific event and get event information as an argument to the callback
|
|
WiFiEventHandler onStationModeConnected(std::function<void(const WiFiEventStationModeConnected&)>);
|
|
WiFiEventHandler onStationModeDisconnected(std::function<void(const WiFiEventStationModeDisconnected&)>);
|
|
WiFiEventHandler onStationModeAuthModeChanged(std::function<void(const WiFiEventStationModeAuthModeChanged&)>);
|
|
WiFiEventHandler onStationModeGotIP(std::function<void(const WiFiEventStationModeGotIP&)>);
|
|
WiFiEventHandler onStationModeDHCPTimeout(std::function<void(void)>);
|
|
WiFiEventHandler onSoftAPModeStationConnected(std::function<void(const WiFiEventSoftAPModeStationConnected&)>);
|
|
WiFiEventHandler onSoftAPModeStationDisconnected(std::function<void(const WiFiEventSoftAPModeStationDisconnected&)>);
|
|
WiFiEventHandler onSoftAPModeProbeRequestReceived(std::function<void(const WiFiEventSoftAPModeProbeRequestReceived&)>);
|
|
WiFiEventHandler onWiFiModeChange(std::function<void(const WiFiEventModeChange&)>);
|
|
|
|
int32_t channel(void);
|
|
|
|
bool setSleepMode(WiFiSleepType_t type, uint8_t listenInterval = 0);
|
|
|
|
WiFiSleepType_t getSleepMode();
|
|
uint8_t getListenInterval ();
|
|
bool isSleepLevelMax ();
|
|
|
|
bool setPhyMode(WiFiPhyMode_t mode);
|
|
WiFiPhyMode_t getPhyMode();
|
|
|
|
void setOutputPower(float dBm);
|
|
|
|
void persistent(bool persistent);
|
|
|
|
bool mode(WiFiMode_t, WiFiState* state = nullptr);
|
|
WiFiMode_t getMode();
|
|
|
|
bool enableSTA(bool enable);
|
|
bool enableAP(bool enable);
|
|
|
|
bool forceSleepBegin(uint32 sleepUs = 0);
|
|
bool forceSleepWake();
|
|
|
|
static uint32_t shutdownCRC (const WiFiState* state);
|
|
static bool shutdownValidCRC (const WiFiState* state);
|
|
static void preinitWiFiOff (); //meant to be called in user-defined preinit()
|
|
|
|
protected:
|
|
static bool _persistent;
|
|
static WiFiMode_t _forceSleepLastMode;
|
|
|
|
static void _eventCallback(void *event);
|
|
|
|
// called by WiFi.mode(SHUTDOWN/RESTORE, state)
|
|
// - sleepUs is WiFi.forceSleepBegin() parameter, 0 = forever
|
|
// - saveState is the user's state to hold configuration on restore
|
|
bool shutdown (uint32 sleepUs = 0, WiFiState* stateSave = nullptr);
|
|
bool resumeFromShutdown (WiFiState* savedState = nullptr);
|
|
|
|
// ----------------------------------------------------------------------------------------------
|
|
// ------------------------------------ Generic Network function --------------------------------
|
|
// ----------------------------------------------------------------------------------------------
|
|
|
|
public:
|
|
int hostByName(const char* aHostname, IPAddress& aResult);
|
|
int hostByName(const char* aHostname, IPAddress& aResult, uint32_t timeout_ms);
|
|
#if LWIP_IPV4 && LWIP_IPV6
|
|
int hostByName(const char* aHostname, IPAddress& aResult, uint32_t timeout_ms, DNSResolveType resolveType);
|
|
#endif
|
|
bool getPersistent();
|
|
|
|
protected:
|
|
friend class ESP8266WiFiSTAClass;
|
|
friend class ESP8266WiFiScanClass;
|
|
friend class ESP8266WiFiAPClass;
|
|
};
|
|
|
|
#endif /* ESP8266WIFIGENERIC_H_ */
|