[switch] Add control() method to API
#5214
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
> [!IMPORTANT] > This requires PR#10105 to be merged first as it was based on that and changes things introduced by that PR. > If that PR is not going to be merged I will be happy to remove from this one the conflicting parts. Adds a new `control(bool target_state)` method to the Switch class API, providing a unified interface for setting switch state based on a boolean parameter. ### Additional context This PR adds a new public API method to the Switch class that complements the existing `turn_on()`, `turn_off()`, and `toggle()` methods. The `control()` method is particularly useful when: - The desired switch state is determined dynamically at runtime - Writing lambda expressions that need to set switch state based on conditions - API integrations where a boolean state parameter is more convenient The method internally delegates to the existing `turn_on()` and `turn_off()` methods, ensuring consistency with the current implementation and maintaining all existing behavior. This is a companion PR to #10105 which adds the `switch.control` automation action that utilizes this new API method.
15 tasks
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Important
This requires PR#10105 to be merged first as it was based on that and changes things introduced by that PR.
If that PR is not going to be merged I will be happy to remove from this one the conflicting parts.
Adds a new
control(bool target_state)method to the Switch class API, providing a unified interface for setting switch state based on a boolean parameter.Additional context
This PR adds a new public API method to the Switch class that complements the existing
turn_on(),turn_off(), andtoggle()methods. Thecontrol()method is particularly useful when:The method internally delegates to the existing
turn_on()andturn_off()methods, ensuring consistency with the current implementation and maintaining all existing behavior. This is a companion PR to #10105 which adds theswitch.controlautomation action that utilizes this new API method.Related issue (if applicable): N/A
Pull request in esphome with YAML changes (if applicable):
control()method to API esphome#10118Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: