Tests:
This adapter requires at least nodejs 18.x!
Fetches all information available in Loxone Miniserver (and Loxone Miniserver Go) and provides changes in realtime.
This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.
Install this adapter via ioBroker Admin:
This is the IP address or host name of your Loxone Miniserver or Miniserver Go.
This is the HTTP port of your Loxone Miniserver.
By default the Miniserver is configured to listen on port 80, but you might have changed it.
Provide a valid username to access the Loxone Miniserver.
It is strongly suggested to use a user different from "admin" for security reasons.
The user only needs read access to the variables you want to use from ioBroker.
Provide the password for the given username (see above).
This will update names in ioBroker whenever they change in the Loxone configuration. If this is disabled, names will only be synchronized the first time a control is detected.
This will populate the enum.rooms enumeration with all rooms provided by the Loxone Miniserver and will link all controls.
This will populate the enum.functions enumeration with all categories provided by the Loxone Miniserver and will link all controls.
Choose what weather data you wish to synchronize:
The adapter automatically connects to the configured Loxone Miniserver and creates states for each control state it finds.
The IDs of the states are formatted like this: loxone.<instance>.<control>.<state>
<instance>
is the ioBroker adapter instance index (usually "0")<control>
is the UUID of the control<state>
is the state within the control (see Supported Control Types for more information).The name provided when configuring a control in Loxone Config will only be used as its display name in ioBroker. This is because a user may choose the same name for multiple controls.
For more information about controls and their states, please also have a look at the Loxone API (especially the Structure File): https://www.loxone.com/enen/kb/api/
By default Loxone Miniserver hides many controls (and thus their states) from the Web interface.
That means, they are also hidden from this ioBroker adapter.
To ensure, all your states are properly reported to ioBroker, please verify that they have "Use" in the "User Interface" section checked:
To see diagnostic inputs (e.g. battery status of Air devices), please verify that the device has "Display diagnostic inputs" checked:
The following global states are currently provided by this adapter:
operatingMode
: the current operating mode number of the Loxone MiniserveroperatingMode-text
: the current operating mode of the Loxone Miniserver as textsunrise
: the number of minutes after midnight when the sun rises todaysunset
: the number of minutes after midnight when the sun goes down todaynotifications
: the number of notificationsmodifications
: the number of modificationsThe following control types are currently supported by this adapter.
Behind the name of the state, you can see the type of the state:
(rw)
: readable and writable: this state can be changed from ioBroker(ro)
: read-only: this state can't be changed from ioBroker(wo)
: write-only: this state's value isn't reported by this adapter, but it can be changed, triggering some action on the Loxone MiniserverProvided by AAL Smart Alarm control.
alarmLevel
(ro) the ID of the current alarm level
alarmCause
(ro) A string representing the last cause for an alarmisLocked
(ro) Reset active, inputs will be ignored and therefore no alarms will be executedisLeaveActive
(ro) Leave input is set, no alarms will be executeddisableEndTime
(ro) End time for the control to be disabledconfirm
(wo) Confirm pending alarmdisable
(wo) Disable control for a certain period of time, no alarms will be executed. Setting it to 0 will reenable the Smart AlarmstartDrill
(wo) Execute test alarmProvided by AAL Smart Emergency Button control.
status
(ro) the ID of the current status
disableEndTime
(ro) End time for the control to be disabledresetActive
(ro) text state with the active reset input (if control is in reset)trigger
(wo) trigger an alarm from the appquit
(wo) quit an active alarmdisable
(wo) disable the control for the given time in seconds. Set to 0 to start control again if it is disabledProvided by burgler alarm control.
armed
(rw) boolean state (true / false) of the alarm; writing true
to this value will immediately turn the alarm on (without the predefined delay)nextLevel
(ro) the ID of the next alarm level
nextLevelDelay
(ro) the delay of the next level in secondsnextLevelDelayTotal
(ro) the total delay of the next level in secondslevel
(ro) the ID of the current alarm level
startTime
(ro) the timestamp when alarm startedarmedDelay
(ro) the delay of the alarm control being armedarmedDelayTotal
(ro) the total delay of the alarm control being armedsensors
(ro) the list of sensorsdisabledMove
(rw) the movement is disabled (true) or not (false)delayedOn
(wo) writing any value to this state arms the alarm with the configured delayquit
(wo) writing any value to this state acknowledges the alarmProvided by central burgler alarm control.
armed
(rw) boolean state (true / false) of the alarm; writing true
to this value will immediately turn the alarm on (without the predefined delay)delayedOn
(wo) writing any value to this state arms the alarm with the configured delayquit
(wo) writing any value to this state acknowledges the alarmProvided by alarm clock control.
isEnabled
(rw) boolean state (true / false) of the alarm clockisAlarmActive
(ro) boolean (true / false) whether the alarm is currently ringingconfirmationNeeded
(ro) boolean (true / false) whether the user needs to confirm the alarmringingTime
(ro) countdown in seconds how long the alarm clock will be ringing until it’s going to snooze againringDuration
(rw) duration in seconds the alarm clock is ringingprepareDuration
(rw) preparation time in secondssnoozeTime
(ro) seconds until snoozing endssnoozeDuration
(rw) duration in seconds of snoozingsnooze
(wo) writing any value to this state snoozes the current alarmdismiss
(wo) writing any value to this state dismisses the current alarmProvided by Music Server Zone.
serverState
(ro) state of the music server:
playState
(rw) the playback state:
clientState
(ro) state of the client:
power
(rw) whether or not the client power is activevolume
(rw) current volumemaxVolume
(ro) zones can be assigned a maximum volumeshuffle
(rw) whether or not playlist shuffle is enabledsourceList
(ro) list containing all zone-favoritesrepeat
(rw) repeat mode:
songName
(ro) song nameduration
(ro) how long the whole track is, -1 if not known (stream)progress
(rw) current position in the trackalbum
(ro) album nameartist
(ro) artist namestation
(ro) station namegenre
(ro) genre namecover
(ro) song/album cover image URLsource
(rw) current selected source identifier (see sourceList
above)prev
(wo) writing any value to this state moves to the previous tracknext
(wo) writing any value to this state moves to the next trackProvided by central Music Server.
control
(wo) sets the play state of all players (true
= play, false
= pause)This device only appears inside a LightController.
red
(rw) red value of the color pickergreen
(rw) green value of the color pickerblue
(rw) blue value of the color pickerSetting one or more of the above states from ioBroker will only send a command to the Miniserver after about 100 ms. This is to prevent the color from changing multiple times for a single user input.
This device only appears inside a Light Controller V2 in Loxone software version 9 and above.
red
(rw) red value of the color pickergreen
(rw) green value of the color pickerblue
(rw) blue value of the color pickerSetting one or more of the above states from ioBroker will only send a command to the Miniserver after about 100 ms. This is to prevent the color from changing multiple times for a single user input.
Provided by timer/schedule.
mode
(ro) current operating mode of the daytimermode-text
(ro) current operating mode name of the daytimeroverride
(ro) the remaining time of the timervalue
(ro) current value, true
or false
for digital and a value for analogvalue-formatted
(ro) current formatted value as textneedsActivation
(ro) only available if the control needs to be activatedresetActive
(ro) stays active as long as the reset input of the daytimer is activepulse
(wo) activates the new value if an entry needs activationProvided by dimmers.
position
(rw) current position for the dimmermin
(ro) current minimum valuemax
(ro) current maximum valuestep
(ro) current step valueon
(wo) writing any value to this state sets the dimmer to the last known positionoff
(wo) writing any value to this state disables the dimmer, sets position to 0 but remembers the last positionProvided by EIB/KNX dimmers.
position
(rw) current position for the dimmeron
(wo) writing any value to this state sets the dimmer to the last known positionoff
(wo) writing any value to this state disables the dimmer, sets position to 0 but remembers the last positionProvided by energy monitor.
prodCurr
(ro) current production powerprodCurrDay
(ro) energy production all over the current dayprodCurrMonth
(ro) energy production all over the current monthprodCurrYear
(ro) energy production all over the current yearprodTotal
(ro) energy production since setting upconsCurr
(ro) current consumption powerconsCurrDay
(ro) energy consumed throughout the current dayconsTotal
(ro) energy consumed since setting updeliveryDay
(ro) unknownearningsDay
(ro) how much money was earned over the current by either consuming the produced power yourself instead of consuming it from the grid, or by exporting unused produced power to the gridearningsMonth
(ro) how much money was earned over the current monthearningsYear
(ro) how much money was earned over the current yearearningsTotal
(ro) how much money was earned since setting upgridCurr
(ro) current grid consumption/delivery power. If negative, power is being delivered to the grid.batteryCurr
(ro) current battery charging/usage power. If negative, the battery is charging.stateOfCharge
(ro) represents the charging state of the battery. 100 = fully charged.co2Factor
(ro) How much co2 does it take to produce one kWh, used to compute CO2 savingsonline
(ro) true: online, false: offlineProvided by gate controls.
position
(ro) the position from 1 = up to 0 = downactive
(rw) current direction of the gate movement
preventOpen
(ro) whether preventing opening of doorpreventClose
(ro) whether preventing closing of doorProvided by central gate control.
open
(wo) opens all gatesclose
(wo) closes all gatesstop
(wo) stops all gate motorsProvided by
total
(ro) total number of seconds the counter has been active so farremaining
(ro) how many seconds left until the next maintenance is requiredlastActivation
(ro) the timestamp when the counter was activated the last timeoverdue
(ro) false
if not overdue, otherwise maintenance is requiredmaintenanceInterval
(ro) seconds until the next maintenanceactive
(ro) whether or not the counter is currently activeoverdueSince
(ro) seconds since the maintainanceInterval was exceededreset
(wo) will cause a reset of the following values
resetAll
(wo) like reset
, but also sets
Provided by virtual states as well as the Loxone Touch switch.
value
(ro) the state value (number) of the controlvalue-formatted
(ro) if configured, the formatted value of the state (using the "Unit" format from Loxone Config)Provided by virtual states as well as the Loxone Touch switch.
active
(ro) boolean state (true / false) of the controlactive-text
(ro) if configured, the text equivalent of the stateactive-image
(ro) if configured, the image equivalent of the stateactive-color
(ro) if configured, the color equivalent of the stateProvided by virtual text states.
text
(ro) the state value of the controltext-formatted
(ro) if configured, the formatted value of the stateProvided by door controllers.
bell
(ro) whether the bell is ringinglastBellEvents
(ro) array containing the timestamps for each bell-activity that wasn't answeredversion
(ro) Loxone Intercoms only - text containing the currently installed firmware
versionsanswer
(wo) writing any value to this state will deactivate the bellThis type of channel might contain other devices. See the respective chapter for more information.
Provided by the intelligent room controller V2 since Miniserver 10.0.
TODO: Documentation currently missing
Provided by different kinds of blinds (automatic and manual).
up
(rw) whether Jalousie is moving updown
(rw) whether Jalousie is moving downposition
(ro) position of the Jalousie, a number from 0 to 1
shadePosition
(ro) shade position of the Jalousie (blinds), a number from 0 to 1
safetyActive
(ro) only used by ones with Autopilot, this represents the safety shutdownautoAllowed
(ro) only used by ones with AutopilotautoActive
(rw) only used by ones with Autopilotlocked
(ro) only by ones with Autopilot, this represents the output QI in Loxone ConfiginfoText
(ro) informs e.g. on what caused the locked state, or what did cause the safety to become active.fullUp
(wo) writing any value to this state triggers a full up motionfullDown
(wo) writing any value to this state triggers a full down motionshade
(wo) writing any value to this state shades the Jalousie to the perfect positionProvided by the central blinds control.
autoActive
(rw) only used by ones with AutopilotfullUp
(wo) writing any value to this state triggers a full up motionfullDown
(wo) writing any value to this state triggers a full down motionshade
(wo) writing any value to this state shades of all blinds to the perfect positionProvided by (hotel) lighting controllers. Scenes can only be modified in the Loxone applications, but can be selected in ioBroker.
activeScene
(rw) current active scene number
sceneList
(ro) list of all scenesplus
(wo) changes to the next sceneminus
(wo) changes to the previous sceneThis type of channel might contain other devices. See the respective chapter for more information.
Provided by (hotel) lighting controllers in Loxone software version 9 and above. Moods can only be modified in the Loxone applications, but can be selected and combined in ioBroker.
moodList
(ro) list of all configured mood namesactiveMoods
(rw) currently active list of mood namesfavoriteMoods
(ro) list of the favorite mood namesadditionalMoods
(ro) list of the non-favorite mood namesplus
(wo) changes to the next moodminus
(wo) changes to the previous moodThis type of channel might contain other devices. See the respective chapter for more information.
Provided by central lighting controller.
control
(wo) turns all lights on or offProvided by Paketsafe Air / Tree.
notificationsDisabledInput
(ro) State of the notifications disabled inputpacketReceived
(ro) State if a packet has been receivedmailReceived
(ro) State if mail has been receiveddisableEndTime
(ro) timestamp until the notifications are disabledconfirmPacket
(wo) Confirm receive of a packetconfirmMail
(wo) Confirm receive of maildisableNotifications
(wo) Disable the notifications for x seconds; 0 seconds for cancelling timerProvided by utility meters.
actual
(ro) the actual value (number)actual-formatted
(ro) if configured, the formatted actual value of the state (using the "Unit" format from Loxone Config)total
(ro) the total value (number)total-formatted
(ro) if configured, the formatted total value of the state (using the "Unit" format from Loxone Config)reset
(wo) writing any value to this state resets the total valueProvided by presence detector.
active
(ro) presence statelocked
(ro) locked stateevents
(ro) the number of eventsinfoText
(ro) reason why the presence detector is lockedProvided by virtual push-button inputs.
active
(rw) the current state of the pushbuttonpulse
(wo) writing any value to this state will simulate the button being pushed only for a very short timeProvided by radio buttons (8x and 16x).
activeOutput
(rw) ID of the currently active output or 0 if none is active ("All Off")Provided by media controller. Basic read only functionality only.
active
(ro) true if the Miniserver is sending the commands for switching the modes or power onmode
(ro) the key for the current mode or 0 if no mode selected ("All Off")"timeout
(ro) the timeout in millisecondsProvided by analog virtual inputs.
value
(rw) the current value of the slidervalue-formatted
(ro) if configured, the formatted value of the state (using the "Unit" format from Loxone Config)error
(ro) indicates an invalid value of the sliderProvided by utility meters.
nextLevel
(ro) the ID of the next alarm level
nextLevelDelay
(ro) delay of the next level in secondsnextLevelDelayTotal
(ro) total delay of the next level in secondslevel
(ro) the ID of the current alarm level
sensors
(ro) the list of sensorsacousticAlarm
(ro) state of the acoustic alarm false for not active and true for activetestAlarm
(ro) whether testalarm is activealarmCause
(ro) the cause of the alarm:
startTime
(ro) timestamp when alarm startedtimeServiceMode
(rw) delay until service mode is disabledmute
(wo) writing any value to this state mutes the sirenequit
(wo) writing any value to this state acknowledges the smoke alarmProvided by virtual input switches.
active
(rw) the current state of the switchProvided by "state".
textAndIcon
(ro) the current value of the stateProvided by stairwell and multifunction switches.
deactivationDelayTotal
(ro) seconds, how long the output will be active if the timer is useddeactivationDelay
(ro) countdown until the output is deactivated
on
(wo) writing any value to this state enables the switch permanently without deactivation delayoff
(wo) writing any value to this state disables the switchpulse
(wo) pulses the switch:
Provided by stairwell and multifunction switches.
entries
(ro) list of entries returned from the miniserverProvided by Virtual Input (Up-Down buttons).
value
(rw) the current value of the inputvalue-formatted
(ro) if configured, the formatted value of the state (using the "Unit" format from Loxone Config)error
(ro) indicates an invalid value of the sliderValue selection.
value
(rw) current valuemin
(ro) current minimum valuemax
(ro) current maximum valuestep
(ro) current step valueProvided by utility meters.
numOpen
(ro) number of open windows & doorsnumClosed
(ro) number of closed windows & doorsnumTilted
(ro) number of tilted windows & doorsnumOffline
(ro) number of windows & doors that are not availablenumLocked
(ro) number of locked windows & doorsnumUnlocked
(ro) number of unlocked windows & doorsThe sum of the values from all these states is equal to the number of windows & doors monitored.? The windows/doors with two states will always be counted to the "worst" state.
For each monitored window / door there will be a device with an index as its ID and the given name. They have the following states:
closed
(ro) the window / door is closedtilted
(ro) the window / door is tiltedopen
(ro) the window / door is openlocked
(ro) the window / door is lockedunlocked
(ro) the window / door is unlockedThe weather server information is provided as a device with multiple channels.
The device is called WeatherServer
.
It contains:
Actual
with the current weather valuesHourXX
where XX
is the number of hours from nowEvery channel contains the following states:
barometricPressure
: numeric barometric pressure valuebarometricPressure-formatted
: formatted barometric pressure value with unitdewPoint
: numeric dew point valuedewPoint-formatted
: formatted dew point value with unitperceivedTemperature
: numeric perceived temperature valueperceivedTemperature-formatted
: formatted perceived temperature value with unitprecipitation
: numeric precipitation valueprecipitation-formatted
: formatted precipitation value with unitrelativeHumidity
: numeric relative humidity valuerelativeHumidity-formatted
: formatted relative humidity value with unitsolarRadiation
: solar radiation valuetemperature
: numeric temperature valuetemperature-formatted
: formatted temperature value with unittimestamp
: timestamp of the data as value.time
(JavaScript time)weatherType
: numeric weather type enumeration valueweatherType-text
: text representation of the weather typewindDirection
: wind direction valuewindSpeed
: wind speed valuewindSpeed-formatted
: formatted wind speed value with unitWhen Loxone adds new control types, they are most often not immediately supported by this adapter.
In this case, the control will have "Unknown:" in front of its name. E.g. Unknown: Wallbox
Those controls will contain all states reported by the Miniserver, but they will all be read-only strings.
If you need better support for a new control type, please follow the steps in the next section to requeset a new feature.
Sentry: unsupported control types will be reported to the developers using Sentry. This way you might get new controls in the next release without having to request it yourself.
Please use the GitHub repository to report any bugs or request new features.
If you require an unsupported control type, please provide the name as it is reported in the error log of ioBroker as well as the entire raw contents of the device in the ioBroker object tree:
Log file example for "LightController":
Native value from ioBroker > Objects
on
/off
instead of active
(#53)Copyright 2023 UncleSamSwiss
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This project is not affiliated directly or indirectly with the company Loxone Electronics GmbH.
Loxone and Miniserver are registered trademarks of Loxone Electronics GmbH.