Comment on page
SmartMetering

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 DLMS protocol section​
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
​bypass retry operations can be given the flag 'bypass retry'. Which means that an operation will not be retried in case of an error.
​priority operations can be given a priority from 0 to 9, default is 4. Higher values causes messages to be processed faster.
​scheduling operations can be scheduled for a certain time.
​bundling operations can be combined in a Bundle.
Messages
SmartMeteringAdHoc
​SynchronizeTime 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.
​GetSynchronizeTimeResponse is an operation which returns the response from the SynchronizeTime operation.
​RetrieveAllAttributeValues is an operation to obtain all the attributes of the whole tree of objects from an E-meter.
​GetRetrieveAllAttributeValuesResponse is an operation which returns the response from the RetrieveAllAttributeValues operation.
​GetSpecificAttributeValue is an operation to obtain a specific attribute value from an ObisCode from an E-meter.
​GetSpecificAttributeValueResponse is an operation which returns the response from the GetSpecificAttributeValue operation.
​GetAssociationLnObjects is an operation to get the associated ln objects.
​GetGetAssociationLnObjectsResponse is an operation which gets the response from the GetAssociationLnObjects operation.
​ScanMbusChannels is an operation to get the M-Bus Short ID attribute values for all four channels from an E-meter.
​ScanMbusChannelsResponse is an operation which returns the response from the ScanMbusChannels operation.
SmartMeteringConfiguration
​SetSpecialDays is an operation to set a dayId profile and its tariffs for a specific date on a device.
​GetSetSpecialDaysResponse is an operation which returns the response from the SetSpecialDays operation.
​SetConfigurationObject is an operation to set ConfigurationObject settings on a device to specify behaviour and connection options.
​GetSetConfigurationObjectResponse is an operation which returns the response from the SetConfigurationObject operation.
​GetConfigurationObject is an operation to retrieve a ConfigurationObject from a device.
​GetConfigurationObjectResponse is an operation which returns the response, a ConfigurationObject, from the GetConfigurationObject operation.
​SetPushSetupAlarm is an operation that pushes received alarm messages to OSGP.
​GetSetPushSetupAlarmResponse is an operation which returns the response from the SetPushSetupAlarm operation.
​SetPushSetupSms is an operation to set an endpoint in a device which tells the device where to connect to when it is waked up.
​GetSetPushSetupSmsResponse is an operation which returns the response from the SetPushSetupSms operation.
​SetAlarmNotifications is an operation to set the types of alarm notifications that must be notified from the device when they occur.
​GetSetAlarmNotificationsResponse is an operation which returns the response from the SetAlarmNotifications operation.
​SetKeyOnGMeter is an operation to transfer and set a G-meter key on a device.
​GetSetKeyOnGMeterResponse is an operation which returns the response from the SetKeyOnGMeterRequest operation.
​SetMbusUserKeyByChannel 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.
​SetMbusUserKeyByChannelResponse is an operation which returns the response from the SetMbusUserKeyByChannel operation.
​GetMbusEncryptionKeyStatus is an operation to retrieve the encryption key status for a M-Bus device.
​GetGetMbusEncryptionKeyStatusResponse is an operation which returns the response from the GetMbusEncryptionKeyStatus operation.
​GetMbusEncryptionKeyStatusByChannel 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.
​GetMbusEncryptionKeyStatusByChannelResponse is an operation which returns the response from the GetMbusEncryptionKeyStatusByChannel operation.
​SetActivityCalendar is an operation to set several parameters on an E-meter such as tariffs per day in a week profile.
​GetSetActivityCalendarResponse is an operation which returns the response from the SetActivityCalendar operation.
​GetAdministrativeStatus is an operation to retrieve the current AdministrativeStatus setting.
​GetGetAdministrativeStatusResponse is an operation which returns the response from the GetAdministrativeStatus operation.
​SetAdministrativeStatus is an operation to set the AdministrativeStatus.
​GetSetAdministrativeStatusResponse is an operation which returns the response from the SetAdministrativeStatus operation.
​GetFirmwareVersion is an operation to retrieve the firmware version(s).
​GetGetFirmwareVersionResponse is an operation which returns the response from the GetFirmwareVersionoperation.
​ReplaceKeys is an operation to change the keys on a E-meter.
​GetReplaceKeysResponse is an operation which returns the response from the ReplaceKeys operation.
​UpdateFirmware is an operation to update the firmware module(s) on a device.
​GetUpdateFirmwareResponse is an operation which returns the response from the UpdateFirmware operation.
​GenerateAndReplaceKeys is an operation to generate and set the encryption and authentication key on a device.
​GenerateAndReplaceKeysResponse is an operation which returns the response from the GenerateAndReplaceKeys operation.
​SetClockConfiguration is an operation to set the clock configuration on a device.
​GetSetClockConfigurationResponse is an operation which returns the response from the SetClockConfiguration operation.
​ConfigureDefinableLoadProfile is an operation to configure the load profile on a device.
​GetConfigureDefinableLoadProfileResponse is an operation which returns the response from the ConfigureDefinableLoadProfile operation.
SmartMeteringInstallation
​AddDevice is an operation to add a device to the OSGP database.
​GetAddDeviceResponse is an operation which returns the response from the AddDevice operation.
​CoupleMbusDevice is an operation to couple a M-Bus device to a gateway.
​GetCoupleMbusDeviceResponse is an operation which returns the response from the CoupleMbusDevice operation.
​CoupleMbusDeviceByChannel is an operation to couple a M-Bus device to a gateway.
​GetCoupleMbusDeviceByChannelResponse is an operation which returns the response from the CoupleMbusDeviceByChannel operation.
​DeCoupleMbusDevice is an operation to decouple an M-Bus device from a gateway.
​GetDeCoupleMbusDeviceResponse is an operation which returns the response from the DeCoupleMbusDevice operation.
SmartMeteringManagement
​ClearMBusStatusOnAllChannels is an operation to clear the M-Bus status on all channels, so G-meters are ready to raise new alarms.
​FindEvents is an operation to retrieve events logging from a device.
​GetFindEventsResponse is an operation which returns the response from the FindEvents operation.
​GetDevices is an operation to retrieve the last known relay statuses for a group of devices.
​EnableDebugging is an operation to enable debug logging for a device.
​GetEnableDebuggingResponse is an operation which returns the response from the EnableDebugging operation.
​DisableDebugging is an operation to disable debug logging for a device.
​GetDisableDebuggingResponse is an operation which returns the response from the DisableDebugging operation.
​FindMessageLogs is an operation to read the debug logging from a device.
​GetFindMessageLogsResponse is an operation which returns the response from the FindMessageLogs operation.
​SetDeviceCommunicationSettings is an operation to set the OSGP device communication settings for a specific device.
​SetDeviceCommunicationSettingsResponse is an operation which returns the response from the SetDeviceCommunicationSettings operation.
​SetDeviceLifecycleStatus is an operation to set the lifecycle status from a device.
​SetDeviceLifecycleStatusResponse is an operation which returns the response from the SetDeviceLifecycleStatus operation.
​SetDeviceLifecycleStatusByChannel is an operation to set the lifecycle status from a device.
​SetDeviceLifecycleStatusByChannelResponse is an operation which returns the response from the SetDeviceLifecycleStatusByChannel operation.
SmartMeteringMonitoring
​GetActualMeterReads is an operation to retrieve the actual meter reads from an E-meter.
​GetActualMeterReadsResponse is an operation which returns the response from the ActualMeterReads operation.
​GetActualMeterReadsGas is an operation to retrieve the actual meter reads from a G-meter.
​GetActualMeterReadsGasResponse is an operation which returns the response from the ActualMeterReadsGas operation.
​GetPeriodicMeterReads is an operation to retrieve the periodic meter reads from an E-meter.
​GetPeriodicMeterReadsResponse is an operation which returns the response from the PeriodicMeterReads operation.
​GetPeriodicMeterReadsGas is an operation to retrieve the periodic meter reads from a G-meter.
​GetPeriodicMeterReadsGasResponse is an operation which returns the response from the PeriodicMeterReadsGas operation.
​GetProfileGenericData is an operation to retrieve any Profile Generic data from an E-meter.
​GetProfileGenericDataResponse is an operation which returns the response from the ProfileGenericData operation.
​ReadAlarmRegister is an operation to read the alarm register from a device.
​GetReadAlarmRegisterResponse is an operation which returns the response from the ReadAlarmRegister operation.
​RetrievePushNotificationAlarm is an operation to push retrieved alarm notifications to OSGP.
​ClearAlarmRegister is an operation to clear the Alarm register flags for pushed event notifications.
​ClearAlarmRegisterResponse is an operation which returns the response from the ClearAlarmRegister operation.
DeviceManagement
​SetDeviceLifecycleStatus is an operation to set the device lifecycle status of a device.
​SetDeviceLifecycleStatusResponse is an operation which returns the response from the SetDeviceLifecycleStatus operation.
SmartMeteringNotification
​SendNotification is an operation to let Webapps know there is a result ready to retrieve from the platform.
SmartMeteringBundle
​Bundle is a special operation in which one or more single operation(s) to a specific device can be bundled.
​GetBundleResponse is an operation which gets the response from the Bundle operation.
All operations sent to this device make use of one communication channel, which may improve performance considerably.
WSDL's
​SmartMetering WSDL's​
​SmartMetering XSD schema's​
Distribution automation
Web Services
Last modified 5mo ago