Skip to content
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

SNMP: Reflect support for string OIDs #34101

Closed
wants to merge 1 commit into from

Conversation

gunkaaa
Copy link

@gunkaaa gunkaaa commented Aug 2, 2024

Proposed change

Update SNMP documentation to reflect that SNMP switches now support comparing OIDs for determining state.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Updated documentation for the Mold Indicator sensor and SNMP switch to enhance clarity and usability.
    • Introduced a comparison of Home Assistant Yellow and Green kits, streamlining product offerings.
  • Bug Fixes
    • Corrected minor textual errors in documentation for better readability.
  • Documentation
    • Enhanced documentation for various integrations, clarifying features and functionalities.
  • Chores
    • Updated links for shipping options to improve user clarity and purchasing choices.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Aug 2, 2024
Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

Walkthrough

The changes involve minor updates across various files, primarily focusing on documentation clarifications and updates to the Gemfile. Key adjustments include version updates for dependencies, textual corrections for clarity, and enhancements to the documentation for Home Assistant integrations. Additionally, the product landing pages have been streamlined to reflect changes in the availability and support of Home Assistant products, notably the transition to a kit-based model for the Home Assistant Yellow.

Changes

File Path Change Summary
Gemfile Updated rubocop version from 1.65.0 to 1.65.1.
source/_includes/common-tasks/data_disk.md Corrected a redundancy in the migration instructions for clarity.
source/_integrations/history_stats.markdown Changed terminology from "integration" to "entity" to broaden context in the documentation.
source/_integrations/mold_indicator.markdown Simplified sensor operation description and added a "Background" section for clarity on humidity prediction.
source/_integrations/snmp.markdown Updated SNMP documentation to reflect support for both integer and string OIDs.
source/_integrations/vicare.markdown Enhanced vicare_mode attribute documentation for clarity regarding its context.
source/_posts/2024-08-01-streamlining-the-home-assistant-yellow-lineup.markdown Introduced updates on Home Assistant Yellow product lineup, focusing on modular offerings and comparisons with Home Assistant Green.
source/green/index.html Updated shipping links for clarity, replacing "ameridroid.com" with an Amazon link and adding back the original link.
source/yellow/index.html Removed detailed descriptions for Home Assistant Yellow, added FAQs, and simplified shipping information.

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?

Share
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>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

Copy link

netlify bot commented Aug 2, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit a5922c6
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66b13644564e3100085e6450
😎 Deploy Preview https://deploy-preview-34101--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Outside diff range, codebase verification and nitpick comments (8)
source/_integrations/mold_indicator.markdown (2)

18-18: Improve readability of the humidity threshold description.

Consider rephrasing "more than ~70%" to "above approximately 70%" for better readability.

- High humidity may lead to mold growth at more than ~70% and causes condensation at 100%.
+ High humidity may lead to mold growth above approximately 70% and causes condensation at 100%.

70-70: Simplify wording and add missing comma.

Consider simplifying "in order to" to "to" and add a comma after "For calibration".

- The Mold Indicator sensor integration needs to be calibrated in order to estimate the temperature at the critical point from the outdoor and indoor temperature.
+ The Mold Indicator sensor integration needs to be calibrated to estimate the temperature at the critical point from the outdoor and indoor temperature.
- For calibration you need to measure the temperature at this critical point and simultaneously write down the values for the indoor- and outdoor temperature sensors used for the Mold Indicator.
+ For calibration, you need to measure the temperature at this critical point and simultaneously write down the values for the indoor and outdoor temperature sensors used for the Mold Indicator.
Tools
LanguageTool

[style] ~70-~70: Consider a shorter alternative to avoid wordiness.
Context: ...nsor integration needs to be calibrated in order to estimate the temperature at the critica...

(IN_ORDER_TO_PREMIUM)


[uncategorized] ~70-~70: A comma is probably missing here.
Context: ...nds on the insulation of your home. For calibration you need to measure the temperature at ...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)

source/_posts/2024-08-01-streamlining-the-home-assistant-yellow-lineup.markdown (6)

16-16: Consider using a stronger adjective.

Replace "I'm happy to say" with a stronger adjective to strengthen the wording.

- and I'm happy to say that now in 2024, it remains our flagship hardware product.
+ and I'm pleased to say that now in 2024, it remains our flagship hardware product.
Tools
LanguageTool

[style] ~16-~16: Consider using a different adjective to strengthen your wording.
Context: ...me Assistant Yellow](/yellow/), and I'm happy to say that now in 2024, it remains our...

(HAPPY_EXCITED)


20-20: Consider using a less overused word.

Replace "biggest" with a less overused alternative.

- It's not the biggest change, but we wanted our community to know
+ It's not the most significant change, but we wanted our community to know
Tools
LanguageTool

[style] ~20-~20: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ...ower-over-ethernet (PoE). It's not the biggest change, but we wanted our community to know - ...

(BIG_DIFFERENCE)


28-28: Add missing comma.

Add a comma after "kits" to separate the clauses.

- unlike our kits there was no assembly required.
+ unlike our kits, there was no assembly required.
Tools
LanguageTool

[uncategorized] ~28-~28: A comma might be missing here.
Context: ...y installed onto the board - unlike our kits there was no assembly required. This me...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


32-32: Add missing comma.

Add a comma after "perspective" to separate the clauses.

- From a timing perspective 2021 and 2022, were not the easiest time to source Raspberry Pi products
+ From a timing perspective, 2021 and 2022 were not the easiest time to source Raspberry Pi products
Tools
LanguageTool

[uncategorized] ~32-~32: A comma might be missing here.
Context: ... Standard used to occupy. From a timing perspective 2021 and 2022, were not the easiest tim...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~32-~32: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ive 2021 and 2022, were not the easiest time to source Raspberry Pi products, includ...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)


32-32: Correct the grammatical number.

Change "time" to "times" to match the context.

- were not the easiest time to source Raspberry Pi products
+ were not the easiest times to source Raspberry Pi products
Tools
LanguageTool

[uncategorized] ~32-~32: A comma might be missing here.
Context: ... Standard used to occupy. From a timing perspective 2021 and 2022, were not the easiest tim...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~32-~32: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ive 2021 and 2022, were not the easiest time to source Raspberry Pi products, includ...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)


40-113: Standardize the table header font size.

Consider standardizing the font size of the table headers for consistency.

- <th style="font-size: 1.2em;">Features</th>
- <th style="font-size: 1.2em;">Home Assistant Green</th>
- <th style="font-size: 1.2em;">Home Assistant Yellow Kit</th>
+ <th style="font-size: 1em;">Features</th>
+ <th style="font-size: 1em;">Home Assistant Green</th>
+ <th style="font-size: 1em;">Home Assistant Yellow Kit</th>

@c0ffeeca7
Copy link
Contributor

There are a few unrelated changed files in this PR. It looks like you need to rebase against next.

@c0ffeeca7
Copy link
Contributor

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.

@c0ffeeca7 c0ffeeca7 marked this pull request as draft August 5, 2024 05:05
@c0ffeeca7 c0ffeeca7 changed the title Draft: Reflect support for for string OIDs per home-assistant/core#122944 Reflect support for for string OIDs per home-assistant/core#122944 Aug 5, 2024
@c0ffeeca7 c0ffeeca7 changed the title Reflect support for for string OIDs per home-assistant/core#122944 SNMP: Reflect support for string OIDs Aug 5, 2024
@home-assistant home-assistant bot closed this Oct 14, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants