https://github.com/reubenmiller/cumulocity-device-enrolment-plugin
https://github.com/reubenmiller/cumulocity-device-enrolment-plugin
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/reubenmiller/cumulocity-device-enrolment-plugin
- Owner: reubenmiller
- License: apache-2.0
- Archived: true
- Created: 2024-06-03T14:24:19.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T13:38:16.000Z (12 months ago)
- Last Synced: 2025-05-14T02:43:34.831Z (19 days ago)
- Language: TypeScript
- Size: 748 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cumulocity Device Enrolment Widget Plugin
The device enrolment widget is used to display device enrolment codes provided by the [c8y-token-syner](https://github.com/reubenmiller/c8y-token-syner) microservice.
This plugin can be used in Device Management or Cockpit.
### Compatibility:
| DEVICE ENROLMENT WIDGET PLUGIN | CUMULOCITY |
| ------------------------------ | ---------- |
| 1.x.x | 1018.0.144 |
## Features
- Generate device enrolment codes for onboarding thin-edge.io devices
## Prerequisites:
Cumulocity c8ycli >=1018.0.144
## Installation
To install the widget plugin, you must add the plugin package to the extensions first and then install it on the desired custom application.
#### To add the plugin package to extensions
1. Navigate to Administration > Ecosystem > Extensions
2. Click **Add extension package** to upload the zip file
#### To install the widget plugin on a custom application
1. Navigate Administration > Ecosystem > Applications
2. Click application name to view the application details.
3. Switch to **Plugins** tab, Click **Install plugins**
4. In the resulting dialog, search for Device enrolment widget, click **Install**
To know more about extensions, see [Administration> Managing applications > Extensions](https://cumulocity.com/guides/users-guide/administration/#extensions) in _User guide_
Note: You need a custom application with Cumulocity IoT dashboard to see the widget in action. A quick way to achieve this is by creating a custom Cockpit application.
To create a custom Cockpit application, follow the steps below:
1. Navigate to Administration > Ecosystem > Applications
2. click **Add application**.
3. In the resulting dialog, select the option **Duplicate existing application**.
4. From the list of applications, select Cockpit (Subscribed). Use the default values and proceed.
## QuickStart
This guide will teach you how to add widget in your existing or new dashboard.
1. Open your application from App Switcher
2. Add new dashboard or navigate to existing dashboard
3. Click `Add Widget`
4. Search for `Device enrolment`
5. Click `Save`
---
These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.
---
For more information you can Ask a Question in the [TECH Community Forums](https://tech.forums.softwareag.com/tag/Cumulocity-IoT).