hub_operations.cpp

Go to the documentation of this file.

#include "hub_internal.h"
 
#include "proto_commands.h"
 
/// @file hub_operations.cpp
/// @brief High-level command execution and queued operation dispatch.
/// @ingroup hioc_hub
///
/// This file owns the outbound user-facing operations on the hub:
/// - cover position and tilt commands,
/// - explicit status requests,
/// - light/switch semantic wrappers,
/// - queued dispatch on the main loop.
///
/// Keeping these methods out of hub_core.cpp makes it easier to reason about the
/// difference between lifecycle/polling logic and the explicit actions initiated
/// by Home Assistant entities.
 
namespace esphome {
namespace home_io_control {
 
namespace {
 
/// @brief Apply adaptive backoff after a failed background status poll.
///
/// The backoff is per-device and per-failure-class. Plain timeouts ramp up gradually, while
/// auth-shaped failures ramp up faster because they already prove the device answered with 0x3C
/// and we are likely just burning airtime with repeated 0x3D responses.
///
/// @param dev Device record to update.
/// @param auth_like_failure True if the failed exchange saw a challenge request.
/// @return Delay in milliseconds until the next automatic poll.
uint32_t apply_status_poll_failure_backoff(IoDevice &dev, bool auth_like_failure) {
  if (auth_like_failure) {
    dev.status_poll_failures = 0;
    if (dev.auth_poll_failures < UINT8_MAX)
      dev.auth_poll_failures++;
    return detail::status_poll_retry_delay_ms(dev.auth_poll_failures, true);
  }
 
  dev.auth_poll_failures = 0;
  if (dev.status_poll_failures < UINT8_MAX)
    dev.status_poll_failures++;
  return detail::status_poll_retry_delay_ms(dev.status_poll_failures, false);
}
 
/// @brief Clear background status-poll failure streaks after a successful reply.
/// @param dev Device record to reset.
void clear_status_poll_failure_backoff(IoDevice &dev) {
  dev.status_poll_failures = 0;
  dev.auth_poll_failures = 0;
}
 
/// @brief Apply tracked-poll failure bookkeeping after an explicit exchange failure.
/// @param component Owning hub component.
/// @param device_id Target device ID.
/// @param retry_after_fail_ms Non-zero only for tracked background status polling.
/// @param auth_like_failure True when the failed exchange saw an auth challenge.
void handle_failed_exchange(IOHomeControlComponent *component, const std::string &device_id,
                            uint32_t retry_after_fail_ms, bool auth_like_failure) {
  if (retry_after_fail_ms == 0)
    return;
 
  if (auto *dev = component->get_device(device_id); dev != nullptr) {
    const uint32_t backoff_ms = apply_status_poll_failure_backoff(*dev, auth_like_failure);
    uint32_t const now = millis();
    if (detail::status_poll_tracking_active(*dev, now) && now + backoff_ms <= dev->poll_deadline) {
      dev->next_update = now + backoff_ms;
      ESP_LOGD(detail::TAG,
               "Background status poll backoff for device %s: delay=%u ms auth_like=%s status_failures=%u "
               "auth_failures=%u",
               device_id.c_str(), backoff_ms, YESNO(auth_like_failure), dev->status_poll_failures,
               dev->auth_poll_failures);
    } else {
      detail::clear_status_poll_tracking(*dev);
    }
  }
}
 
/// @brief Return the human-readable verb for a position-style command.
/// @param dev Device receiving the command.
/// @param position Requested execute position.
/// @return Log-friendly action string such as "open", "turn on", or "lock".
const char *position_command_action(const IoDevice &dev, uint8_t position) {
  if (position == POS_STOP)
    return "stop";
 
  if (!detail::is_binary_entity_position(position))
    return "set position";
 
  bool const active_state = position == detail::BINARY_ENTITY_ON_POSITION;
  switch (device_capability_class(dev.type)) {
    case DeviceCapabilityClass::LIGHT:
    case DeviceCapabilityClass::SWITCH:
      return active_state ? "turn on" : "turn off";
    case DeviceCapabilityClass::LOCK:
      return active_state ? "unlock" : "lock";
    case DeviceCapabilityClass::UNKNOWN:
    case DeviceCapabilityClass::COVER:
    case DeviceCapabilityClass::CLIMATE:
    case DeviceCapabilityClass::SENSOR:
    case DeviceCapabilityClass::BEACON:
    default:
      return active_state ? "open" : "close";
  }
}
 
/// @brief Return the accepted entity/profile label for rejected execute-position logs.
/// @param position Requested execute position.
/// @return Expected profile label for detail::log_rejected_operation().
const char *position_rejection_profile(uint8_t position) {
  return detail::is_binary_entity_position(position) ? "cover_position or binary_on_off" : "cover_position";
}
 
/// @brief Update device poll-tracking state before an execute-position request is sent.
/// @param dev Device record to update.
/// @param position Requested execute position.
/// @return true when active tracked polling should be started immediately by the caller.
bool prepare_position_poll_tracking(IoDevice &dev, uint8_t position) {
  if (position == POS_STOP) {
    detail::clear_status_poll_tracking(dev);
    return false;
  }
 
  dev.single_follow_up_poll_pending = dev.status_poll_interval_ms == 0;
  return true;
}
 
/// @brief Roll back tracked polling after a failed execute-position request.
/// @param dev Device record to update.
/// @param position Requested execute position.
void rollback_position_poll_tracking(IoDevice &dev, uint8_t position) {
  if (position != POS_STOP)
    detail::clear_status_poll_tracking(dev);
}
 
/// @brief Decide whether post-success tracked polling should be scheduled.
/// @param dev Device record to update.
/// @param position Requested execute position.
/// @return true when the caller should arm tracked polling after a successful request.
bool should_finalize_position_poll_tracking(const IoDevice &dev, uint8_t position) {
  return position != POS_STOP && dev.status_poll_interval_ms != 0 && dev.next_update == 0;
}
 
}  // namespace
 
// Execute an authenticated request on the standard command channel and, on success, feed the
// device's reply back through the normal inbound status parser so all state normalization stays
// in one place.
bool IOHomeControlComponent::execute_request_and_update_(const std::string &device_id, const IoFrame &request,
                                                         bool warn_on_no_response, uint32_t retry_after_fail_ms) {
  IoFrame response;
  if (!this->send_and_receive_(request, response, FREQ_CH2)) {
    handle_failed_exchange(this, device_id, retry_after_fail_ms, this->last_exchange_debug_.saw_challenge);
    this->log_exchange_debug_(device_id.c_str());
    if (warn_on_no_response) {
      ESP_LOGW(detail::TAG, "Command 0x%02X failed for device %s: no valid response (stage=%s tries=%u)", request.cmd,
               device_id.c_str(), this->last_exchange_debug_.stage, this->last_exchange_debug_.tries);
    }
    return false;
  }
 
  if (response.cmd == CMD_ERROR_RESP) {
    if (response.data_len == 0) {
      detail::log_frame_issue(this, "rx", "unsupported_payload", response, frame_length(response));
    } else {
      detail::log_command_result(device_id, response.data[0], request.cmd, true);
    }
    handle_failed_exchange(this, device_id, retry_after_fail_ms, this->last_exchange_debug_.saw_challenge);
    return false;
  }
 
  if (retry_after_fail_ms != 0) {
    if (auto *dev = this->get_device(device_id); dev != nullptr)
      clear_status_poll_failure_backoff(*dev);
  }
 
  this->update_device_status_(response);
  return true;
}
 
bool IOHomeControlComponent::set_device_position(const std::string &device_id, uint8_t position) {
  auto *dev = this->get_device(device_id);
  if (dev == nullptr || !this->initialized_)
    return false;
 
  const char *action = position_command_action(*dev, position);
 
  // Once a device family is known, use the profile helpers to reject YAML/entity mismatches
  // before they hit the radio path. Unknown types still pass through so discovery and imported
  // devices keep working as before.
  if (!detail::known_device_accepts_execute_position(*dev, position)) {
    detail::log_rejected_operation(device_id, *dev, action, position_rejection_profile(position));
    return false;
  }
 
  if (prepare_position_poll_tracking(*dev, position))
    this->begin_status_poll_tracking_(device_id, dev->status_poll_interval_ms);
 
  ESP_LOGI(detail::TAG, "Sending %s to device %s (profile=%s)", action, device_id.c_str(),
           device_operation_profile_name(dev->type));
 
  IoFrame request;
  if (!create_execute(request, this->node_id_, dev->node_id, true, position)) {
    rollback_position_poll_tracking(*dev, position);
    return false;
  }
  bool const ok = this->execute_request_and_update_(device_id, request, true, 0);
  if (!ok) {
    rollback_position_poll_tracking(*dev, position);
    return false;
  }
  if (should_finalize_position_poll_tracking(*dev, position))
    this->begin_status_poll_tracking_(device_id, dev->status_poll_interval_ms);
  return true;
}
 
bool IOHomeControlComponent::set_device_tilt(const std::string &device_id, uint8_t tilt_percent) {
  auto *dev = this->get_device(device_id);
  if (dev == nullptr || !this->initialized_)
    return false;
 
  if (!detail::known_device_accepts_execute_tilt(*dev)) {
    detail::log_rejected_operation(device_id, *dev, "set tilt", "tilt-capable cover");
    return false;
  }
 
  dev->single_follow_up_poll_pending = dev->status_poll_interval_ms == 0;
  this->begin_status_poll_tracking_(device_id, dev->status_poll_interval_ms);
 
  ESP_LOGI(detail::TAG, "Sending tilt=%u%% to device %s (profile=%s)", tilt_percent, device_id.c_str(),
           device_operation_profile_name(dev->type));
 
  IoFrame request;
  if (!create_execute_tilt(request, this->node_id_, dev->node_id, true, tilt_percent)) {
    detail::clear_status_poll_tracking(*dev);
    return false;
  }
  bool const ok = this->execute_request_and_update_(device_id, request, true, 0);
  if (!ok) {
    detail::clear_status_poll_tracking(*dev);
    return false;
  }
  if (dev->status_poll_interval_ms != 0 && dev->next_update == 0)
    this->begin_status_poll_tracking_(device_id, dev->status_poll_interval_ms);
  return true;
}
 
bool IOHomeControlComponent::request_device_status(const std::string &device_id) {
  auto *dev = this->get_device(device_id);
  if (dev == nullptr || !this->initialized_)
    return false;
 
  if (!detail::known_device_supports_status_requests(*dev)) {
    detail::log_rejected_operation(device_id, *dev, "status request", "status-capable actuator");
    return false;
  }
 
  IoFrame request;
  // Tilt-capable covers need the extended 0x03200100 status request so the response includes
  // the reliable 16-byte tilt block. Other devices stay on the shorter generic request.
  bool const request_ok = device_supports_tilt(dev->type)
                              ? create_get_status_tilt(request, this->node_id_, dev->node_id)
                              : create_get_status(request, this->node_id_, dev->node_id);
  if (!request_ok)
    return false;
  uint32_t const retry_after_fail_ms =
      detail::status_poll_tracking_active(*dev, millis()) ? detail::STATUS_RETRY_AFTER_FAIL_MS : 0;
  return this->execute_request_and_update_(device_id, request, false, retry_after_fail_ms);
}
 
bool IOHomeControlComponent::request_device_name(const std::string &device_id) {
  auto *dev = this->get_device(device_id);
  if (dev == nullptr || !this->initialized_)
    return false;
 
  IoFrame request;
  if (!create_get_name(request, this->node_id_, dev->node_id, true))
    return false;
  return this->execute_request_and_update_(device_id, request, false, 0);
}
 
bool IOHomeControlComponent::set_light_state(const std::string &device_id, bool on) {
  auto *dev = this->get_device(device_id);
  if (dev == nullptr || !this->initialized_)
    return false;
 
  if (!detail::known_device_matches_entity_class(*dev, DeviceCapabilityClass::LIGHT)) {
    detail::log_rejected_operation(device_id, *dev, "light command", "light entity");
    return false;
  }
 
  // Light entities are binary-only for now, so they intentionally reuse the controller's
  // existing execute path with the proven on/off position encoding.
  return this->set_device_position(device_id,
                                   on ? detail::BINARY_ENTITY_ON_POSITION : detail::BINARY_ENTITY_OFF_POSITION);
}
 
bool IOHomeControlComponent::set_switch_state(const std::string &device_id, bool on) {
  auto *dev = this->get_device(device_id);
  if (dev == nullptr || !this->initialized_)
    return false;
 
  if (!detail::known_device_matches_entity_class(*dev, DeviceCapabilityClass::SWITCH)) {
    detail::log_rejected_operation(device_id, *dev, "switch command", "switch entity");
    return false;
  }
 
  // Switches share the same transport-level representation as binary lights.
  return this->set_device_position(device_id,
                                   on ? detail::BINARY_ENTITY_ON_POSITION : detail::BINARY_ENTITY_OFF_POSITION);
}
 
bool IOHomeControlComponent::set_lock_state(const std::string &device_id, bool locked) {
  auto *dev = this->get_device(device_id);
  if (dev == nullptr || !this->initialized_)
    return false;
 
  if (!detail::known_device_matches_entity_class(*dev, DeviceCapabilityClass::LOCK)) {
    detail::log_rejected_operation(device_id, *dev, "lock command", "lock entity");
    return false;
  }
 
  // Lock entities currently reuse the protocol's proven binary execute encoding:
  // unlock maps to 0 and lock maps to 100.
  return this->set_device_position(device_id,
                                   locked ? detail::BINARY_ENTITY_OFF_POSITION : detail::BINARY_ENTITY_ON_POSITION);
}
 
void IOHomeControlComponent::queue_set_device_position(const std::string &device_id, uint8_t position) {
  IoDevice *dev = this->get_device(device_id);
  if (dev != nullptr && !detail::known_device_matches_entity_class(*dev, DeviceCapabilityClass::COVER)) {
    detail::log_rejected_operation(device_id, *dev, "queued cover command", "cover entity");
    return;
  }
  this->pending_operations_.push_back({PendingOperationType::SET_POSITION, device_id, position});
}
 
void IOHomeControlComponent::queue_set_device_tilt(const std::string &device_id, uint8_t tilt_percent) {
  IoDevice *dev = this->get_device(device_id);
  if (dev != nullptr && !detail::known_device_accepts_execute_tilt(*dev)) {
    detail::log_rejected_operation(device_id, *dev, "queued tilt command", "tilt-capable cover");
    return;
  }
  this->pending_operations_.push_back({PendingOperationType::SET_TILT, device_id, tilt_percent});
}
 
void IOHomeControlComponent::queue_request_device_status(const std::string &device_id) {
  IoDevice *dev = this->get_device(device_id);
  if (dev != nullptr && !detail::known_device_supports_status_requests(*dev)) {
    detail::log_rejected_operation(device_id, *dev, "queued status request", "status-capable actuator");
    return;
  }
 
  // Keep at most one pending status poll per device. Without this, an overdue next_update can add
  // the same poll on every main-loop iteration until the first queued request is finally processed.
  for (const auto &operation : this->pending_operations_) {
    if (operation.type == PendingOperationType::REQUEST_STATUS && operation.device_id == device_id)
      return;
  }
 
  this->pending_operations_.push_back({PendingOperationType::REQUEST_STATUS, device_id, 0});
}
 
void IOHomeControlComponent::queue_request_device_name(const std::string &device_id) {
  if (this->get_device(device_id) == nullptr)
    return;
 
  for (const auto &operation : this->pending_operations_) {
    if (operation.type == PendingOperationType::REQUEST_NAME && operation.device_id == device_id)
      return;
  }
 
  this->pending_operations_.push_back({PendingOperationType::REQUEST_NAME, device_id, 0});
}
 
void IOHomeControlComponent::queue_discover_and_pair() {
  // Pairing is globally exclusive work. Keep at most one queued request so repeated button presses
  // while the radio is busy do not stack duplicate discovery attempts.
  for (const auto &operation : this->pending_operations_) {
    if (operation.type == PendingOperationType::DISCOVER_AND_PAIR)
      return;
  }
  this->pending_operations_.push_back({PendingOperationType::DISCOVER_AND_PAIR, {}, 0});
}
 
void IOHomeControlComponent::queue_set_light_state(const std::string &device_id, bool on) {
  IoDevice *dev = this->get_device(device_id);
  if (dev != nullptr && !detail::known_device_matches_entity_class(*dev, DeviceCapabilityClass::LIGHT)) {
    detail::log_rejected_operation(device_id, *dev, "queued light command", "light entity");
    return;
  }
 
  // Queue through the same scheduler as covers so radio work stays serialized while still keeping
  // the light-vs-switch semantics available for capability checks at dispatch time.
  this->pending_operations_.push_back({PendingOperationType::SET_LIGHT_STATE, device_id,
                                       on ? detail::BINARY_ENTITY_ON_POSITION : detail::BINARY_ENTITY_OFF_POSITION});
}
 
void IOHomeControlComponent::queue_set_lock_state(const std::string &device_id, bool locked) {
  IoDevice *dev = this->get_device(device_id);
  if (dev != nullptr && !detail::known_device_matches_entity_class(*dev, DeviceCapabilityClass::LOCK)) {
    detail::log_rejected_operation(device_id, *dev, "queued lock command", "lock entity");
    return;
  }
 
  this->pending_operations_.push_back(
      {PendingOperationType::SET_LOCK_STATE, device_id,
       locked ? detail::BINARY_ENTITY_OFF_POSITION : detail::BINARY_ENTITY_ON_POSITION});
}
 
void IOHomeControlComponent::queue_set_switch_state(const std::string &device_id, bool on) {
  IoDevice *dev = this->get_device(device_id);
  if (dev != nullptr && !detail::known_device_matches_entity_class(*dev, DeviceCapabilityClass::SWITCH)) {
    detail::log_rejected_operation(device_id, *dev, "queued switch command", "switch entity");
    return;
  }
 
  // Queue through the same scheduler as covers so radio work stays serialized while still keeping
  // the light-vs-switch semantics available for capability checks at dispatch time.
  this->pending_operations_.push_back({PendingOperationType::SET_SWITCH_STATE, device_id,
                                       on ? detail::BINARY_ENTITY_ON_POSITION : detail::BINARY_ENTITY_OFF_POSITION});
}
 
void IOHomeControlComponent::process_pending_operation_() {
  if (this->busy_ || this->pending_operations_.empty())
    return;
 
  // Pop before dispatch so any handler that re-queues follow-up work sees the queue in its
  // post-consumption state and cannot accidentally execute the same operation twice.
  PendingOperation const operation = std::move(this->pending_operations_.front());
  this->pending_operations_.pop_front();
 
  switch (operation.type) {
    case PendingOperationType::SET_POSITION:
      this->set_device_position(operation.device_id, operation.position);
      break;
    case PendingOperationType::SET_TILT:
      this->set_device_tilt(operation.device_id, operation.position);
      break;
    case PendingOperationType::SET_LIGHT_STATE:
      this->set_light_state(operation.device_id, operation.position == detail::BINARY_ENTITY_ON_POSITION);
      break;
    case PendingOperationType::SET_LOCK_STATE:
      this->set_lock_state(operation.device_id, operation.position == detail::BINARY_ENTITY_OFF_POSITION);
      break;
    case PendingOperationType::SET_SWITCH_STATE:
      this->set_switch_state(operation.device_id, operation.position == detail::BINARY_ENTITY_ON_POSITION);
      break;
    case PendingOperationType::REQUEST_STATUS:
      this->request_device_status(operation.device_id);
      break;
    case PendingOperationType::REQUEST_NAME:
      this->request_device_name(operation.device_id);
      break;
    case PendingOperationType::DISCOVER_AND_PAIR:
      this->discover_and_pair();
      break;
  }
}
 
}  // namespace home_io_control
}  // namespace esphome