Result of a hub-level management action such as rename. More...

#include <management_actions.h>

Collaboration diagram for esphome::home_io_control::ManagementActionResult:

Public Attributes
bool	success {false}
	Whether the requested management action succeeded.
bool	verified {false}
	Whether a follow-up readback confirmed the applied state.
bool	has_result_code {false}
	True when result_code contains a decoded CMD_ERROR_RESP byte.
uint8_t	result_code {0}
	Optional CMD_ERROR_RESP result byte.
std::string	action
	Action name, e.g. "rename_device".
std::string	device_id
	Target IO-homecontrol device ID.
std::string	message
	Human-readable outcome summary.
std::string	requested_name
	Requested normalized UTF-8 name for rename actions.
std::string	applied_name
	Verified cached UTF-8 name after a readback, when available.
std::string	probe_name
	Probe name for probe_device()/probe_sweep(), e.g. "private_fn".
std::string	probe_index
	Requested index argument, as received (before parsing).
bool	has_response_cmd {false}
	True when response_cmd contains a probe reply's command byte.
uint8_t	response_cmd {0}
	Probe reply's command byte (distinct from a CMD_ERROR_RESP result_code above, which is a different byte with a different meaning).
std::string	response_hex
	Probe reply's full raw wire hex, for pasting into scripts/corpus/ingest.py.
bool	terminal_refusal {false}
	True when probe_device() failed for a reason that will recur identically for every remaining index in a sweep (diagnostic probes not enabled, device moving) — set only by probe_device(), read only by probe_sweep() to decide whether to stop early.

Detailed Description

Result of a hub-level management action such as rename.

Returned by ManagementActions::rename_device() and re-exported from the hub as IOHomeControlComponent::ManagementActionResult via a public type alias.

Definition at line 35 of file management_actions.h.

Member Data Documentation

◆ action

std::string esphome::home_io_control::ManagementActionResult::action

Action name, e.g. "rename_device".

Definition at line 40 of file management_actions.h.

◆ applied_name

std::string esphome::home_io_control::ManagementActionResult::applied_name

Verified cached UTF-8 name after a readback, when available.

Definition at line 44 of file management_actions.h.

◆ device_id

std::string esphome::home_io_control::ManagementActionResult::device_id

Target IO-homecontrol device ID.

Definition at line 41 of file management_actions.h.

◆ has_response_cmd

bool esphome::home_io_control::ManagementActionResult::has_response_cmd {false}

True when response_cmd contains a probe reply's command byte.

Definition at line 47 of file management_actions.h.

◆ has_result_code

bool esphome::home_io_control::ManagementActionResult::has_result_code {false}

True when result_code contains a decoded CMD_ERROR_RESP byte.

Definition at line 38 of file management_actions.h.

◆ message

std::string esphome::home_io_control::ManagementActionResult::message

Human-readable outcome summary.

Definition at line 42 of file management_actions.h.

◆ probe_index

std::string esphome::home_io_control::ManagementActionResult::probe_index

Requested index argument, as received (before parsing).

Definition at line 46 of file management_actions.h.

◆ probe_name

std::string esphome::home_io_control::ManagementActionResult::probe_name

Probe name for probe_device()/probe_sweep(), e.g. "private_fn".

Definition at line 45 of file management_actions.h.

◆ requested_name

std::string esphome::home_io_control::ManagementActionResult::requested_name

Requested normalized UTF-8 name for rename actions.

Definition at line 43 of file management_actions.h.

◆ response_cmd

uint8_t esphome::home_io_control::ManagementActionResult::response_cmd {0}

Probe reply's command byte (distinct from a CMD_ERROR_RESP result_code above, which is a different byte with a different meaning).

Definition at line 48 of file management_actions.h.

◆ response_hex

std::string esphome::home_io_control::ManagementActionResult::response_hex

Probe reply's full raw wire hex, for pasting into scripts/corpus/ingest.py.

Definition at line 51 of file management_actions.h.

◆ result_code

uint8_t esphome::home_io_control::ManagementActionResult::result_code {0}

Optional CMD_ERROR_RESP result byte.

Definition at line 39 of file management_actions.h.

◆ success

bool esphome::home_io_control::ManagementActionResult::success {false}

Whether the requested management action succeeded.

Definition at line 36 of file management_actions.h.

◆ terminal_refusal

bool esphome::home_io_control::ManagementActionResult::terminal_refusal {false}

True when probe_device() failed for a reason that will recur identically for every remaining index in a sweep (diagnostic probes not enabled, device moving) — set only by probe_device(), read only by probe_sweep() to decide whether to stop early.

A structured flag rather than probe_sweep() pattern-matching message text, which would silently break if that text were ever reworded.

Definition at line 53 of file management_actions.h.

◆ verified

bool esphome::home_io_control::ManagementActionResult::verified {false}

Whether a follow-up readback confirmed the applied state.

Definition at line 37 of file management_actions.h.

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

components/home_io_control/management_actions.h

Public Attributes