Skip to content

Conversation

@tomquist
Copy link
Owner

@tomquist tomquist commented Sep 23, 2025

Summary

  • register the VNSE3 Venus E 3.0 base type so it reuses the Venus device definition
  • document the new device type in the README, Venus docs, and Home Assistant add-on translations
  • record the new device support in the changelog

Testing

  • npm test

https://chatgpt.com/codex/tasks/task_e_68d25137c340832eb823b915f611914e

Summary by CodeRabbit

  • New Features
    • Added support for Venus E 3.0 devices (VNSE3-x, e.g., VNSE3-0) alongside existing Venus types.
  • Documentation
    • Updated README and Venus device guide to document VNSE3-x in addition to HMG-x.
    • Added CHANGELOG entry noting VNSE3-0 support.
  • Chores
    • Updated English and German translations to include VNSE3-0 as an example Venus device type in configuration guidance.

@coderabbitai
Copy link

coderabbitai bot commented Sep 23, 2025

Walkthrough

Adds support for the Venus E 3.0 device type (VNSE3-x) by extending Venus device type recognition. Updates documentation (CHANGELOG, README, docs) and translations (en, de) to mention VNSE3-0 alongside existing HMG types. No API signatures or control flow beyond device type matching are changed.

Changes

Cohort / File(s) Summary
Device support update
src/device/venus.ts
Expand supported deviceTypes from ['HMG'] to ['HMG', 'VNSE3'] for Venus device definition.
Documentation
CHANGELOG.md, README.md, docs/venus.md
Add or clarify VNSE3-x (e.g., VNSE3-0) as a supported Venus device type in changelog, device types list, and subscription docs.
Translations
ha_addon/translations/en.yaml, ha_addon/translations/de.yaml
Update configuration.devices.description text to include VNSE3-0 as an alternative Venus device type; no other text changes.

Sequence Diagram(s)

sequenceDiagram
  participant U as User / Add-on Config
  participant R as Device Resolver
  participant V as Venus Device

  Note over U,R: Config includes deviceType (e.g., HMG-x or VNSE3-x) and deviceId
  U->>R: Submit deviceType + deviceId
  R->>V: Initialize/resolve Venus device with provided deviceType
  alt Supported deviceType (HMG or VNSE3)
    V-->>R: Recognized
    R-->>U: Proceed to connect/subscribe
  else Unsupported
    V-->>R: Not recognized
    R-->>U: Report configuration error
  end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my ears at VNSE3,
A shiny star in device marquee.
Docs now hum in harmony,
EN and DE agree with glee.
Hops of joy in version tree—
Venus sings, “Support for me!” 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Add Venus E 3.0 device type" is a short, single sentence that accurately and concisely summarizes the primary change in the diff — registering VNSE3 (Venus E 3.0) as a supported Venus device and updating documentation and translations to reflect it.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch register-vnse3-as-venus-device

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7fc83f0 and e861e48.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: build (linux/arm/v7)
  • GitHub Check: build (linux/arm64)
  • GitHub Check: build (linux/amd64)
  • GitHub Check: build-addon (linux/arm64)
  • GitHub Check: build-addon (linux/arm/v7)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

10-10: Replace placeholder with PR number.

Use the actual PR reference instead of #??.

-- Venus: Add support for Venus E 3.0 device type (VNSE3-0) (#??)
+- Venus: Add support for Venus E 3.0 device type (VNSE3-0) (#182)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f0937fe and 7fc83f0.

📒 Files selected for processing (6)
  • CHANGELOG.md (1 hunks)
  • README.md (1 hunks)
  • docs/venus.md (1 hunks)
  • ha_addon/translations/de.yaml (1 hunks)
  • ha_addon/translations/en.yaml (1 hunks)
  • src/device/venus.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: build (linux/arm64)
  • GitHub Check: build (linux/amd64)
  • GitHub Check: build (linux/arm/v7)
  • GitHub Check: build-addon (linux/arm64)
  • GitHub Check: build-addon (linux/arm/v7)
🔇 Additional comments (5)
docs/venus.md (1)

81-81: LGTM: VNSE3 type documented alongside HMG.

Please confirm that device topics using VNSE3-x (e.g., VNSE3-0) behave identically to HMG-x in your local tests/subscriptions.

README.md (1)

316-316: LGTM: Device type list now includes VNSE3-X.

Consider adding a short note that “Venus Device Commands” apply to both HMG and VNSE3 for clarity in docs.

ha_addon/translations/en.yaml (1)

31-31: LGTM: Add-on description updated to include VNSE3-0.

ha_addon/translations/de.yaml (1)

31-31: LGTM: German translation includes VNSE3-0 example.

src/device/venus.ts (1)

137-137: LGTM — VNSE3 registered as Venus base type. Repo-wide search found no code-level enums/validation/schemas preventing VNSE3; occurrences are limited to docs/translations/README (informational).

@tomquist tomquist merged commit c28fd4e into develop Sep 23, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants