Document new Time SMA Filter flag, update_by_time. #36181
Conversation
home-assistant
bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
❌ Deploy Preview for home-assistant-docs failed.
|
📝 Walkthrough📝 WalkthroughWalkthroughThe changes involve updates to the documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant FilterSensor
participant TimeSimpleMovingAverage
User->>FilterSensor: Configure filter with update_by_time
FilterSensor->>TimeSimpleMovingAverage: Set update_by_time to true/false
TimeSimpleMovingAverage->>FilterSensor: Update based on time intervals
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (3)source/_integrations/filter.markdown (3)
The example appropriately shows the recommended
The description contains unnecessary line breaks that could affect rendering. - description: Controls whether the Time SMA filter updates based on time intervals
- (`true`) or only when new data arrives (`false`). Defaults to `false` for
- backward compatibility, but setting to `true` is recommended for more responsive
- time-based averaging, especially when input values change infrequently. See
- [_time_simple_moving_average_](#time-simple-moving-average) filter.
+ description: Controls whether the Time SMA filter updates based on time intervals (`true`) or only when new data arrives (`false`). Defaults to `false` for backward compatibility, but setting to `true` is recommended for more responsive time-based averaging, especially when input values change infrequently. See [_time_simple_moving_average_](#time-simple-moving-average) filter.
The note effectively explains the default behavior and provides a clear rationale for using Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
source/_integrations/filter.markdown (2)
188-192: Fix typo in the Time SMA descriptionThere's a typo in the word "general":
-input values don't change for a long period of time. In geenral, you probably want to +input values don't change for a long period of time. In general, you probably want to
113-114: Remove trailing spacesPlease remove the trailing spaces from these lines to maintain consistent formatting.
🧰 Tools
🪛 Markdownlint (0.35.0)
113-113: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
114-114: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/filter.markdown(3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
source/_integrations/filter.markdown
113-113: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
114-114: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
🔇 Additional comments (1)
source/_integrations/filter.markdown (1)
60-60: LGTM: Good example of the new parameter usage
The example correctly demonstrates how to use the new update_by_time parameter with the recommended value of true.
source/_integrations/filter.markdown
Outdated
| update_by_time: | ||
| description: This defaults to `false` for backward compatibility. | ||
| You probably want to set it to `true`. See [_time_simple_moving_average_] | ||
| (#time-simple-moving-average) filter. | ||
| required: false | ||
| type: bool | ||
| default: false |
There was a problem hiding this comment.
Fix broken link in the parameter description
The link to the time_simple_moving_average section is broken due to an unexpected line break. Please fix the markdown link syntax:
- You probably want to set it to `true`. See [_time_simple_moving_average_]
- (#time-simple-moving-average) filter.
+ You probably want to set it to `true`. See [_time_simple_moving_average_](#time-simple-moving-average) filter.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| update_by_time: | |
| description: This defaults to `false` for backward compatibility. | |
| You probably want to set it to `true`. See [_time_simple_moving_average_] | |
| (#time-simple-moving-average) filter. | |
| required: false | |
| type: bool | |
| default: false | |
| update_by_time: | |
| description: This defaults to `false` for backward compatibility. | |
| You probably want to set it to `true`. See [_time_simple_moving_average_](#time-simple-moving-average) filter. | |
| required: false | |
| type: bool | |
| default: false |
🧰 Tools
🪛 Markdownlint (0.35.0)
113-113: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
114-114: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
dbrand666
requested review from
a team,
rohankapoorcom,
emontnemery,
bachya,
starkillerOG,
fabaff,
rytilahti,
syssi,
frenck,
joostlek,
balloob,
synesthesiam,
thecode,
chemelli74,
raman325,
ludeeus,
pvizeli and
Kane610
as code owners
thecode
removed request for
marcelveldt,
kellerza,
epenet,
zxdavb,
OttoWinter,
joostlek,
jbouwh,
raman325,
cgarwood,
azogue,
pree,
tronikos,
robmarkcole,
farmio,
emontnemery,
starkillerOG,
Quentame,
ludeeus,
pvizeli,
Santobert,
klaasnicolaas,
kbx81,
Ernst79,
Kane610,
mib1185,
chemelli74 and
gjohansson-ST
|
@coderabbitai full review |
Proposed change
Document the new
update_by_timeflag for the Time SMA Filter. See home-assistant/core#131745Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
update_by_time, for filter sensors to enhance functionality and control.Documentation
update_by_timeparameter, emphasizing its relevance and providing recommendations for optimal use.