Overview
Edge Devices are small computing units installed at sites to collect time-series data from various systems before securely transmitting it to the CoolPlanetOS platform, typically via the MQTT protocol. To ensure secure communication, each Edge Device must be configured with an encryption key and certificate, which are then authenticated by CoolPlanetOS.
The Edge Device Management system in CoolPlanetOS enables users to:
Configure new Edge Devices
View, manage and comment on existing Edge Devices
Revoke certificates and keys
Create new Certificates and keys
Accessing Edge Device Management
The Edge Device Management system is available under the Admin → Edge Devices menu option. This section provides a central interface for managing all Edge Devices.
Edge Device List View
The Edge Device List screen allows users to search for devices and view key details at a glance.
Fields Displayed
Name: A human-readable friendly name for the Edge Device.
MQTT Client ID: The unique identifier used by the platform to authenticate the Edge Device.
Type: The device type (e.g., Episensor, Ewon, Fatbox, etc.).
Install Date: The date when the device was installed and commissioned on-site.
Notes: Any additional notes or metadata related to the device.
Site: The site to which the Edge Device is assigned.
Available Actions
Clicking an Edge Device Name navigates to its Details View.
Users can multi-select Edge Devices and delete them via the Actions menu.
Edge Device Details View
Clicking on a device in the Edge Device List opens the Edge Device Details View, where additional information is displayed.
Additional Fields
Certificates and Keys: Displays the list of certificates and keys, when they were created and a button to revoke each one.
Generate Button: Clicking the "Generate & Download" button generates a new cert and keys and downloads them to the users computer.
Users can log troubleshooting notes or configuration changes via the commenting section of the Edge Device Details View.
Creating a New Edge Device
Users can create a new Edge Device by clicking "New Edge Device" from the Edge Device List View.
Creation Workflow
Enter Required Details:
Name (mandatory)
MQTT Client ID: (mandatory) Note: This cannot be edited after creation.
Type (select from predefined list)
Install Date (mandatory)
Notes (optional)
Site (mandatory)
Click "Create Edge Device".
The system generates the device, and users are redirected to the Edge Device Details View.
Post-Creation Steps
Initially, the Edge Device does not have security keys. Users must click "Generate & Download" to generate and download them. Please note that the edge device certificate and keys must be stored carefully as they cannot be redownloaded from CoolPlanetOS for security reasons. In this instance, the keys and certs should be revoked, and a new set generated. Users can generate and download up to 5 certificates and keys per edge device.
Updating an Edge Device
To modify an existing Edge Device:
Open the Edge Device Details View.
Click "Edit Edge Device" (under the action menu).
Modify any fields.
Click "Save Changes".
Notes on Editing
Users cannot modify the MQTT Client ID
Deleting an Edge Device
Users can delete one or multiple Edge Devices from the Edge Device List View by:
Selecting devices.
Clicking "Delete" in the Actions menu.
Confirming the deletion.
Individual Edge Devices can also be deleted via the actions menu in the Edge Device Details View.
⚠️ Warning: Edge Device Deletion is permanent and will remove the device’s authentication from the system.