EPSherpa logo
EPSherpa logo
Accessories
AppCertificates
Configuration from A to Z
Control response time
Customer Specific
Devices
External Signals
DSO

AgrolaAutarcoAxpoBEE EnergyCompanion EnergyDexterDiagnostic testsDNO Relay ControlDynamic Energy TradingEdmijElia
Elindus
Energy Flexibility Solutions (EFS)EnervalisEngieEPEX Spot SolarEuropean CommoditiesFleco PowerFlowerFrank EnergieFuseboxGreenchoiceHallostroomImbyKratTrade
Monitoring
Mqtt
BaselinesLive MQTT controlOnboarding FlowScheduled MQTT controlVirtual Power Plant
New integrationsNext EnergyOpinumParagraph 14a IntegrationPlan-ahead APIPleeviRepoweredScholtTrevionVGT EnergyYuso - Battery ControlYuso - Solar Curtailment
InstallationLicenseNetworkQuick StartSafety, maintenance and legal noticesSpecificationsStatus LEDs
Toolbox
Troubleshooting
Video tutorialsWiring & connectivity guidelines
External SignalsMqtt

External Signal Onboarding Flow

Tip
Tip

The Onboarding guideline is meant for new integrations using the Eniris MQTT Protocol.

A drawback of the MQTT protocol is that there is no notification or data transfer when a new installation is added. Therefore it is recommended to include the following steps before fully integrating with the EPSherpa EMS.

Setup

The following will be required to set up an onboarding flow

  1. External API

    • A public API is required

  2. At least two endpoints

    • Onboarding endpoint The onboarding endpoint can be used by the EPSherpa EMS to send a signal indicating that the installation is ready to be controlled. Additional info may include contract numbers entered by users, installation address, device info
    • Offboarding endpoint The offboarding endpoint can be used to indicate that the external control signal has been removed from the EPSherpa EMS, and control is no longer possible.
    • Status/healthcheck endpoint The healthcheck endpoint can be polled regularly by the EPSherpa EMS to provide a status update of the devices, or the system as a whole.

Example

  1. A new user adds the external signal in the EPSherpa EMS. The Onboarding endpoint will be called to indicate that the EPSherpa EMS is ready to be listening for commands.

  2. The EPSherpa EMS has lost connection with the battery. The healthcheck endpoint will contain an error message.

  3. A contract number is required to link a EPSherpa EMS serial number to a customer. A contract number can be included in the onboarding flow, reducing back-and-forth communication between external signals and end customers.

Live MQTT control

Previous Page

Scheduled MQTT control

Next Page

On this page

External Signal Onboarding FlowSetupExample