You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »



The Lobaro wMbus Parser is used from device Parsers and available as web API at https://platform.lobaro.com/#/wmbus/parser


Response JSON

The following is an example of the parsing result of an encrypted example telegram from the OMS specification:


{
  "Raw": "0x2e4493157856341233037a2a0020055923c95aaa26d1b2e7493b013ec4a6f6d3529b520edff0ea6defc99d6d69ebf3",
  "RawWithCrc": "0x2e44931578563412330333637a2a0020055923c95aaa26d1b2e7493b2a8b013ec4a6f6d3529b520edff0ea6defc955b29d6d69ebf3ec8a",
  "FrameFormat": "A",
  "Length": 46,
  "CField": "0x44",
  "CFieldString": "0x44 (SND_NR)",
  "MField": "0x9315",
  "MFieldCodeString": "ELS",
  "MFieldLongString": "Elster GmbH, Germany, Europe",
  "Id": 305419896,
  "IdString": "12345678",
  "Version": 51,
  "Device": "0x03",
  "DeviceString": "Gas",
  "CiField": "0x7a",
  "HeaderKnown": true,
  "PayloadKnown": true,
  "Header": {
    "Serial": 0,
    "IdString": "",
    "ManufacturerCode": 0,
    "MFieldCodeString": "",
    "MFieldLongString": "",
    "Version": 0,
    "DeviceType": 0,
    "DeviceString": "",
    "EncryptionMode": 5,
    "EncryptionModeString": "AES with CBC",
    "EncryptedBlocks": 2,
    "HopCount": 0,
    "IsAccessible": true,
    "IsBidirectionalMode": false,
    "IsSynchronous": false,
    "ReservedBit": false,
    "TelegramType": 0,
    "AccessNumber": 42,
    "StatusByte": 0,
    "ConfigField": [
      32,
      5
    ]
  },
  "Body": {
    "Raw": "0x2f2f0c1427048502046d32371f1502fd1700002f2f2f2f2f2f2f2f2f2f2f2f2f",
    "DataRecords": [
      {
        "DifDataLength": 4,
        "DifFunctionString": "Current Value",
        "DifDataFormat": "BCD (8 digits)",
        "VifUnit": "m^3",
        "VifQuantity": "Volume",
        "VifExponent": 0.01,
        "VifEDescription": "",
        "Value": 2850427,
        "ValueScaled": 28504.27,
        "ValueString": "28504.27",
        "Tariff": 0,
        "StorageNo": 0,
        "DifVif": "0x0c14",
        "Data": "0x27048502",
        "Dif": {
          "Value": 12,
          "DifE": []
        },
        "Vif": {
          "IsPresent": true,
          "Value": 20,
          "VifE": []
        }
      },
      {
        "DifDataLength": 4,
        "DifFunctionString": "Current Value",
        "DifDataFormat": "signed binary (32 bits), or date/time in F format",
        "VifUnit": "",
        "VifQuantity": "Time & Date",
        "VifExponent": 1,
        "VifEDescription": "",
        "Value": 354367282,
        "ValueScaled": 354367282,
        "ValueString": "2008-05-31T23:50:00Z",
        "Tariff": 0,
        "StorageNo": 0,
        "DifVif": "0x046d",
        "Data": "0x32371f15",
        "Dif": {
          "Value": 4,
          "DifE": []
        },
        "Vif": {
          "IsPresent": true,
          "Value": 109,
          "VifE": []
        }
      },
      {
        "DifDataLength": 2,
        "DifFunctionString": "Current Value",
        "DifDataFormat": "signed binary (16 bits), or date in G format",
        "VifUnit": "",
        "VifQuantity": "Error flags",
        "VifExponent": 1,
        "VifEDescription": "",
        "Value": 0,
        "ValueScaled": 0,
        "ValueString": "0",
        "Tariff": 0,
        "StorageNo": 0,
        "DifVif": "0x02fd17",
        "Data": "0x0000",
        "Dif": {
          "Value": 2,
          "DifE": []
        },
        "Vif": {
          "IsPresent": true,
          "Value": 253,
          "VifE": [
            23
          ]
        }
      }
    ],
    "PayloadKnown": true,
    "IsEncrypted": false,
    "DecryptionFailed": false,
    "BlockCiField": 0
  },
  "AField": {
    "Id": 305419896,
    "Version": 51,
    "Device": 3
  },
  "Ell": null,
  "Afl": null,
  "BodyParseError": "",
  "CrcValid": true,
  "HasCrc": true,
  "SourceType": "",
  "IsCompactFrame": false,
  "FormatSignature": 61330,
  "FormatFrame": "DBQEbQL9Fw=="
}




Domain Model Mapping Extention


When Using wMbus/OMS Telegrams there is a Problem: The Telegrams are self describing in a way that they describe values as "this is a Volume in m³" "this is a Date with Time" but they dont include the information about the businesses meaning if the value.

For example in the following "heat cost" device we got several H.C.A Values and 3 Date informations:

When we want to create a heating bill for tenants we need to know the meaning because we want to use a Due Date and the Value for that due Date or we want to use the actual H.C.A Value with the it is from.
The problem here is: The order and meaning of these Values differ widely. Sometimes the actual Value is the first one, sometimes the last one, Sometimes Due Date values of the last 12 months are presented in  descending order sometimes in ascending order. Sometimes the date information regarding due dates are grouped next to the duedate values some times values and date information are kept in 2 blocks. So we want to archive a a way to configure the logical meaning for different devices so we can produce a general usable format containing the meter data usable by billing software.


Mapping Configuration

Configures how telegrams are mapped to the Domain Model.

Example Configuration for Kampstrup MC603, a Diehl Heat Meters and a Engelman Water Meter

{
	"mappings":[	
	{
		"comment":"Kampstrup MC603",
		"filter":{
			"formatSignature":"7869",
			"manafacture":"KAM",
			"type":"04",
			"version":53
		},
		"heat":{
			"currentValueIdx":0,
			"flowTemperatureIdx": 5,
			"returnTemperatureIdx": 6,
			"volumeIdx": 3
		}
	},
	{
		"comment":"Diehl Heat Meter",
		"filter":{
			"formatSignature":"9290",
			"manafacture":"DME",
			"type":"04",
			"version":65
		},
		"heat":{
			"currentValueIdx":0,
			"dueDateValueIdx":7,
			"dueDateDateIdx":8			
		}
	},
	{
		"comment":"Engelmann Water Meter",
		"filter":{
			"formatSignature":"052D",
			"manafacture":"EFE",
			"type":"07",
			"version":0
		},
		"water":{
			"currentValueIdx":19,
			"currentDateIdx":18,
			"dueDateValueIdx":1,
			"dueDateDateIdx":0
		}
	}
  ]
}

The Mapping contains 3 Parts:

  • A comment so humans can identify the mappings.
  • A filter part to select telegrams that the mapping shall be applied to. The mapping is applied if all filters match true.
  • A object "heat" or "water" defining which values of the telegram shall be mapped in to which Field of a Domain Model output.


API Endpoint

curl Example: (With mapping from: domainMappings.json File)

Method: POST

Path: /api/meterData

URL Params:

raw: Raw OMS/WMBUS Telegram in Hex: raw=44442d2c0198508035048d20aac070c420dd3d967a564c53dfe4dedfbc45e8d41912db6c0973921bef3c2d5dc8d3b6fe01cc272258cd728f825a2d2e76b256fd722680

MeterKey: WMBUS Mode 5/7 key for decryption as Hex String: key=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

Body: Type: application/json with a Mapping Configuration as described on this Page.

Answers: With Domain Data described under "Metering Domain Model" on this Page.

Authorization: Header ("Authorization") with Bearer Token from the Platform: https://platform.lobaro.com/#/organisation/integrations/rest/

Curl Example:

curl -X 'POST' \  'localhost:8082/api/meterData?raw=44442d2c0198508035048d20aac070c420dd3d967a564c53dfe4dedfbc45e8d41912db6c0973921bef3c2d5dc8d3b6fe01cc272258cd728f825a2d2e76b256fd722680&key=7ADA08C8C89C7D21EAEE6F662BF0A6ED' \
-H 'accept: \ application/json' -H 'Authorization: Bearer eyJh[...]' -H "Content-Type: application/json" -d @domainMappings.json 


Metering Domain Model

Example output of a Kampstrup MC603 with the example Configuration from Mapping Configuration

{
  "id": "KAM80509801532022-01-24T14:55:50+01:00",
  "type": "HeatMeterReading",
  "meterId": "80509801",
  "linkLayerId": "80509801",
  "meterType": 4,
  "manufacturer": "KAM",
  "manufacturerLinkLayer": "KAM",
  "version": 53,
  "versionLinkLayer": 0,
  "currentValue": {
    "date": "2022-01-24T14:55:50.171063+01:00",
    "value": 0,
    "unit": "Wh"
  },
  "flowTemperature": {
    "date": "2022-01-24T14:55:50.171063+01:00",
    "value": 24.08,
    "unit": "°C"
  },
  "returnTemperature": {
    "date": "2022-01-24T14:55:50.171063+01:00",
    "value": 23.96,
    "unit": "°C"
  },
  "volume": {
    "date": "2022-01-24T14:55:50.171063+01:00",
    "value": 0,
    "unit": "m^3"
  }
}





  • No labels