pimatic-charts by Kosta (treban) | github | npm

pimatic-charts

This plugin provides a chart device for the pimatic frontend. It is based on highcharts.

Please make feature requests!

Features

Chart device
Gauge device
Many customization options

Installation

Just activate the plugin in your pimatic config. The plugin manager automatically installs the package with his dependencys.

Configuration

You can load the plugin by adding following in the config.json from your pimatic server:

{
  "plugin": "charts",
  "debug": true
}

Usages

The devices are based on the built-in variable device from pimatic.

Chart device

The device needs only one configured variable. The config has a default y axis definition. You can assign each variable to one y axis. But also all variables to the same axis.

chart image

Example chart device:

{
  "variables": [
    {
      "name": "pressure",
      "expression": "$wetter.pressure",
      "type": "number",
      "chart": "areaspline",
      "yaxis": 2,
      "dashstyle": "Solid",
      "color": "#a6c96a"
    },
    {
      "name": "temperature",
      "expression": "$wetter.temperature",
      "type": "number",
      "step": false,
      "chart": "areaspline",
      "yaxis": 0,
      "dashstyle": "Solid",
      "color": "#f28f43"
    },
    {
      "name": "humidity",
      "expression": "$wetter.humidity",
      "type": "number",
      "step": false,
      "chart": "spline",
      "yaxis": 1,
      "dashstyle": "Solid"
    },
    {
      "name": "windspeed",
      "expression": "$wetter.windspeed",
      "type": "number",
      "chart": "spline",
      "yaxis": 3,
      "dashstyle": "Solid"
    }
  ],
  "echo": {
    "additionalNames": []
  },
  "id": "testchart",
  "name": "Weather",
  "class": "ChartDevice",
  "xlabel": "x-label",
  "height": 250,
  "subtitle": "Subtitle",
  "timerange": "7d",
  "legend": true,
  "interval": 5,
  "yaxis": [
  {
    "label": "Temperature",
    "unit": "°C"
  },
  {
    "label": "humidity",
    "opposite": true,
    "unit": "%"
  },
  {
    "label": "pressure",
    "unit": "mbar"
  },
  {
    "label": "windspeed",
    "unit": "m/s",
    "opposite": true
  }
],
"allowzoom": true,
"allowtrace": true,
"datebuttons": [
  {
    "label": "3day",
    "count": 6,
    "unit": "day",
    "datagrouping": true
  },
  {
    "label": "1min",
    "count": 1,
    "datagrouping": false,
    "unit": "minute"
  },
  {
    "label": "3day",
    "count": 3,
    "unit": "day",
    "datagrouping": false
  },
  {
    "label": "ALL",
    "unit": "all",
    "count": 0,
    "datagrouping": false
  }
],
"showdatepicker": true
},

Gauge device

gauge image

Example gauge device:

{
  "scale": 0.8,
  "variables": [
    {
      "name": "Tank",
      "expression": "$tank",
      "type": "number",
      "min": 0,
      "max": 30000,
      "unit": "liter",
      "showRange": true,
      "label": "Tank level"
    },
    {
      "name": "Power",
      "expression": "$power",
      "type": "number",
      "min": 0,
      "max": 5000,
      "unit": "kW/h",
      "showRange": true,
      "label": "Power"
    }
  ],
  "echo": {
    "additionalNames": []
  },
  "id": "gauge",
  "name": "Gauge Device",
  "class": "GaugeDevice"
},

ChangeLog

0.0.1 : First public version
0.0.2 :
- BUGFIX (#1: UTC)
- dashStyle included
0.0.3 :
- line colors
- date picker
0.0.4 :
- FIX #5 & #6

LICENSE

This plugin is licenses under CC BY-NC 3.0 and is not free for commercial and Governmental use.

Credits

Plugin Config Options

charts plugin config options

Option	Description	Default
debug boolean	Enabled debug messages	false

Device Config Options

chart

ChartDevice

Chart Properties

Option

Description

Default

subtitle
string

Subtitle

""

xlabel
string

X - label

""

height
number

Chart height

timerange
string

Time-range to display

"1d"

legend
boolean

Show legend

false

allowzoom
boolean

Allow zoom

false

allowtrace
boolean

Allow mouse trace

false

showdatalabels
boolean

Show data labels

false

interval
number

Refresh interval in seconds. 0 = never

variables
array of objects

Variables to display

[]

Elements

Option	Description	Default
name string	Name for the corresponding variable without spaces
expression string	The expression to use to get the value. Can be just a variable name ($myVar), or a calculation ($myVar + 10)
type string	The type of the variable is fix
chart string	The type of the chart for this variable
dashstyle string	The type of dash style.
yaxis number	The yAxis reference	0
step boolean	Draw steps instead lines.	false
color string	The line color

yaxis
array of objects

yAxis

[
  {
    "label": "",
    "unit": ""
  }
]

Elements

showdatepicker
boolean

If datepicker is enabled, you must define the date buttons

false

datebuttons
array of objects

Date picker buttons

[
  {
    "label": "1min",
    "count": 1,
    "unit": "minute",
    "datagrouping": false
  },
  {
    "label": "1day",
    "count": 1,
    "unit": "day",
    "datagrouping": false
  },
  {
    "label": "ALL",
    "count": 0,
    "unit": "all",
    "datagrouping": false
  }
]

Elements

GaugeDevice

Gauge Properties

Option

Description

Default

scale
number

scale factor

variables
array of objects

Variables to display

[]

Elements

Option	Description	Default
name string	Name for the corresponding variable without spaces
label string	Label
expression string	The expression to use to get the value. Can be just a variable name ($myVar), a calculation ($myVar + 10)
type string	The type of the variable is fix
min number	The min value
max number	The max value
unit string	A custom unit label
showRange boolean	Show range

pimatic-charts is written by Kosta (treban)