Per-device poll scheduling state. More...

#include <status_poll_policy.h>

Collaboration diagram for esphome::home_io_control::PollTracking:

Public Attributes
uint32_t	interval_ms {0}
	Configured follow-up poll interval (0 = no configured cadence; delays fall back to remaining time / default settle delay).
uint32_t	next_update {0}
	Absolute millis() timestamp for the next poll; 0 = idle.
uint32_t	poll_deadline {0}
	Hard stop for bounded follow-up polling.
uint8_t	status_poll_failures {0}
	Consecutive background poll failures (silent — no reply).
uint8_t	auth_poll_failures {0}
	Consecutive background poll failures that saw a 0x3C challenge.
uint8_t	moving_poll_misses {0}
	Consecutive failed polls of a moving device skipped so far (see MOVING_POLL_MISSES_SKIPPED); not counted in the two streaks above.
bool	stop_settle {false}
	The next poll reads where an accepted STOP left the device (a settling read).
bool	confirm_stopped {false}
	The next poll confirms a stop off target (a settling read, see decisions::StoppedReport::SETTLING).
uint32_t	settle_update {0}
	Absolute millis() timestamp of the predicted-end read; 0 = none planned.
std::optional< uint16_t >	last_remaining_s
	Remaining time of the last report that was aimed at (> 2 s).
uint8_t	stale_reports {0}
	Reports in a row whose remaining time did not fall.
bool	predicted_end_read {false}
	The next poll is the predicted-end read (a settling read).

Detailed Description

Per-device poll scheduling state.

Definition at line 181 of file status_poll_policy.h.

Member Data Documentation

◆ auth_poll_failures

uint8_t esphome::home_io_control::PollTracking::auth_poll_failures {0}

Consecutive background poll failures that saw a 0x3C challenge.

Definition at line 187 of file status_poll_policy.h.

◆ confirm_stopped

bool esphome::home_io_control::PollTracking::confirm_stopped {false}

The next poll confirms a stop off target (a settling read, see decisions::StoppedReport::SETTLING).

Definition at line 191 of file status_poll_policy.h.

◆ interval_ms

uint32_t esphome::home_io_control::PollTracking::interval_ms {0}

Configured follow-up poll interval (0 = no configured cadence; delays fall back to remaining time / default settle delay).

Definition at line 182 of file status_poll_policy.h.

◆ last_remaining_s

std::optional<uint16_t> esphome::home_io_control::PollTracking::last_remaining_s

Remaining time of the last report that was aimed at (> 2 s).

Definition at line 194 of file status_poll_policy.h.

◆ moving_poll_misses

uint8_t esphome::home_io_control::PollTracking::moving_poll_misses {0}

Consecutive failed polls of a moving device skipped so far (see MOVING_POLL_MISSES_SKIPPED); not counted in the two streaks above.

Definition at line 188 of file status_poll_policy.h.

◆ next_update

uint32_t esphome::home_io_control::PollTracking::next_update {0}

Absolute millis() timestamp for the next poll; 0 = idle.

Definition at line 184 of file status_poll_policy.h.

◆ poll_deadline

uint32_t esphome::home_io_control::PollTracking::poll_deadline {0}

Hard stop for bounded follow-up polling.

Definition at line 185 of file status_poll_policy.h.

◆ predicted_end_read

bool esphome::home_io_control::PollTracking::predicted_end_read {false}

The next poll is the predicted-end read (a settling read).

Definition at line 196 of file status_poll_policy.h.

◆ settle_update

uint32_t esphome::home_io_control::PollTracking::settle_update {0}

Absolute millis() timestamp of the predicted-end read; 0 = none planned.

Definition at line 193 of file status_poll_policy.h.

◆ stale_reports

uint8_t esphome::home_io_control::PollTracking::stale_reports {0}

Reports in a row whose remaining time did not fall.

Definition at line 195 of file status_poll_policy.h.

◆ status_poll_failures

uint8_t esphome::home_io_control::PollTracking::status_poll_failures {0}

Consecutive background poll failures (silent — no reply).

Definition at line 186 of file status_poll_policy.h.

◆ stop_settle

bool esphome::home_io_control::PollTracking::stop_settle {false}

The next poll reads where an accepted STOP left the device (a settling read).

Definition at line 190 of file status_poll_policy.h.

The documentation for this struct was generated from the following file:

components/home_io_control/status_poll_policy.h

Public Attributes