LogoLogo
  • Introduction
  • General platform architecture
    • Platform properties
    • Architecture introduction
    • Architecture functional layers
    • Architecture Principles
    • Platform components description
    • Message flow examples
    • Logical Authorisation Model
    • Non-functional overview
      • TimeBehavior
      • Internationalization and localization
      • Security
      • Scalability
      • Redundancy
      • Performance
    • Technical Overview
      • Web Services Layer
      • Domain Layer
      • Core Layer
      • Protocol Layer
      • Technology Stack
    • Use cases
    • Throttling
  • General User's Guide
    • Installation Guide
      • Installation
        • Vagrant
        • Manual Setup
      • GitHub configuration
      • Platform Setup
      • Test the Platform
        • Using SoapUi
        • Using the Demo App
    • Configuration
      • Add a device
      • Users
      • Add a new organisation
      • Throttling
    • Web Services
    • Deployment
    • FAQ
  • Open Source Community
    • Start contributing
    • Developers 101
    • Contributing to the code
    • Contributing to documentation
    • Communication and Contact
    • Governance
    • Code of Conduct
    • Foundation
  • Domains
    • Admin
    • Smart lighting
      • Use cases
      • Light Schedules
    • Tariff switching
    • Microgrids
    • Distribution automation
    • SmartMetering
      • Web Services
        • bypass retry
        • priority
        • scheduling
        • AdHocManagement
          • GetAssociationLnObjects
          • GetGetAssociationLnObjectsResponse
          • RetrieveConfigurationObjects
          • GetRetrieveConfigurationObjectsResponse
          • SpecificConfigurationObject
          • SynchronizeTime
          • GetSynchronizeTimeResponse
        • Bundle
          • Bundle
          • GetBundleResponse
        • Configuration
          • GetAdministrativeStatus
          • GetGetAdministrativeStatusResponse
          • GetFirmwareVersion
          • GetGetFirmwareVersionResponse
          • UpdateFirmware
          • GetUpdateFirmwareResponse
          • ReplaceKeys
          • GetReplaceKeysResponse
          • GetKeys
          • SetActivityCalendar
          • GetSetActivityCalendarResponse
          • SetAdministrativeStatus
          • GetSetAdministrativeStatusResponse
          • SetAlarmNotifications
          • GetSetAlarmNotificationsResponse
          • SetConfigurationObject
          • GetSetConfigurationObjectResponse
          • SetKeyOnGMeter
          • GetSetKeyOnGMeterResponse
          • SetPushSetupAlarm
          • GetSetPushSetupAlarmResponse
          • SetPushSetupSms
          • GetSetPushSetupSmsResponse
          • SetSpecialDays
          • GetSetSpecialDaysResponse
          • GetConfigurationObject
          • GetConfigurationObjectResponse
          • ConfigureDefinableLoadProfile
          • GetConfigureDefinableLoadProfileResponse
          • SetMbusUserKeyByChannel
          • GetSetMbusUserKeyByChannelResponse
          • GetMbusEncryptionKeyStatus
          • GetGetMbusEncryptionKeyStatusResponse
          • GetMbusEncryptionKeyStatusByChannel
          • GetGetMbusEncryptionKeyStatusByChannelResponse
          • ScanMbusChannels
          • ScanMbusChannelsResponse
        • Installation
          • AddDevice
          • GetAddDeviceResponse
          • CoupleMbusDevice
          • GetCoupleMbusDeviceResponse
          • DeCoupleMbusDevice
          • GetDeCoupleMbusDeviceResponse
        • Management
          • FindEvents
          • GetFindEventsResponse
          • GetDevices
          • SetDeviceLifecycleStatusByChannel
          • SetDeviceLifecycleStatusByChannelResponse
          • EnableDebugging
          • DisableDebugging
          • FindMessageLogs
          • GetGsmDiagnostic
        • Monitoring
          • GetActualMeterReads
          • GetActualMeterReadsResponse
          • GetActualMeterReadsGas
          • GetActualMeterReadsGasResponse
          • GetPeriodicMeterReads
          • GetPeriodicMeterReadsResponse
          • GetPeriodicMeterReadsGas
          • GetPeriodicMeterReadsGasResponse
          • GetProfileGenericData
          • GetProfileGenericDataResponse
          • ReadAlarmRegister
          • GetReadAlarmRegisterResponse
          • RetrievePushNotificationAlarm
        • Notification
          • SendNotification
      • ResponseMessages
      • Use cases
    • Guidelines to add a new domain to GXF
  • Protocols
    • IEC61850
      • SWDevice-010805
        • SWDevice-010805.icd
        • RegisterDevice
        • GetConfiguration
        • SetConfiguration
        • SetEventNotifications
        • EventNotification
        • SetSchedule
        • GetFirmwareVersion
        • UpdateFirmware
        • SetReboot
        • StartSelfTest
        • StopSelfTest
        • SetLight
        • SetTransition
        • GetStatus
        • UpdateDeviceSslCertification
      • FlexOVL_540_171101_2
        • FlexOVL_540_171101_2_out.icd
        • GetStatus
        • EventNotification
    • DLMS / COSEM
      • DLMS protocol adapter configuration
      • DLMS device simulator
    • OSLP
      • OSLP v0.5.1
        • Protobuf Contract
      • OSLP v0.6.1
        • Protobuf Contract
        • RegisterDevice
        • ConfirmRegisterDevice
        • GetConfiguration
        • SetConfiguration
        • SetEventNotifications
        • EventNotification
        • SetSchedule
        • ResumeSchedule
        • GetFirmwareVersion
        • UpdateFirmware
        • SetReboot
        • StartSelfTest
        • StopSelfTest
        • SetLight
        • SetTransition
        • GetStatus
        • UpdateDeviceSslCertification
        • SetDeviceVerificationKey
        • SwitchFirmware
        • SwitchConfiguration
    • MQTT
  • Support
  • License
Powered by GitBook
On this page
  • Scope
  • Features
  • Generic functionality
  • Messages
  • SmartMeteringAdHoc
  • SmartMeteringConfiguration
  • SmartMeteringInstallation
  • SmartMeteringManagement
  • SmartMeteringMonitoring
  • DeviceManagement
  • SmartMeteringNotification
  • SmartMeteringBundle
  • WSDL's

Was this helpful?

Export as PDF
  1. Domains

SmartMetering

PreviousDistribution automationNextWeb Services

Last updated 1 year ago

Was this helpful?

This chapter describes the SmartMetering domain including the web services. Currently the web services of the beta version are described, since the web services have not yet officially been released. Information on the DLMS device simulator can be found in the

Scope

The goal of this domain is to read and manage millions of smart meters. This includes smart meter installation, firmware updates, smart meter removal, read smart meter values, time synchronisation, etc. Everything that is needed to professionally manage millions of smart meters is or can be included in this domain.

Features

Currently, the following Smart Metering features are available within the open smart grid platform:

  • Add smart meter to the platform, so the device is known and additional actions can be performed for the device

  • Process shipment file, which adds several smart meters to the platform along with all needed information

  • Synchronize time between smart meters and head-end system, in case the smart meter adjusts its time, some events will be logged

  • Retrieve events from the smart meter, several event logs are available

  • Retrieve periodic meter reads from the smart meter

Generic functionality

  • operations can be given the flag 'bypass retry'. Which means that an operation will not be retried in case of an error.

  • operations can be given a priority from 0 to 9, default is 4. Higher values causes messages to be processed faster.

  • operations can be scheduled for a certain time.

  • operations can be combined in a .

Messages

SmartMeteringAdHoc

SmartMeteringConfiguration

SmartMeteringInstallation

SmartMeteringManagement

SmartMeteringMonitoring

DeviceManagement

SmartMeteringNotification

SmartMeteringBundle

All operations sent to this device make use of one communication channel, which may improve performance considerably.

WSDL's

is an operation to synchronize the date and time on a device. The date and time are retrieved from the server and sent to the device.

is an operation which returns the response from the operation.

is an operation to obtain all the attributes of the whole tree of objects from an E-meter.

is an operation which returns the response from the operation.

is an operation to obtain a specific attribute value from an ObisCode from an E-meter.

is an operation which returns the response from the operation.

is an operation to get the associated ln objects.

is an operation which gets the response from the operation.

is an operation to get the M-Bus Short ID attribute values for all four channels from an E-meter.

is an operation which returns the response from the operation.

is an operation to set a dayId profile and its tariffs for a specific date on a device.

is an operation which returns the response from the operation.

is an operation to set ConfigurationObject settings on a device to specify behaviour and connection options.

is an operation which returns the response from the operation.

is an operation to retrieve a ConfigurationObject from a device.

is an operation which returns the response, a ConfigurationObject, from the operation.

is an operation that pushes received alarm messages to OSGP.

is an operation which returns the response from the operation.

is an operation to set an endpoint in a device which tells the device where to connect to when it is waked up.

is an operation which returns the response from the operation.

is an operation to set the types of alarm notifications that must be notified from the device when they occur.

is an operation which returns the response from the operation.

is an operation to transfer and set a G-meter key on a device.

is an operation which returns the response from the operation.

is an operation to set the M-Bus encryption key on an M-Bus device by using the E-meter device identification and channel from the G-meter.

is an operation which returns the response from the operation.

is an operation to retrieve the encryption key status for a M-Bus device.

is an operation which returns the response from the operation.

is an operation to get the M-Bus encryption key status from an M-Bus device by using the E-meter device identification and channel from the G-meter.

is an operation which returns the response from the operation.

is an operation to set several parameters on an E-meter such as tariffs per day in a week profile.

is an operation which returns the response from the operation.

is an operation to retrieve the current AdministrativeStatus setting.

is an operation which returns the response from the operation.

is an operation to set the AdministrativeStatus.

is an operation which returns the response from the operation.

is an operation to retrieve the firmware version(s).

is an operation which returns the response from the .

is an operation to change the keys on a E-meter.

is an operation which returns the response from the operation.

is an operation to update the firmware module(s) on a device.

is an operation which returns the response from the operation.

is an operation to generate and set the encryption and authentication key on a device.

is an operation which returns the response from the operation.

is an operation to set the clock configuration on a device.

is an operation which returns the response from the operation.

is an operation to configure the load profile on a device.

is an operation which returns the response from the operation.

is an operation to add a device to the OSGP database.

is an operation which returns the response from the operation.

is an operation to couple a M-Bus device to a gateway.

is an operation which returns the response from the operation.

is an operation to couple a M-Bus device to a gateway.

is an operation which returns the response from the operation.

is an operation to decouple an M-Bus device from a gateway.

is an operation which returns the response from the operation.

is an operation to clear the M-Bus status on all channels, so G-meters are ready to raise new alarms.

is an operation to retrieve events logging from a device.

is an operation which returns the response from the operation.

is an operation to retrieve the last known relay statuses for a group of devices.

is an operation to enable debug logging for a device.

is an operation which returns the response from the operation.

is an operation to disable debug logging for a device.

is an operation which returns the response from the operation.

is an operation to read the debug logging from a device.

is an operation which returns the response from the operation.

is an operation to set the OSGP device communication settings for a specific device.

is an operation which returns the response from the operation.

is an operation to set the lifecycle status from a device.

is an operation which returns the response from the operation.

is an operation to set the lifecycle status from a device.

is an operation which returns the response from the operation.

is an operation to retrieve the actual meter reads from an E-meter.

is an operation which returns the response from the operation.

is an operation to retrieve the actual meter reads from a G-meter.

is an operation which returns the response from the operation.

is an operation to retrieve the periodic meter reads from an E-meter.

is an operation which returns the response from the operation.

is an operation to retrieve the periodic meter reads from a G-meter.

is an operation which returns the response from the operation.

is an operation to retrieve any Profile Generic data from an E-meter.

is an operation which returns the response from the operation.

is an operation to read the alarm register from a device.

is an operation which returns the response from the operation.

is an operation to push retrieved alarm notifications to OSGP.

is an operation to clear the Alarm register flags for pushed event notifications.

is an operation which returns the response from the operation.

is an operation to set the device lifecycle status of a device.

is an operation which returns the response from the operation.

is an operation to let Webapps know there is a result ready to retrieve from the platform.

is a special operation in which one or more single operation(s) to a specific device can be bundled.

is an operation which gets the response from the operation.

DLMS protocol section
bypass retry
priority
scheduling
bundling
Bundle
SynchronizeTime
GetSynchronizeTimeResponse
SynchronizeTime
RetrieveAllAttributeValues
GetRetrieveAllAttributeValuesResponse
RetrieveAllAttributeValues
GetSpecificAttributeValue
GetSpecificAttributeValueResponse
GetSpecificAttributeValue
GetAssociationLnObjects
GetGetAssociationLnObjectsResponse
GetAssociationLnObjects
ScanMbusChannels
ScanMbusChannelsResponse
ScanMbusChannels
SetSpecialDays
GetSetSpecialDaysResponse
SetSpecialDays
SetConfigurationObject
GetSetConfigurationObjectResponse
SetConfigurationObject
GetConfigurationObject
GetConfigurationObjectResponse
GetConfigurationObject
SetPushSetupAlarm
GetSetPushSetupAlarmResponse
SetPushSetupAlarm
SetPushSetupSms
GetSetPushSetupSmsResponse
SetPushSetupSms
SetAlarmNotifications
GetSetAlarmNotificationsResponse
SetAlarmNotifications
SetKeyOnGMeter
GetSetKeyOnGMeterResponse
SetKeyOnGMeterRequest
SetMbusUserKeyByChannel
SetMbusUserKeyByChannelResponse
SetMbusUserKeyByChannel
GetMbusEncryptionKeyStatus
GetGetMbusEncryptionKeyStatusResponse
GetMbusEncryptionKeyStatus
GetMbusEncryptionKeyStatusByChannel
GetMbusEncryptionKeyStatusByChannelResponse
GetMbusEncryptionKeyStatusByChannel
SetActivityCalendar
GetSetActivityCalendarResponse
SetActivityCalendar
GetAdministrativeStatus
GetGetAdministrativeStatusResponse
GetAdministrativeStatus
SetAdministrativeStatus
GetSetAdministrativeStatusResponse
SetAdministrativeStatus
GetFirmwareVersion
GetGetFirmwareVersionResponse
GetFirmwareVersionoperation
ReplaceKeys
GetReplaceKeysResponse
ReplaceKeys
UpdateFirmware
GetUpdateFirmwareResponse
UpdateFirmware
GenerateAndReplaceKeys
GenerateAndReplaceKeysResponse
GenerateAndReplaceKeys
SetClockConfiguration
GetSetClockConfigurationResponse
SetClockConfiguration
ConfigureDefinableLoadProfile
GetConfigureDefinableLoadProfileResponse
ConfigureDefinableLoadProfile
AddDevice
GetAddDeviceResponse
AddDevice
CoupleMbusDevice
GetCoupleMbusDeviceResponse
CoupleMbusDevice
CoupleMbusDeviceByChannel
GetCoupleMbusDeviceByChannelResponse
CoupleMbusDeviceByChannel
DeCoupleMbusDevice
GetDeCoupleMbusDeviceResponse
DeCoupleMbusDevice
ClearMBusStatusOnAllChannels
FindEvents
GetFindEventsResponse
FindEvents
GetDevices
EnableDebugging
GetEnableDebuggingResponse
EnableDebugging
DisableDebugging
GetDisableDebuggingResponse
DisableDebugging
FindMessageLogs
GetFindMessageLogsResponse
FindMessageLogs
SetDeviceCommunicationSettings
SetDeviceCommunicationSettingsResponse
SetDeviceCommunicationSettings
SetDeviceLifecycleStatus
SetDeviceLifecycleStatusResponse
SetDeviceLifecycleStatus
SetDeviceLifecycleStatusByChannel
SetDeviceLifecycleStatusByChannelResponse
SetDeviceLifecycleStatusByChannel
GetActualMeterReads
GetActualMeterReadsResponse
ActualMeterReads
GetActualMeterReadsGas
GetActualMeterReadsGasResponse
ActualMeterReadsGas
GetPeriodicMeterReads
GetPeriodicMeterReadsResponse
PeriodicMeterReads
GetPeriodicMeterReadsGas
GetPeriodicMeterReadsGasResponse
PeriodicMeterReadsGas
GetProfileGenericData
GetProfileGenericDataResponse
ProfileGenericData
ReadAlarmRegister
GetReadAlarmRegisterResponse
ReadAlarmRegister
RetrievePushNotificationAlarm
ClearAlarmRegister
ClearAlarmRegisterResponse
ClearAlarmRegister
SetDeviceLifecycleStatus
SetDeviceLifecycleStatusResponse
SetDeviceLifecycleStatus
SendNotification
Bundle
GetBundleResponse
Bundle
SmartMetering WSDL's
SmartMetering XSD schema's