📝 Flesh out setup and configuration guide in README #21

Open

mat wants to merge 1 commit from docs/47-setup-tutorial into main

pull from: docs/47-setup-tutorial

merge into: mat:main

mat:main

mat:fix/5-energy-hour-offset

mat:feat/c7-reauth

mat:docs/api-exploration

mat:fix/46-value-guard

mat:feat/40-site-metrics

mat:chore/release-0.4.0

mat:7-problème-de-connexion-version-anterieure-a-gen4-2

mat:update-python-comwatt

mat:7-problème-de-connexion-version-anterieure-a-gen4

mat:3-adjust-update-frequency-for-comwattenergysensor

mat:9-enhancement-request-additional-device-control-modes-for-comwatt-integration

mat:fix/power-sensor

mat:fix/device-child-not-containing-id#10

mat:4-optimize-api-client-handling-for-multiple-sensors

mat:use-go.comwatt.com

Conversation 0 Commits 1 Files changed 2 +70 -10

mat commented 2026-04-24 17:16:27 +00:00

Owner

Copy link

Summary

Closes MateoGreil/homeassistant-comwatt#47.

Expands both README.md and README-fr.md with the step-by-step guide the reporter asked for: prerequisites, install path (HACS + manual), click-by-click configuration, what success looks like, and the most common failure modes.

Scope

• No code change. README-only.
• Both English and French versions stay in sync.

Test plan

• Eyeball the rendered markdown on Forgejo / GitHub.

## Summary Closes [MateoGreil/homeassistant-comwatt#47](https://github.com/MateoGreil/homeassistant-comwatt/issues/47). Expands both `README.md` and `README-fr.md` with the step-by-step guide the reporter asked for: prerequisites, install path (HACS + manual), click-by-click configuration, what success looks like, and the most common failure modes. ## Scope - No code change. README-only. - Both English and French versions stay in sync. ## Test plan - [ ] Eyeball the rendered markdown on Forgejo / GitHub.

mat added 1 commit 2026-04-24 17:16:27 +00:00

📝 Flesh out setup and configuration guide in README ... d492315248

Closes #47.

Issue #47 asked for a step-by-step installation and configuration
guide: where to put username/password, which account to use, etc.
The previous README only said "Install via HACS … restart … add
integration", which left new users stuck.

Both READMEs (English and French) now have:

- **Prerequisites** section naming the Comwatt Gen 4 website, required
  HA version, and HACS as recommended.
- **Installation** split into "Via HACS (recommended)" — step-by-step
  for adding the repo as a custom source — and "Manual installation"
  from the Releases archive.
- **Configuration** with the exact click path, the distinction between
  Comwatt credentials and HA credentials, and the my.home-assistant.io
  shortcut badge.
- **Verifying it works** explaining what devices/entities should
  appear, where to look, and the common failure modes (wrong creds,
  backend outage, Gen 3 account needing the Indepbox integration).
- **Usage** pointer to the Energy dashboard for `*_total_energy`.

mat force-pushed docs/47-setup-tutorial from d492315248 to 52c4f1cb41 2026-04-24 21:53:07 +00:00 Compare

All checks were successful

Hide all checks

Validate / validate-hacs (pull_request) Has been skipped

Details

Validate / validate-hassfest (pull_request) Has been skipped

Details

Validate / lint-ruff (pull_request) Successful in 7s

Details

Validate / test-pytest (pull_request) Successful in 1m44s

Details

Validate / type-check-mypy (pull_request) Successful in 1m48s

Details

Validate / validate-hacs (push) Has been skipped

Details

Validate / validate-hassfest (push) Has been skipped

Details

Validate / lint-ruff (push) Successful in 7s

Details

Validate / test-pytest (push) Successful in 1m44s

Details

Validate / type-check-mypy (push) Successful in 1m48s

Details

This pull request can be merged automatically.

This branch is out-of-date with the base branch

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin docs/47-setup-tutorial:docs/47-setup-tutorial

git switch docs/47-setup-tutorial

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main

git merge --no-ff docs/47-setup-tutorial

git switch docs/47-setup-tutorial

git rebase main

git switch main

git merge --ff-only docs/47-setup-tutorial

git switch docs/47-setup-tutorial

git rebase main

git switch main

git merge --no-ff docs/47-setup-tutorial

git switch main

git merge --squash docs/47-setup-tutorial

git switch main

git merge --ff-only docs/47-setup-tutorial

git switch main

git merge docs/47-setup-tutorial

git push origin main

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

No items

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

mat/homeassistant-comwatt!21

No description provided.