External Signal Onboarding Flow

Before implementing the integration, request its Eniris MQTT credentials through the distributor. The onboarding API does not create broker credentials.

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 Sofar 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 Sofar 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 Sofar EMS, and control is no longer possible.
   • Status/healthcheck endpoint The healthcheck endpoint can be polled regularly by the Sofar 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 Sofar EMS. The Onboarding endpoint will be called to indicate that the Sofar EMS is ready to be listening for commands.

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

3. A contract number is required to link a Sofar 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.