Skip to content

Add get_kvs_value and set_kvs_value actions for Shelly RPC devices#157349

Merged
bieniu merged 25 commits into
home-assistant:devfrom
bieniu:shelly-kvs
Dec 12, 2025
Merged

Add get_kvs_value and set_kvs_value actions for Shelly RPC devices#157349
bieniu merged 25 commits into
home-assistant:devfrom
bieniu:shelly-kvs

Conversation

@bieniu
Copy link
Copy Markdown
Member

@bieniu bieniu commented Nov 26, 2025

Breaking change

Proposed change

Adds following actions:

  • get_kvs_value - gets a value from the device's Key-Value-Storage
  • set_kvs_value - sets a value in the device's Key-Value-Storage

Feature request: https://community.home-assistant.io/t/support-for-shelly-kvs-values-as-sensors/757687
Waiting for home-assistant-libs/aioshelly#1000

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @thecode, @chemelli74, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (shelly) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of shelly can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign shelly Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@bieniu bieniu added docs-missing waiting-for-upstream We're waiting for a change upstream labels Nov 26, 2025
@bieniu bieniu removed the waiting-for-upstream We're waiting for a change upstream label Dec 1, 2025
@bieniu bieniu marked this pull request as ready for review December 1, 2025 21:57
Copilot AI review requested due to automatic review settings December 1, 2025 21:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds two new service actions (get_kvs_value and set_kvs_value) to the Shelly integration, enabling users to interact with the Key-Value Storage (KVS) feature available on Shelly RPC devices (Gen2 and newer). The implementation includes comprehensive validation, error handling, test coverage, and user-facing documentation.

Key changes:

  • New services module with device validation and error handling for KVS operations
  • Support for retrieving and setting KVS values on RPC-enabled Shelly devices
  • Quality scale updates marking action-setup and related rules as complete

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
homeassistant/components/shelly/services.py New services module implementing get_kvs_value and set_kvs_value actions with comprehensive validation (RPC-only, non-sleeping devices) and error handling
homeassistant/components/shelly/__init__.py Integrates services setup by calling async_setup_services during component initialization
homeassistant/components/shelly/const.py Adds ATTR_KEY and ATTR_VALUE constants for service parameter definitions
homeassistant/components/shelly/services.yaml Defines service schemas with device selector and text/object fields for KVS operations
homeassistant/components/shelly/strings.json Adds service descriptions, field labels, and error messages for KVS functionality
homeassistant/components/shelly/icons.json Adds import/export icons for get_kvs_value and set_kvs_value services
homeassistant/components/shelly/quality_scale.yaml Updates quality scale marking action-related rules as complete
tests/components/shelly/test_services.py Comprehensive test coverage including success cases, validation errors, device compatibility checks, and exception handling

Comment thread tests/components/shelly/test_services.py
Comment thread homeassistant/components/shelly/strings.json Outdated
Copy link
Copy Markdown
Member

@thecode thecode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested with various payloads, looks great 👍

@bieniu bieniu merged commit 6e99411 into home-assistant:dev Dec 12, 2025
36 checks passed
@bieniu bieniu deleted the shelly-kvs branch December 12, 2025 12:15
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants