Skip to content

Commit fb1e0f8

Browse files
Update semantic model badge tables (openhab#1495)
The tables were wrong and confusing. I fixed the errors (reverse engineered from code), merged them into one, streamlined it so it shows the three relevant columns "Equipment", "Point" and "Property". Signed-off-by: Eiko Wagenknecht <[email protected]>
1 parent 5ffa909 commit fb1e0f8

File tree

1 file changed

+23
-38
lines changed

1 file changed

+23
-38
lines changed

Diff for: tutorials/getting_started/model.md

+23-38
Original file line numberDiff line numberDiff line change
@@ -186,43 +186,28 @@ To change the type of an equipment or point, simply edit the tags.
186186
Some of these edits are possible from the Model Page itself.
187187
Where that's not supported, you can make the changes through the Item's Page.
188188

189-
## Controls and Sensor types
190-
191-
This is a table descibing the Equipment types and point class and type to enable display of badges and measurements on the location cards.
192-
This is based off the sources linked below.
193-
189+
## Badges
190+
191+
This is a table describing the Equipment, Point and Property classes needed to enable the display of status and measurement badges on the location cards.
192+
193+
| Badge | Type | Equipment | Point | Property |
194+
|--------------|-------------|------------------------------------------------------------|------------------------------------|-------------|
195+
| Lights | Status | * | Control, Switch | Light |
196+
| Windows | Status | Window | OpenState | * |
197+
| Doors | Status | Door, FrontDoor, BackDoor, InnerDoor, CellarDoor, SideDoor | OpenState | * |
198+
| Garage Doors | Status | GarageDoor | OpenState | * |
199+
| Blinds | Status | Blinds | OpenState | * |
200+
| Presence | Status | * | Status | Presence |
201+
| Lock | Status | Lock | Status, OpenState, Control, Switch | * |
202+
| Climate | Status | HVAC | Status, Control, Switch | * |
203+
| Screens | Status | Screen, Television | Status, Control, Switch | Power |
204+
| Speakers | Status | Receiver, Speaker | Status, Control, Switch | Power |
205+
| Projectors | Status | Projector | Status, Control, Switch | Power |
206+
| Alarms | Status | * | Alarm | * |
207+
| Luminance | Measurement | * | Measurement | Light |
208+
| Temperature | Measurement | * | Measurement | Temperature |
209+
| Humidity | Measurement | * | Measurement | Humidity |
210+
211+
This table is based off the sources:
194212
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/status-badge.vue#L63>
195213
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/measurement-badge.vue#L48>
196-
197-
### Badges
198-
199-
| Type | Equipment | Equipment subtypes allowed | Point Class | Point Type | Point Subtypes allowed |
200-
| ----------- | --- | ---- | ----------- | ---- | ----- |
201-
| Lights | ANY | NA |Control | Light | yes |
202-
| Windows | Window | no | Status | OpenState | no |
203-
| Doors | Door or FrontDoor | no | Status | OpenState | no |
204-
| Garage Doors | GarageDoor | no | Status | OpenState | no |
205-
| Blinds | Blinds | no | Status | OpenState | no |
206-
| Presence | ANY | NA | Status | Presence | yes |
207-
| Lock | Lock | no | Status | OpenState | no |
208-
| Lock | Lock | no | Status | ANY | no |
209-
| Lock | Lock | no | Control | ANY | yes |
210-
| Climate | HVAC | yes | Status | ANY | no |
211-
| Climate | HVAC | yes | Control | ANY | yes |
212-
| Screens | Screen | yes | Status | Power | no |
213-
| Screens | Screen | yes | Control | Power | yes |
214-
| Speakers | Receiver or Speaker | Status | Power | no |
215-
| Speakers | Receiver or Speaker | Control | Power | yes |
216-
| Projectors | Projector | no | Status | Power | no |
217-
| Projectors | Projector | no | Control | Power | yes |
218-
| Alarms | ANY | NA | Alarm | ANY | yes |
219-
220-
### Measurements
221-
222-
These don't care about equipment and just look at points
223-
224-
| Type | Point Class | Point Type | Point Subtypes allowed |
225-
| ----------- | ----------- | ---- | ----- |
226-
| luminance | Measurement | Light | yes |
227-
| temperature | Measurement | Temperature | yes |
228-
| humidity | Measurement | Humidity | yes |

0 commit comments

Comments
 (0)