HAMQTT_Button_Config Struct Reference

Configuration parameters for a HAMQTT button. More...

#include <hamqtt_button.h>

Public Member Functions
HAMQTT_Button_Config	hamqtt_button_config_default (void)
	Returns a default-initialized button configuration.

Public Attributes
char *	device_class
	The class of the button, which alters how its state and icon is rendered.
bool	enabled_by_default
	Set to false if the button should not be enabled when the button is first added.
char *	entity_picture
	URL to a picture for the button.
char *	icon
	Icon for the button.
char *	name
	The name of the button shown in Home Assistant.
char *	unique_id
	Unique identifier used for discovery in Home Assistant.

Detailed Description

Configuration parameters for a HAMQTT button.

Member Function Documentation

hamqtt_button_config_default()

HAMQTT_Button_Config hamqtt_button_config_default

(

void

)

Returns a default-initialized button configuration.

Caller is still responsible for assigning unique_id

Returns

A default-initialized HAMQTT_Button_Config struct.

Member Data Documentation

device_class

char* HAMQTT_Button_Config::device_class

The class of the button, which alters how its state and icon is rendered.

Note

Optional.

entity_picture

char* HAMQTT_Button_Config::entity_picture

URL to a picture for the button.

Note

Optional.

icon

char* HAMQTT_Button_Config::icon

Icon for the button.

Note

Optional.

---

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

• include/HAMQTT/hamqtt_button.h