Skip to content

Enhance 'follow' profile description in items.md#2653

Open
jwrw wants to merge 1 commit intoopenhab:mainfrom
jwrw:patch-1
Open

Enhance 'follow' profile description in items.md#2653
jwrw wants to merge 1 commit intoopenhab:mainfrom
jwrw:patch-1

Conversation

@jwrw
Copy link
Copy Markdown

@jwrw jwrw commented Jan 27, 2026

Clarified the description of the 'follow' profile to better explain its functionality and impact on linked channels. I didn't understand the existing wording, so hopefully this makes it clearer and more useful.

Clarified the description of the 'follow' profile to better explain its functionality and impact on linked channels.

Signed-off-by: Jim Watson <jimwrwatson@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 27, 2026

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 ef2b221
🔍 Latest deploy log https://app.netlify.com/projects/openhab-docs-preview/deploys/6978decbe2c1a20008090ce6
😎 Deploy Preview https://deploy-preview-2653--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 project configuration.

Comment thread configuration/items.md
|-----------------------------------------------------------------------------------------------|---------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `default` | State | All | If you don't specify any Profile, this Profile will be used. For State Channels, this means that states and commands are just propagated from the Channel to the Item and vice versa without any changes. For Trigger Channels, the Default Profile won't change anything on the Item. |
| `follow` | State | All | If one device should "follow" the actions of another device, this can be used. The term "follow" in this case means that any state that is sent to an Item will be forwarded from this Item to any linked Channel with the `follow` Profile. It takes state updates on an Item and sends them as a command onto the Channel. In the direction from the ThingHandler towards the Item, this Profile ignores state updates. |
| `follow` | State | All | This Profile can be used to make one device "follow" the actions of another device. The channel will "follow" an item linked to the Channel using this Profile. This means that any state that is sent to that Item will be forwarded from this Item to any Channel linked using the `follow` Profile. It takes state updates on the Item and sends them as a command onto the Channel. Here is can affect other Items linked to that channel with say a `Default` Profile, or can carry out other command actions configured on that channel (e.g. to publish a command via MQTT). In the direction from the ThingHandler towards the Item, this Profile ignores state updates. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't understand that new sentence "Here is can ..."

Copy link
Copy Markdown
Author

@jwrw jwrw Mar 21, 2026

Choose a reason for hiding this comment

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

Quite correct - it should read "Here it can..."

What's the bast way to correct this?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What about

This can affect other Items linked to that channel with, say, a Default Profile, or can carry out other command actions configured on that channel (e.g., to publish a command via MQTT).

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