Compass Widget Plugin for Cumulocity

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

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 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 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 TECHcommunity Forums.

You can find additional information in the Software AG TECHcommunity.