openHAB 4.2 Milestone discussion

seimenb · July 6, 2024, 1:50pm

Hi berni

From 4.2.0 M3 on the Shelly binding thinks the shelly 2.5 (and all other Gen1 devices) is a Gen2 device, what is not true.

2024-07-06 14:50:16.278 [DEBUG] [y.internal.handler.ShellyBaseHandler] - shelly25-relay-98f4acf2a04c: Start initializing for thing Wohnzimmer - Lampe, type shelly25-relay, IP address 192.168.5.221, Gen2: true, CoIoT: true

The problem is with Gen 1 devices that are defined in a .things file. If the devices are UI defined, everything works. See as allready mentioned here:

berni · July 6, 2024, 2:44pm

Thanks @seimenb
I see a lot of other people also have the problem with the file configuration and Shelly Gen 1 devices, so I’m not the only one. Right now I have no plans to move any things to UI config, as I have everything under GIT version control.
I hope this will be fixed, otherwise it’s gonna be a bad surprise for the shelly people using .things file configs when they update to 4.2.
Just downgraded to 4.2.0M2, as this version works.

J-N-K · July 6, 2024, 3:06pm

I have no real knowledge about the shelly binding and don’t own shelly devices, so I can’t try myself. Can you please show a thing configuration for

a shelly gen 1 thing
a shelly gen 2 thing

that worked in M2, but not in RC1?

seimenb · July 6, 2024, 4:08pm

I think the problem started with this PR

where anithing gets mixed up with if a device isGen2 or not.

J-N-K · July 6, 2024, 4:15pm

Can you try adding deviceGeneration=1 to the thing configuration?

Lolodomo · July 6, 2024, 4:38pm

A git issue was created 3 days ago.

Lolodomo · July 6, 2024, 4:49pm

I believe this property was not properly implemented, it is set only by discovery stuff and by the thing handler supporting Bluetooth devices. So it will be unset for other kind of devices.

@J-N-K : your workaround should clearly help, at least for Gen1 devices. Similar workaround is probably required for Gen2 devices.

berni · July 6, 2024, 5:02pm

I’ve deleted the thing out of my configuration and then added this:

Thing shelly:shelly25-relay:1234567890abc "Wohnzimmer - Lampe" @ "Wohnzimmer" [deviceIp="1.2.3.4", deviceGeneration=1]

No success tho, same error.

I only own Gen 1 devices it seems, I have no shelly devices that work, so I can’t share a shelly gen 2 thing configuration.

J-N-K · July 6, 2024, 5:02pm

But there must be other issues, because in the log posted above (for a shelly25) the device is identified as generation 2, but the websocket connection fails.

IMO Someone who has these issues should do the following:

show the textual config that worked before
disable the textual config and add the device from discovery, the show the corresponding YAML

Edit: @berni shelly25-relay is a generation 1 device? I would have guessed it’s generation 2.

berni · July 6, 2024, 5:07pm

Shelly 2.5 is Gen1, You can check it here: https://shelly-api-docs.shelly.cloud/
No need to guess

Lolodomo · July 6, 2024, 5:09pm

Binding code seems to expect a string. So maybe try deviceGeneration=“1”

github.com

openhab/openhab-addons/blob/2610ba5ca6a5b2099556033f37b84ba69e886bb9/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyBaseHandler.java#L157


      
          this.thingTable = thingTable;
          this.thingName = getString(thing.getLabel());
          this.messages = translationProvider;
          this.cache = new ShellyChannelCache(this);
          this.channelDefinitions = new ShellyChannelDefinitions(messages);
          this.bindingConfig = bindingConfig;
          this.config = getConfigAs(ShellyThingConfiguration.class);
          this.httpClient = httpClient;
          
          Map<String, String> properties = thing.getProperties();
          String gen = getString(properties.get(PROPERTY_DEV_GEN));
          String thingType = getThingType();
          gen2 = !"1".equals(gen) || ShellyDeviceProfile.isGeneration2(thingType);
          blu = ShellyDeviceProfile.isBluSeries(thingType);
          this.api = !blu ? !gen2 ? new Shelly1HttpApi(thingName, this) : new Shelly2ApiRpc(thingName, thingTable, this)
                  : new ShellyBluApi(thingName, thingTable, this);
          if (gen2) {
              config.eventsCoIoT = false;
          }
          if (config.eventsCoIoT) {
              this.coap = new Shelly1CoapHandler(this, coapServer);

seimenb · July 6, 2024, 5:10pm

textual config of an Shelly 2.5 (Gen1 device)

Thing shelly:shelly25-relay:pool "Shelly Switch 2.5 Pool" [deviceIp="1.2.3.4", userId="xy", password="abc", updateInterval=15, eventsCoIoT=false, eventsButton=false, eventsPush=false, eventsSwitch=false]

and the YAML from the discovery of the same device

UID: shelly:shelly25-relay:pool
label: Shelly Switch 2.5 Pool
thingTypeUID: shelly:shelly25-relay
configuration:
  eventsCoIoT: false
  deviceIp: 1.2.3.4
  eventsSwitch: false
  updateInterval: 15
  eventsButton: false
  eventsPush: false
channels:
  - id: device#alarm
    channelTypeUID: shelly:alarmTrigger
    label: Alarm
    description: Alarmauslöser, z.B. schwaches WiFi Signal erkannt oder Überhitzung
    configuration: {}
  - id: device#wifiSignal
    channelTypeUID: system:signal-strength
    label: Signalstärke
    description: Zeigt die aktuelle Signalstärke an. Werte von 0 (Kein Signal) bis 4
      (Ausgezeichnet).
    configuration: {}
  - id: device#deviceName
    channelTypeUID: shelly:deviceName
    label: Gerätename
    description: Symbolischer Name des Gerätes (Konfiguration über Shelly App)
    configuration: {}
  - id: device#internalTemp
    channelTypeUID: system:indoor-temperature
    configuration: {}
  - id: device#accumulatedWatts
    channelTypeUID: shelly:meterAccuWatts
    label: Kumulierter Verbrauch
    description: Kumulierter Verbrauch in Watt (schließt alle Strommesser ein)
    configuration: {}
  - id: device#accumulatedWTotal
    channelTypeUID: shelly:meterAccuTotal
    label: Kumulierter Gesamtverbrauch
    description: Kumulierter Gesamtverbrauch in kWh (schließt alle Strommesser ein)
    configuration: {}
  - id: device#supplyVoltage
    channelTypeUID: shelly:supplyVoltage
    label: Versorgungsspannung
    description: Externe Versorgungsspannung
    configuration: {}
  - id: device#uptime
    channelTypeUID: shelly:uptime
    label: Laufzeit
    description: Anzahl Sekunden seit dem das Gerät mit Strom versorgt wurde
    configuration: {}
  - id: device#updateAvailable
    channelTypeUID: shelly:updateAvailable
    label: Firmwareaktualisierung verfügbar
    description: "EIN: Es ist eine neuere Firmwareversion verfügbar (Update kann mit
      der Shelly App oder im Shelly Manager durchgeführt werden)"
    configuration: {}
  - id: device#heartBeat
    channelTypeUID: shelly:heartBeat
    label: Letzte Aktivität
    description: Zeitpunkt der letzten Aktivität. Hierbei kann es sich um einen
      erfolgreichen API-Aufruf, oder Sensor-Aktualisierung handeln. Dies
      schließt eine erfolgreiche Netzwerk-Kommunikation ein (WiFi + IP).
    configuration: {}
  - id: device#statusLed
    channelTypeUID: shelly:ledStatusDisable
    label: Status-LED aus
    description: LED-Anzeige für Netzwerkstatus deaktivieren
    configuration: {}
  - id: relay1#output
    channelTypeUID: system:power
    label: Betrieb 1
    configuration: {}
  - id: relay1#timerActive
    channelTypeUID: shelly:timerActive
    label: Autom. EIN/AUS Timer aktiv 1
    description: "EIN: Ein Timer ist aktiv, OFF: kein Timer aktiv"
    configuration: {}
  - id: relay1#autoOn
    channelTypeUID: shelly:timerAutoOn
    label: Auto-AN-Timer 1
    description: Wenn der Ausgang abgeschaltet wird, wird er nach n Sekunden
      automatisch wieder eingeschaltet
    configuration: {}
  - id: relay1#autoOff
    channelTypeUID: shelly:timerAutoOff
    label: Auto-AUS Timer 1
    description: Wenn der Ausgang eingeschaltet wird, wird er nach n Sekunden
      automatisch wieder ausgeschaltet
    configuration: {}
  - id: relay2#output
    channelTypeUID: system:power
    label: Betrieb 2
    configuration: {}
  - id: relay2#timerActive
    channelTypeUID: shelly:timerActive
    label: Autom. EIN/AUS Timer aktiv 2
    description: "EIN: Ein Timer ist aktiv, OFF: kein Timer aktiv"
    configuration: {}
  - id: relay2#autoOn
    channelTypeUID: shelly:timerAutoOn
    label: Auto-AN-Timer 2
    description: Wenn der Ausgang abgeschaltet wird, wird er nach n Sekunden
      automatisch wieder eingeschaltet
    configuration: {}
  - id: relay2#autoOff
    channelTypeUID: shelly:timerAutoOff
    label: Auto-AUS Timer 2
    description: Wenn der Ausgang eingeschaltet wird, wird er nach n Sekunden
      automatisch wieder ausgeschaltet
    configuration: {}
  - id: relay1#input
    channelTypeUID: shelly:inputState
    label: Eingang/Taste 1
    description: Aktueller Status des Eingangs/der Taste
    configuration: {}
  - id: relay1#button
    channelTypeUID: system:button
    label: Ereignisauslöser 1
    configuration: {}
  - id: relay2#input
    channelTypeUID: shelly:inputState
    label: Eingang/Taste 2
    description: Aktueller Status des Eingangs/der Taste
    configuration: {}
  - id: relay2#button
    channelTypeUID: system:button
    label: Ereignisauslöser 2
    configuration: {}
  - id: meter1#currentWatts
    channelTypeUID: shelly:meterWatts
    label: Stromverbrauch 1
    description: Aktueller Energieverbrauch in Watt
    configuration: {}
  - id: meter1#totalKWH
    channelTypeUID: shelly:meterTotal
    label: Gesamtverbrauch 1
    description: Gesamtverbrauch in kWh seit das Gerät eingeschaltet wurde (wird
      beim Neustart zurückgesetzt)
    configuration: {}
  - id: meter1#lastPower1
    channelTypeUID: shelly:lastPower1
    label: Schnitt letzte Minute 1
    description: Stromverbrauch der letzten Minute, gerundet
    configuration: {}
  - id: meter1#lastUpdate
    channelTypeUID: shelly:lastUpdate
    label: Letzte Aktualisierung 1
    description: Zeitstempel der letzten Statusaktualisierung
    configuration: {}
  - id: meter2#currentWatts
    channelTypeUID: shelly:meterWatts
    label: Stromverbrauch 2
    description: Aktueller Energieverbrauch in Watt
    configuration: {}
  - id: meter2#totalKWH
    channelTypeUID: shelly:meterTotal
    label: Gesamtverbrauch 2
    description: Gesamtverbrauch in kWh seit das Gerät eingeschaltet wurde (wird
      beim Neustart zurückgesetzt)
    configuration: {}
  - id: meter2#lastPower1
    channelTypeUID: shelly:lastPower1
    label: Schnitt letzte Minute 1
    description: Stromverbrauch der letzten Minute, gerundet
    configuration: {}
  - id: meter2#lastUpdate
    channelTypeUID: shelly:lastUpdate
    label: Letzte Aktualisierung 2
    description: Zeitstempel der letzten Statusaktualisierung
    configuration: {}

And here the textual config from an Shelly Pro 3 (Gen2 device)

Thing shelly:shellypro3:boiler "Shelly Pro 3 Boiler" [deviceIp="1.2.3.4", userId="xy", password="abc", updateInterval=15, eventsCoIoT=false, eventsButton=false, eventsPush=false, eventsSwitch=false]

And the according YAML

UID: shelly:shellypro3:boiler
label: Shelly 3 Boiler
thingTypeUID: shelly:shellypro3
configuration:
  enableBluGateway: false
  deviceIp: 1.2.3.4
  updateInterval: 60
  enableRangeExtender: false
channels:
  - id: device#alarm
    channelTypeUID: shelly:alarmTrigger
    label: Alarm
    description: Alarmauslöser, z.B. schwaches WiFi Signal erkannt oder Überhitzung
    configuration: {}
  - id: device#wifiSignal
    channelTypeUID: system:signal-strength
    label: Signalstärke
    description: Zeigt die aktuelle Signalstärke an. Werte von 0 (Kein Signal) bis 4
      (Ausgezeichnet).
    configuration: {}
  - id: device#deviceName
    channelTypeUID: shelly:deviceName
    label: Gerätename
    description: Symbolischer Name des Gerätes (Konfiguration über Shelly App)
    configuration: {}
  - id: device#internalTemp
    channelTypeUID: system:indoor-temperature
    configuration: {}
  - id: device#accumulatedWatts
    channelTypeUID: shelly:meterAccuWatts
    label: Kumulierter Verbrauch
    description: Kumulierter Verbrauch in Watt (schließt alle Strommesser ein)
    configuration: {}
  - id: device#accumulatedWTotal
    channelTypeUID: shelly:meterAccuTotal
    label: Kumulierter Gesamtverbrauch
    description: Kumulierter Gesamtverbrauch in kWh (schließt alle Strommesser ein)
    configuration: {}
  - id: device#accumulatedReturned
    channelTypeUID: shelly:meterAccuReturned
    label: Kumulierte Einspeisung
    description: Kumulierte Einspeisung in kW/h (schließt alle Strommesser ein)
    configuration: {}
  - id: device#uptime
    channelTypeUID: shelly:uptime
    label: Laufzeit
    description: Anzahl Sekunden seit dem das Gerät mit Strom versorgt wurde
    configuration: {}
  - id: device#updateAvailable
    channelTypeUID: shelly:updateAvailable
    label: Firmwareaktualisierung verfügbar
    description: "EIN: Es ist eine neuere Firmwareversion verfügbar (Update kann mit
      der Shelly App oder im Shelly Manager durchgeführt werden)"
    configuration: {}
  - id: device#heartBeat
    channelTypeUID: shelly:heartBeat
    label: Letzte Aktivität
    description: Zeitpunkt der letzten Aktivität. Hierbei kann es sich um einen
      erfolgreichen API-Aufruf, oder Sensor-Aktualisierung handeln. Dies
      schließt eine erfolgreiche Netzwerk-Kommunikation ein (WiFi + IP).
    configuration: {}
  - id: relay1#output
    channelTypeUID: system:power
    label: Betrieb 1
    configuration: {}
  - id: relay1#timerActive
    channelTypeUID: shelly:timerActive
    label: Autom. EIN/AUS Timer aktiv 1
    description: "EIN: Ein Timer ist aktiv, OFF: kein Timer aktiv"
    configuration: {}
  - id: relay1#autoOn
    channelTypeUID: shelly:timerAutoOn
    label: Auto-AN-Timer 1
    description: Wenn der Ausgang abgeschaltet wird, wird er nach n Sekunden
      automatisch wieder eingeschaltet
    configuration: {}
  - id: relay1#autoOff
    channelTypeUID: shelly:timerAutoOff
    label: Auto-AUS Timer 1
    description: Wenn der Ausgang eingeschaltet wird, wird er nach n Sekunden
      automatisch wieder ausgeschaltet
    configuration: {}
  - id: relay2#output
    channelTypeUID: system:power
    label: Betrieb 2
    configuration: {}
  - id: relay2#timerActive
    channelTypeUID: shelly:timerActive
    label: Autom. EIN/AUS Timer aktiv 2
    description: "EIN: Ein Timer ist aktiv, OFF: kein Timer aktiv"
    configuration: {}
  - id: relay2#autoOn
    channelTypeUID: shelly:timerAutoOn
    label: Auto-AN-Timer 2
    description: Wenn der Ausgang abgeschaltet wird, wird er nach n Sekunden
      automatisch wieder eingeschaltet
    configuration: {}
  - id: relay2#autoOff
    channelTypeUID: shelly:timerAutoOff
    label: Auto-AUS Timer 2
    description: Wenn der Ausgang eingeschaltet wird, wird er nach n Sekunden
      automatisch wieder ausgeschaltet
    configuration: {}
  - id: relay3#output
    channelTypeUID: system:power
    label: Betrieb 3
    configuration: {}
  - id: relay3#timerActive
    channelTypeUID: shelly:timerActive
    label: Autom. EIN/AUS Timer aktiv 3
    description: "EIN: Ein Timer ist aktiv, OFF: kein Timer aktiv"
    configuration: {}
  - id: relay3#autoOn
    channelTypeUID: shelly:timerAutoOn
    label: Auto-AN-Timer 3
    description: Wenn der Ausgang abgeschaltet wird, wird er nach n Sekunden
      automatisch wieder eingeschaltet
    configuration: {}
  - id: relay3#autoOff
    channelTypeUID: shelly:timerAutoOff
    label: Auto-AUS Timer 3
    description: Wenn der Ausgang eingeschaltet wird, wird er nach n Sekunden
      automatisch wieder ausgeschaltet
    configuration: {}
  - id: relay1#input
    channelTypeUID: shelly:inputState
    label: Eingang/Taste 1
    description: Aktueller Status des Eingangs/der Taste
    configuration: {}
  - id: relay1#button
    channelTypeUID: system:button
    label: Ereignisauslöser 1
    configuration: {}
  - id: relay2#input
    channelTypeUID: shelly:inputState
    label: Eingang/Taste 2
    description: Aktueller Status des Eingangs/der Taste
    configuration: {}
  - id: relay2#button
    channelTypeUID: system:button
    label: Ereignisauslöser 2
    configuration: {}
  - id: relay3#input
    channelTypeUID: shelly:inputState
    label: Eingang/Taste 3
    description: Aktueller Status des Eingangs/der Taste
    configuration: {}
  - id: relay3#button
    channelTypeUID: system:button
    label: Ereignisauslöser 3
    configuration: {}

Lolodomo · July 6, 2024, 5:17pm

Generation is also computed by this method:

github.com

openhab/openhab-addons/blob/2610ba5ca6a5b2099556033f37b84ba69e886bb9/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyDeviceProfile.java#L406


      
                  // Extract version from string, e.g. 20210226-091047/v1.10.0-rc2-89-g623b41ec0-master
                  Matcher matcher = version.startsWith("v") ? GEN1_VERSION_PATTERN.matcher(vers)
                          : GEN2_VERSION_PATTERN.matcher(vers);
                  if (matcher.find()) {
                      return matcher.group(0);
                  }
              }
              return "";
          }
          
          public static boolean isGeneration2(String thingType) {
              return thingType.startsWith("shellyplus") || thingType.startsWith("shellypro") || thingType.contains("mini")
                      || (thingType.startsWith("shelly") && thingType.contains("g3")) || isBluSeries(thingType);
          }
          
          public static boolean isBluSeries(String thingType) {
              return thingType.startsWith("shellyblu") && !thingType.startsWith(THING_TYPE_SHELLYBLUGW_STR);
          }
          
          public boolean coiotEnabled() {
              if ((settings.coiot != null) && (settings.coiot.enabled != null)) {

berni · July 6, 2024, 5:19pm

Also doesn’t work, shows the error “COMMUNICATION_ERROR Unerwarteter Fehler - WebSocket error” and now the old error “Unsupported Auth type” again.

Thing shelly:shelly25-relay:1234567890abc "Wohnzimmer - Lampe" @ "Wohnzimmer" [deviceIp="1.2.3.4", deviceGeneration="1"]

J-N-K · July 6, 2024, 5:21pm

!"1".equals(gen) already ends the computation when gen is not set (empty string). But setting deviceGeneration="1" explicitly should work. The code should probably look like this: (!gen.isBlank() && !"1".equals(gen)) || ShellyDeviceProfile....

berni · July 6, 2024, 5:36pm

So it seems to be like I’ve already assumed in one of my first posts. Bug has probably been introduced with PR 16625 (this line change is suspicious), released with Openhab 4.2.0.M3. A check thingType.startsWith("shelly") has been added to method isGeneration2.

This code doesn’t seem right:

    public static boolean isGeneration2(String thingType) {
        return thingType.startsWith("shellyplus") || thingType.startsWith("shellypro") || thingType.contains("mini")
                || isBluSeries(thingType);
                || (thingType.startsWith("shelly") && thingType.contains("g3")) ||

Why would a thing type starting with string shelly be a Gen 2 device? The thing type of Shelly 2.5 (Gen 1) starts with shelly (shelly:shelly25-relay), and it’s not a Gen2.

Lolodomo · July 6, 2024, 5:39pm

There is a AND condition with thing type containing “g3”.

berni · July 6, 2024, 5:40pm

That’s true, you are right.

Lolodomo · July 6, 2024, 5:44pm

@J-N-K I agree with your conclusion but unfortunately @berni told us that setting deviceGeneration does not help. Strange…

J-N-K · July 6, 2024, 5:44pm

Please go to the karaf console and try

update org.openhab.binding.shelly https://download.smarthomej.org/org.openhab.binding.shelly-4.2.0-SNAPSHOT.jar