The last "stopped" report a device sent away from its own target, kept to confirm the next. More...

#include <proto_device_model.h>

Collaboration diagram for esphome::home_io_control::StopCandidate:

Public Member Functions
bool	armed () const
	True when a report is remembered.
void	clear ()
	Forget the remembered report.

Public Attributes
float	target {UNKNOWN_POSITION}
	Target the device reported with the off-target "stopped".
float	position {UNKNOWN_POSITION}
	Current position it reported with it.

Detailed Description

The last "stopped" report a device sent away from its own target, kept to confirm the next.

A cover can come to rest a little off its target and say so (a VELUX SSL 119-171 raw short of an end stop, a Somfy pergola 378-479 raw off an intermediate target; corpus velux_ssl_statuspoll_stopped_off_target and somfy_pergola_louver_statuspoll_replies_sx1262). A second report naming the same target and the same current position confirms the device is at rest there (decisions::classify_stopped_report()). Observed values only, never a prediction.

Definition at line 474 of file proto_device_model.h.

Member Function Documentation

◆ armed()

bool esphome::home_io_control::StopCandidate::armed ( ) const

inlinenodiscard

True when a report is remembered.

Definition at line 479 of file proto_device_model.h.

◆ clear()

void esphome::home_io_control::StopCandidate::clear ( )

inline

Forget the remembered report.

Definition at line 481 of file proto_device_model.h.

Member Data Documentation

◆ position

float esphome::home_io_control::StopCandidate::position {UNKNOWN_POSITION}

Current position it reported with it.

Definition at line 476 of file proto_device_model.h.

◆ target

float esphome::home_io_control::StopCandidate::target {UNKNOWN_POSITION}

Target the device reported with the off-target "stopped".

Definition at line 475 of file proto_device_model.h.

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

components/home_io_control/proto_device_model.h

Public Member Functions