-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changes has been added for the checklist and removed console.log
- Loading branch information
Showing
6 changed files
with
67 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,67 @@ | ||
# Cumulocity device details widget plugin | ||
# Cumulocity Device Details Widget Plugin [<img width="35" src="https://user-images.githubusercontent.com/67993842/97668428-f360cc80-1aa7-11eb-8801-da578bda4334.png"/>](https://github.com/SoftwareAG/cumulocity-device-details-widget-plugin/releases/download/1.0.0-beta/device-details-runtime-widget-1.0.0-beta.zip) | ||
|
||
This Device Details Widget is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. It shows current device details properties in widget. | ||
This Device Details Widget Plugin is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. This Plugin is designed to display the Device Details can fetch the details from the Api call and can display data according to the fields provided. The angular widget has the ability to summarize information relating to the names from the Api call. | ||
|
||
``` | ||
"exports": [ | ||
{ | ||
"name": "Cumulocity Device Details Widget Plugin", | ||
"module": "GpDeviceDetailsWidgetModule", | ||
"path": "./widget/gp-device-details-widget.module.ts", | ||
"description": "Adds a custom widget to the shell application" | ||
} | ||
] | ||
``` | ||
### Please note that this plugin is in currently under BETA mode. | ||
|
||
**How to start** | ||
Run the command below to scaffold a `widget` plugin. | ||
### Please choose Demo Widget release based on Cumulocity/Application builder version: | ||
|
||
``` | ||
c8ycli new <yourPluginName> widget-plugin | ||
``` | ||
|APPLICATION BUILDER | CUMULOCITY | DEVICE DETAILS WIDGET PLUGIN | | ||
|--------------------|-------------|-------------------------------| | ||
| 2.0.x(coming soon) | >= 1016.x.x | 1.x.x | | ||
|
||
|
||
![Device_Details_1](https://user-images.githubusercontent.com/99970126/181510210-2e16463e-0c57-4048-b458-4253a1c913ec.PNG) | ||
|
||
![Device-Details-Config](https://user-images.githubusercontent.com/99970126/188394087-58a3da72-1ae3-4812-8aef-a6afe3a64c9a.png) | ||
|
||
|
||
## Features | ||
|
||
## Installation | ||
|
||
### Runtime Widget Deployment? | ||
|
||
- This plugin support runtime deployment. Download [Runtime Binary](https://github.com/SoftwareAG/cumulocity-device-details-widget-plugin/releases/download/1.0.0-beta/device-details-runtime-widget-1.0.0-beta.zip) and follow runtime deployment instructions from [here](https://github.com/SoftwareAG/cumulocity-runtime-widget-loader). | ||
|
||
As the app.module is a typical Cumuloctiy application, any new plugin can be tested via the CLI: | ||
## Supported Product Versions | ||
|
||
- **App Builder:** Tested with Cumulocity App Builder version 1.3.0 | ||
**Requirements:** | ||
* Git | ||
* NodeJS (release builds are currently built with `v14.18.0`) | ||
* NPM (Included with NodeJS) | ||
|
||
**Instructions** | ||
1. Clone the repository: | ||
``` | ||
git clone https://github.com/SoftwareAG/cumulocity-device-details-widget-plugin.git | ||
``` | ||
2. Change directory: | ||
``` | ||
cd cumulocity-device-details-widget-plugin | ||
``` | ||
3. Install the dependencies: | ||
``` | ||
npm install | ||
``` | ||
4. (Optional) Local development server: | ||
``` | ||
npm start -- --shell cockpit | ||
``` | ||
5. Build the app: | ||
``` | ||
npm run build | ||
``` | ||
6. Deploy the app: | ||
``` | ||
npm run deploy | ||
``` | ||
|
||
|
||
In the Module Federation terminology, `widget` plugin is called `remote` and the `cokpit` is called `shell`. Modules provided by this `widget` will be loaded by the `cockpit` application at the runtime. This plugin provides a basic custom widget that can be accessed through the `Add widget` menu. | ||
------------------------------ | ||
|
||
> Note that the `--shell` flag creates a proxy to the cockpit application and provides` GpDeviceDetailsWidgetModule` as an `remote` via URL options. | ||
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). | ||
|
||
Also deploying needs no special handling and can be simply done via `npm run deploy`. As soon as the application has exports it will be uploaded as a plugin. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters