Description

Returns detailed information of a specific service location:

General information
Appliances
Actuators (Smappee Switch / Comfort plug)
Sensors (Gas & Water monitor)
Metering configuration (Smappee Genius and Connect-serie)
- this information is different from what is returned by the Get Servicelocation Info call. The information returned here is in line with the new style of configuration that was introduced for the 2nd generation of smappee devices - Smappee Infinity.

Every channel of every measurement that is returned has 2 indices. One that you will use to read data from the channel in a consumption call (i.e. "consumptionIndex"). The other index is used when you read consumption data from the MQTT power topic.

Resource URL

https://app1pub.smappee.net/dev/v3/servicelocation/[SERVICELOCATIONID]/meteringconfiguration

HTTP method

GET

HTTP header

Authorization: Bearer [ACCESS_TOKEN]

[ACCESS_TOKEN] being the access token received from the Get token or Refresh token authentication calls.

Parameters

Parameter	Type	Description
SERVICELOCATIONID	Path Parameter	The actual id of an accessible service location (see Get Servicelocations)

Example

https://app1pub.smappee.net/dev/v3/servicelocation/123/meteringconfiguration

Result

{
  "serviceLocationId": 123,
  "serviceLocationUuid": "6eefadeb-5c08-47cd-87b6-9897acb9fb8f",
  "name": "My Place",
  "timezone": "Europe/Brussels",
  "lon": 0.0,
  "lat": 0.0,
  "electricityCost": 0.0,
  "electricityCurrency": "EUR",
  "appliances": [
    {
      "id": 1,
      "name": "Coffeemaker",
      "type": "cooking"
    },
    {
      "id": 2,
      "name": "Refrigerator",
      "type": "refridgeration"
    }
  ],
  "actuators": [
    {
      "id": 1,
      "name": "TV plug"
    },
    {
      "id": 2,
      "name": "Office plug"
    }
  ],
  "sensors": [
    {
      "id": 2,
      "name": "3003000078",
      "channels": [
        {
          "name": "Garage",
          "ppu": 100.0,
          "uom": "m3",
          "enabled": false,
          "type": "gas",
          "channel": 1
        },
        {
          "name": "Outdoor",
          "ppu": 100.0,
          "uom": "m3",
          "enabled": false,
          "type": "water",
          "channel": 2
        }
      ]
    }
  ],
  "channelsConfiguration": {
    for backwards compatibility only, please use measurements below
  },
  "measurements": [
    {
      "id": 1,
      "name": "Grid",
      "type": "GRID",
      "channels": [
        {
          "consumptionIndex": 1,
          "powerTopicIndex": 1,
          "name": "Grid",
          "phase": "PHASEA"
        },
        {
          "consumptionIndex": 2,
          "powerTopicIndex": 2,
          "name": "Grid",
          "phase": "PHASEB"
        },
        {
          "consumptionIndex": 3,
          "powerTopicIndex": 3,
          "name": "Grid",
          "phase": "PHASEC"
        }
      ]
    },
    {
      "id": 2,
      "name": "Car Charger",
      "type": "SUBCIRCUIT",
      "channels": [
        {
          "consumptionIndex": 4,
          "powerTopicIndex": 4,
          "name": "Car charger",
          "phase": "PHASEB"
        }
      ]
    }
  ]
}

Versioning

Version 1 (v1)

Not supported

Version 2 (v2)

Not supported

Version 3 (v3)

Introduced.

The "consumptionIndex" in the channels sections of a measurement needs to be used in the Get electricity consumption call to match measurements to their electricity consumption. The "powerTopicIndex" are the indices that needs to be used when matching measurements to the realtime or power MQTT topics.

Content

Smappee API

Get metering configuration