-
-
Notifications
You must be signed in to change notification settings - Fork 711
stateDescription: change to read-write #2487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
stateDescription: change to read-write #2487
Conversation
✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
I do not think that the failure to generate the documentation at Netlify is in this change. |
I also ran into the failing preview build and created #2491 to fix it. |
2dbe784
to
cfb6cab
Compare
|
||
Internally items have a State Description, which can be obtained by GET `/rest/items/<itemName>`. | ||
When an item is linked to a channel without `CommandTopic`, the State Description of the item is read-only. | ||
Some UIs may disallow the user to edit such an item. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is wrong. Item editing does not depend on the state description.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In OH-Android it does depend - openhab/openhab-android#3870.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think your wording is wrong and hence we are talking about different things.
Item editing is actually modifying the config. You mean sending commands, not editing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it:
@@ -275,7 +275,7 @@ Location My_Location "My Location [%2$s°N %3$s°E %1$sm]" // e.g.
Internally items have a State Description, which can be obtained by GET `/rest/items/<itemName>`.
When an item is linked to a channel without `CommandTopic`, the State Description of the item is read-only.
-Some UIs may disallow the user to edit such an item.
+Some UIs may disallow the user to send commands to such an item.
To change the item to read-write add `stateDescription=" "[readOnly=false]` in bindingconfig.
#### State Transformation
a3c858b
to
27c5786
Compare
This takes the text from openhab/openhab-addons#18362 (comment) and extends the documentation, telling the user how an item, bound to read-only channel, can be made read-write.
However I have experience only with MQTT and there
CommandTopic
applies. For other thingsCommandTopic
might not be adequate.