Skip to content
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

Add documentation for how to add custom tags to the model. #2414

Open
mti-sk opened this issue Nov 27, 2024 · 4 comments
Open

Add documentation for how to add custom tags to the model. #2414

mti-sk opened this issue Nov 27, 2024 · 4 comments

Comments

@mti-sk
Copy link

mti-sk commented Nov 27, 2024

Hi,
could you add to doc how to add custom tags to the model, please ?
Reference: openhab/openhab-core#4459

To add a new tag create a .yml file in $OH_CONF/tags.

Here's an example:

version: 1

tags:

  • uid: Location_Home
    label: Home
    description: A house or home.
    synonyms:

    • House
    • Building
  • uid: Location_Indoor_Room_LivingRoom_Den
    label: Den
    description: A living room with a TV.
    synonyms:

    • Game room
    • TV room
  • uid: Location_Indoor_Room_LivingRoom_FrontRoom
    label: Front Room
    description: The front room of the house where guests are received.
    synonyms:

    • Sitting room
    • Music room
  • uid: Location_Indoor_Room_UtilityRoom
    label: Utility Room
    description: Room with HVAC, hot water heaters, laundry, etc.

  • uid: Equipment_Service
    label: Service
    description: A software service that provides something relevant to the home automation.
    synonyms:

    • Software
    • API
    • Daemon
  • uid: Equipment_MediaPlayer
    label: Media Player
    description: A device that can play media.
    synonyms:

    • Player
    • Speaker
    • Display
  • uid: Equipment_Occupancy
    label: Occupancy
    description: An equipment that monitors occupancy in a space.

  • uid: Point_BatteryProperty
    label: Battery Property
    description: A property of a battery.

  • uid: Property_Availability
    label: Availability
    description: Indicates the availability of a service or device.
    synonyms:

    • Online status
    • Offline status
    • Online/Offline status
  • uid: Property_Radon
    label: Radon
    description: Having to do with radon gas.

  • uid: Property_VOC
    label: VOC
    description: Having to do with volitile organic chemicals.

  • uid: Property_Media
    label: Media
    description: Streaming audio or video.
    synonyms:

    • Video
    • Music
    • Stream
  • uid: Property_Cost
    label: Cost
    description: The amount of money something requires.

  • uid: Property_Cloudiness
    label: Cloudiness
    description: Having to do with clouds.

  • uid: Property_Weather
    label: Weather
    description: Having to do with weather conditions.

  • uid: Property_Time
    label: Time
    description: Having to do with time.

  • uid: Property_Image
    label: Image
    description: Consisting or related to an image, perhaps from a camera.

It has examples of locations, equipment, points and properties.

Relevant openHAB forum post: https://community.openhab.org/t/oh-4-1-tutorial-to-manage-custom-semantic-tags/148135

@stefan-hoehn
Copy link
Contributor

Do you mind pointing to the page in the openHAB documentation and make a proposal how it should be documented? I would even be more happy, if you provided a pull request for the documentation. Thanks.
@lolodomo maybe you can point us to the right pages where it should be documented?

@openhab-bot
Copy link
Collaborator

This issue has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/ideas-and-discussion-what-features-do-you-want-in-openhab-5-0/160573/48

@rkoshak
Copy link
Contributor

rkoshak commented Dec 2, 2024

I would propose either a brand new page or, since the semantic model is an Item only concept on the Item's configuration page. Given that Profiles are also burried under the Item's page I'd say the Item's config page is probably most appropriate.

@stefan-hoehn
Copy link
Contributor

@mti-sk So, Rich is pointing to this page: https://www.openhab.org/docs/configuration/items.html#items

Are you able to add this information to that page in the docs repo? https://github.com/openhab/openhab-docs in particular on that page https://github.com/openhab/openhab-docs/blob/main/configuration/items.md and provide a PR for that?

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

No branches or pull requests

4 participants