Add OSO Energy Service documentation

[osohotwateriot]

Proposed change

Add custom service documentation for OSO Energy

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.
• [x] 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: https://github.com/home-assistant/core/pull/118770
• Link to parent pull request in the Brands repository:
• 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 current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• New Features
  • Introduced new services for OSO Energy integration:
    • Retrieve and set temperature profiles for water heaters.
    • Adjust minimum water quantity at 40°C.
    • Control heating operations with turn on/off services based on temperature limits.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	52b3c13d5dbc482e75408335dac02c238667020c
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6666eb0f39834f000985d885
😎 Deploy Preview	https://deploy-preview-33070--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.

[home-assistant[bot]]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The changes introduce new services in the OSO Energy integration for managing water heater temperature profiles and heating control. Users can now retrieve and set temperature profiles, adjust the minimum water quantity at 40°C, and control heating operations based on temperature limits. These enhancements provide greater control and flexibility for managing water heaters.

Changes

File	Change Summary
source/_integrations/osoenergy.markdown	Added services for managing temperature profiles and heating control for water heaters in the OSO Energy integration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant OSOEnergy

    User->>HomeAssistant: Call osoenergy.get_profile(entity_id)
    HomeAssistant->>OSOEnergy: Retrieve temperature profile
    OSOEnergy-->>HomeAssistant: Return temperature profile
    HomeAssistant-->>User: Display temperature profile

    User->>HomeAssistant: Call osoenergy.set_profile(entity_id, hour_00, ..., hour_23)
    HomeAssistant->>OSOEnergy: Set temperature profile
    OSOEnergy-->>HomeAssistant: Acknowledge profile set
    HomeAssistant-->>User: Confirm profile set

    User->>HomeAssistant: Call osoenergy.set_v40_min(entity_id, v40_min)
    HomeAssistant->>OSOEnergy: Set minimum water quantity at 40°C
    OSOEnergy-->>HomeAssistant: Acknowledge minimum water quantity set
    HomeAssistant-->>User: Confirm minimum water quantity set

    User->>HomeAssistant: Call osoenergy.turn_off(entity_id, until_temp_limit)
    HomeAssistant->>OSOEnergy: Turn off heating
    OSOEnergy-->>HomeAssistant: Acknowledge heating off
    HomeAssistant-->>User: Confirm heating off

    User->>HomeAssistant: Call osoenergy.turn_on(entity_id, until_temp_limit)
    HomeAssistant->>OSOEnergy: Turn on heating
    OSOEnergy-->>HomeAssistant: Acknowledge heating on
    HomeAssistant-->>User: Confirm heating on

---

Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between bd78abe76f3dfc189408b6316058003010779540 and 52b3c13d5dbc482e75408335dac02c238667020c.

Files selected for processing (1)

• source/_integrations/osoenergy.markdown (1 hunks)

Additional context used

LanguageTool

source/_integrations/osoenergy.markdown

[misspelling] ~21-~21: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ..._integration_type: integration --- The OSO Energy integration for Home Assistant a...

---

[misspelling] ~21-~21: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ported devices and services offered by OSO Energy This...

---

[misspelling] ~23-~23: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...Energy](https://www.osoenergy.no) This OSO Energy integration uses a subscription ...

---

[misspelling] ~23-~23: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...user can create for his account on the [OSO Energy website](https://portal.osoenerg...

---

[uncategorized] ~23-~23: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) Context: ...onfigure it within Home Assistant. Once configured Home Assistant will detect and add all ...

---

[misspelling] ~23-~23: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... Home Assistant will detect and add all OSO Energy devices. {% include integration...

---

[misspelling] ~31-~31: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...y.get_profile You can use the serviceosoenergy.get_profile` to get the temperature pro...

---

[misspelling] ~81-~81: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...y.set_profile You can use the serviceosoenergy.set_profile` to set the temperature pro...

---

[misspelling] ~150-~150: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...y.set_v40_min You can use the serviceosoenergy.set_v40_min` to set the minimum quantit...

---

[misspelling] ~173-~173: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ergy.turn_off You can use the serviceosoenergy.turn_off` to turn off the heating on yo...

---

[misspelling] ~196-~196: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...nergy.turn_on You can use the serviceosoenergy.turn_on` to turn on the heating on your...

---

[misspelling] ~219-~219: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...mit: true ``` ## Binary sensors The OSO Energy integration exposes OSO Energy...

---

[misspelling] ~219-~219: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... The OSO Energy integration exposes OSO Energy data as a binary sensor. It prov...

---

[uncategorized] ~222-~222: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) Context: ... heater is currently in an extra energy/high demand state. - Power save - Indication if t...

---

[misspelling] ~230-~230: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...y heating the water. ## Sensors The OSO Energy integration exposes OSO Energy...

---

[misspelling] ~230-~230: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... The OSO Energy integration exposes OSO Energy data as a sensor. It provides th...

---

[style] ~239-~239: For conciseness, consider replacing this expression with an adverb. (AT_THE_MOMENT) Context: ...gy that is stored and available for use at the moment - the current kWh equivalent capacity o...

---

[misspelling] ~251-~251: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...pe of the heater. ## Water heater The OSO Energy water heater integration integra...

---

[misspelling] ~251-~251: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ater heater integration integrates your OSO Energy devices into Home Assistant. It...

---

[misspelling] ~253-~253: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...e Assistant. It supports the following OSO Energy devices: - Water Heaters - Sens...

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.