Changes and compatibility
Changes since version 2.8 that affect existing integrations
This page collects the changes since version 2.8 that can affect an existing integration: removed calls, changed formats and new requirements. New calls are listed in the release notes and in the API reference.
A controller's version is returned by softwareUpdateCheck in the field versionInstalled. getVersion, by contrast, names the versions of the individual building blocks (api, ncd, engine), not that of the controller.
3.4.0
- Unknown yes/no values: If a device has not reported a yes/no value yet,
valueis nownullinstead offalse. This affectsgetComponentDataand the component lists, for example. Check forfalseonly if the value must really have been reported.
3.2.0
- Events only after the login: A Socket.io connection receives events only once it is logged in. Before that, only
stateChangeforapp,bus,engineandsystemreaches it. - Logout:
logoutcloses the connection it came through and every other connection of the same session. - Changed users: If a user is removed or disabled, or gets a new password or another group, the controller ends their sessions and closes their connections, including those logged in with
authwithout a session. Your program must expect the controller to close the connection and must reconnect. See Sessions. - Camera streams over
/janus: The controller checks every message instead of passing it through to Janus. Only the requests a camera view needs go on: session and streaming plugin, pluswatch,switch,start,pauseandstop.watchandswitchapply only to streams of cameras the user may see; an admin may watch any stream. Other requests, such as creating or changing mountpoints, get a Janus error from the controller, for admins too. An invalid or already used token is refused with HTTP 403. - Users without admin rights no longer receive credentials:
getCameras, also throughgetEverything, returns only scheme, host and port inurl, without login, path and parameters.getJanusConfigurationreturns noapisecret; on the/janusconnection the controller adds it itself.getJanusOneTimeTokenanswers with error code 117 if the user may see no camera.getCloudStatusreturns only the connection status (status,connected,connecting,enabled,registered,syncEnabled), not the linked account.getProfileMetareturns onlyenabledandstatus.getMQTTStatusreturns the broker address without credentials.- The component lists contain no
configOverridesfor add-ons. getSIPClientsreturns only the user's own SIP clients and those for all users. TheonSIPClientAddedevent contains nouserAgentOptions.
3.1.0
- Administrator passwords: An administrator account needs a password of at least 6 characters. Creating or changing one with a shorter or empty password returns error code 106 ("Administrator accounts require a password of at least 6 characters"; the text follows the language of the connection). Existing accounts are left as they are.
- Software updates:
softwareUpdateCheck,getAutoSoftwareUpdateInfo,enableAutoSoftwareUpdateandinstallSoftwareUpdatesdistinguish between security and feature updates.postponeSoftwareUpdateis new. - Node-RED: version 5.0.7.
3.0.0
- Removed:
getUserAuth,enableUserAuthanddisableUserAuth. - Changed format:
getSystemSerialPortsreturns objects with device path and a description of the connected hardware instead of a list of device paths. - MQTT: The controller only uses its own broker; an external broker can no longer be configured. Controller and engine log in with their own, automatically managed accounts, so renaming the MQTT user no longer cuts their connection. See MQTT.
- Cameras: The camera list and a camera's stream follow the user's room permissions.
- Camera and cover images: Forwarding the images requires authentication. A client that cannot send a session along fetches a short-lived token for exactly one image with
getForwarderToken. - Users: The display name is limited to 64 characters. With
setCurrentUser, a signed-in user changes their own display name without administrator rights.
2.8.7
- System variables: The parameter
defaultValueis gone fromaddSystemVariableandsetSystemVariable, from the replies ofgetSystemVariableandgetSystemVariablesand from the eventonSystemVariableAdded.
2.8.5
- MQTT: When the skill is switched on, the controller generates credentials if none are set yet. Clients that used to connect without authentication then need user name and password.
2.8.4
- MQTT: Once credentials are set, the controller secures its own broker with them and rejects clients without authentication. The security check warns when none are set.
- mRemote: Port 5500 for the mRemote GUI is closed.
2.8.2
- Socket.io v4: Current clients connect with Socket.io v4 through the path
/socket.io-v4. The path/socket.iofor Socket.io v2 remains. See Connect and Authenticate. - File uploads: The calls
importKNXProject,importLutronProject,importAddonProfile,importBackup,importRoomImage,importFloorImage,importKeyfile,importLogoandimportUpdateaccept files directly, as an alternative to the SocketIOFileUpload library. - MCP: The controller offers an MCP server (beta). See MCP.
- Removed:
setTimerPosition,setNotificationPositionand the tado° calls. - KNX projects:
downloadKNXProject,removeKNXProject,getKNXMainGroups,getKNXMiddleGroups,getKNXTopologyandgetKNXGroupAddressestake the project name as a parameter and answer with error code 112 if the project does not exist. - Node-RED: node-red-contrib-nomos from version 1.5.3 on needs a controller running version 2.8.2 or later. See Node-RED.
2.8.1
- Room and scene permissions: Permissions can be restricted to rooms and scenes per user and group, with the calls
getUserRoomPermission,setUserRoomPermission,getUserScenePermission,setUserScenePermissionand their counterparts for groups. A restricted user only reads and switches over the API what these permissions allow.
2.8.0
- Hardware: Controllers with an ARM v7 processor are no longer supported.