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.

Sign up for GitHub

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
Open

stateDescription: change to read-write #2487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions configuration/items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,13 @@ Number Livingroom_Clock_Battery "Battery Charge [%d %%]" // e.g. "
Location My_Location "My Location [%2$s°N %3$s°E %1$sm]" // e.g. "49.26°N 123.19°E 0m"
```

##### State Description

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

To change the item to read-write add `stateDescription=" "[readOnly=false]` in bindingconfig.

#### State Transformation

Transformations can be used in the state part of an Item, to translate the raw state of an Item into another language, or to convert technical values into human readable information.
Expand Down