Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including iobroker.hm-rpc with all npm packages installed. Try it out:

var iobrokerHmRpc = require("iobroker.hm-rpc")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

iobroker.hm-rpc v1.14.24

Connects HomeMatic Interface-Processes (BidCos-Services, Homegear and CUxD) via XML-RPC or BIN-RPC to ioBroker

Logo

ioBroker HomeMatic RPC Adapter

Build Status Number of Installations Number of Installations NPM version Downloads

NPM

Connects HomeMatic Interface-Processes (BidCos-Services, Homegear and CUxD) via XML-RPC or BIN-RPC to ioBroker

Configuration

HomeMatic Address

Homematic Address is the IP of the HomeMatic CCU respectively the Host that is running the BidCos-Service(s). CCU IP address.

HomeMatic Port

CCU Port.

Usually:

  • 2001 for wireless devices (https: 42001),
  • 2000 for wired devices (https: 42000),
  • 8701 for CUxD daemon,
  • 2010 for Homematic IP devices (https: 42010)
  • 9292 for Virtual Devices (https: 49292)

Daemon

CCU/Homematic can support different types of devices (wired, wireless, hmip, CUxD) and for every type you should create the instance of adapter separately.

Protocol

There are two protocols for communication XML-RPC and BIN-RPC. BIN-RPC is faster, but it can be, that the end device do not support it or supports it incorrect. In this case switch the protocol to XML.

Notice: CUxD can only communicate with BIN-RPC and HMIP and RFD only via XML-RPC protocol.

Synchronize objects (once)

After very first start the instance read all devices from CCU/Homematic. If you changed the configuration (rename devices, add or removed devices) you can synchronise the configuration in ioBroker by enabling this option.

The instance will be restarted immediately, synchronize all devices anew and deactivate this option itself.

Adapter Address

This address has to be the IP under which the host that is running the adapter itself is reachable. This address is used by the CCU to connect to the adapter. This address cannot be "0.0.0.0", because CCU/Homematic cannot reach ioBroker under "0.0.0.0" IP address.

Adapter port

The port number on which the ioBroker will run. Let it 0 for automatically selection.

Adapter Callback Address

Sometimes the ioBroker server runs behind the router, to solve this problem, that inboud and outbound addresses are different, this option can be used. Here you can define the IP address of the router and the router will according to the port route the traffic to ioBroker.

Used if ioBroker runs in Docker.

Check communication interval(sec)

Send pings to CCU/Homematic with such intervall.

Reconnect interval (sec)

How many seconds will be waited before connect attempts.

Don't delete devices on adapter start

If this flag is not activated, the ioBroker will remove devices from configuration if device is not found at adapter start in CCU/Homematic. Activate this flag to do not delete such a devices. This is to avoid a bug on CCU side, where hmip devices are not correctly transmitted to ioBroker and thus will be deleted on adapter startage and be recreated when transmitted some milliseconds later. The flag is automatically checked when you selected hmip as daemon. However, when you delete devices while adapter is running, the adapter will be notified by CCU and will remove devices which are removed on CCU.

Use https

If this flag is activated, the connection will be established via https instead http. This only works with XML-RPC protocol.

Username and password

If 'use https' is activated you can fill in the username and password of a CCU user. In case the CCU needs authentication on the API, you have to provide the credentials here.

Custom commands

It is possible to send custom commands, e. g. to read and control the master area of a device which allows the user to configure heating week programs and more.

This is done by sending a message to the adapter, which contains the method as first parameter, followed by an object which has to contain the ID of the target device as well as optional the paramType, which specifies e. g. the MASTER area. Additional parameters have to be sent in the params object.

Examples:

Log all values of the MASTER area of a device:

sendTo('hm-rpc.0', 'getParamset', {ID: 'OEQ1861203', paramType: 'MASTER'}, res => {
    log(JSON.stringify(res));
});

Set an attribute of the MASTER area to a specific value:

sendTo('hm-rpc.0', 'putParamset', {ID: 'OEQ1861203', paramType: 'MASTER', params: {'ENDTIME_FRIDAY_1': 700}}, res => {
    log(JSON.stringify(res));
});

List all devices:

sendTo('hm-rpc.0', 'listDevices', {}, res => {
    log(JSON.stringify(res));
});

Set a value, like the adapter does on stateChange:

sendTo('hm-rpc.1', 'setValue', {ID: '000453D77B9EDF:1', paramType: 'SET_POINT_TEMPERATURE', params: 15}, res => {
    log(JSON.stringify(res));
});

Get the paramsetDescription of a devices channel:

sendTo('hm-rpc.1', 'getParamsetDescription', {ID: '000453D77B9EDF:1', paramType: 'VALUES'}, res => {
    log(JSON.stringify(res));
});

Get firmware information of a device (in this case we are logging the FW status):

sendTo('hm-rpc.1', 'getDeviceDescription', {ID: '0000S8179E3DBE', paramType: 'FIRMWARE'}, res => {
    if (!res.error) {
        log(`FW status: ${res.result.FIRMWARE_UPDATE_STATE}`)
    } else {
        log(res.error)
    }
});

Additional information

If you use HomeMatic switches or remotes their button states will only be acknowledged by CCU and thus by ioBroker, when you have a running 'dummy' program on the CCU which depends on the related switch or remote.

Changelog

1.14.24 (2020-10-15)

  • (foxriver76) fixed error with some blinds if no adapter restart has been performed

1.14.23 (2020-09-03)

  • (foxriver76) value.temperature will have unit °C no matter of delivered unit by CCU

1.14.21 (2020-08-18)

  • (foxriver76) fixed virtual-devices objects being recreated on instance startage (#271)

1.14.20 (2020-08-17)

  • (foxriver76) fix for % scaling of float numbers

1.14.19 (2020-08-16)

  • (foxriver76) now logging exact command on error

1.14.18 (2020-08-08)

  • (foxriver76) fix issue when CuxD listDevices does not deliver valid array
  • (foxriver76) fix error with % scaling in some edge cases

1.14.15 (2020-07-21)

  • (foxriver76) fix bug on forced reinitialization run

1.14.14 (2020-07-10)

  • (bluefox) Added roles for presence sensor

1.14.13 (2020-07-07)

  • (foxriver76) fix edge case on EPAPER command (IOBROKER-HM-RPC-5Z)
  • (foxriver76) Catch error on createDevices if CCU does not deliver valid ADDRESS (IOBROKER-HM-RPC-5X)

1.14.12 (2020-07-03)

  • (foxriver76) Continue execution if error on retrieving a paramset from CCU

1.14.11 (2020-06-21)

  • (bluefox) Change name of Instance according to the role (RF, Wired, HMIP)

1.14.10 (2020-06-14)

  • (foxriver76) removed meta data caching completely because meta data can be dynamic due to FW update or CuxD

1.14.6 (2020-06-05)

  • (foxriver76) added some hmip roles for channel 0

1.14.5 (2020-05-29)

  • (foxriver76) fixed edge case problem IOBROKER-HM-RPC-5E

1.14.4 (2020-05-28)

  • (jens-maus) updated all device images to latest ones include hmip-wired ones

1.14.3 (2020-05-18)

  • (foxriver76) catch edge case error if row.value has no native

1.14.2 (2020-04-24)

  • (foxriver76) catch errors on rpc client creation

1.14.1 (2020-04-23)

  • (foxriver76) catch potential errors on createServer
  • (foxriver76) new meta data approach: we only store meta data gathered by the user, otherwise cached meta data can be very old and outdated, we have to monitor performance of this approach (more requests to CCU on first setup)
  • (foxriver76) add name and icon to meta folder
  • (foxriver76) minor code improvements

1.13.0 (2020-04-02)

  • (foxriver76) sentry plugin support

1.12.10 (2020-03-05)

  • (foxriver76) fixed no 'dpType for ..' error in all cases

1.12.9 (2020-02-29)

  • (foxriver76) replace DISPLAY_DATA_STRING by DIN_66003 encodings

1.12.8 (2020-02-26)

  • (foxriver76) improved error handling on undefined methods

1.12.7 (2020-02-16)

  • (foxriver76) if role "value.window" is a boolean it is now correctly a "sensor.window"

1.12.6 (2020-01-08)

  • (foxriver76) make all LEVEL dps of unit % if they are w.o. unit and have min/max

1.12.5 (2020-01-06)

  • (foxriver76) handle some meta data more abstract
  • (foxriver76) make DIMMER_REAL.LEVEL of unit '%' even it is not by definition

1.12.2 (2019-12-19)

  • (foxriver76) fix issue on https with less robust ccu emulations

1.12.1 (2019-12-06)

  • (foxriver76) fixed problem with max values of value lists

1.12.0 (2019-12-05)

  • (foxriver76) no longer use adapter.objects
  • (foxriver76) js-controller v > 2 required

1.11.1 (2019-11-20)

  • (foxriver76) LOCK.OPEN is now of type button to prevent misunderstandings

1.11.0 (2019-11-10)

  • (foxriver76) make OFFSET and REPEATS of epaper configurable
  • (foxriver76) EPAPER_SIGNAL is now type string

1.10.3 (2019-10-27)

  • (foxriver76) fixed info channel

1.10.2 (2019-10-24)

  • (foxriver76) replace min max values of hmip with correct numbers

1.10.0 (2019-08-12)

  • (foxriver76) new meta data handling procedure
  • js-controller >= 1.4.2 required

Older entries

here

License

The MIT License (MIT)

Copyright (c) 2014-2020 bluefox dogafox@gmail.com

Copyright (c) 2014 hobbyquaker

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.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free