Modules

What is a module?

A module is a visual object in the web application that displays data from a specific data channel. An example of a module is the graph. An instance of a module can be resized and moved anywhere inside the application grid, and new instances can be added and removed dynamically.

The module class

The Module class is an abstract base class for all modules. It contains all the common code needed to make the module implementations work.

Module overview

Empty module (EmptyModule)

A dummy/placeholder module which is placed in the back of each cell.

Canvas gauge (CanvasGauge)

This is a simple canvas-based gauge. It can be configured with various bar thicknesses, circle area to cover and colors.

Circle canvas gauge (CircleCanvasGauge)

This is a specialized version of the canvas gauge, where the bar covers a whole circle. The thickness and color can be adjusted.

Chart (ChartModule)

This module displays historical data in a SmoothieChart-based chart. See Libraries for more information about SmoothieChart.

Percentage bar (LinearGauge)

This is a horizontal gauge which usually gets used to show a percentage.

Percentage bar set (LinearGaugeSet)

This is a set of 2 percentage bars. May not work in the final version, and is not used.

YouTube module (YouTubeModule)

A module that can display any YouTube video. It takes the video URL as a constructor parameter.

Image module (ImageModule)

A simple module for displaying an image. Takes an image source as a constructor parameter.

Speed-o-meter (Speedometer)

A deprecated test module. It was used to prototype a gauge without using canvas.

Text module (TextModule)

A simple module which can display some text. It currently shows the current time.

Edit button (EditButton)

This is not really a module, but is placed statically in the top-left corner. It is used by the layout to add buttons for editing and selecting a preset.