Result payload used by hub-level management actions such as rename. More...

#include <hub_core.h>

Collaboration diagram for esphome::home_io_control::IOHomeControlComponent::ManagementActionResult:

Public Attributes
bool	success {false}
	Whether the requested management action succeeded.
bool	verified {false}
	Whether a follow-up readback verified 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 from the device.
std::string	action
	Action name, for example "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.

Detailed Description

Result payload used by hub-level management actions such as rename.

Definition at line 73 of file hub_core.h.

Member Data Documentation

◆ action

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

Action name, for example "rename_device".

Definition at line 78 of file hub_core.h.

◆ applied_name

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

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

Definition at line 82 of file hub_core.h.

◆ device_id

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

Target IO-homecontrol device ID.

Definition at line 79 of file hub_core.h.

◆ has_result_code

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

True when result_code contains a decoded CMD_ERROR_RESP byte.

Definition at line 76 of file hub_core.h.

◆ message

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

Human-readable outcome summary.

Definition at line 80 of file hub_core.h.

◆ requested_name

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

Requested normalized UTF-8 name for rename actions.

Definition at line 81 of file hub_core.h.

◆ result_code

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

Optional CMD_ERROR_RESP result byte from the device.

Definition at line 77 of file hub_core.h.

◆ success

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

Whether the requested management action succeeded.

Definition at line 74 of file hub_core.h.

◆ verified

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

Whether a follow-up readback verified the applied state.

Definition at line 75 of file hub_core.h.

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

components/home_io_control/hub_core.h

Public Attributes