SUMMARY.md

Table of contents

• 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