Forwarding to an AMQP 0-9-1 broker

We can forward messages to an AMQP 0-9-1 broker of choice, for example to a RabbitMQ broker. We can publish to a specific topic or to an exchange with a routing key. We use the persistent delivery mode an app id teleport. The body of all messages is JSON encoded and they contain a content type property with value application/json.

Warning

This integration is about AMQP 0-9-1. AMQP 1.0 is not supported by this integration, since this is a completely different protocol. If you need AMQP 1.0, please have a look at our Azure Service Bus integration.

Tip

• Messages are delivered at least once. You need to deduplicate yourself.
• We can add new properties to any object in the JSON-message without increasing in the version (message type). Therefore make sure that your parser does not reject messages with unknown properties.

Below, examples of the payloads of the following messages can be found:

• Solar power
  • Regular messages
  • Flash messages
• Wind power
• Battery power
  • Regular messages
  • Flash messages
• Meter power

Solar power

Solar assets produce two types of messages: regular messages and flash messages.

Regular messages

An example of the body of a message forwarded from a Teleport device that is connected to a solar asset. The type property of the message is solarPower:3.

{
  "teleportHashId": "8de4y2", // uniquely identifies the teleport device
  "assetIdentifier": "huawei-4100", // globally unique identifier of the asset, when available the brand and serial number of the asset
  "attempt": 0, // 0-indexed delivery attempt
  "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC
  "activePower": 12000.4, // in W, can be null
  "generatedEnergy": 250000.7, // in Wh, can be null
  "activePowerLimit": {
    "percentage": 30.4, // can be null
    "reduction": 13000.9 // in W, can be null. The power reduction allocated to this asset given the active ReduceProductionPower command
  },
  "availableActivePower": 20000.1, // in W, can be null. Always null if no pyranometer or irradiance sensor is installed
  "scheduled": true // false for "extra" measurements (eg. directly after command execution and at Teleport initialisation)
}

Flash messages

Solar assets report flash messages more often than regular messages (typically every second) and contain information that is needed for dispatching algorithms and to forward to the TSO when doing aFRR. Flash messages are active only when the relevant control strategy is activated. An example of a request containing one flash message forwarded from a Teleport device that is connected to a solar asset. The type property of the message is solarPower.flash:1.

{
  "teleportHashId": "8de4y2", // uniquely identifies the teleport device
  "assetIdentifier": "huawei-4100", // globally unique identifier of the asset, when available the brand and serial number of the asset
  "attempt": 0, // 0-indexed delivery attempt
  "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC
  "activePower": 12000.8, // in W, can be null
  "activePowerLimitReduction": 13000.4, // in W, can be null
  "availableActivePower": 20000.7, // in W, can be null. Always null if no pyranometer or irradiance sensor is installed
  "scheduled": true // false for "extra" measurements (eg. directly after command execution and at Teleport initialisation)
}

Wind power

An example of the body of a message forwarded from a Teleport device that is connected to a wind energy converter. The type property of the message is windPower:1.

{
  "teleportHashId": "8de4y2", // uniquely identifies the teleport device
  "assetIdentifier": "enercon-4100", // globally unique identifier of the asset, when available the brand and serial number of the asset
  "attempt": 0, // 0-indexed delivery attempt
  "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC
  "observations": {
    "activePower": 12000.4, // in W, can be null
    "windSpeed": 2.1, // in m/s, can be null
    "availableActivePower": 12000.2, // in W, can be null
    "constrainedAvailableActivePower": {
      "currentWind": 12000.42, // in W, can be null
      "technical": 12000.3, // in W, can be null
      "forceMajeure": 12000.4, // in W, can be null
      "externalSetpoints": 12000.7 // in W, can be null
    },
    "converters": [
      {
        "identifier": "12345", // serial number of the converter
        "activePower": 3.3, // in W, can be null
        "windSpeed": 2.4 // in m/s, can be null
      },
      {
        "identifier": "6789", // serial number of the converter
        "activePower": 9.1, // in W, can be null
        "windSpeed": 2.4 // in m/s, can be null
      }
    ],
    "activePowerLimit": {
      "percentage": 5.7 // can be null
    },
    "scheduled": true // false for "extra" measurements (eg. directly after command execution and at Teleport initialisation)
  }
}

Battery power

Battery assets produce two types of messages: regular messages and flash messages.

Regular messages

An example of a request containing one message forwarded from a Teleport device that is connected to a battery is shown below. The type property of the message is batteryPower:1.

{
  "teleportHashId": "8de4y2", // uniquely identifies the teleport device
  "assetIdentifier": "alfen-123", // globally unique identifier of the asset, when available the brand and serial number of the asset
  "attempt": 0, // 0-indexed delivery attempt. integer
  "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC
  "batteryStatus": "on", // can be "on", "off", "other" or null (see warning and errors in case of 'other')
  "energy": {
    "charged": 1000.2, // in Wh, can be null. Nonnegative
    "discharged": 1000.3 // in Wh, can be null. Nonnegative
  },
  "frequency": 50.2, // in Hz, can be null. Nonnegative
  "activePower": 1000.1, // in W, can be null. Positive means discharging, negative charging.
  "reactivePower": 100.1, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power
  "stateOfCharge": 90.1, // in %, can be null. Nonnegative
  "stateOfHealth": 85.1, // in %, can be null. Nonnegative
  "availableEnergy": 50.1, // in Wh, can be null. Nonnegative
  "ratedEnergy": 1000.1, // in Wh, can be null. Nonnegative
  "availableActivePower": {
    "charge": 300.1, // in W, can be null. Nonnegative
    "discharge": 500.1 // in W, can be null. Nonnegative
  },
  "availableReactivePower": {
    "inject": 300.1, // in var, can be null. Nonnegative
    "absorb": 500.1 // in var, can be null. Nonnegative
  },
  "activePowerSetpoint": {
    "dispatchPower": 100.1, // in W, can be null. Positive means discharging, negative charging.
    "deliverFCR": 100.1, // in W, can be null. Positive means discharging, negative charging.
    "chargeToState": 20.1, // in W, can be null. Positive means discharging, negative charging.
    "aggregate": 220.1 // in W, can be null. Positive means discharging, negative charging.
  },
  "threePhaseConnectionTypeHighVoltage": "delta", // can be "wye" or "delta", can be null
  "acVoltageMediumVoltage": {
    "phase": {
      "l1": 230.4, // in V, can be null. Nonnegative
      "l2": 230.1, // in V, can be null. Nonnegative
      "l3": 230.2 // in V, can be null. Nonnegative
    }, // can be null
    "line": {
      "l1": 230.4, // in V, can be null. Nonnegative
      "l2": 230.1, // in V, can be null. Nonnegative
      "l3": 230.2 // in V, can be null. Nonnegative
    } // can be null
  },
  "acCurrentMediumVoltage": {
    "phase": {
      "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value
      "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value
      "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value
    }, // can be null
    "line": {
      "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value
      "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value
      "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value
    } // can be null
  },
  "auxiliaryPower": {
    "active": -120.3, // in W, can be null. Negative means consuming, positive generating, will be negative or 0
    "reactive": -28.4 // in Var, can be null. Negative means consuming, positive generating, will be negative or 0
  }, // can be null
  "batteryEnergyStorageSystems": [
    {
      "identifier": "alfen-5678", // brand and serial number of the bess or if that's not available, its index
      "cellTemperature": {
        "min": 50.1, // in ºC, can be null, min value of all cells
        "max": 50.1 // in ºC, can be null, max value of all cells
      },
      "roomTemperature": 30.1, // in ºC, can be null
      "stateOfCharge": 50.1, // in %, can be null. Nonnegative
      "availableEnergy": 1000.1, // in Wh, can be null. Nonnegative
      "availableActivePower": {
        "charge": 300.1, // in W, can be null. Nonnegative
        "discharge": 500.1 // in W, can be null. Nonnegative
      },
      "threePhaseConnectionTypeLowVoltage": "wye", // can be "wye" or "delta", can be null
      "acVoltageLowVoltage": {
        "phase": {
          // can be null
          "l1": 230.4, // in V, can be null. Nonnegative
          "l2": 230.1, // in V, can be null. Nonnegative
          "l3": 230.2 // in V, can be null. Nonnegative
        },
        "line": {
          // can be null
          "l1": 230.4, // in V, can be null. Nonnegative
          "l2": 230.1, // in V, can be null. Nonnegative
          "l3": 230.2 // in V, can be null. Nonnegative
        }
      },
      "acCurrentLowVoltage": {
        "phase": {
          // can be null
          "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value
          "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value
          "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value
        },
        "line": {
          // can be null
          "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value
          "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value
          "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value
        }
      },
      "racks": [
        {
          "identifier": "alfen-1", // brand and serial number of the rack or if that's not available, its index
          "dcVoltage": 12.5, // in V, can be null. Nonnegative
          "dcCurrent": 23.5 // in A, can be null. Delivering to the grid is a positive value
        }
        // can be many
      ],
      "warnings": ["ALFEN_SOME_WARNING_1", "ATEPS_SOME_WARNING_2"], // see error codes section
      "errors": ["ALFEN_SOME_ERROR_1"] // see error codes section
    }
    // can be many
  ],
  // The configuration property has the same structure as the operation property of a SetBatteryOperation. Values are actually read out from the battery, not just a copy of what the Teleport has been instructed to do
  "configuration": {
    "dispatchPower": {
      "activePower": 50.1 // In W, Positive means discharging, negative charging.
    }, // can be null
    "deliverFCR": {
      "maxRate": 100.1 // In W, Nonnegative.
    }, // can be null
    "chargeToState": {
      "percentage": 50.1 // In %, Nonnegative.
    } // can be null
  }, // can be null
  "warnings": ["ALFEN_SOME_WARNING_1", "ATEPS_SOME_WARNING_B"], // see error codes section
  "errors": ["ALFEN_SOME_ERROR_1"], // see error codes section
  "scheduleCompleteUntil": "2023-01-01T00:00:00Z", // first gap in the schedule for this assetIdentifier. ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC, can be null
  "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation
}

Flash messages

Batteries report flash messages more often than regular messages (typically every second) and contain information that is needed for dispatching algorithms and to forward to the TSO when doing aFRR/FCR. The type property of the message is batteryPower.flash:1. An example of a request containing one flash message forwarded from a Teleport device that is connected to a battery:

{
  "teleportHashId": "8de4y2", // uniquely identifies the teleport device
  "assetIdentifier": "alfen-123", // globally unique identifier of the asset, when available the brand and serial number of the asset
  "attempt": 0, // 0-indexed delivery attempt. integer
  "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC
  "frequency": 50.1, // in Hz, can be null
  "activePower": 1000.1, // in W, can be null. Positive means discharging, negative charging.
  "availableEnergy": 1000.1, // in Wh, can be null
  "availableActivePower": {
    "charge": 300.1, // in W, can be null
    "discharge": 500.1 // in W, can be null
  },
  "stateOfCharge": 90.1, // in %, can be null.
  "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation
}

Meter power

An example of a request containing one message forwarded from a Teleport device that is connected to a power meter is shown below. The type property of the message is meterPower:1.

{
  "teleportHashId": "8de4y2", // uniquely identifies the teleport device
  "assetIdentifier": "janitza-UMG806-12345", // globally unique identifier of the asset, when available the brand and serial number of the asset
  "attempt": 0, // 0-indexed delivery attempt. integer
  "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC
  "phaseVoltage": {
    "l1": 230.4, // in V, can be null. Nonnegative
    "l2": 230.1, // in V, can be null. Nonnegative
    "l3": 230.2 // in V, can be null. Nonnegative
  },
  "current": {
    "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value
    "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value
    "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value
  },
  "activePower": {
    "l1": 2626.56, // in W, can be null. Delivering to the grid is a positive value
    "l2": 2876.25, // in W, can be null. Delivering to the grid is a positive value
    "l3": 2325.02, // in W, can be null. Delivering to the grid is a positive value
    "sum": 7827.83 // in W, can be null. Delivering to the grid is a positive value
  },
  "reactivePower": {
    "l1": 0.2, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power
    "l2": 0.2, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power
    "l3": 0.2, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power
    "sum": 0.2 // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power
  },
  "frequency": 50.21, // in Hz, can be null. Nonnegative
  "activeEnergyConsumed": {
    "l1": 31235.1, // in Wh, can be null. Nonnegative
    "l2": 31235.1, // in Wh, can be null. Nonnegative
    "l3": 31235.1, // in Wh, can be null. Nonnegative
    "sum": 93702.1 // in Wh, can be null. Nonnegative
  },
  "activeEnergyDelivered": {
    "l1": 31235.2, // in Wh, can be null. Nonnegative
    "l2": 31235.2, // in Wh, can be null. Nonnegative
    "l3": 31235.2, // in Wh, can be null. Nonnegative
    "sum": 93702.2 // in Wh, can be null. Nonnegative
  },
  "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation
}