Extend sitemap syntax for icon #3378

lolodomo · 2023-02-17T00:38:19Z

The icon value can now contain until 3 segments separated by a semi-column.
First segment is the icon source. Example: oh, if, iconify, material, f7, ...
Second segment is the icon set (and can be empty). Example: classic
Third segment is the icon name (and can contain hyphen). Example: temperature

In case only two segments are provided, the first segment is the icon source and the second the icon name. "classic" icon set is assumed.
In case only one segment is provided, the icon source is assumed to be the openHAB server and its classic icon set and the value is then the icon name.

Ability to surround the value with simple or double quotes is kept for better backward compatibility.

Signed-off-by: Laurent Garnier [email protected]

lolodomo · 2023-02-24T08:13:38Z

I encounter difficulties to define the right syntax. Current PR is not working as expected.

ID cannot be used as icon segment as "-" should be accepted.

mherwege · 2023-02-24T13:37:16Z

How about creating a new terminal ICON_ID:

terminal ICON_ID:
    ('a'..'z' | 'A'..'Z' | '_') ('a'..'z' | 'A'..'Z' | '_' | '-' | '0'..'9')* |
    '"' ('a'..'z' | 'A'..'Z' | '_') ('a'..'z' | 'A'..'Z' | '_' | '-' | '0'..'9')* '"' |
    "'" ('a'..'z' | 'A'..'Z' | '_') ('a'..'z' | 'A'..'Z' | '_' | '-' | '0'..'9')* "'";

That also avoids the variants in each input type (provided the quotes are handled properly elsewhere, but it should as it worked with STRING terminals).
I simplified the terminal syntax, removing the option to start with ^ or a number, but that is probably OK for icon id's.

Keep the valueConverter and put ICON_ID under Icon in line 151 (instead of STRING | ID).

lolodomo · 2023-02-24T18:23:35Z

I tried yesterday to create a new terminal id but my attempt leaded to an error when building. I will try again with your proposal.

lolodomo · 2023-02-25T13:19:36Z

@mherwege : did you get some difficulties when you updated the sitemap syntax ?
With my last changes, compiling is now OK.
I have only updated the bundle org.openhab.core.model.sitemap in my production environment and restarted the server.Here are the logs I got:

14:16:05.417 [INFO ] [del.core.internal.ModelRepositoryImpl] - Loading model 'test.sitemap'
14:16:05.881 [INFO ] [del.core.internal.ModelRepositoryImpl] - Loading model 'test2.sitemap'
...
14:16:50.922 [WARN ] [del.core.internal.ModelRepositoryImpl] - Configuration model 'test.sitemap' is either empty or cannot be parsed correctly!
14:16:50.948 [WARN ] [del.core.internal.ModelRepositoryImpl] - Configuration model 'test2.sitemap' is either empty or cannot be parsed correctly!

I have no syntax error displayed, that is a good point.
But finally the loading is apparently failing.

mhilbush · 2023-02-25T13:24:54Z

See this.

https://community.openhab.org/t/openhab-4-0-snapshot-discussion/142322/188

lolodomo · 2023-02-25T13:35:00Z

@mhilbush : I have only a problem with my sitemap files.
And I updated only one of my bundles (the other are from snapshot 3301):

openhab> bundle:list -s | grep model
 46 x Active   x  80 x 2.1.9                  x io.swagger.core.v3.swagger-models
189 x Active   x  80 x 4.0.0.202302040305     x org.openhab.core.model.core
190 x Active   x  80 x 4.0.0.202302040307     x org.openhab.core.model.item
191 x Active   x  80 x 4.0.0.202302040309     x org.openhab.core.model.item.ide
192 x Active   x  80 x 4.0.0.202302040309     x org.openhab.core.model.item.runtime
193 x Active   x  80 x 4.0.0.202302040313     x org.openhab.core.model.lsp
194 x Active   x  80 x 4.0.0.202302040307     x org.openhab.core.model.persistence
195 x Active   x  80 x 4.0.0.202302040308     x org.openhab.core.model.persistence.ide
196 x Active   x  80 x 4.0.0.202302040308     x org.openhab.core.model.persistence.runtime
197 x Active   x  80 x 4.0.0.202302040312     x org.openhab.core.model.rule
198 x Active   x  80 x 4.0.0.202302040312     x org.openhab.core.model.rule.ide
199 x Active   x  80 x 4.0.0.202302040312     x org.openhab.core.model.rule.runtime
200 x Active   x  80 x 4.0.0.202302040311     x org.openhab.core.model.script
201 x Active   x  80 x 4.0.0.202302040311     x org.openhab.core.model.script.ide
202 x Active   x  80 x 4.0.0.202302040311     x org.openhab.core.model.script.runtime
203 x Active   x  80 x 4.0.0.202302251312     x org.openhab.core.model.sitemap
204 x Active   x  80 x 4.0.0.202302040309     x org.openhab.core.model.sitemap.ide
205 x Active   x  80 x 4.0.0.202302040309     x org.openhab.core.model.sitemap.runtime
206 x Active   x  80 x 4.0.0.202302040309     x org.openhab.core.model.thing
207 x Active   x  80 x 4.0.0.202302040310     x org.openhab.core.model.thing.ide
208 x Active   x  80 x 4.0.0.202302040310     x org.openhab.core.model.thing.runtime

I am wondering if this is required or not that I recompile and deploy a new version of the bundles org.openhab.core.model.sitemap.ide and org.openhab.core.model.sitemap.runtime ?

mhilbush · 2023-02-25T13:44:46Z

Ok, then I guess unrelated to what was reported on the forum.

I opened an issue for that problem.

#3400

lolodomo · 2023-02-25T13:47:57Z

When I recompile from main (with my changes) and deploy the bundle, it works again, so this is certainly something more in link with my changes.
That's why I would like to have feedback from @mherwege who handled and tested an updated sitemap syntax very recently.

mherwege · 2023-02-25T14:10:25Z

@lolodomo I have been testing this in the Eclipse IDE. I did an mvn install on core.model.sitemap, didn’t touch the ide or runtime projects. I did have all three open (+ the basicui project) so they where picked up when resolving the launch bnd file. And that worked for testing. I did not try to move the file into an install of OH and test outside of the IDE.
The important part is to have all code generated properly and included. An mvn clean install on the sitemap repository should make sure of that. The message you get about the sitemaps points to something it cannot interpret in the sitemaps, probably because the new code is not included properly or does not work as expected. It may help to check the generated code to see if something is not as expected there.

lolodomo · 2023-02-25T14:28:27Z

Unfortunately, I have still an old Eclipse not fully compatible with Java 17. I can edit and compile code but I can't run OH inside Eclipse.
During this time, I try to move to your changed syntax with the added "input" element and I did not encounter this same kind of problem. So clearly, this is a problem with my own updated sitemap syntax.

lolodomo · 2023-04-11T11:16:35Z

Here is an example of sitemap showing the different cases:

sitemap test label="Tests"
{
        Frame label="Icon ref without quotes" {
                Default item=CurrentTemp icon=temperature
                Default item=CurrentHumidity icon=classic:humidity
                Default item=CurrentPressure icon=oh:classic:pressure
                Default item=CurrentPressureTrend icon=material::arrow_drop_down
                Default item=SetpointTemp icon=iconify:wi:day-sunny-overcast iconcolor=["green"]
                Default item=TestString icon=material::favorite iconcolor=["yellow"]
        }
        Frame label="Icon ref with quotes" {
                Default item=CurrentTemp icon="temperature"
                Default item=CurrentHumidity icon="classic:humidity"
                Default item=CurrentPressure icon="oh:classic:pressure"
                Default item=CurrentPressureTrend icon="material::arrow_drop_down"
                Default item=SetpointTemp icon="iconify:wi:day-sunny-overcast" iconcolor=["green"]
                Default item=TestString icon="material::favorite" iconcolor=["yellow"]
        }
}

And the result in Basic UI:

lolodomo · 2023-04-11T11:21:17Z

I found a way to change the syntax that works as expected.
PR is now ready for review.

clinique

LGTM

lolodomo · 2023-04-11T12:58:07Z

It seems the build succeeded but with the now so famous final "Finished: UNSTABLE".

The icon value can now contain until 3 segments separated by a semi-column. First segment is the icon source. Example: oh, if, iconify, material, f7, ... Second segment is the icon set (and can be empty). Example: classic Third segment is the icon name (and can contain hyphen). Example: temperature In case only two segments are provided, the first segment is the icon source and the second the icon name. "classic" icon set is assumed if icon source is "oh". In case only one segment is provided, the icon source is assumed to be the openHAB server and its classic icon set and the value is then the icon name. Ability to surround the value with simple or double quotes is kept for better backward compatibility. Signed-off-by: Laurent Garnier <[email protected]> Fix

lolodomo · 2023-04-11T18:18:52Z

I finally changed the expectation when the icon value contains only 2 segments to be more compliant with Main UI syntax.
Here is an example of sitemap showing the different cases:

sitemap test label="Tests"
{
        Frame label="Icon ref without quotes" {
                Default item=CurrentTemp icon=temperature
                Default item=CurrentHumidity icon=oh:humidity
                Default item=CurrentPressure icon=oh:classic:pressure
                Default item=CurrentPressureTrend icon=material:arrow_drop_down
                Default item=SetpointTemp icon=iconify:wi:day-sunny-overcast iconcolor=["green"]
                Default item=TestString icon=material:favorite iconcolor=["yellow"]
        }
        Frame label="Icon ref with quotes" {
                Default item=CurrentTemp icon="temperature"
                Default item=CurrentHumidity icon="oh:humidity"
                Default item=CurrentPressure icon="oh:classic:pressure"
                Default item=CurrentPressureTrend icon="material:arrow_drop_down"
                Default item=SetpointTemp icon="iconify:wi:day-sunny-overcast" iconcolor=["green"]
                Default item=TestString icon="material:favorite" iconcolor=["yellow"]
        }
}

And the result in an updated version of Basic UI:

J-N-K

LGTM

lolodomo · 2023-04-14T17:05:54Z

@mherwege : do you think it requires a change in the sitemap generator of MainUI?

mherwege · 2023-04-14T17:08:34Z

@lolodomo Yes, it does. It generates it with quotes around the icon name.
The challenge with all of this is that it requires special treatment without quotes. The json in the rest messages always has quotes.
I will look into this, working on some other validation improvements there also.

J-N-K · 2023-04-14T17:22:09Z

@mherwege Do we need to revert this for M2?

lolodomo · 2023-04-14T17:56:15Z

The quotes are still an available option in sitemap.
It is for item definition that I removed this option.
So if the sitemap generator uses quotes for the icon, that is fine and there is probably nothing to change.

mherwege · 2023-04-15T05:39:41Z

@lolodomo It is OK when writing out the code for the sitemap. But I tested your example sitemap above. The variant without quotes now makes the sitemap code interpretation fail. The parser needs to be in sync with the xtext parser. I will see what I can do.
There may also be an issue when importing items from items files with the new syntax now.
@J-N-K I don't think we need to revert, as there is an easy workaround: Remove the quotes from the textual definition when importing items/writing sitemap code in the UI. We can fix it for the next milestone.

J-N-K · 2023-04-15T05:48:54Z

Next milestone is scheduled for sunday, that‘s why I‘m asking.

mherwege · 2023-04-15T06:18:59Z

@lolodomo @J-N-K I created openhab/openhab-webui#1843 that includes fixes for this, tested with the examples provided.

openhab-bot · 2023-04-19T18:23:23Z

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

https://community.openhab.org/t/openhab4-m1-earlybird/145193/25

- Adapt sitemap and item lexers to changes in icon name syntax - Restrict the elements that can be added to a sitemap - Added extra sitemap validations (in line with xtext validation in core) - Added test for sitemap parser and validation This solves the issue in main UI created by openhab/openhab-core#3539 and openhab/openhab-core#3378. Signed-off-by: Mark Herwege <[email protected]>

lolodomo requested a review from a team as a code owner February 17, 2023 00:38

lolodomo force-pushed the sitemap_model_icon branch from 1eec2ae to 389a76a Compare February 25, 2023 13:12

lolodomo force-pushed the sitemap_model_icon branch 3 times, most recently from 0115ca0 to 7134bd5 Compare February 26, 2023 19:31

lolodomo mentioned this pull request Mar 25, 2023

Adding "category" property to things #3467

Open

lolodomo force-pushed the sitemap_model_icon branch from 7134bd5 to f3c60dc Compare April 11, 2023 11:08

lolodomo changed the title ~~[WIP] Update sitemap syntax for icon~~ Extend sitemap syntax for icon Apr 11, 2023

lolodomo force-pushed the sitemap_model_icon branch from f3c60dc to 527ad75 Compare April 11, 2023 11:18

clinique approved these changes Apr 11, 2023

View reviewed changes

lolodomo mentioned this pull request Apr 11, 2023

Item - Category field #3052

Closed

lolodomo force-pushed the sitemap_model_icon branch from 527ad75 to aebe73d Compare April 11, 2023 18:04

J-N-K added the enhancement An enhancement or new feature of the Core label Apr 12, 2023

J-N-K added this to the 4.0 milestone Apr 12, 2023

J-N-K approved these changes Apr 12, 2023

View reviewed changes

J-N-K merged commit fa37a46 into openhab:main Apr 12, 2023

lolodomo deleted the sitemap_model_icon branch April 12, 2023 15:47

lolodomo mentioned this pull request Apr 14, 2023

Extend item syntax for category/icon #3539

Merged

mherwege mentioned this pull request Apr 15, 2023

Sitemap and item config parsing adjustments openhab/openhab-webui#1843

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend sitemap syntax for icon #3378

Extend sitemap syntax for icon #3378

lolodomo commented Feb 17, 2023 •

edited

Loading

lolodomo commented Feb 24, 2023 •

edited

Loading

mherwege commented Feb 24, 2023 •

edited

Loading

lolodomo commented Feb 24, 2023

lolodomo commented Feb 25, 2023 •

edited

Loading

mhilbush commented Feb 25, 2023

lolodomo commented Feb 25, 2023 •

edited

Loading

mhilbush commented Feb 25, 2023

lolodomo commented Feb 25, 2023

mherwege commented Feb 25, 2023

lolodomo commented Feb 25, 2023

lolodomo commented Apr 11, 2023

lolodomo commented Apr 11, 2023

clinique left a comment

lolodomo commented Apr 11, 2023

lolodomo commented Apr 11, 2023

J-N-K left a comment

lolodomo commented Apr 14, 2023

mherwege commented Apr 14, 2023 •

edited

Loading

J-N-K commented Apr 14, 2023

lolodomo commented Apr 14, 2023 •

edited

Loading

mherwege commented Apr 15, 2023 •

edited

Loading

J-N-K commented Apr 15, 2023

mherwege commented Apr 15, 2023

openhab-bot commented Apr 19, 2023

Extend sitemap syntax for icon #3378

Extend sitemap syntax for icon #3378

Conversation

lolodomo commented Feb 17, 2023 • edited Loading

lolodomo commented Feb 24, 2023 • edited Loading

mherwege commented Feb 24, 2023 • edited Loading

lolodomo commented Feb 24, 2023

lolodomo commented Feb 25, 2023 • edited Loading

mhilbush commented Feb 25, 2023

lolodomo commented Feb 25, 2023 • edited Loading

mhilbush commented Feb 25, 2023

lolodomo commented Feb 25, 2023

mherwege commented Feb 25, 2023

lolodomo commented Feb 25, 2023

lolodomo commented Apr 11, 2023

lolodomo commented Apr 11, 2023

clinique left a comment

Choose a reason for hiding this comment

lolodomo commented Apr 11, 2023

lolodomo commented Apr 11, 2023

J-N-K left a comment

Choose a reason for hiding this comment

lolodomo commented Apr 14, 2023

mherwege commented Apr 14, 2023 • edited Loading

J-N-K commented Apr 14, 2023

lolodomo commented Apr 14, 2023 • edited Loading

mherwege commented Apr 15, 2023 • edited Loading

J-N-K commented Apr 15, 2023

mherwege commented Apr 15, 2023

openhab-bot commented Apr 19, 2023

lolodomo commented Feb 17, 2023 •

edited

Loading

lolodomo commented Feb 24, 2023 •

edited

Loading

mherwege commented Feb 24, 2023 •

edited

Loading

lolodomo commented Feb 25, 2023 •

edited

Loading

lolodomo commented Feb 25, 2023 •

edited

Loading

mherwege commented Apr 14, 2023 •

edited

Loading

lolodomo commented Apr 14, 2023 •

edited

Loading

mherwege commented Apr 15, 2023 •

edited

Loading