External Signal Onboarding Flow
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 a-TroniX Controller.
Setup
The following will be required to set up an onboarding flow
-
External API
- A public API is required
-
At least two endpoints
- Onboarding endpoint The onboarding endpoint can be used by the a-TroniX Controller 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 a-TroniX Controller, and control is no longer possible.
- Status/healthcheck endpoint The healthcheck endpoint can be polled regularly by the a-TroniX Controller to provide a status update of the devices, or the system as a whole.
Example
-
A new user adds the external signal in the a-TroniX Controller. The Onboarding endpoint will be called to indicate that the a-TroniX Controller is ready to be listening for commands.
-
The a-TroniX Controller has lost connection with the battery. The healthcheck endpoint will contain an error message.
-
A contract number is required to link a a-TroniX Controller 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.
