[sdl] Document mouse wheel encoder sensor and mouse button binary sensor#6715
Open
clydebarrow wants to merge 1 commit into
Open
[sdl] Document mouse wheel encoder sensor and mouse button binary sensor#6715clydebarrow wants to merge 1 commit into
clydebarrow wants to merge 1 commit into
Conversation
- Add new sensor/sdl page for the mouse wheel rotary encoder - Document mouse_button option on the SDL binary sensor - Document newly-functional rotation option on the SDL display - Add SDL mouse wheel sensor to the component index - Clarify display requirement wording on the touchscreen page Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
17 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation update for the SDL host platform: adds a new sensor page for the mouse wheel rotary encoder, documents the new mouse_button option on the SDL binary sensor, documents the now-functional rotation option on the SDL display, registers the new sensor in the component index, and clarifies the SDL display requirement on the touchscreen page.
Changes:
- New
sensor/sdl.mdxpage documenting the mouse wheel encoder sensor and adding it to the component index. - Updated
binary_sensor/sdl.mdxto documentmouse_buttonand makekeyoptional. - Updated
display/sdl.mdxfor the newrotationoption and added a See Also link; touchscreen page wording clarified.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/components/sensor/sdl.mdx | New page documenting SDL mouse wheel rotary encoder sensor. |
| src/content/docs/components/binary_sensor/sdl.mdx | Adds mouse_button option and adjusts key to optional. |
| src/content/docs/components/display/sdl.mdx | Documents rotation option and adds link to new sensor page. |
| src/content/docs/components/touchscreen/sdl.mdx | Clarifies wording about required SDL display. |
| src/content/docs/components/index.mdx | Registers new SDL mouse wheel sensor entry. |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
Description
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist
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
/src/content/docs/components/index.mdxwhen 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 lower_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
/public/images/folder of this repository.Use the image in your component's index table entry in
/src/content/docs/components/index.mdx.Example: For a component called "DHT22 Temperature Sensor", use:
Note: All images used in ImgTable components must be placed in
/public/images/as the component resolves them to absolute paths.