Upstream/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-11-29 12:55:46 +01:00
Code Issues Projects Releases Wiki Activity

add SUB_BUTTON macro and ability to button schema to define the class (#4450)

Browse Source 
* add ability to button schema to define the class

* add SUB_BUTTON macro
This commit is contained in:
Regev Brody 2023-02-19 21:54:03 +02:00 committed by GitHub
parent e68beb8a43
commit 72391389a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 28 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
esphome/components/button/__init__.py
View File

@ -17,6 +17,7 @@ from esphome.const import (
) )
from esphome.core import CORE, coroutine_with_priority from esphome.core import CORE, coroutine_with_priority
from esphome.cpp_helpers import setup_entity from esphome.cpp_helpers import setup_entity
from esphome.cpp_generator import MockObjClass
CODEOWNERS = ["@esphome/core"] CODEOWNERS = ["@esphome/core"]
IS_PLATFORM_COMPONENT = True IS_PLATFORM_COMPONENT = True
@ -56,11 +57,15 @@ _UNDEF = object()
def button_schema( def button_schema(
class_: MockObjClass = _UNDEF,
*,
icon: str = _UNDEF, icon: str = _UNDEF,
entity_category: str = _UNDEF, entity_category: str = _UNDEF,
device_class: str = _UNDEF, device_class: str = _UNDEF,
) -> cv.Schema: ) -> cv.Schema:
schema = BUTTON_SCHEMA schema = BUTTON_SCHEMA
if class_ is not _UNDEF:
schema = schema.extend({cv.GenerateID(): cv.declare_id(class_)})
if icon is not _UNDEF: if icon is not _UNDEF:
schema = schema.extend({cv.Optional(CONF_ICON, default=icon): cv.icon}) schema = schema.extend({cv.Optional(CONF_ICON, default=icon): cv.icon})
if entity_category is not _UNDEF: if entity_category is not _UNDEF:

7
esphome/components/button/button.h
View File

@ -15,6 +15,13 @@ namespace button {
} \ } \
} }
#define SUB_BUTTON(name) \
protected: \
button::Button *name##_button_{nullptr}; \
\
public: \
void set_##name##_button(button::Button *button) { this->name##_button_ = button; }
/** Base class for all buttons. /** Base class for all buttons.
* *
* A button is just a momentary switch that does not have a state, only a trigger. * A button is just a momentary switch that does not have a state, only a trigger.

3
esphome/components/copy/button/__init__.py
View File

@ -16,10 +16,9 @@ CopyButton = copy_ns.class_("CopyButton", button.Button, cg.Component)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = (
button.button_schema() button.button_schema(CopyButton)
.extend( .extend(
{ {
cv.GenerateID(): cv.declare_id(CopyButton),
cv.Required(CONF_SOURCE_ID): cv.use_id(button.Button), cv.Required(CONF_SOURCE_ID): cv.use_id(button.Button),
} }
) )

15
esphome/components/factory_reset/button/__init__.py
View File

@ -13,15 +13,12 @@ FactoryResetButton = factory_reset_ns.class_(
"FactoryResetButton", button.Button, cg.Component "FactoryResetButton", button.Button, cg.Component
) )
CONFIG_SCHEMA = ( CONFIG_SCHEMA = button.button_schema(
button.button_schema( FactoryResetButton,
device_class=DEVICE_CLASS_RESTART, device_class=DEVICE_CLASS_RESTART,
entity_category=ENTITY_CATEGORY_CONFIG, entity_category=ENTITY_CATEGORY_CONFIG,
icon=ICON_RESTART_ALERT, icon=ICON_RESTART_ALERT,
) ).extend(cv.COMPONENT_SCHEMA)
.extend({cv.GenerateID(): cv.declare_id(FactoryResetButton)})
.extend(cv.COMPONENT_SCHEMA)
)
async def to_code(config): async def to_code(config):

12
esphome/components/restart/button/__init__.py
View File

@ -10,13 +10,11 @@ from esphome.const import (
restart_ns = cg.esphome_ns.namespace("restart") restart_ns = cg.esphome_ns.namespace("restart")
RestartButton = restart_ns.class_("RestartButton", button.Button, cg.Component) RestartButton = restart_ns.class_("RestartButton", button.Button, cg.Component)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = button.button_schema(
button.button_schema( RestartButton,
device_class=DEVICE_CLASS_RESTART, entity_category=ENTITY_CATEGORY_CONFIG device_class=DEVICE_CLASS_RESTART,
) entity_category=ENTITY_CATEGORY_CONFIG,
.extend({cv.GenerateID(): cv.declare_id(RestartButton)}) ).extend(cv.COMPONENT_SCHEMA)
.extend(cv.COMPONENT_SCHEMA)
)
async def to_code(config): async def to_code(config):

2
esphome/components/safe_mode/button/__init__.py
View File

@ -17,11 +17,11 @@ SafeModeButton = safe_mode_ns.class_("SafeModeButton", button.Button, cg.Compone
CONFIG_SCHEMA = ( CONFIG_SCHEMA = (
button.button_schema( button.button_schema(
SafeModeButton,
device_class=DEVICE_CLASS_RESTART, device_class=DEVICE_CLASS_RESTART,
entity_category=ENTITY_CATEGORY_CONFIG, entity_category=ENTITY_CATEGORY_CONFIG,
icon=ICON_RESTART_ALERT, icon=ICON_RESTART_ALERT,
) )
.extend({cv.GenerateID(): cv.declare_id(SafeModeButton)})
.extend({cv.GenerateID(CONF_OTA): cv.use_id(OTAComponent)}) .extend({cv.GenerateID(CONF_OTA): cv.use_id(OTAComponent)})
.extend(cv.COMPONENT_SCHEMA) .extend(cv.COMPONENT_SCHEMA)
) )

8
esphome/components/shutdown/button/__init__.py
View File

@ -10,11 +10,9 @@ from esphome.const import (
shutdown_ns = cg.esphome_ns.namespace("shutdown") shutdown_ns = cg.esphome_ns.namespace("shutdown")
ShutdownButton = shutdown_ns.class_("ShutdownButton", button.Button, cg.Component) ShutdownButton = shutdown_ns.class_("ShutdownButton", button.Button, cg.Component)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = button.button_schema(
button.button_schema(entity_category=ENTITY_CATEGORY_CONFIG, icon=ICON_POWER) ShutdownButton, entity_category=ENTITY_CATEGORY_CONFIG, icon=ICON_POWER
.extend({cv.GenerateID(): cv.declare_id(ShutdownButton)}) ).extend(cv.COMPONENT_SCHEMA)
.extend(cv.COMPONENT_SCHEMA)
)
async def to_code(config): async def to_code(config):