util.h

Go to the documentation of this file.

#pragma once
#include "esphome/core/defines.h"
#ifdef USE_NETWORK
#include <span>
#include <string>
#include "esphome/core/helpers.h"
#include "ip_address.h"
 
#ifdef USE_ETHERNET
#include "esphome/components/ethernet/ethernet_component.h"
#endif
#ifdef USE_MODEM
#include "esphome/components/modem/modem_component.h"
#endif
#ifdef USE_WIFI
#include "esphome/components/wifi/wifi_component.h"
#endif
#ifdef USE_OPENTHREAD
#include "esphome/components/openthread/openthread.h"
#endif
#ifdef USE_ESP32
#include "esp_netif.h"
#endif
 
namespace esphome::network {
 
#if defined(USE_ESP32) && USE_NETWORK_IPV6
void fill_ip6_addresses(esp_netif_t *netif, IPAddresses &addresses);
#endif
 
// The order of the components is important: WiFi should come after any possible main interfaces (it may be used as
// an AP that uses a previous interface for NAT).
 
ESPHOME_ALWAYS_INLINE inline bool is_connected() {
  // With a single interface enabled the checks below collapse to `if (x) return true; return false;`, which
  // clang-tidy wants folded into one return. Keep the per-interface form so every enabled interface is checked.
  // NOLINTBEGIN(readability-simplify-boolean-expr)
#ifdef USE_ETHERNET
  if (ethernet::global_eth_component != nullptr && ethernet::global_eth_component->is_connected())
    return true;
#endif
 
#ifdef USE_MODEM
  if (modem::global_modem_component != nullptr && modem::global_modem_component->is_connected())
    return true;
#endif
 
#ifdef USE_WIFI
  if (wifi::global_wifi_component != nullptr && wifi::global_wifi_component->is_connected())
    return true;
#endif
 
#if defined(USE_OPENTHREAD) && !defined(USE_OPENTHREAD_BORDER_ROUTER)
  // A border router is reached over its Wi-Fi backbone, so the Thread link alone does not count
  if (openthread::global_openthread_component != nullptr && openthread::global_openthread_component->is_connected())
    return true;
#endif
 
#ifdef USE_HOST
  return true;  // Assume it's connected
#endif
  return false;
  // NOLINTEND(readability-simplify-boolean-expr)
}
 
bool is_disabled();
static constexpr size_t USE_ADDRESS_BUFFER_SIZE = 70;
const char *get_use_address_to(std::span<char, USE_ADDRESS_BUFFER_SIZE> buf);
IPAddresses get_ip_addresses();
 
}  // namespace esphome::network
#endif