unitHint error in xml schema?

jsjames · June 4, 2024, 6:32pm

I am trying to add a unitHint to an item-type definition in my thing.xml.

<channel-type id="saltOutput">
	<item-type unitHint="%">Number:Dimensionless</item-type>
	<label>Salt Output (%)</label>
	<description>Current salt output setting for the chlorinator (%).</description>
	<state readOnly="true"/>
</channel-type>

However, I get the following error in Eclipse (and similar error when I run mvn externally):

cvc-type.3.1.1: Element 'item-type' is a simple type, so it cannot have attributes, excepting those whose namespace name is identical to 'http://www.w3.org/2001/XMLSchema-instance' and whose [local name] is one of 'type', 'nil', 'schemaLocation' or 'noNamespaceSchemaLocation'. However, the attribute, 'unitHint' was found.

I have pulled the latest changes from openhab-addons. Any suggestions?

Lolodomo · June 5, 2024, 6:16am

Error is normal, you can’t do that. The unit can be defined at item level, not at channel (type) level.

Lolodomo · June 5, 2024, 6:21am

Sorry, it was recently added and I have no experience with this new feature.

github.com/openhab/openhab-core

Unit hint in thing channels

openhab:main ← mherwege:unit-hint

opened 09:47PM - 04 Feb 24 UTC

mherwege

+84 -21

Resolves https://github.com/openhab/openhab-core/issues/3854 To help the user… in configuring the right unit when creating items from thing channels, one of the suggestions was to use a unitHint that could be provided by the binding developer. This PR implements the core part of this: - Add a `unit-hint` field to the channel type. - Expose this `unit-hint` field in the REST API. The second part of this will have to be extending mainUI to use the `unit-hint` as proposed unit in configuration when available. This can be especially useful for channels that provide % values, where QuantityType:Dimensionless has a default of Units.ONE. Note that an alternative solution with changing the default unit for QuantityType:Dimensionless has not gained support (https://github.com/openhab/openhab-core/issues/4077 and https://github.com/openhab/openhab-core/pull/4078). This PR does help for users creating new items from channels in mainUI. It will not help for users using textual configuration. For dimensions with different units in SI or US measurement systems, it is possible to provide 2 unit hints in one string separated by comma. The first one will be SI, the second US. The suggested one in the UI will depend on the measurement system setting. This PR extends the `thing-description-1.0.0.xsd` and adds a new attribute to the input-type. Further investigation is required, as this may make it impossible to run bindings that have this field added on an older core (parsing the xml may fail). This is very similar to the situation described in https://github.com/openhab/openhab-core/issues/4062 for a change in `addon.xml`. To limit issues with newer bindings on older cores (going forward from 4.2), this may have to be solved in parallel.

Mherwege · June 5, 2024, 7:51am

Your syntax looks correct. I am pretty sure Eclipse is validating against an old version fo the schema in your installation. I don’t have the problem and I am using Eclipse as well. You may have to do an mvn clean install on the whole addons folder or use the -U flag to force downloading all dependencies again to get the latest version. If you just do it on the folder of the new addon, it may not pick it up.

jsjames · June 9, 2024, 9:46pm

If others have this issue, I was able to resolve by deleting the cached entry in this directory ~/.lemminx/cache/https/openhab.org/schemas