spitzlbergerj / MMM-CaravanPiFillLevels

MagicMirror module for the CaravanPi project to show filling levels of tanks in a smart caravan.

MMM-CaravanPiFillLevels - a MagicMirror² Module

This MagicMirror² module is used in the CaravanPi project to display filling levels from e.g. a fresh water tank or/and a waste-holding tank. CaravanPi is a project based on a Raspberry Pi for a smart caravan.

In the CaravanPi project Magic Mirror is used as a display module. The screen is usually not mounted behind a mirror, but can also be used as a TV in the caravan. For the Caravan Pi project there are further modules for Magic Mirror:

MMM-CaravanPiPosition - Module for displaying level information

MMM-CaravanPiGasWeight - Module for indicating the filling of a gas bottle via a scale

MMM-CaravanPiTemperature - Module for displaying temperature values e.g. in the refrigerator

MMM-CaravanPiClimate - Module for displaying climate values

Screendumps

modus: Boxlines

Installation

In your terminal, go to your MagicMirror's Module folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/spitzlbergerj/MMM-CaravanPiFillLevels

install the node dependencies:

cd MMM-CaravanPiFillLevels/ && npm install

install a nesessary npm modul:

npm install async

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
		{
			module: "MMM-CaravanPiFillLevels",
			position: "top_right",
			header: 'Füllstände Tanks',
			config: {
				updateInterval: 500,
				style: "boxlines",
				tanks: [
					{
						name: "Frischwassertank",
						file: "tank1",
						nr: 1,
					},
					{
						name: "Fäkalientank",
						file: "tank2",
						nr: 2,
					},
				],
			}
		},

]

Configuration options

The following properties can be configured:

Option	Description
valueDir	Optional - The directory in which the values read by the sensors are stored. If not set, the default is: /home/pi/CaravanPi/values
updateInterval	Optional - The update interval in milliseconds. If not set, the default is: 300000 (5 minutes)
showDate	Optional - Decides whether the date/time at which the values were determined is displayed. Possible values: true or false Default is true
localeStr	Optional - String for country-specific formatting of numbers. Possible values: see Tags for Identifying Languages Default is 'de-DE'
style	Optional - Decides in which style the values are displayed. Possible values: lines, boxes or boxlinesDefault is 'lines'
tanks	Required - Add all your tanks that should appear in the MagicMirror. Each tank must include the following properties: Option Description name Name that is to be displayed for this sensor. file File name from which the values are to be read nr number of the tank