Remove modbus.restart / modbus.stop. by janiversen · Pull Request #33609 · home-assistant/home-assistant.io

janiversen · 2024-07-07T13:59:37Z

Proposed change

modbus.restart / modbus.stop is currently deprecated, but it seems it was forgotten to remove it from the documentation.

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).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

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
- Added example for writing a float32 type register to the Modbus integration documentation.
Documentation
- Removed instructions for communication stop/restart services in the Modbus integration.

coderabbitai · 2024-07-07T13:59:43Z

Walkthrough

The recent change in the Modbus integration involved removing the communication stop/restart services and instead providing an example for writing a register in the float32 data type. This shift focuses more on practical usage and less on managing communication states.

Changes

File	Change Summary
source/_integrations/modbus.md	Removed communication stop/restart services; added example for writing float32 register.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ModbusIntegration
    participant ModbusDevice

    User->>ModbusIntegration: Write Float32 Register Request
    ModbusIntegration->>ModbusDevice: Send Write Float32 Request
    ModbusDevice->>ModbusIntegration: Acknowledge Write
    ModbusIntegration->>User: Write Confirmation

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 50497f0 and 2689900.

Files selected for processing (1)

source/_integrations/modbus.markdown (1 hunks)

Additional context used

LanguageTool

source/_integrations/modbus.markdown

[misspelling] ~1621-~1621: Possible spelling mistake found.
Context: ...f 16-bit values. Single value will call modbus function code 0x06. Array will call mod...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~1621-~1621: Possible spelling mistake found.
Context: ...bus function code 0x06. Array will call modbus function code 0x10. Values might need r...

(MORFOLOGIK_RULE_EN_US)

[grammar] ~1621-~1621: The verb “reverse” needs to be in the to-infinitive form.
Context: ...modbus function code 0x10. Values might need reverse ordering. E.g., to set 0x0004 you might...

(MISSING_TO_BEFORE_A_VERB)

[grammar] ~1621-~1621: Possible subject-verb agreement error detected.
Context: ...t 0x0004 you might need to set [4,0], this depend on the byte order of your CPU | | state...

(THIS_THAT_AGR)

[misspelling] ~1622-~1622: Possible spelling mistake found.
Context: ...e_coil) A single boolean or an array of booleans. Single boolean will call modbus functi...

(MORFOLOGIK_RULE_EN_US)

[uncategorized] ~1622-~1622: Possible missing article found.
Context: ...single boolean or an array of booleans. Single boolean will call modbus function code ...

(AI_HYDRA_LEO_MISSING_A)

[misspelling] ~1622-~1622: Possible spelling mistake found.
Context: ...y of booleans. Single boolean will call modbus function code 0x05. Array will call mod...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~1622-~1622: Possible spelling mistake found.
Context: ...bus function code 0x05. Array will call modbus function code 0x0F ...

(MORFOLOGIK_RULE_EN_US)

[uncategorized] ~1626-~1626: Possible missing comma found.
Context: ...e register To write a float32 datatype register use network format like 10.0 == `0x41...

(AI_HYDRA_LEO_MISSING_COMMA)

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 Configration 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.

netlify · 2024-07-07T13:59:54Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`2689900`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/668a9f4c4e9dfc00082f2302
😎 Deploy Preview	https://deploy-preview-33609--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 site configuration.

coderabbitai

Actionable comments posted: 3

frenck

Thanks, @janiversen 👍

../Frenck

Remove modbus.restart / modbus.stop.

2689900

home-assistant Bot added the current This PR goes into the current branch label Jul 7, 2024

janiversen mentioned this pull request Jul 7, 2024

Modbus restart error on 2024.7.1 home-assistant/core#121432

Closed

coderabbitai Bot reviewed Jul 7, 2024

View reviewed changes

Comment thread source/_integrations/modbus.markdown

Comment thread source/_integrations/modbus.markdown

Comment thread source/_integrations/modbus.markdown

frenck approved these changes Jul 7, 2024

View reviewed changes

frenck merged commit e4dba5f into current Jul 7, 2024

frenck deleted the restart branch July 7, 2024 14:08

github-actions Bot locked and limited conversation to collaborators Jul 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove modbus.restart / modbus.stop.#33609

Remove modbus.restart / modbus.stop.#33609
frenck merged 1 commit into
currentfrom
restart

janiversen commented Jul 7, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 7, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

netlify Bot commented Jul 7, 2024 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

frenck left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

janiversen commented Jul 7, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

netlify Bot commented Jul 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

janiversen commented Jul 7, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 7, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

netlify Bot commented Jul 7, 2024 •

edited

Loading