Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaozmc/iobroker.oekofen-json
Connect ioBroker to OekoFEN Pellematic via JSON
https://github.com/chaozmc/iobroker.oekofen-json
iobroker iobroker-adapter iobrokeradapter json-api oekofen pellematic pellet-stove
Last synced: about 1 month ago
JSON representation
Connect ioBroker to OekoFEN Pellematic via JSON
- Host: GitHub
- URL: https://github.com/chaozmc/iobroker.oekofen-json
- Owner: chaozmc
- License: mit
- Created: 2022-06-11T00:07:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T00:50:38.000Z (5 months ago)
- Last Synced: 2024-10-31T00:24:11.977Z (about 2 months ago)
- Topics: iobroker, iobroker-adapter, iobrokeradapter, json-api, oekofen, pellematic, pellet-stove
- Language: JavaScript
- Homepage:
- Size: 396 KB
- Stars: 4
- Watchers: 4
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG_OLD.md
- License: LICENSE
Awesome Lists containing this project
README
# ioBroker.oekofen-json
[](https://www.npmjs.com/package/iobroker.oekofen-json)
[](https://www.npmjs.com/package/iobroker.oekofen-json)
[](https://david-dm.org/chaozmc/iobroker.oekofen-json)
[](https://nodei.co/npm/iobroker.oekofen-json/)
**Tests:** 
## oekofen-json adapter for ioBroker
### Description
This adapter connects a OekoFEN heater with the new touch interface (also called [Pelletronic Touch](https://www.oekofen.com/en-gb/pelletronic-touch/)) to ioBroker. As OekoFEN implemented the JSON interface step by step and without public available documentation it should work at least with Version 3.10d and newer.
As there are many combinations of heaters, solarmodules, layer storages, sterling engines etc. out there, this adapters tries to read all available datapoints from the interface and creates the objects on the fly at startup.
Read-Only datapoints are created as such as these starts mit L_ prefix in their name. Also converts the adapter the number's scaling according to the informations provided by the interface (factor attribute). For example, the heater deals with temperatures in the format XXX and factor 0.1, this will be converted by the adapter to XX.X on read operations and back to XXX on write operations.
### Installation
After installation, it's just required to enter
* the IP,
* TCP port,
* the "so-called" password
* and the interval
at which the adapter tries to pull the updates.
The adapter maintains the connected state, even there's no real permanent connection. If the device sends an error or the adapter isn't able to contact the OekoFEN controller it set's the connected state to false. For example this could happen if there are too many requests on the controller, which answers with HTTP 401 then. Under normal conditions the rate limit of the controller shouldn't be hit (2,5 seconds between requests).
## Changelog
### 1.0.5 (2023-09-23)
* (chaozmc) set min node version to 18.x (merge pull request #23)
### 1.0.4 (2023-09-22)
* (chaozmc) Removed Node 16.x from Test-and-release (fix Issue #19)
* (chaozmc) updated dependencies
* (chaozmc) updated protobufjs and google-gax
* (chaozmc) updated word-wrap
### 1.0.3 (2023-05-09)
* (chaozmc) Bump version
### 1.0.2 (2023-05-09)
* (chaozmc) Added missing translations
* (chaozmc) Updated Copyright Year
* (chaozmc) Added .releaseconfig.json for release-script
* (chaozmc) changed github workflow config
### 1.0.1 (2023-01-21)
* (chaozmc) Fixed extensive object creation when using a wrong password (fixes Issue #18)
* (chaozmc) Added counter to stop adapter after 10 unsuccessful requests
* (chaozmc) Added check if there would be more than 50 top-level-objects to be created
### **0.0.3**
* (chaozmc) code cleanup, trigger for update & rescan
### **0.0.2**
* (chaozmc) first working release, fixed 0-value updates
### **0.0.1**
* (chaozmc) initial build phase, much try and error
## License
MIT License
Copyright (c) 2023 chaozmc
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.