MMM-Domoticz

This MagicMirror module allows you read data from your Domiticz Home Center

Important message

Due to a great number of requests that I am not able to implement, mostly simply because I don't have the same devices connected to my Domoticz system there will be no more new features added to this module. In the past some addiditions have been made that probably is only used by the user that requested it. It is not possible to award every request.

Installation

Navigate into your MagicMirror's modules folder and execute git clone https://github.com/spoturdeal/MMM-Domoticz.git.
Add the module inside config.js placing it where you prefer ;)

Config

Option	Description
`updateInterval`	How fast do you like updates. Type: `Integer` Default: 45
`apiBase`	The IP Address of your Domoticz. Type: `string` Default: 192.168.xxx.xxx
`apiPort`	The port your Domiticz uses. Type: `Integer` Default: 8080
`apiUser`	The username you use to login on your Domoticz. Type: `string` Default: XXXX
`apiPw`	The password you use to login.. Type: `string` Default: xxxx
`energyTitle`	Energy title. Type: `string` Options: Anything Default: Energy used by
`batteryTitle`	Battery title. Type: `string` Options: Anything Default: Battery level
`coTitle`	CO2 title. Type: `string` Options: Anything Default: CO2 level
`blindsTitle`	Blinds title. Type: `string` Options: Anything Default: Blinds
`voltageTitle`	Voltage title. Type: `string` Options: Anything Default: Voltage/Current
`alarmTitle`	Alarm title. Type: `string` Options: Anything Default: Alarm system
`alarmLabel`	Alarm label. Type: `string` Options: Anything Default: Current alarm status:
`rainLabel`	Rain label. Type: `string` Options: Anything Default: Rain meter:
`energyNow`	The text for the energy you currently use. Type: `string` Default: Currently
`energyTotal`	The text of total energy used. Type: `string` Default: Total used
`energyMeter1`	Label for energymeter 1. Type: `string` Default: kWh meter I
`energyMeter2`	Label for energymeter 2. Type: `string` Default: kWh meter II
`gasTotal`	The text of total gas used. Type: `string` Default: Total gas used
`gasToday`	The text of total gas used today. Type: `string` Default: Today used gas
`waterTotal`	The text of total water used. Type: `string` Default: Total H2O used
`waterToday`	The text of total water used today. Type: `string` Default: Today used H2O
`moduleTitle`	Defines the headline text. Type: `string` Default: My smart home by Domoticz
`temperatureTitle`	Defines the temperature text. Type: `string` Default: Current temperatures Domoticz
`batteryThreshold`	Below this value it will be shown. Type: `Integer` Default: 15
`coThreshold`	Above this level in ppm it will be shown. Type: `Integer` Default: 700
`showItems`	The items you like to show. Type `array` One of the following: `temperature, energy,battery,co,blinds,humidity,baro,usage,voltage,alarm,sensor,pulse,meter` Default `['temperature','energy','usage','meter']`
`subMenus`	Set if you want separate menus. Type: `boolean` Options: true, false Default: true
`smartMeter`	Set to true if you use a P1 USB smart meter. Type: `boolean` Options: true, false Default: false
`smartMeterOffset`	Set the beginning value of your smart meter. Type: `integer` Default: 0
`smartMeterGasOffset`	Set the beginning value of your smart gas meter. Type: `integer` Default: 0
`smartMeterWaterOffset`	Set the beginning value of your smart water meter. Type: `integer` Default: 0
`excludeDevices`	The device you like to show wich are ON. Type `array` One of the following: `Livingroom`, `Garden lights` Default `none`
`onlyShowExcluded`	Only shows the devices that are in the excludedDevices array. (For backward compatibility didn't change the name excludedDevice setting) Type `boolean` Default `false`
`textWhite`	Set the text colour to white instead of grey. Type `boolean`: true of false Default false
`alarmOffLabel`	Label if alarm is off. Type: `string` Options: Anything Default: Security Disarmed
`alarmOnLabel`	Label if alarm is armed. Type: `string` Options: Anything Default: Security Armed
`groupSensors`	Group the values of one sensor. If true the name will not repeat and a hook is shown. On position left it sometimes give strange effects. Type `boolean`: true of false Default false

Here is an example of an entry in config.js

{
	module: "MMM-Domoticz",
	position: "top_right",   // see mirror setting for options
	config: {          
		updateInterval: 45, // every 45 seconds
		apiBase: '192.168.xxx.xxx',
		apiPort: 8080,
		apiUser: "XXXX",
    		apiPw: "xxxx",
		moduleTitle: "My smart home by Domoticz",
		energyTitle: "Energy used by",
		batteryTitle: "Battery level",
		coTitle: "CO2 level",
		blindsTitle: "Blinds",
		energyNow: "Currently using",
		energyTotal: "Energy used",
		energyToday: "Energy used today",
		batteryThreshold: 20,
    		coThreshold: 650,
		subMenus: true,
		smartMeter: false,
		smartMeterOffset: 0,
		showItems: ['temperature','energy','battery','co','blinds','humidity','baro','usage','voltage','alarm','sensor','pulse','meter','rain'],   
		excludeDevices: ['none','add your own'],  // Device that will not be shown
		onlyShowExcluded: false, // if true only exluded devices are shown
		textWhite: false,
		alarmOffLabel: "Disabled",
		groupSensors: false
	}
}

Screenshots

Display type: details

Use an ESP32 WiFi module to controll your shutters

Control your shutter with WiFi asnd ESP32 module

22th April 2018

Added Humidity and Barometric pressure. Must be added in config.js to be shown grouped on the sensors name.

23th April 2018

Added current use of Watts please update config.js showItems with 'usage' Added total and todays use of energy in kWh.

24th October 2018

Added alarm status requested by jacha05 Added Voltage and current requested by offgridonrocker Changed error in example config.js (typo in excludedDevices is now excludeDevices).

15th Januari 2019

Added Alarm system texts update the config if needed Re-Added Sensors made by BlackCatDeployment Restructured layout scripts.

21st May 2019 v1.18

Added support for SmartMeter p1 through USB Added SmartMeter offset requested by 1kOhm Changed excluded device to make it possible to only show selected Device requested by RienduPre Changed power usage metering if using a smartmeter requested by RienduPre

25th May 2019 v1.24

Added smartMeter for Gas and Water Added support for SO pulse meters

26th May 2019 v1.26

Added meter values

30th June 2019 v1.35

Added rain meter

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

SpoturDeal/MMM-Domoticz