-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Lidl auriol docs #4733
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: current
Are you sure you want to change the base?
Lidl auriol docs #4733
Conversation
## Walkthrough
The documentation was updated to add support for multiple new weather station models in the `remote_receiver` component, including configuration variables and automation triggers for each. Additionally, various documentation files were added or updated to reflect new components, sensor configuration changes, and version updates.
## Changes
| File | Change Summary |
|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| components/remote_receiver.rst | Added new configuration variables and automation triggers for multiple weather station models (e.g., WS2032, Lidl 4LD, Nexus, AHFL). Added these as remote code options for binary sensors. |
| components/audio_dac/es8388.rst | Added new documentation for the ES8388 audio DAC component, detailing configuration and usage. |
| components/display/max7219digit.rst | Added documentation of new runtime actions for MAX7219 digit display (invert, turn on/off, reverse, intensity). |
| components/esp32.rst | Updated documentation to add CPU frequency options (360MHz, 400MHz) and new ESP32 variants (esp32c2, esp32c5, esp32c6, esp32p4). |
| components/index.rst | Added new component entries for USB Host, USB UART, CM1106 sensor, and ES8388 audio DAC in the documentation index. |
| components/logger.rst | Added documentation for ESP32-C5 and ESP32-P4 variants with default UART pin mappings and supported logging interfaces. |
| components/lvgl/index.rst | Clarified default and fallback behavior of LVGL buffer_size configuration option. |
| components/lvgl/widgets.rst | Added optional `content_style` configuration variable to the LVGL tabview widget. |
| components/online_image.rst | Added documentation for new boolean `cached` variable in lambdas indicating image cache status. |
| components/sensor/cm1106.rst | Added new documentation for CM1106 CO2 sensor platform, including zero-point calibration action. |
| components/sensor/ccs811.rst | Simplified example config; made `eco2` and `tvoc` optional; clarified default I2C address. |
| components/sensor/dps310.rst | Changed `pressure` and `temperature` config variables from required to optional. |
| components/sensor/ee895.rst | Simplified example config; made sensor options optional; renamed sensors to shorter names. |
| components/sensor/ens160.rst | Simplified examples; changed `eco2` and `tvoc` from required to optional; updated SPI example pin placeholder. |
| components/sensor/hte501.rst | Simplified example config; made temperature and humidity sensors optional and renamed. |
| components/sensor/hyt271.rst | Simplified example config; made temperature and humidity optional and renamed sensors. |
| components/sensor/mhz19.rst | Changed `co2` and `temperature` config variables from required to optional. |
| components/sensor/ms5611.rst | Simplified example config; made `pressure` and `temperature` optional; renamed sensors. |
| components/sensor/ms8607.rst | Changed temperature, pressure, and humidity config variables from required to optional. |
| components/sensor/senseair.rst | Simplified example config; made `co2` sensor optional; removed explicit UART config. |
| components/sensor/sgp30.rst | Simplified example config; changed `eco2` and `tvoc` from required to optional; updated defaults for `store_baseline` and `update_interval`. |
| components/sensor/shtcx.rst | Simplified example config; made temperature and humidity optional; renamed sensors. |
| components/sensor/t6615.rst | Changed `co2` config variable from required to optional. |
| components/switch/modbus_controller.rst | Added optional boolean `assumed_state` configuration variable to disable periodic register reads. |
| components/sx1509.rst | Clarified keypad pin usage; changed key_rows range to 2–8; added `keys` string and `on_key` automation trigger; updated references. |
| components/usb_host.rst | Added new documentation for USB Host interface on ESP32-S3 and ESP32-S2 devices, including device configuration and behavior. |
| components/usb_uart.rst | Added new documentation for USB UART component on ESP32-S3 and ESP32-S2 devices, detailing supported devices and configuration options. |
| conf.py | Updated project documentation version and release strings to "2025.6" and "2025.6.0-dev". |
| Doxygen | Updated project version number in Doxygen config from "2025.5.0" to "2025.6.0-dev". |
| Makefile | Changed `ESPHOME_REF` variable from fixed version "2025.5.1" to "dev". |
| _static/version | Updated version identifier from "2025.5.1" to "2025.6.0-dev". |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant WS as Weather Station
participant RR as Remote Receiver
participant AT as Automation Trigger
WS->>RR: Transmit weather data (e.g., WS2032, Lidl 4LD, Nexus, AHFL)
RR->>RR: Decode weather data
RR->>AT: Trigger corresponding automation (pass x: WeatherStationData) Suggested labels
Suggested reviewers
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
components/remote_transmitter.rst (1)
956-980
: New Action Documentation for Lidl AuriolThe new
remote_transmitter.transmit_lidl_auriol
action is well incorporated and follows the established format of other remote transmitter actions. However, please consider the following points:
- The YAML snippet uses
battery_level: 1
while the documentation specifies a boolean value (e.g.true
/false
). It is advisable to use an explicit boolean (e.g.true
if the battery is not low, orfalse
if it is low) for clarity.- There appears to be a potential inconsistency in the unit or description of the rain parameter. Here it is described as “measured rain delta (impulses)”, so ensure that this matches with the corresponding field in the receiver documentation.
- In the transmitter documentation the field is named battery_level while the receiver uses batter_level. Please confirm the intended naming and adjust for consistency across components.
components/remote_receiver.rst (2)
68-68
: New Protocol Entry for Lidl AuriolThe addition of the lidl_auriol protocol entry in the configuration variables is clear and consistent with similar entries. Please verify that the documented parameters (e.g., units for rain delta) are in line with the rest of the documentation.
236-239
: New Automation Trigger: on_lidl_auriolThe documentation for the on_lidl_auriol automation trigger is well detailed and matches the style of other triggers. A couple of points to check:
- The data type is presented as
remote_base::LidlAuriolData
. Please ensure that the field names within this structure are consistent with the transmitter documentation (notably, confirm whether it should bebattery_level
orbatter_level
).- Also, verify the unit consistency for the rain measurement, as the transmitter documentation mentions “impulses” whereas elsewhere similar parameters might use different units.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
components/remote_receiver.rst
(3 hunks)components/remote_transmitter.rst
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/remote_receiver.rst
components/remote_transmitter.rst
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/remote_receiver.rst (1)
236-238
: Introduce Automation Trigger for Lidl Auriol DataThe new automation trigger on_lidl_auriol is well-documented. It provides the necessary detail—including the data type, suggestions for creating template sensors, the repetition of the 52-bit code, and the recommendation for a throttle filter. For clarity, you might consider breaking the technical details (sync word timing and idle time recommendation) into a sub-list or a short note.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
components/remote_receiver.rst
(3 hunks)components/remote_transmitter.rst
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- components/remote_transmitter.rst
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/remote_receiver.rst
🔇 Additional comments (2)
components/remote_receiver.rst (2)
68-68
: Add New Dump Option for Lidl AuriolThe new dump option for lidl_auriol is added in line with the other codec entries. The text is clear and consistent with the existing style.
505-512
: Document Remote Code Selection for Lidl AuriolA new trigger for lidl_auriol is introduced in the remote code selection section, specifying the required parameters:
- id: 8-bit identifier unique to the sensor.
- battery_level: (Required, bool) with the note that it is
false
when the battery is low.- channel, temperature, and rain: Clearly documented.
Ensure that the description for battery_level accurately reflects the sensor behavior (i.e.,
false
indicates low battery).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
components/remote_receiver.rst (2)
505-506
: Duplicate Entry in Binary Sensor Triggers
It appears that the bullet forlidl_auriol
in the binary sensor section is duplicated over two consecutive lines. Please remove one of these lines to avoid redundancy and ensure clarity in the documentation.
507-512
: Define Data Structure for Lidl Auriol Trigger
The field definitions for thelidl_auriol
binary sensor trigger (i.e.id
,battery_level
,channel
,temperature
, andrain
) are consistent with the expected sensor data. For improved clarity, consider specifying that forbattery_level
, a value offalse
indicates a low battery (or rephrase to “battery low”) to eliminate any ambiguity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/remote_receiver.rst
(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/remote_receiver.rst
🔇 Additional comments (1)
components/remote_receiver.rst (1)
68-68
: Add Lidl Auriol Dump Protocol
The new dump configuration forlidl_auriol
is clearly added and follows the same style as the other protocol entries. This correctly extends the list of supported protocols.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (2)
components/remote_receiver.rst (2)
236-239
: New Automation Trigger for Lidl Auriol
The addition of the on_lidl_auriol automation trigger is clear and consistent with the other triggers. It properly documents the data type passed to automations and even includes a note regarding template sensors. For clarity, consider linking to further guidance on setting up those template sensors if such documentation exists elsewhere in the project.
507-516
: Detailed Field Documentation for Lidl Auriol Data
The documentation for the Lidl Auriol trigger’s data structure is comprehensive and clear. Each field is well defined, which will help users understand the expected data format. In a future update, you might consider adding model-specific notes or examples to indicate which fields are applicable to which sensor models for even better clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/remote_receiver.rst
(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/remote_receiver.rst
🔇 Additional comments (1)
components/remote_receiver.rst (1)
68-68
: New Configuration Variable Addition for Lidl Auriol
The newly added bullet for lidl_auriol fits well with the existing list of decoders. It clearly indicates that this protocol will decode and dump Lidl Weather Station data. Please ensure that the implementation behind this configuration variable behaves as documented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/remote_transmitter.rst (1)
956-985
: Review of the "transmit_lidl_auriol" Action AdditionThe new action
remote_transmitter.transmit_lidl_auriol
is clearly defined and follows the established documentation structure. The YAML code block demonstrates a minimal configuration that includes the required parameter (model
) along with several optional parameters such asid
,battery_level
,channel
,temperature
, andrain
.Suggestions:
- Expand YAML Example: Consider extending the YAML sample to include additional optional parameters such as
humidity
,wind_direction_degrees
,wind_speed
, andwind_gust
. This will provide users with a more comprehensive example and clarify the full range of configurable options.- Clarify "battery_level": The configuration description for
battery_level
notes that "Most models only expect a one bit value. Below 25 will be mapped to 0." It may be beneficial to clarify whether users should supply a percentage value or a binary indicator based on this mapping.Overall, the addition is consistent with similar actions documented in this file, and the structure is easy to follow.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/remote_transmitter.rst
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/remote_transmitter.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/remote_receiver.rst (1)
240-254
: Inconsistent Indentation in New Weather Station Automation TriggersThere is an indentation inconsistency in the multi-line bullet items for the new weather station automation triggers. For example, in the "on_weather_station_4ld631", "on_weather_station_h10515", and "on_weather_station_l08037a" items, the first continuation line is indented with three spaces instead of the two spaces used elsewhere. This inconsistency likely causes the reStructuredText linter error
Definition list ends without a blank line; unexpected unindent
Please adjust these lines to use two spaces for continuation lines so that the list is parsed correctly.
Below is a diff proposal to fix the indentation:
@@ - 4LD631 weather station data has been decoded. A variable ``x`` of type :apistruct:`remote_base::WeatherStationData` + 4LD631 weather station data has been decoded. A variable ``x`` of type :apistruct:`remote_base::WeatherStationData` @@ - H10515/DCF weather station data has been decoded. A variable ``x`` of type :apistruct:`remote_base::WeatherStationData` + H10515/DCF weather station data has been decoded. A variable ``x`` of type :apistruct:`remote_base::WeatherStationData` @@ - L08037A weather station data has been decoded. A variable ``x`` of type :apistruct:`remote_base::WeatherStationData` + L08037A weather station data has been decoded. A variable ``x`` of type :apistruct:`remote_base::WeatherStationData`🧰 Tools
🪛 GitHub Actions: Lint
[error] 245-245: Definition list ends without a blank line; unexpected unindent.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/remote_receiver.rst
(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/remote_receiver.rst
🪛 GitHub Actions: Lint
components/remote_receiver.rst
[error] 245-245: Definition list ends without a blank line; unexpected unindent.
🔇 Additional comments (1)
components/remote_receiver.rst (1)
68-72
: New Weather Station Configuration Variables AddedThe five new configuration variables for weather stations are clearly described and follow the established style. Ensure that the corresponding backend handling is updated if needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/remote_receiver.rst
(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/remote_receiver.rst
🔇 Additional comments (2)
components/remote_receiver.rst (2)
68-72
: New Weather Station Configuration Variables Added
The documentation now includes new configuration variables for weather station data decoding. The descriptions—for example, “Decode and dump WS2032 weather station data” and “Decode and dump Lidl 4LD631 weather station data”—are clear. Please verify that the use of vendor names (e.g., “Lidl” versus “Nexus”) is consistent with your overall naming conventions and design intent.
240-254
: New Automation Triggers for Weather Stations Introduced
These new automation trigger entries (with theon_
prefix) provide detailed guidance (including the recommendation to "Create template sensors to pass them further to HA") for handling weather station data. The clarity in the trigger descriptions is good; please ensure that their usage aligns with existing automation trigger patterns in the documentation.
components/remote_receiver.rst
Outdated
- **weather_station_2032**: Trigger on a decoded WS2032 weather station data. | ||
- **weather_station_4ld631**: Trigger on a decoded Lidl 4LD631 weather station data. | ||
- **weather_station_h10515**: Trigger on a decoded Lidl H10515/DCF weather station data. | ||
- **weather_station_l08037a**: Trigger on a decoded Lidl L08037A weather station data. | ||
- **weather_station_nexus**: Trigger on a decoded Nexus weather station data. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Duplicate Weather Station Trigger Documentation Detected
There is an additional block of weather station trigger entries without the on_
prefix that duplicates the information already provided in lines 240–254. This redundancy can cause confusion. It is recommended to remove one of these duplicate blocks—preferably the non-prefixed entries—to improve clarity and maintain consistency. For example, applying the following diff to remove the duplicate block is suggested:
Please review and remove this duplicate block so that only the properly prefixed automation triggers (lines 240–254) remain.
Committable suggestion skipped: line range outside the PR's diff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next
branch and rebase.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
No idea what to do. I had no next branch in my fork. Now created one and rebased my branch onto it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (5)
components/online_image.rst (1)
72-73
: Typographical Consistency: Use Singular “Lambda” ReferenceFor consistency with other ESPHome docs, consider changing “:ref:
lambdas <config-lambda>
” to the singular form “:ref:lambda <config-lambda>
”.components/sx1509.rst (3)
63-67
: Consider adding an example forkeys
andon_key
It may help users to see a concrete snippet showing how to format thekeys
string and configure anon_key
automation. For instance:keys: "123A456B789C*0#D" on_key: then: - logger.log: "Pressed key: {{ x }}"
74-78
: Fix typo in note block
There’s a duplicated “the the” in the note. Removing one improves readability.- Automatic handling of multiple keys (e.g. PIN code entry) is possible with the - the :ref:`Key Collector <key_collector>` component. + Automatic handling of multiple keys (e.g. PIN code entry) is possible with the + :ref:`Key Collector <key_collector>` component.
212-212
: Verify the key_collector link format
Ensure that the:doc:
reference resolves correctly—consider using a title/path form, e.g.:- :doc:`Key Collector component </components/key_collector>`components/sensor/ms5611.rst (1)
42-45
: Make temperature sub-entity optional
Thetemperature
configuration block is now marked as Optional, matching the simplified documentation style.Consider swapping the order of the
temperature
andpressure
bullets here to match the order shown in the example configuration snippet.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
components/sensor/images/cm1106.png
is excluded by!**/*.png
images/cm1106.png
is excluded by!**/*.png
images/es8388.svg
is excluded by!**/*.svg
images/usb.svg
is excluded by!**/*.svg
📒 Files selected for processing (31)
Doxygen
(1 hunks)Makefile
(1 hunks)_static/version
(1 hunks)components/audio_dac/es8388.rst
(1 hunks)components/display/max7219digit.rst
(1 hunks)components/esp32.rst
(2 hunks)components/index.rst
(3 hunks)components/logger.rst
(2 hunks)components/lvgl/index.rst
(2 hunks)components/lvgl/widgets.rst
(1 hunks)components/online_image.rst
(1 hunks)components/remote_receiver.rst
(3 hunks)components/sensor/ccs811.rst
(2 hunks)components/sensor/cm1106.rst
(1 hunks)components/sensor/dps310.rst
(1 hunks)components/sensor/ee895.rst
(1 hunks)components/sensor/ens160.rst
(2 hunks)components/sensor/hte501.rst
(1 hunks)components/sensor/hyt271.rst
(1 hunks)components/sensor/mhz19.rst
(1 hunks)components/sensor/ms5611.rst
(1 hunks)components/sensor/ms8607.rst
(1 hunks)components/sensor/senseair.rst
(1 hunks)components/sensor/sgp30.rst
(1 hunks)components/sensor/shtcx.rst
(1 hunks)components/sensor/t6615.rst
(1 hunks)components/switch/modbus_controller.rst
(1 hunks)components/sx1509.rst
(2 hunks)components/usb_host.rst
(1 hunks)components/usb_uart.rst
(1 hunks)conf.py
(1 hunks)
✅ Files skipped from review due to trivial changes (22)
- components/sensor/ms8607.rst
- components/sensor/mhz19.rst
- components/sensor/t6615.rst
- components/switch/modbus_controller.rst
- Makefile
- components/sensor/hte501.rst
- _static/version
- Doxygen
- components/sensor/dps310.rst
- components/sensor/ens160.rst
- components/logger.rst
- conf.py
- components/sensor/shtcx.rst
- components/lvgl/widgets.rst
- components/audio_dac/es8388.rst
- components/index.rst
- components/sensor/cm1106.rst
- components/display/max7219digit.rst
- components/esp32.rst
- components/usb_uart.rst
- components/usb_host.rst
- components/lvgl/index.rst
🚧 Files skipped from review as they are similar to previous changes (1)
- components/remote_receiver.rst
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**
: - Do not generate or add any sequence diagrams
components/sensor/senseair.rst
components/sensor/hyt271.rst
components/online_image.rst
components/sensor/ccs811.rst
components/sensor/ee895.rst
components/sensor/sgp30.rst
components/sensor/ms5611.rst
components/sx1509.rst
🔇 Additional comments (21)
components/online_image.rst (2)
72-77
: Clear and Comprehensive Documentation forcached
VariableThe new section clearly describes the
cached
variable’s purpose and usage within lambdas, covering both cache-hit and cache-miss scenarios, and the link to the HTTP caching spec is helpful.
1-1
: Missing Index Entry for New DocumentationThis file adds substantial content, but I don’t see an update to
components/index.rst
. Please add an entry there to surface theonline_image
documentation in the component index.components/sx1509.rst (1)
56-59
: Docs update for keypad row/column ranges looks correct
The minimum of 2 rows (2–8) and 1–8 columns aligns with the hardware’s 8×8 engine requirement. Good catch updating from the previous 1–8/7-pin limits.components/sensor/senseair.rst (1)
37-37
: Mark CO₂ sub-entity as optional
Theco2
sensor option is now marked as Optional, aligning with the simplified example configuration pattern applied across other sensor docs.components/sensor/hyt271.rst (3)
20-23
: Simplify example sensor names
Renamed the example sensor names to"Temperature"
and"Humidity"
for consistency and brevity in alignment with other components.
27-29
: Make temperature sub-entity optional
Thetemperature
configuration block is now marked as Optional, matching the streamlined pattern across sensor documentation.
31-33
: Make humidity sub-entity optional
Thehumidity
configuration block is now marked as Optional, consistent with the documentation simplification.components/sensor/ms5611.rst (2)
31-33
: Simplify example sensor names
Renamed"Outside Temperature"
/"Outside Pressure"
to"Temperature"
/"Pressure"
, reducing verbosity and matching the style used in other sensor docs.
38-41
: Make pressure sub-entity optional
Thepressure
configuration block is now marked as Optional, aligning with the overall pattern of optional sensor sub-entities.components/sensor/ccs811.rst (3)
41-44
: Make eCO₂ sub-entity optional
Theeco2
configuration block is now marked as Optional, reflecting the removal of explicit required settings.
45-49
: Make TVOC sub-entity optional
Thetvoc
configuration block is now marked as Optional, consistent with other sensor sub-entity optionality changes.
59-61
: Make I²C address parameter optional
Theaddress
setting under Advanced is now marked as Optional with a clear default; this clarifies that explicit addressing is not mandatory.components/sensor/ee895.rst (4)
25-29
: Simplify example sensor names
Renamed"Office CO2"
,"Office Temperature"
, and"Office Pressure"
to"CO2"
,"Temperature"
, and"Pressure"
for brevity and consistency.
34-37
: Make temperature sub-entity optional
Thetemperature
configuration block is now marked as Optional, following the updated documentation pattern.
38-41
: Make CO₂ sub-entity optional
Theco2
configuration block is now marked as Optional, aligning with the other sub-entity changes.
42-45
: Make pressure sub-entity optional
Thepressure
configuration block is now marked as Optional, completing the consistent optionality updates across all sensor sub-entities.components/sensor/sgp30.rst (5)
22-24
: Example uses generic sensor names
The updated YAML snippet now uses concise sensor names (eCO2
,TVOC
) without location-specific prefixes, improving clarity and consistency with other platform examples.
29-31
:eco2
parameter correctly marked as optional
The configuration variable has been changed from Required to Optional, aligning with the simplified usage model and matching similar updates in other sensor docs.
33-35
:tvoc
parameter correctly marked as optional
Thetvoc
block is now marked as Optional, which is consistent with the revised configuration behavior and other platform documentation.
37-38
: Store_baseline default updated to boolean literal
Switching the default from"yes"
to the booleantrue
is more explicit and conforms to YAML best practices.
43-44
: Increased update_interval default
Raising the defaultupdate_interval
from 1 s to 60 s reduces bus load and matches the recommended settings for this sensor.
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
next
because this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
current
because 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.rst
when creating new documents for new components or cookbook.