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.

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

Items: Add unit metadata for UoM (Number:) Items #1901

Merged
merged 3 commits into from
May 20, 2023
Merged

Items: Add unit metadata for UoM (Number:) Items #1901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e84087
Items: Add `unit` metadata for UoM (`Number:`) Items
florian-h05 May 15, 2023
da3a78e
Items: Fix metadata menu warnings
florian-h05 May 15, 2023
8d28ea2
Change label, description & order of `unit` metadata
florian-h05 May 18, 2023
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
1 change: 1 addition & 0 deletions bundles/org.openhab.ui/web/src/assets/definitions/metadata/namespaces.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export default [
{ name: 'unit', label: 'Unit' },
{ name: 'stateDescription', label: 'State Description' },
{ name: 'commandDescription', label: 'Command Options' },
{ name: 'synonyms', label: 'Synonyms' },
Expand Down
15 changes: 9 additions & 6 deletions bundles/org.openhab.ui/web/src/components/item/metadata/item-metadata-menu.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
<f7-list>
<ul>
<f7-list-item
v-for="namespace in wellKnownNamespaces" :key="namespace"
v-for="namespace in wellKnownNamespaces" :key="namespace.name"
:link="'/settings/items/' + item.name + '/metadata/' + namespace.name"
:title="namespace.label"
:after="namespace.value || 'Not Set'" />
</ul>
<ul v-if="customNamespaces.length > 0">
<f7-list-item divider />
<f7-list-item
v-for="namespace in customNamespaces" :key="namespace"
v-for="namespace in customNamespaces" :key="namespace.name"
:link="'/settings/items/' + item.name + '/metadata/' + namespace.name"
:title="namespace.label"
:after="namespace.value || 'Not Set'" />
Expand All @@ -37,6 +37,9 @@ export default {
metadataNamespaces: MetadataNamespaces
}
},
beforeMount () {
if (this.item.type.indexOf('Number:') < 0) this.metadataNamespaces = this.metadataNamespaces.filter(n => n.name !== 'unit')
},
computed: {
editableNamespaces () {
if (!this.item.metadata) return []
Expand All @@ -54,9 +57,9 @@ export default {
},
wellKnownNamespaces () {
return this.editableNamespaces
.filter((n) => MetadataNamespaces.some((wk) => wk.name === n.name))
.filter((n) => this.metadataNamespaces.some((wk) => wk.name === n.name))
.map((n) => {
const wellKnown = MetadataNamespaces.find((wk) => wk.name === n.name)
const wellKnown = this.metadataNamespaces.find((wk) => wk.name === n.name)
return {
...n,
label: wellKnown.label
Expand All @@ -65,7 +68,7 @@ export default {
},
customNamespaces () {
return this.editableNamespaces
.filter((n) => !MetadataNamespaces.some((wk) => wk.name === n.name))
.filter((n) => !this.metadataNamespaces.some((wk) => wk.name === n.name))
.map((n) => {
return {
...n,
Expand All @@ -87,7 +90,7 @@ export default {
buttons: [
[
{ label: true, text: 'Well-known namespaces' },
...MetadataNamespaces.map((n) => {
...this.metadataNamespaces.map((n) => {
return {
text: n.label,
color: 'blue',
Expand Down
32 changes: 32 additions & 0 deletions bundles/org.openhab.ui/web/src/components/item/metadata/item-metadata-unit.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<template>
<div>
<f7-block-header>
<b style="color: var(--f7-theme-color) !important;">WARNING: Changing the internal unit can corrupt your persisted data!</b>
</f7-block-header>
<f7-list>
<f7-list-input
label="Unit"
name="value"
ref="value"
type="text"
placeholder="leave empty to use system default"
:value="metadata.value"
@blur="(evt) => metadata.value = evt.target.value" />
</f7-list>
<f7-block-footer class="param-description">
<small>All processed values are internally normalized to the specified <code>unit</code>. The normalized value is used to propagate the value to external integrations (e.g. persistence, REST API, WebSocket) so these values will always have the specified unit and scale.
<br>
Changing the <code>unit</code> will change the values that these systems receive.
<br>
<br>
Additionally the <code>unit</code> will be used in UIs if no unit is specified for the state description. The state description is used for display purpose only, it can contain any compatible unit and will not affect the internal <code>unit</code>.
</small>
</f7-block-footer>
</div>
</template>

<script>
export default {
props: ['itemName', 'metadata', 'namespace']
}
</script>
3 changes: 3 additions & 0 deletions bundles/org.openhab.ui/web/src/pages/settings/items/metadata/item-metadata-edit.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ import YAML from 'yaml'
import MetadataNamespaces from '@/assets/definitions/metadata/namespaces.js'

import ItemMetadataItemDescription from '@/components/item/metadata/item-metadata-itemdescription.vue'
import ItemMetadataUnit from '@/components/item/metadata/item-metadata-unit.vue'
import ItemMetadataSynonyms from '@/components/item/metadata/item-metadata-synonyms.vue'
import ItemMetadataWidget from '@/components/item/metadata/item-metadata-widget.vue'
import ItemMetadataWidgetOrder from '@/components/item/metadata/item-metadata-widgetorder.vue'
Expand Down Expand Up @@ -109,6 +110,8 @@ export default {
case 'stateDescription':
case 'commandDescription':
return ItemMetadataItemDescription
case 'unit':
return ItemMetadataUnit
case 'synonyms':
return ItemMetadataSynonyms
case 'widget':
Expand Down