Abfrage von am CLS Modul angebunden Geräte

Zielsetzung und Anwendungsbereich

Ziel dieses Dokuments ist es, den Leser in die Position zu versetzen die angeschlossenen Zähler eines CLS Moduls abzufragen.

Abfrage der aktuell sichtbaren Zählen

Das CLS Modul führt eine Liste der aktuell sichtbaren Zähler, welche remote abgerufen werden kann. Diese Liste wird für die Zähler und Erweiterungsmodoule der folgenden Typen geführt:

  • M-Bus Draht (Parameter "type" ist mbus)
  • Wireless M-Bus (Parameter "type" ist oms)
  • One-Wire (Parameter "type" ist 1w)
  • Modbus (Parameter "type" ist modbus)
  • LoRaWAN (Parameter "type" ist lora)

Um die angeschlossenen Geräte abzurufen muss ein Plugin Command an das CLS Modul gesendet werden. Dieses kann über das CLS Center geschehen. Die URL lautet wie folgt und muss per HTTP POST angesprochen werden:

https://KUNDE.aktiver-emt.de/clscenter/gateways/sendcommand/tomac?mac=mac&pluginname=system&plugincall=hwConnected&params={"type":type}&api_key=special_key

Die Parameter der URL müssen entsprechend ersetzt werden. Die Kundeninstanz muss korrekt über den Platzhalter KUNDE angegeben werden, die MAC des CLS Moduls muss im Parameter mac festgehalten sein. Den passenden Typ für das Feld type entnehmen Sie bitte der oben stehenden Liste.

Abfrage der angeschlossenen Zähler

Da alle Anfragen gegenüber dem CLS Modul asynchron sind, muss die Antwort auf die Abfrage vom Inventory Modul der CLS Center Kundeninstanz abgerufen werden. Bitte beachten Sie, dass auch diese Anfrage per OAUTH authentifiziert werden muss.

Um alle Daten, welche zu dem CLS Modul gehören abzufragen verwenden Sie die folgende URL per HTTP GET:

https://KUNDE.aktiver-emt.de/inventory/cls/mac

Bitte ersetzen Sie die entsprechenden Parameter passend ihrer Konfiguration und Instanz.

Die Rückmeldung beinhaltet alle Daten, welche aktuell für das CLS Modul vorliegen. Das nächste Listing enthält nur die relevanten Teile der Antwort:

{
  "replyCode": 200,
  "replyText": "data",
  "data": {
      "type":         "CLS",
      "ownerNo":      "...........",
      "macAddress":   "...........",
      "manufacturer": "...........",
      "visibleMeters": [
          {
               "ownerNumber":    "1640221192261704",
               "type":           "Meter",
               "connectionType": "mbus"
          }
      ]
  }
}

In diesem Fall ist ein M-Bus Zähler mit der Sekundäradresse 1640221192261704 angeschlossen.

Abfrage der angeschlossenen Relaismodule

Die angeschlossenen Relaismodule und andere Erweiterungen können über die oben geannte Abfrage remote vom CLS Modul abgefragt werden. Dazu muss der Parameter type auf modbus gesetzt werden.

Über das Inventory können die Daten abgefragt werden, die relevanten Teile der Antwort sind hier dargestellt:

{
  "replyCode": 200,
  "replyText": "data",
  "data": {
      "type":         "CLS",
      "ownerNo":      "...........",
      "macAddress":   "...........",
      "manufacturer": "...........",
      "deviceIds":    [ "10000016" ]
  }
}

In diesem Beispiel ist ein Relais-Modul mit der Unique ID 10000016 am CLS Modul angeschlossen.