Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dilyanpalauzov
Copy link
Contributor

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 things CommandTopic might not be adequate.

Copy link

netlify bot commented Apr 24, 2025

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

Name Link
🔨 Latest commit 27c5786
🔍 Latest deploy log https://app.netlify.com/sites/openhab-docs-preview/deploys/681f114377d56b0008a615df
😎 Deploy Preview https://deploy-preview-2487--openhab-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dilyanpalauzov
Copy link
Contributor Author

I do not think that the failure to generate the documentation at Netlify is in this change.

@wborn
Copy link
Member

wborn commented Apr 29, 2025

I also ran into the failing preview build and created #2491 to fix it.

@dilyanpalauzov dilyanpalauzov force-pushed the stateDescription_read_write branch from 2dbe784 to cfb6cab Compare May 6, 2025 11:20

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.
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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

@dilyanpalauzov dilyanpalauzov force-pushed the stateDescription_read_write branch from a3c858b to 27c5786 Compare May 10, 2025 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants