Support for Equipment -> Light for light badge

Sim · February 17, 2023, 8:50am

Looking at this:

github.com/openhab/openhab-webui

[Design/Spec] Location semantic cards: header

opened 03:24PM - 24 Nov 20 UTC

closed 10:39PM - 28 Nov 20 UTC

ghys

enhancement main ui

This issue discusses the design and features of the header of a location card, w…hen not customized by users using slots. As a semantic card it inherits a number of common properties described in #555 (like background color/image). ## Title By default, the title is the label of the item (or its name if it has none). ## Subtitle If the location has a parent, the label or name of the parent is the default (but it should be possible to remove it, for instance if the cards are manually put in groups by the user (see #555). ## At-a-glance modules The built-in at-a-glance modules (or "complications" as in watch screens) use the semantic model to gather information about the location and display it in a summarized manner with little icons and eventually a short label, "rewarding" the time taken to build a well-designed model by automatically providing information in the header of the card. The goal is not to be exhaustive, rather cover what should be the most popular scenarios. There will still of course be cases outside this anticipated well-known scenarios, and esoteric needs; therefore ideally users should be able to customize these modules, or add more (with slots). It should also be possible to hide automatically shown modules that doesn't work well or aren't desired. A location card with all modules having something to display should resemble the following example ("worst case scenario"): ![image](https://user-images.githubusercontent.com/2004147/100102623-265a6e00-2e64-11eb-8e58-59b2d71e6506.png) It is a little busy, but the average card should be much less so since a module isn't displayed when there is nothing to show. ### General principles for querying data from the model - Normally the user will have put Equipment in the Locations. Most of these pieces of equipment will have Points. Gathering states from Points is always preferred as opposed to gathering states from Equipment item themselves, but we do it anyway if we couldn't find any matching Point. For instance, for blinds, look for OpenState points in equipment tagged Blinds (the preferred default), but if we can't find any, analyze the state of the Equipment items themselves - and consider a state of OPEN, or CLOSED appropriately. - In order to leave out any ambiguity about which Points to consider, the admin has the option of relating Points directly to the Location without any Equipment in between. There are many ways to do it: * a Point can be made a member of both its parent Equipment, and also the Location it's in. * the item could be duplicated at the Location level and linked to the same channel so that it reflects the same data * a Group with an aggregation function (e.g. average) can be added as a Point to the Location to compute a state for the location from the state of the desired items. <br />we should therefore prioritize the results by considering first only the Points which have a direct _hasLocation_ relation to the location; but if none match, we can consider those indirectly related through their equipment items. ### Built-in glance modules #### ![image](https://user-images.githubusercontent.com/2004147/100102773-57d33980-2e64-11eb-963d-a109917144ba.png) Number of alarms (after the title) __Point_Alarm__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Point_Alarm__ _isPointOf_ __(any equipment)__ _hasLocation_ __(the location)__ Count those with the state `ON`: if any result, display the count after the title as shown. #### ![image](https://user-images.githubusercontent.com/2004147/100103443-332b9180-2e65-11eb-9031-43e4ff910145.png) Nb. Lights on __Point_Control*__ _relatedTo_ __Property_Light__ _hasLocation_ __(the location)__ with the state ___If no matching item found:___ __Point_Control*__ _relatedTo_ __Property_Light__ _isPointOf_ __(any equipment)__ _hasLocation_ __(the location)__ Count those with the state `ON`, integer>0 or H,S,B with B > 0: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100104468-80f4c980-2e66-11eb-9a3e-4fccf906dade.png) Nb. of Open Windows __Point_Status_OpenState__ _isPointOf_ __Equipment_Window__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_Window__ _hasLocation_ __(the location)__ Count those with the state `OPEN`: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100105088-42134380-2e67-11eb-8c95-3c20a27e4438.png) Nb. of Open Doors __Point_Status_OpenState__ _isPointOf_ __Equipment_Door__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_Door__ _hasLocation_ __(the location)__ Count those with the state `OPEN`: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100105203-60793f00-2e67-11eb-881b-4b56a20f9589.png) Nb. of Open Garage Doors __Point_Status_OpenState__ _isPointOf_ __Equipment_GarageDoor__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_GarageDoor__ _hasLocation_ __(the location)__ Count those with the state `OPEN`: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100105349-89013900-2e67-11eb-9c37-2b4bc3c2acf4.png) Nb. of Open Blinds __Point_Status_OpenState__ _isPointOf_ __Equipment_Blinds__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_Blinds__ _hasLocation_ __(the location)__ Count those with the state `OPEN` or integer=0: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100105840-18a6e780-2e68-11eb-99ab-59db6bd18ae8.png) Presence Detected __Point_Status__ _relatedTo_ __Property_Presence__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Point_Status__ _relatedTo_ __Property_Presence__ _isPointOf_ __(any equipment)__ _hasLocation_ __(the location)__ If any result has the state `ON` or `OPEN`, display the icon. #### ![image](https://user-images.githubusercontent.com/2004147/100106269-a682d280-2e68-11eb-893e-22ec7dcfaab0.png) Locks __Point_Status__ or __Point_Control*__ _isPointOf_ __Equipment_Lock__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_Lock__ _hasLocation_ __(the location)__ If all results have the state `CLOSED` or `OFF`: display ![image](https://user-images.githubusercontent.com/2004147/100107368-da122c80-2e69-11eb-8309-a5e35b0ac90f.png) If any result has the state `ON` or `OPEN`: single result, display the icon ![image](https://user-images.githubusercontent.com/2004147/100106269-a682d280-2e68-11eb-893e-22ec7dcfaab0.png); multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100107597-18a7e700-2e6a-11eb-835a-9cae2c5e916a.png) Climate Control Powered On (A/C, Heating) __Point_Status__ or __Point_Control*__ __relatedTo_ __Property_Power__ _isPointOf_ __Equipment_HVAC__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_HVAC__ _hasLocation_ __(the location)__ If any result has the state `ON`, display the icon. #### ![image](https://user-images.githubusercontent.com/2004147/100108170-ca471800-2e6a-11eb-89f5-2b6ac2b83ff5.png) Nb. of Screens Powered On __Point_Status__ or __Point_Control*__ __relatedTo_ __Property_Power__ _isPointOf_ __Equipment_Screen__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_Screen__ _hasLocation_ __(the location)__ Count those with the state `ON`: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100108678-55c0a900-2e6b-11eb-9a46-073f96633e94.png) Nb. of Speakers/AV Receivers Powered On __Point_Status__ or __Point_Control*__ __relatedTo_ __Property_Power__ _isPointOf_ __Equipment_Speaker__ or __Equipment_Receiver__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_Speaker__ or __Equipment_Receiver__ _hasLocation_ __(the location)__ Count those with the state `ON`: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100108973-a89a6080-2e6b-11eb-91ed-d34c7094bcf1.png) Nb. of Projectors Powered On __Point_Status__ or __Point_Control*__ __relatedTo_ __Property_Power__ _isPointOf_ __Equipment_Projector__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Equipment_Projector__ _hasLocation_ __(the location)__ Count those with the state `ON`: single result, display the icon only; multiple results, display the icon and the count. #### ![image](https://user-images.githubusercontent.com/2004147/100109449-22324e80-2e6c-11eb-94aa-c24ec0a72918.png) Temperature (Measurement & Setpoint) ##### Measurement part: __Point_Measurement__ _relatedTo_ __Property_Temperature__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Point_Measurement__ _relatedTo_ __Property_Temperature__ _isPointOf_ __(any equipment)__ _hasLocation_ __(the location)__ Compute the average of the valid values (if single result, take the result a fortiori), and display if valid. ##### Setpoint part: __Point_Setpoint__ _relatedTo_ __Property_Temperature__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Point_Setpoint__ _relatedTo_ __Property_Temperature__ _isPointOf_ __(any equipment)__ _hasLocation_ __(the location)__ There should be only one result in theory; out of an abundance of caution, compute the average of the valid values (if single result, take the result a fortiori), and display if valid between parentheses after the measurement. #### ![image](https://user-images.githubusercontent.com/2004147/100110410-30349f00-2e6d-11eb-8ac0-45b2211f3a31.png) Humidity (Measurement) __Point_Measurement__ _relatedTo_ __Property_Humidity__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Point_Measurement__ _relatedTo_ __Property_Humidity__ _isPointOf_ __(any equipment)__ _hasLocation_ __(the location)__ Compute the average of the valid values (if single result, take the result a fortiori), and display if valid. #### ![image](https://user-images.githubusercontent.com/2004147/100112490-928e9f00-2e6f-11eb-8d77-70a8835b3ab3.png) Luminance/Ambient Light (Measurement) __Point_Measurement__ _relatedTo_ __Property_Light__ _hasLocation_ __(the location)__ ___If no matching item found:___ __Point_Measurement__ _relatedTo_ __Property_Light__ _isPointOf_ __(any equipment)__ _hasLocation_ __(the location)__ Compute the average of the valid values (if single result, take the result a fortiori), and display if valid.

a simple problem appears, already reported from 2 years ago:

github.com/openhab/openhab-webui

Add support for Equipment_Lightbulb for light badge

opened 12:03PM - 15 Aug 21 UTC

vguna

enhancement main ui

## The problem I mainly configure my semantic model with having equipment directly in locations. So If I look at the Locations section with all the rooms, I can see e.g. lightbulbs directly under Devices of a location - not Properties. Now I fell in love with the badges displayed on the cards. As it seems there is currently no support for lights coming from `Equipment_Lightbulb`s. I found this PR https://github.com/openhab/openhab-webui/issues/556 which nicely shows the graceful fallback behavior, if no points etc. are configured, but looking at the equipment directly.  ## Your suggestion It would be awesome if there would also be a fallback to `Equipment_Lightbulb`s to show the light badge.  ## Your environment ```yaml runtimeInfo: version: 3.1.0 buildString: Release Build locale: de-DE systemInfo: configFolder: /etc/openhab userdataFolder: /var/lib/openhab logFolder: /var/log/openhab javaVersion: 11.0.12 javaVendor: Azul Systems, Inc. javaVendorVersion: Zulu11.50+19-CA osName: Linux osVersion: 5.10.52-v7l+ osArchitecture: arm availableProcessors: 4 freeMemory: 116663208 totalMemory: 309374976 bindings: - amazonechocontrol - astro - bluetooth - goecharger - http - knx - mail - miio - mqtt - network - openweathermap - smartmeter - systeminfo - telegram - tr064 - weathercompany - weatherunderground clientInfo: device: ios: false android: false androidChrome: false desktop: true iphone: false ipod: false ipad: false edge: false ie: false firefox: true macos: false windows: true cordova: false phonegap: false electron: false nwjs: false webView: false webview: false standalone: false os: windows pixelRatio: 1 prefersColorScheme: light isSecureContext: false locationbarVisible: true menubarVisible: true navigator: cookieEnabled: true deviceMemory: N/A hardwareConcurrency: 8 language: de languages: - de - en-US - en onLine: true platform: Win32 screen: width: 1920 height: 1080 colorDepth: 24 support: touch: false pointerEvents: true observer: true passiveListener: true gestures: false intersectionObserver: true themeOptions: dark: light filled: true pageTransitionAnimation: default bars: filled homeNavbar: default homeBackground: default expandableCardAnimation: default userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:90.0) Gecko/20100101 Firefox/90.0 timestamp: 2021-08-15T12:01:57.164Z ```

It would be awesome if there would also be a fallback to Equipment → Light to show the light badge.

Thanks you!