https://github.com/cumulocity-iot/cumulocity-compass-widget-plugin

Displays an animated compass direction based on the measurement data provided. Developed by Global Presales.
https://github.com/cumulocity-iot/cumulocity-compass-widget-plugin

compass compass-plugin cumulocity-compass-widget-plugin cumulocity-iot cumulocity-package cumulocity-widget global-presales iot-analytics plugin

Last synced: 4 months ago
JSON representation

Displays an animated compass direction based on the measurement data provided. Developed by Global Presales.

• Host: GitHub
• URL: https://github.com/cumulocity-iot/cumulocity-compass-widget-plugin
• Owner: Cumulocity-IoT
• License: apache-2.0
• Created: 2023-01-10T11:27:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-08T05:23:37.000Z (almost 2 years ago)
• Last Synced: 2024-12-20T17:16:44.739Z (6 months ago)
• Topics: compass, compass-plugin, cumulocity-compass-widget-plugin, cumulocity-iot, cumulocity-package, cumulocity-widget, global-presales, iot-analytics, plugin
• Language: TypeScript
• Homepage:
• Size: 759 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Deprecation notice

This plugin is not further developed and it might break with upcoming Cumulocity releases. Use it at your own risk.

The repository is archived but feel free to fork & adapt it to your needs in a new repo.

# Compass Widget Plugin for Cumulocity [](https://github.com/Cumulocity-IoT/cumulocity-compass-widget-plugin/releases/download/1.0.3/sag-ps-pkg-compass-widget-1.0.3.zip)

This is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit.The Compass Widget displays an animated compass direction based on the measurement data provided.

### Please choose Compass Widget release based on Cumulocity/Application builder version:

|APPLICATION BUILDER   |  CUMULOCITY   |  COMPASS WIDGET    |

|-------------------- |------------ |------------------|

| 2.x.x               | >= 1016.x.x |	1.x.x          |

![compass](images/compass.png)

## Features

**Realtime:** Realtime direction updates from defined measurement.

## Prerequisite

   Cumulocity c8ycli >=1016.x.x

## Installation

### Runtime Widget Deployment?

* This widget supports runtime deployment. Download [Runtime Binary](https://github.com/Cumulocity-IoT/cumulocity-compass-widget-plugin/releases/download/1.0.3/sag-ps-pkg-compass-widget-1.0.3.zip) and install via Administrations --> Ecosystems --> Applications --> Packages.

## Quickstart

This guide will teach you how to add the widget in your existing or new dashboard.

1. Open the Application Builder application from the app switcher (Next to your username in the top right)

2. Add a new dashboard or navigate to an existing dashboard

3. Click `Add Widget`

4. Search for `Compass`

5. See below for the configuration options

### Configuration options

1. Select your device in the `Target Assets or Devices` field

2. Select the device measurement and fragment in the `Measurement` dropdown

3. Click `Save`

The compass widget will refresh each time a new measurement value is sent from the device.

### Sending data to the Compass widget

The compass widget will listen for the measurement and fragment which you have specified in the configuration options above

The compass arrow will move to the numeric measurement value which must be between 0 and 360 to represent the arrow rotation in degrees.

In the 'body' of your Cumulocity measurement, you will need to include the following: 

	

	    {  

	      measurementseries: The measurement series which has been selected in the compass widget e.g. "weather_station" 

          {

             measureementfragment: The measurement fragment which has been selected in the compass widget e.g. "wind_direction"  

	         {

	           value: numeric value from 0 to 360 to represent the rotation of the compass arrow e.g. 270

	           unit: the unit label  e.g. "degrees"

             }

	         .

	         .

	    }

   e.g. 

	    {

	        weather_station: { 

	          wind_direction: {

	            value: 270,

	            unit: "degrees"

	          }

	        }  

	        .

	        .

	    }

	    

------------------------------

This widget is provided as-is and without warranty or support. They do not constitute part of the Cumulocity product suite. Users are free to use, fork and modify them, subject to the license agreement. While Cumulocity GmbH 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://techcommunity.cumulocity.com).