Generalize settings and sensors into properties #1753
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This removes the unnecessary division between sensors and settings in favor of just having "properties" that can have different access flags.
This will greatly simplify the API as all properties are alike, the difference is just in the access flags.
The earlier API to get settable properties (settings) and readable properties (sensors) is kept intact for the time being.
* SettingDescriptor is no more, all readable and writable properties are described using PropertyDescriptors.
* SettingType is replaced with PropertyConstraint to allow signaling allowed ranges or choices.
* EnumSettingDescriptor is now EnumDescriptor
* NumberSettingDescriptor is now RangeDescriptor
* Add 'access' to Descriptor
* This will also allow for generic `descriptors` interface in the future, if needed.
* Add 'property' to Descriptor
* None for actions, allwos more generic interface for properties.
* Add 'properties' method to 'Device' to get all property descriptors. 'settings' and 'sensors' return a filtered dict based on the properties for backwards compat.
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## master #1753 +/- ##
==========================================
- Coverage 81.68% 81.56% -0.13%
==========================================
Files 193 192 -1
Lines 18029 18028 -1
Branches 3845 3846 +1
==========================================
- Hits 14727 14704 -23
- Misses 3014 3038 +24
+ Partials 288 286 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Windows builds are failing due to a dependency issue, which I'll ignore for now to unblock further development. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This removes the unnecessary division between sensors and settings in favor of just having "properties" that can have different access flags.
This will greatly simplify the API as all properties are alike, the difference is just in the access flags.
The earlier API to get settable properties (settings) and readable properties (sensors) is kept intact for the time being.
SettingDescriptor is no more, all readable and writable properties are described using PropertyDescriptors:
Add 'access' to Descriptor
descriptorsinterface in the future, if needed.Add 'property' to Descriptor
Add 'properties' method to 'Device' to get all property descriptors. 'settings' and 'sensors' return a filtered dict based on the properties for backwards compat.