MMM-Loxone

This is a module for the MagicMirror².

MMM-Loxone connects to your Loxone Miniserver and lets it communicate to your MagicMirror².

Disclaimer

This package has been written for the Raspberry Pi and has only be tester on the Raspberry Pi please report any incompatibilities.

Security

This module doesn't transmit the defined credentials, it uses tokens to talk to your Loxone Miniserver.

Please create an user for your MagicMirror² to keep your personal credentials secure!

Dependencies

• An Installation of MagicMirror²
• LxCommunicator (Installed via npm install)
• when (Installed via npm install)

Upcoming features

• Support controls like Alarm, WindowMonitor, Simple Virtual outputs, Weather in a modular way
• Further power saving features (Ability to switch off the monitors AC power via an relay)
• Quick overview, whats up in your home

Installation

Navigate into your MagicMirror's modules folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/idoodler/MMM-Loxone

Navigate to the new MMM-Loxone folder and install the node dependencies.

npm install

Update the module

Navigate into the MMM-Loxone folder with cd ~/MagicMirror/modules/MMM-Loxone and get the latest code from github with git pull.

If you haven't changed the modules, this should work without any problems. Type git status to see your changes, if there are any, you can reset them with git reset --hard. After that, git pull should be possible.

Using the module

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

var config = {
    modules: [
        {
            module: 'MMM-Loxone',
            config: {
                // See below for configurable options
            }
        }
    ]
}

Configuration options

Option	Description
host	Required: Defines the Loxone Miniserver host. It can be an IP or your CloudDNS address Example: 192.168.0.46 or dns.loxonecloud.com/EEE00000000 Type: string
user	Required: Defines the Loxone Miniserver username. Type: string
pwd	Required: Defines the Loxone Miniserver password. Type: string
roomUuid	Optional: Defines the room of which the room temperature is displayed Info: Modules like the default currentWeather and MMM-forecast-io will display the indoor temperature, please refere to their documentation Type: string
observingUuids	Optional: Defines controls that should be shown on our module. Supported Controls: Virtual State, State Type: array Default: Empty array
presence	Optional: If enabled this module will use the LightControllerV2 in the defined room, or the virtual state defined in presenceUuid to set the MagicMirror to sleep or wake it up Type: bool Default: false
presenceUuid	Optional: Defines a digital virtual state control that will be used to detect presende. If the virtual state is ON the mirror will be on, if the state if OFF the mirror will be off Note: Can be used to override the default behaviour of using the first LightControllerV2 in the room Type: string
fadeOut	Optional: Fades out the webinterface before the HDMI output is disabled (MagicMirror goes to sleep) Type: bool Default: false
showInfoNotifications	Optional: If info notifications should be shown. Type: bool Default: true
showErrorNotifications	Optional: If error notifications should be shown. Type: bool Default: true
showSystemNotifications	Optional: If system notifications should be shown. Type: bool Default: true
showNotificationOfControlTypes	Optional: Defines, what controls are able to show notifications on your MagicMirror². Type: array Default: [ "Intercom", "Alarm", "SmokeAlarm", "Sauna" ]
allow3rdParty	Optional: If 3rd Party modules are able to use this module to communicate with your Loxone Miniserver. Type: bool Default: false

Display the room temperature

Requirements

• The room needs to have at lease contain one Intelligent Room Controller (v2)
  • The first Intelligent Room Controller (v2) will be used if multiple are defined in one room
• roomUuid needs to be defined in the MMM-Loxone configuration in config.js
• currentWeather or MMM-forecast-io must be installed and correctly configured to display the indoor room temperature

Display Notifications

Requirements

• You must define the alert module in your config.json file.

Example:

{
	module: "alert"
}

How to get the roomUuid

1. Open the Loxone Webinterface
2. Navigate to the room you want to display the room temperature
3. Copy the last path component displayed in your browsers URL-Bar
   

Populate observingUuids

observingUuids is an array of control uuids

Example:

observingUuids: [
    "0d12f989-0060-c82f-ffff2083eaf2523c"
]

1. Open the Loxone Webinterface
2. Navigate to the control you want to display on your mirror
   • Virtual State and State controls are supported
3. Copy the last path component displayed in your browsers URL-Bar
   

Developer notes

Notifications emitted by MMM-Loxone

NotificationKey	Description
INDOOR_TEMPERATURE	Modules like the default currentWeather and MMM-forecast-io will display the indoor temperature. Please implement this notification key if you want to display the indoor temperature in your module. Note: roomUUID must be configured in your config.json
USER_PRESENCE	Modules can use this notification to pause or resume your module. Example: true if the User is present in the room, false if not. Payload: bool Note: roomUUID and presence must be configured in your config.json
LOXONE_STATE	Any state emitted by the Loxone Miniserver with its UUID and value. Ready to be used by any other module. Payload: Number or String Note: allow3rdParty must be configured in your config.json
LOXONE_STRUCTURE_FILE	The current structure file of the Loxone Miniserver as an Object {}. Payload: Object Note: allow3rdParty must be configured in your config.json
LOXONE_OSS	Out Of Service status of the Loxone Miniserver. Example: true if the Miniserver is rebooting, false if the Miniserver is up and running. Payload: bool Note: allow3rdParty must be configured in your config.json

Next steps

• Statistics
• Systemstate

License

The MIT License (MIT)

Copyright (c) 2018 David Gölzhäuser

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.