home-assistant.io Add Emoncms unique identifier documentation

Proposed change

Update emoncms documentation related to the support of a unique identifier

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/120751
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

Documentation
- Updated Emoncms integration guide with instructions for handling unique identifiers in Emoncms version 11.5.7+.
- Provided steps for database migration in Home Assistant for Emoncms upgrades.
- Updated configuration steps for the Emoncms sensor integration.
- Added '@alexandrecuer' as a new code owner for the Emoncms documentation.

Jun 29 '24 13:06 alexandrecuer

Walkthrough

The changes in the emoncms integration document include adding a new code owner, updating instructions for handling Emoncms unique identifiers (starting from version 11.5.7), and providing migration steps for the Home Assistant database to support Emoncms upgrades. Additionally, the configuration steps for the emoncms sensor integration have been updated.

Changes

File Path	Change Summary
`source/_integrations/emoncms.markdown`	Added `'@alexandrecuer'` to the list of code owners. Updated instructions for handling unique identifiers in Emoncms from version 11.5.7 onwards. Provided steps for database migration in Home Assistant for Emoncms upgrades. Updated the configuration steps for the `emoncms` sensor integration.

Sequence Diagram(s)

No sequence diagrams are generated as the changes are primarily documentation updates without a specific control flow or feature modification.

Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 59ae6b7b3eea0489237be68247a017bcd008ff4d and d9fa547e9ebba41d40808ea0ee2e27eb96e73057.

Files selected for processing (1)

source/_integrations/emoncms.markdown (4 hunks)

Additional context used

LanguageTool

source/_integrations/emoncms.markdown

[misspelling] ~20-~20: Possible spelling mistake found. Context: ... title: Configuration file --- The emoncms sensor {% term integration %} creates ...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~20-~20: Possible spelling mistake found. Context: ...n your local or cloud-based version of Emoncms. To enable this ...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~34-~34: Possible spelling mistake found. Context: ...s.org id: 1 ``` **As of July 2024, Emoncms produces a unique identifier starting f...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~35-~35: Possible spelling mistake found. Context: ... 11.5.7.** If you upgrade your existing Emoncms installation to a version shipping a un...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~35-~35: Possible spelling mistake found. Context: ...unique identifier, please [migrate your Emoncms database](https://docs.openenergymonito...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~37-~37: Possible spelling mistake found. Context: ...egration will discover all sensors from Emoncms and will use the unit of measurement sp...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~37-~37: Possible spelling mistake found. Context: ... measurement specified in the Feed from Emoncms, in preference to the one set in the co...

(MORFOLOGIK_RULE_EN_US)

[style] ~37-~37: ‘in preference to’ might be wordy. Consider a shorter alternative. Context: ...ent specified in the Feed from Emoncms, in preference to the one set in the configuration. Teste...

(EN_WORDINESS_PREMIUM_IN_PREFERENCE_TO)

[misspelling] ~37-~37: Possible spelling mistake found. Context: ... set in the configuration. Tested with Emoncms V1...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~39-~39: Possible spelling mistake found. Context: ...rite information from Home Assistant to Emoncms, you can use the [emoncms_history](/i...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~39-~39: Possible spelling mistake found. Context: ...e Assistant to Emoncms, you can use the emoncms_history {% term integration %}. ## Co...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~43-~43: Possible spelling mistake found. Context: ...guration variables {% configuration %} api_key: description: The read API key fo...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~45-~45: Possible spelling mistake found. Context: ... description: The read API key for your Emoncms user. required: true type: string u...

(MORFOLOGIK_RULE_EN_US)

[typographical] ~46-~46: This sentence does not start with an uppercase letter. Context: ...e read API key for your Emoncms user. required: true type: string url: description...

(UPPERCASE_SENTENCE_START)

[misspelling] ~47-~47: Possible spelling mistake found. Context: ...s user. required: true type: string url: description: "The base URL of Emoncm...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~49-~49: Possible spelling mistake found. Context: ...ng url: description: "The base URL of Emoncms, use https://emoncms.org for the clou...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~49-~49: Possible spelling mistake found. Context: ...he cloud-based version. For self-hosted Emoncms or EmonPi you may need to use a URL of ...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~49-~49: Possible spelling mistake found. Context: ...sed version. For self-hosted Emoncms or EmonPi you may need to use a URL of `http://x....

(MORFOLOGIK_RULE_EN_US)

[uncategorized] ~51-~51: This abbreviation for “identification” is spelled all-uppercase. Context: ...ncms`." required: true type: string id: description: Positive integer identi...

(ID_CASING)

[misspelling] ~53-~53: Possible spelling mistake found. Context: ... Must be unique if you specify multiple Emoncms sensors. required: true type: integ...

(MORFOLOGIK_RULE_EN_US)

[typographical] ~54-~54: This sentence does not start with an uppercase letter. Context: ...you specify multiple Emoncms sensors. required: true type: integer include_only_feed...

(UPPERCASE_SENTENCE_START)

[misspelling] ~57-~57: Possible spelling mistake found. Context: ... description: Positive integer list of Emoncms feed IDs. Only the feeds with feed IDs ...

(MORFOLOGIK_RULE_EN_US)

[style] ~57-~57: To form a complete sentence, be sure to include a subject. Context: ...d IDs specified here will be displayed. Can not be specified if exclude_feed_id i...

(MISSING_IT_THERE)

[typographical] ~58-~58: This sentence does not start with an uppercase letter. Context: ...ed if exclude_feed_id is specified. required: false type: list exclude_feed_id: ...

(UPPERCASE_SENTENCE_START)

[misspelling] ~61-~61: Possible spelling mistake found. Context: ... description: Positive integer list of Emoncms feed IDs. All the feeds will be display...

(MORFOLOGIK_RULE_EN_US)

[style] ~61-~61: To form a complete sentence, be sure to include a subject. Context: ...as sensors except the ones listed here. Can not be specified if `include_only_feed_...

(MISSING_IT_THERE)

[typographical] ~62-~62: This sentence does not start with an uppercase letter. Context: ... include_only_feed_id is specified. required: false type: list sensor_names: des...

(UPPERCASE_SENTENCE_START)

[misspelling] ~65-~65: Possible spelling mistake found. Context: ... on feed ID. The dictionary consists of feedid: name pairs. Sensors for feeds with th...

(MORFOLOGIK_RULE_EN_US)

[typographical] ~70-~70: This sentence does not start with an uppercase letter. Context: ...coming-data) to alter the feed value. required: false type: template scan_interval: ...

(UPPERCASE_SENTENCE_START)

[typographical] ~74-~74: This sentence does not start with an uppercase letter. Context: ...te interval of the sensor in seconds. required: false type: integer unit_of_measurem...

(UPPERCASE_SENTENCE_START)

[misspelling] ~77-~77: Possible spelling mistake found. Context: ...y sensor where the unit is not set in Emoncms. If no unit is set in Emoncms or in the...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~77-~77: Possible spelling mistake found. Context: ...t* set in Emoncms. If no unit is set in Emoncms or in the configuration, the default (W...

(MORFOLOGIK_RULE_EN_US)

[typographical] ~78-~78: This sentence does not start with an uppercase letter. Context: ...ration, the default (W) will be used. required: false default: W type: string {% e...

(UPPERCASE_SENTENCE_START)

[misspelling] ~81-~81: Possible spelling mistake found. Context: ...d: false default: W type: string {% endconfiguration %} ## Default naming scheme The names...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~85-~85: Possible spelling mistake found. Context: ...tion will use the feed names defined in Emoncms if available, or the feed ID otherwise,...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~86-~86: Possible spelling mistake found. Context: ...D otherwise, and will be prefixed with "Emoncms", e.g., "Emoncms Total Power" or "Emonc...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~86-~86: Possible spelling mistake found. Context: ...will be prefixed with "Emoncms", e.g., "Emoncms Total Power" or "Emoncms Feed 5". If th...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~86-~86: Possible spelling mistake found. Context: ...oncms", e.g., "Emoncms Total Power" or "Emoncms Feed 5". If the id property is anythi...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~87-~87: Possible spelling mistake found. Context: ..., the ID will be shown as well, e.g., "Emoncms 2 Feed 5". If sensor_names` is used, ...

(MORFOLOGIK_RULE_EN_US)

[typographical] ~93-~93: It appears that a comma is missing. Context: ... with no prefix. ### Examples In this section you find some more examples of how this...

(DURING_THAT_TIME_COMMA)

[misspelling] ~95-~95: Possible spelling mistake found. Context: ...he unit of measurement being set by the Emoncms Feed or the default unit. ```yaml sens...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~135-~135: Possible spelling mistake found. Context: ...es will be chosen based on id and the Emoncms feedid. ```yaml # Example configurat...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~135-~135: Possible spelling mistake found. Context: ...be chosen based on id and the Emoncms feedid. ```yaml # Example configuration.yaml...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~173-~173: Possible spelling mistake found. Context: ...eed_id: - 107 - 106 ``` {% endraw %} Display feeds from the same Emoncms...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~175-~175: Possible spelling mistake found. Context: ... endraw %} Display feeds from the same Emoncms instance with 2 groups of feeds, where ...

(MORFOLOGIK_RULE_EN_US)

Markdownlint

source/_integrations/emoncms.markdown

198-198: null Files should end with a single newline character

(MD047, single-trailing-newline)

Additional comments not posted (1)

source/_integrations/emoncms.markdown (1)
11-11: Add a newline for consistency.

Add a newline after the last code owner for better readability.
ha_codeowners:
  - '@borpin'
+  
  - '@alexandrecuer'

[!TIP]

Early access features: enabled

We are currently testing the following features in early access:

OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

Please join our Discord Community to provide feedback and report issues.

OSS projects are currently opted into early access features by default.

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.

Jun 29 '24 13:06 coderabbitai[bot]

Deploy Preview for home-assistant-docs ready!

Name	Link
Latest commit	d9fa547e9ebba41d40808ea0ee2e27eb96e73057
Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/668306b0ea05ac0008190023
Deploy Preview	https://deploy-preview-33473--home-assistant-docs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.