home-assistant.io
home-assistant.io copied to clipboard
Update nsw_fuel_station documentation
To go with the update from yaml to config_flow.
Proposed change
Update documentation to go with https://github.com/home-assistant/core/pull/146001
That PR updates the integration from legacy yaml to config_flow.
Type of change
- [ ] Spelling, grammar or other readability improvements (
currentbranch). - [ ] Adjusted missing or incorrect information in the current documentation (
currentbranch). - [ ] Added documentation for a new integration I'm adding to Home Assistant (
nextbranch).- [ ] I've opened up a PR to add logos and icons in Brands repository.
- [X] Added documentation for a new feature I'm adding to Home Assistant (
nextbranch). - [ ] Removed stale or deprecated documentation.
Additional information
- Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/146001
- Link to parent pull request in the Brands repository: N/A
- This PR fixes or closes issue: fixes #
Checklist
- [X] This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the
currentbranch. - I made a change that is related to an upcoming version of Home Assistant and used the
nextbranch.
- I made a change to the existing documentation and used the
- [X] The documentation follows the Home Assistant documentation standards.
Summary by CodeRabbit
-
Documentation
- Improved clarity, structure, and formatting across multiple integration and feature documentation pages.
- Added details and troubleshooting tips for text-to-speech (TTS) options and audio settings.
- Updated device and integration support information, including new supported devices and standards.
- Simplified setup instructions and enhanced guidance for integrations such as NSW Fuel Station and ATOM Echo.
- Standardized formatting, headings, and metadata for consistency and readability.
- Clarified authentication provider documentation by removing specific installation and script references.
- Expanded Z-Wave JS documentation with detailed instructions for device removal, network migration, backup, reset, and full removal.
- Added new integration documentations for Shelly Z-Wave and updated code ownership metadata for multiple integrations.
- Removed documentation for deprecated integrations including Decora, Dlib face detect/identify, Eddystone temperature, GStreamer, Keyboard, LIRC, Pandora, SMS, Snips, TensorFlow, and others.
- Updated blueprint schema, templating, and common task documentation for improved clarity.
- Enhanced update procedures and troubleshooting guidance for Home Assistant OS and Core.
- Refined documentation for various integrations to reflect new features, metadata, and supported platforms.
-
Chores
- Updated development dependencies including Rubocop and textlint.
- Enhanced GitHub workflow to enforce markdown file naming conventions.
- Updated codeowners file to reflect current maintainers and contributors.
- Incremented Home Assistant version and release date metadata.
Deploy Preview for home-assistant-docs ready!
| Name | Link |
|---|---|
| Latest commit | 828de7cdb8b9c4255b6e23769a790d01bcde62d4 |
| Latest deploy log | https://app.netlify.com/projects/home-assistant-docs/deploys/684d25fb3429400008a8f84c |
| Deploy Preview | https://deploy-preview-39348--home-assistant-docs.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
π Walkthrough
Walkthrough
This update includes documentation improvements, formatting standardization, and minor metadata enhancements across multiple markdown files. It introduces a new GitHub Actions workflow step to enforce .markdown file extensions in a specific directory, updates several development gem versions, and revises numerous integration docs for clarity, consistency, and up-to-date configuration instructions. Several deprecated or removed integration docs were deleted and redirects added. New integration docs and metadata were added or updated. No changes to code or exported entities were made.
Changes
| File(s) | Change Summary |
|---|---|
| .github/workflows/test.yml | Added a workflow step to detect .md files in source/_integrations, warn, and fail if found. |
| Gemfile | Updated development gems: rake 13.2.1 β 13.3.0, sass-embedded 1.89.0 β 1.89.2, rubocop 1.75.7 β 1.76.1, ruby-lsp 0.23.23 β 0.24.1. |
| package.json | Updated textlint devDependency from ^14.7.2 to ^14.8.0. |
| source/_docs/authentication/providers.markdown | Removed Home Assistant Core limitation and LDAP script reference from command line provider documentation. |
| source/_integrations/eafm.markdown source/_integrations/ipp.markdown source/_integrations/locative.markdown |
Standardized YAML frontmatter delimiters from four dashes to three dashes; minor spacing adjustments. |
| source/_integrations/esphome.markdown | Reorganized for stylistic consistency: used integration term macro, adjusted heading case, improved formatting, and repositioned the "Removing the integration" section. No technical content changes. |
| source/_integrations/eve.markdown | Added works_with: matter to integration metadata. |
| source/_integrations/govee_ble.markdown | Added H5129 device with link; noted active scan requirement for H5075 and H5129 in supported devices list. |
| source/_integrations/linkplay.markdown source/_integrations/motionmount.markdown |
Changed markdown list and frontmatter delimiters from hyphens to plus signs; no content changes. |
| source/_integrations/nsw_fuel_station.markdown | Replaced manual setup instructions with configuration flow include; removed YAML config example; clarified fuel type modification process. |
| source/_integrations/tts.markdown | Expanded documentation for tts.speak/say actions: detailed supported options, audio settings, cache behavior, REST API parameters, and troubleshooting for audio issues. Added section on preferred audio settings and example usage. |
| source/voice_control/index.markdown | Changed capitalization of two section headers for consistency. |
| source/voice_control/thirteen-usd-voice-remote.markdown | Updated setup instructions to describe a customization wizard; added section on removing Wi-Fi credentials via USB serial; corrected minor text and navigation details. |
| source/_integrations/adax.markdown | Added "Sensor" platform and "Energy monitoring" section; added new codeowner @lazytarget. |
| source/_integrations/airgradient.markdown | Expanded documentation with new sections on use cases, supported devices, update entity, update intervals, limitations, troubleshooting, and example automation. |
| source/_integrations/airthings.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/alexa_devices.markdown | Renamed from Amazon Devices to Alexa Devices; domain and IoT class updated; expanded supported platforms and devices; added MFA account warning; updated supported entities list. |
| source/_integrations/balay.markdown | Added ha_zeroconf: true metadata field. |
| source/_integrations/beewi_smartclim.markdown | Removed instructions for installing Bluetooth backend on Home Assistant Core; retained container and host support notes. |
| source/_integrations/blue_current.markdown | Added "button" platform to metadata. |
| source/_integrations/bluesound.markdown | Reordered ha_platforms list: button before media_player. |
| source/_integrations/bluetooth.markdown | Removed references to Home Assistant Core and Supervised in Linux Bluetooth requirements; renamed subsection to focus on Container; generalized version requirements. |
| source/_integrations/bosch_alarm.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/comelit.markdown | Changed ha_quality_scale from bronze to silver. |
| source/_integrations/constructa.markdown | Added ha_zeroconf: true metadata field. |
| source/_integrations/decora.markdown | Deleted integration documentation file for Leviton Decora Bluetooth dimmer. |
| source/_integrations/dlib_face_detect.markdown | Deleted integration documentation file. |
| source/_integrations/dlib_face_identify.markdown | Deleted integration documentation file. |
| source/_integrations/eddystone_temperature.markdown | Deleted integration documentation file. |
| source/_integrations/eheimdigital.markdown | Added diagnostics platform to metadata. |
| source/_integrations/energenie_power_sockets.markdown | Removed mention of Home Assistant Core from USB device access troubleshooting; retained Container note. |
| source/_integrations/ezviz.markdown | Removed @baqs from codeowners. |
| source/_integrations/gaggenau.markdown | Added ha_zeroconf: true metadata field. |
| source/_integrations/gpsd.markdown | Removed entire "Setup" section including installation and testing instructions. |
| source/_integrations/growatt_server.markdown | Added "Prerequisites" section specifying Growatt account requirement. |
| source/_integrations/gstreamer.markdown | Deleted integration documentation file. |
| source/_integrations/home_connect.markdown | Added ha_dhcp: true metadata; corrected heading from "List of binary sensors" to "List of sensors". |
| source/_integrations/homee.markdown | Changed platform identifier from alarm-control-panel to alarm_control_panel. |
| source/_integrations/immich.markdown | Changed integration type from "service" to "integration"; added ha_quality_scale: silver; updated media source and troubleshooting links to absolute paths. |
| source/_integrations/jewish_calendar.markdown | Added diagnostics platform to metadata. |
| source/_integrations/keyboard.markdown | Deleted integration documentation file. |
| source/_integrations/knocki.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/knx.markdown | Clarified and standardized documentation for remove and respond_to_read parameters in KNX entity platforms; improved descriptions without changing behavior. |
| source/_integrations/lamarzocco.markdown | Updated data updates description: clarified push updates and fallback polling intervals with new schedule updates polling. |
| source/_integrations/lirc.markdown | Deleted integration documentation file. |
| source/_integrations/matter.markdown | Removed statement disallowing Matter on Home Assistant Core; clarified supported installation types and support status. |
| source/_integrations/media_source.markdown | Removed incorrect statement about default media directory for Home Assistant Core users. |
| source/_integrations/met_eireann.markdown | Updated URLs referencing Met Γireann API dataset. |
| source/_integrations/mqtt.markdown | Minor formatting and link updates; no functional changes. |
| source/_integrations/neff.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/nextcloud.markdown | Added detailed list of sensors created by the integration with default enabled states; noted update entity creation. |
| source/_integrations/onvif.markdown | Removed note about installing libxml2 and libxslt Python interfaces on virtual environments. |
| source/_integrations/openweathermap.markdown | Added new codeowner @wittypluck. |
| source/_integrations/pandora.markdown | Deleted integration documentation file. |
| source/_integrations/paperless_ngx.markdown | Increased quality scale from "bronze" to "silver"; added note about minimum supported Paperless-ngx version 2.15. |
| source/_integrations/pitsos.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/powerfox.markdown | Corrected polling interval from 1 minute to 10 seconds. |
| source/_integrations/probe_plus.markdown | Capitalized ha_iot_class value from "local_push" to "Local Push". |
| source/_integrations/profilo.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/ps4.markdown | Removed entire "Debian-based" section under "Granting Port Access". |
| source/_integrations/recorder.markdown | Added new action recorder.get_statistics with parameters and example usage. |
| source/_integrations/rehlko.markdown | Added "binary_sensor" platform to metadata. |
| source/_integrations/remote_calendar.markdown | Fixed typographical error: changed "an resource" to "a resource". |
| source/_integrations/russound_rio.markdown | Added "Russound ACA-E5" to supported devices list. |
| source/_integrations/russound_rnet.markdown | Removed "Russound ACA-E5" from supported devices list. |
| source/_integrations/scrape.markdown | Added new configuration option payload_template (template type) for POST request payloads. |
| source/_integrations/seventeentrack.markdown | Added new action seventeentrack.add_package with required data attributes and example usage. |
| source/_integrations/shelly.markdown | Added ha_quality_scale: silver metadata. |
| source/_integrations/shelly_zwave.markdown | Added new integration documentation for Shelly Z-Wave devices with metadata, supported devices, and references. |
| source/_integrations/siemens.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/sms.markdown | Deleted integration documentation file. |
| source/_integrations/snips.markdown | Deleted integration documentation file. |
| source/_integrations/spotify.markdown | Formatting and indentation improvements; updated polling description with glossary term markup. |
| source/_integrations/sql.markdown | Added "Data updates" section describing default polling and custom polling interval instructions; removed MS SQL specific subsection. |
| source/_integrations/squeezebox.markdown | Added "Update" category to metadata. |
| source/_integrations/sun.markdown | Updated codeowner from @Swamp-Ig to @home-assistant/core. |
| source/_integrations/switchbot.markdown | Reordered "Fan" category; added codeowner @zerzhang; set quality scale to gold; added new lock and hub devices with detailed features. |
| source/_integrations/switchbot_cloud.markdown | Added newline at end of file. |
| source/_integrations/template.markdown | Removed @PhracturedBlue from codeowners; updated cover entity state template description and link. |
| source/_integrations/tensorflow.markdown | Deleted integration documentation file. |
| source/_integrations/thermador.markdown | Added ha_dhcp: true metadata field. |
| source/_integrations/voip.markdown | Added new codeowner @jaminh. |
| source/_integrations/zerproc.markdown | Removed section on Bluetooth stack requirements for Home Assistant Core Python environments. |
| source/_integrations/zimi.markdown | Lowercased title; removed codeowner @mhannon11; added ha_quality_scale: bronze and ha_integration_type: integration metadata. |
| source/_integrations/zwave_js.markdown | Significantly expanded documentation: added detailed setup steps, device removal, network migration, backup, controller reset, and removal instructions; improved advanced installation notes and UI clarifications; restructured sections for clarity. |
| source/_posts/2023-01-04-release-20231.markdown | Updated URL for intents and languages project to https://ohf-voice.github.io/intents/. |
| source/_posts/2023-01-26-year-of-the-voice-chapter-1.markdown | Updated URL for Home Assistant Intents project to https://ohf-voice.github.io/intents/. |
| source/_posts/2023-02-01-release-20232.markdown | Updated URL for Home Assistant Intents project to https://ohf-voice.github.io/intents/. |
| source/_posts/2023-04-27-year-of-the-voice-chapter-2.markdown | Updated URL linked to "[45 languages]" to https://ohf-voice.github.io/intents/. |
| source/_posts/2023-07-20-year-of-the-voice-chapter-3.markdown | Updated URL linked to "[50 languages]" to https://ohf-voice.github.io/intents/. |
| source/_posts/2023-10-12-year-of-the-voice-chapter-4-wakewords.markdown | Updated URL for supported languages link to https://ohf-voice.github.io/intents/. |
| source/_posts/2024-12-04-release-202412.markdown | Minor textual and whitespace edits; updated URL for language contributions progress to https://ohf-voice.github.io/intents/; removed trailing spaces in integration lists. |
| source/_posts/2024-12-19-voice-chapter-8-assist-in-the-home.markdown | Corrected URL link for language support to https://ohf-voice.github.io/intents/. |
| source/_posts/2025-02-05-release-20252.markdown | Updated documentation link for Broadcast intent language support to https://ohf-voice.github.io/intents/. |
| source/_posts/2025-06-11-release-20256.markdown | New release blog post announcing Home Assistant 2025.6 with new features, integrations, improvements, deprecations, and fixes. |
| source/_redirects | Added redirects for removed integrations: decora, dlib_face_detect, dlib_face_identify, eddystone_temperature, gstreamer, keyboard, lirc, pandora, sms, snips, tensorflow. |
| source/changelogs/core-2025.6.markdown | New comprehensive changelog for Home Assistant Core 2025.6 and 2025.6.1 patch covering new features, integrations, fixes, typing improvements, and more. |
| source/common-tasks/general.markdown | Changed heading levels from ## to ### for two sections in "Defining a custom polling interval". |
| source/common-tasks/os.markdown | Enhanced OS update documentation with clearer instructions, troubleshooting, backup emphasis, advanced boot slot explanation, and formatting improvements. |
| source/green/index.html | Removed pricing mention "$99" from Home Assistant Green description. |
| source/installation/troubleshooting.markdown | Clarified instruction to select "Show details" instead of "pulsing blue dot" for viewing logs during onboarding. |
| source/more-info/unsupported/lxc.markdown | Fixed typo: changed "prosed" to "proceed". |
| source/voice-pe/index.html | Changed pricing display from "$59" to "$69 / β¬59"; expanded pricing disclaimer to clarify regional price differences. |
| source/voice-pe/styles.css | Adjusted CSS variable --price-mobile for responsiveness; modified margin-bottom of price text with media queries for different screen widths. |
Sequence Diagram(s)
sequenceDiagram
participant GitHub Actions
participant Workflow Step
participant Developer
GitHub Actions->>Workflow Step: Run markdown-lint job
Workflow Step->>Workflow Step: Search for .md files in source/_integrations
alt .md files found
Workflow Step->>Developer: Output file paths and warning
Workflow Step->>Workflow Step: Exit with status 1 (fail job)
else No .md files found
Workflow Step->>Workflow Step: Continue to next step
end
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
πͺ§ Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and explain its main purpose.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaior@coderabbitai titleanywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
hi there, @buxtronix. Thank you for contributing πͺ
It looks like this PR was created based on the current branch. Please rebase it against the next branch. One way to do this is to close this PR, pull the latest next branch, and create a new branch based on that.
I'm drafting this PR, as changes are needed. Please undraft it, once the changes have been implemented and the PR is ready for review again.