ethernet_provisioner.h

Go to the documentation of this file.

#ifndef SENSESP_NET_ETHERNET_PROVISIONER_H_
#define SENSESP_NET_ETHERNET_PROVISIONER_H_
 
// Native RMII Ethernet support.
//
// Currently only ESP32-P4 ships an Arduino-ESP32 ETH.h implementation
// that SensESP can drive without writing a custom EMAC bring-up, so the
// entire EthernetProvisioner class is guarded behind CONFIG_IDF_TARGET_ESP32P4.
// On any other target, including this header compiles to nothing and
// `EthernetConfig` / `EthernetProvisioner` are simply not declared —
// so a user sketch that tries to call
// `builder.set_ethernet(EthernetConfig::…())` on a classic ESP32 will
// get a clear compile error at the use site ("'EthernetConfig' was
// not declared in this scope") rather than a silent runtime failure.
//
// When future ESP32 variants grow a usable Arduino-ESP32 ETH driver,
// the guard can be widened accordingly.
 
#include <Arduino.h>
 
#if defined(CONFIG_IDF_TARGET_ESP32P4)
 
#include <ETH.h>
 
#include "sensesp/net/network_provisioner.h"
#include "sensesp_base_app.h"
 
namespace sensesp {
 
class EthernetProvisioner;

struct EthernetConfig {
  using ProvisionerType = EthernetProvisioner;
 
  eth_phy_type_t phy_type = ETH_PHY_IP101;
  int32_t phy_addr = 1;
  int mdc_pin = 31;
  int mdio_pin = 52;
  int power_pin = 51;  // PHY reset pin
  eth_clock_mode_t clock_mode = EMAC_CLK_EXT_IN;

  static EthernetConfig waveshare_esp32p4_poe() {
    EthernetConfig cfg;
    cfg.phy_type = ETH_PHY_IP101;
    cfg.phy_addr = 1;
    cfg.mdc_pin = 31;
    cfg.mdio_pin = 52;
    cfg.power_pin = 51;
    cfg.clock_mode = EMAC_CLK_EXT_IN;
    return cfg;
  }
};

class EthernetProvisioner : public NetworkProvisioner {
 public:
  explicit EthernetProvisioner(const EthernetConfig& config);
  ~EthernetProvisioner() override;
 
  // -- NetworkProvisioner --
  IPAddress local_ip() const override;
  IPAddress gateway_ip() const override;
  String mac_address() const override;
  bool is_connected() const override;
 
  // -- Ethernet-specific --
  int link_speed_mbps() const;

  bool is_full_duplex() const;
 
 private:
  EthernetConfig config_;
};
 
}  // namespace sensesp
 
#endif  // CONFIG_IDF_TARGET_ESP32P4
 
#endif  // SENSESP_NET_ETHERNET_PROVISIONER_H_