api_wizard.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/defines.h"
 
#ifdef USE_API_WIZARD
 
#include <cstddef>
#include <cstdint>
#ifdef USE_API_WIZARD_MULTIPLE_INPUTS
#include <cstring>
#endif
 
#include "esphome/core/hal.h"
#include "proto.h"
#include "esphome/core/string_ref.h"
 
namespace esphome::api {
 
class WizardInputSetRequest;
 
static constexpr size_t WIZARD_ENTITY_ID_BUFFER_SIZE = 256;
 
extern const uint8_t API_WIZARD_DATA[] PROGMEM;
 
#ifdef USE_API_WIZARD_INPUTS
struct WizardInputEntry {
  uint32_t key;     // FNV-1 hash of the ESPHome id of the input
  char *entity_id;  // RAM buffer, WIZARD_ENTITY_ID_BUFFER_SIZE bytes or size, shared with the homeassistant entity
#ifdef USE_API_WIZARD_MULTIPLE_INPUTS
  uint16_t size;  // Buffer size of a multiple input, 0 for a single input
#endif
};
 
extern const WizardInputEntry API_WIZARD_INPUTS[] PROGMEM;
 
const char *wizard_set_input(const WizardInputSetRequest &msg);
#endif
 
#ifdef USE_API_WIZARD_STANDALONE_INPUTS
class WizardInput {
 public:
  explicit WizardInput(const char *entity_id) : entity_id_(entity_id) {}
  StringRef entity_id() const { return StringRef(this->entity_id_); }
  bool has_entity_id() const { return this->entity_id_[0] != '\0'; }
#ifdef USE_API_WIZARD_MULTIPLE_INPUTS
  size_t entity_id_count() const {
    if (!this->has_entity_id())
      return 0;
    size_t count = 1;
    for (const char *p = this->entity_id_; (p = strchr(p, ',')) != nullptr; p++)
      count++;
    return count;
  }
  template<typename F> void for_each_entity_id(F &&callback) const {
    // The device stores the list without spaces or empty entries
    const char *start = this->entity_id_;
    while (*start != '\0') {
      const char *end = strchr(start, ',');
      if (end == nullptr)
        end = start + strlen(start);
      callback(StringRef(start, end - start));
      start = *end == ',' ? end + 1 : end;
    }
  }
#endif
 
 protected:
  const char *entity_id_;
};
#endif
 
}  // namespace esphome::api
 
#endif  // USE_API_WIZARD