[miele] Clean up properties and improve reliability and performance

[jlaur]

Fixes #11422

Signed-off-by: Jacob Laursen jacob-github@vindvejr.dk

Reliability

#11244 introduced a dependency to the protocol property for correctly handling both ZigBee and Wi-Fi appliances. This had two drawbacks:

• The protocol property is a technical protocol prefix ("hdm:ZigBee:" or "hdm:LAN:"). [miele] Fix multicast and multi-protocol support (ZigBee/Wi-Fi) #11244 did not change this, but it would make more sense to expose a user-oriented protocol name like "ZigBee" or "Wi-Fi". This is not possible with current technical dependency.
• In rare scenarios properties are not correctly set. This breaks channel updates as correct API calls cannot be made without protocol prefix. I'm not sure exactly when this happens, but it could be timing related if properties are not initialized before receiving state updates.

Similarly a dependency to the serialNumber property was introduced for correct handling multicast updates.

To fix both problems, two internal appliance caches are now used for fast lookup of UID from appliance id (i.e. "0123456789#0" -> "hdm:ZigBee:0123456789#0") as well as from remote UID/serial number. After removing this property dependency, the protocol property has been renamed to protocolAdapter which now contains only the actual protocol adapter name, i.e. ZigBee or LAN. Additionally, a new property, connectionType, has been introduced. For Wi-Fi devices protocolAdapter is LAN and connectionType is WiFi.

Performance

Appliance cache has been changed from List to HashMap for faster lookups, and is also being used more actively now for looking up UID's.

Property cleanup

Properties removed:

• brandId always containing value MI.
• companyId always containing value MI.

Properties renamed:

• dc renamed to deviceClass. Now also set for things configured in files, where previously only auto-discovered things had this property set.
• protocol renamed to protocolAdapter as this is more correct.

Properties added:

• model containing the appliance model.
• connectionType (not available for ZigBee appliances).

Before:

After:

Refactoring

Refer to "gateway" instead of "ZigBee network" in configuration, since both ZigBee and LAN/Wi-Fi appliances are supported by the gateway.

Added constants for remaining handlers with hardcoded device classes.

Changed obscure string operations for skipping this result of the getDeviceClassObjects response:
"DeviceClass": "com.prosyst.mbs.services.zigbee.hdm.deviceclasses.ReportingControl"

while processing only this result:
"DeviceClass": "com.miele.xgw3000.gateway.hdm.deviceclasses.MieleWashingMachine"
(or other device class name for appliance)

Fixed all warnings:

• Potential null pointer access
• Redundant null check
• Import never used

Fixed some Static Code Analysis issues:

• The package org.apache.commons.lang3.StringUtils should not be used.
• 'static' modifier out of order with the JLS suggestions.
• First javadoc author should have "Initial contribution" contribution description.

Translation

Added default i18n properties file and partial Danish translation as baseline. Next steps will be adding custom strings for states, programs and phases so these can be provided in desired language. This is not planned within the context of this PR.

[jlaur]

JAR: https://drive.google.com/file/d/1Azw9vo2I4tSDnuFZhlP7e1qlC_WZWs2C/view?usp=sharing

[jlaur]

@kgoderis, @kaikreuzer - would it be possible for you to review this PR? It would be nice if it could be included in next milestone as it fixes an issue with dependency to protocol and seriaNumber properties which really would be nice to solve sooner than later.

[kaikreuzer]

Many thanks @jlaur for this nice refactoring and for cleaning up so many places in the code along the way!
Looks all good to me, so let's merge!