Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iobroker-community-adapters/iobroker.fhem

Communication with FHEM over Telnet
https://github.com/iobroker-community-adapters/iobroker.fhem

fhem iobroker smarthome

Last synced: 14 days ago
JSON representation

Communication with FHEM over Telnet

Awesome Lists containing this project

README 

        
![Logo](admin/fhem.png)

# ioBroker.fhem



![Number of Installations](http://iobroker.live/badges/fhem-installed.svg)

![Number of Installations](http://iobroker.live/badges/fhem-stable.svg)

[![NPM version](http://img.shields.io/npm/v/iobroker.fhem.svg)](https://www.npmjs.com/package/iobroker.fhem)



![Test and Release](https://github.com/iobroker-community-adapters/ioBroker.fhem/workflows/Test%20and%20Release/badge.svg)

[![Translation status](https://weblate.iobroker.net/widgets/adapters/-/fhem/svg-badge.svg)](https://weblate.iobroker.net/engage/adapters/?utm_source=widget)

[![Downloads](https://img.shields.io/npm/dm/iobroker.fhem.svg)](https://www.npmjs.com/package/iobroker.fhem)



This adapter allows to connect FHEM to ioBroker.



**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](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0.



To enable the connection the telnet must be enabled in FHEM. To enable it (enabled by default) check following settings in `fhem.cfg`:



`define telnetPort telnet 7072 global`



Exactly same port and the IP address of FHEM host (or localhost if FHEM and ioBroker run on same PC) should be used for settings of adapter.



ioBroker sends at the start `jsonlist2` command to get all `Readings` from the list.



## Supported devices

Normally all devices are supported. But some of them are better integrated.



The problems appear especially by controlling of the states.

Because there is no clear attributes structure ioBroker tries to guess which `PossibleSets` fields can be used.

Actually only following attributes are supported:

- RGB: If RGB exists in `PossibleSets` and in `Readings` it will be combined into one state that can be read and written. Values like `#234567` will be automatically converted to `234567`.

- on off state: If `on` and `off` exist in `PossibleSets` and `state` in `Readings`, it will be combined into on state under name `state`. It can be controlled with true and false and commands will be changed to `set DEVICE on` and `set DEVICE off`.



## Features and Usage



* If room "ioBroker" exist in FHEM, only this objects will be synchronized

* After synchronization FHEM unused Objects will be automatically deleted.

* Internals like `TYPE`, `NAME`, `PORT`, `manufacturername`, `modelid`, `swversion` will be synchronized (`role=value.xxx`)

* Attributes like `room`, `alias`, `disable`, `comment` will be synchronized, and it is possible to edit Attributes in ioBroker. (`role=state.xxx`)

* Set role and other during synchronization

  * `Readings xxx` with any `PossibleSets` will be set `role=state.xxx`

  * `Readings xxx` without PossibleSets will be set `role=value.xxx`

  * `Readings xxx` with PossibleSets "noArg" will be set `role=button.xxx`

  * `Readings xxx` with PossibleSets "slider" will be set `role=level.xxx, min=slider(min), max=slider(max)`

  * `Readings "desired-temp"` will be set `role=level.temperature, min=5, max=35, unit=°C`.

  * `Readings "pct, brightness,dim"` will be set `role=level.dimmer, min=0, max=100, unit=%`

  * `Readings "Volume, volume, GroupVolume"` will be set `role=level.volume, min=0, max=100, unit=%`

  * `Readings "GroupVolume"` will be set `role=level.volume.group`, `min=0`, `max=100`, `unit=%`

* `SmartName` for Cloud Adapter will be set automatically with alias or name (only `fhem.0` and objects with `role = level.temperature, level.dim, level.volume`)



## Changelog

### 3.0.0 (2024-07-22)

NodeJS >= 18.x and js-controller >= 5 is required



* (@LausiD) Removed warning from log

* (@klein0r) Updated tests and dependencies



### 2.0.5 (2023-08-13)

* (mcm1957) Dependencies have been updated

* (mcm1957) Adapter now requires node 16



### 2.0.4 (2023-08-13)

* (LausiD) Several problems have been fixed (#213, #214)



### 2.0.3 (2023-01-03)

* (Apollon77/LausiD) Made sure that all objects are initialized correctly



### 2.0.2 (2022-12-23)

* (bluefox) Corrected error with `members`



### 2.0.0 (2022-12-22)

* (bluefox) Refactoring

* (bluefox) Corrected some GitHub issues

* (bluefox) Added JSON config



### 1.6.3 (2021-07-26)

* (Apollon77) fix crash case



### 1.6.2 (2021-07-16)

* (LausiD) fix crash case



### 1.6.1 (2021-06-30)

* (LausiD) fix use Controller 3.3.x

* (Apollon77) js-controller 3.3 optimizations

* (Apollon77) Add Sentry crash reporting



### 1.6.0 (2021-04-09)

* (LausiD) Several fixes and changes



### 1.5.3 (2020-06-30)

* (LausiD) Several fixes



### 1.5.2 (2020-05-15)

* (Apollon77) Fix wrong method calls



### 1.5.0 (2020-05-08)

* (LausiD) Several fixes and changes



### 1.4.3 (2020-03-21)

* (LausiD) fix compact mode



### 1.4.2 (2020-01-10)

* (bluefox) Running timers will be stopped by unload



### 1.4.1 (2019-12-12)

* (LausiD) Several fixes and changes



### 1.4.0 (2019-10-22)

* (LausiD) Optimized adapter



### 1.3.0 (2019-07-14)

* (bluefox) Compact mode was added



### 1.2.2 (2019-06-12)

* (LausiD) Several fixes and changes



### 1.2.1 (2019-03-28)

* (LausiD) Several fixes and changes



### 1.2.0 (2019-02-16)

* (LausiD) Sync readingsGroup, set states ioBroker from FHEM, add different sensors



### 1.1.1 (2018-11-08)

* (LausiD) add debug mode



### 1.1.0 (2018-10-22)

* (LausiD) Sync objects from ioBroker to FHEM is possible



### 1.0.0 (2018-10-15)

* (LausiD) Min/max were defined as number



### 0.5.6 (2018-09-09)

* (LausiD) Some roles were updated



### 0.5.5 (2018-08-22)

* (LausiD) Several fixes and changes

* (bluefox) Admin3



### 0.5.0 (2018-04-29)

* (LausiD) Several fixes and changes



### 0.4.2 (2018-04-15)

* (TonyBostonTB) Fix wordings



### 0.4.1 (2017-04-14)

* (bluefox) add link to FHEM im admin



### 0.4.0 (2017-03-12)

* (LausiD) fix some types

* (bluefox) define custom prompt



### 0.3.0 (2017-02-25)

 * (LausiD) fix some types

 * (bluefox) add password for telnet



### 0.2.2 (2016-06-17)

* (bluefox) implement On/Off state and fix RGB

* (bluefox) add debug output by control



### 0.2.1 (2016-06-12)

* (bluefox) support of RGB values for control



### 0.2.0

* (bluefox) implemented write

* (bluefox) try to read meta information if unknown event received



### 0.1.0

* (bluefox) initial release



## License

The MIT License (MIT)



Copyright (c) 2016-2024 bluefox 



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.