Iobroker-jsonexplorer NPM

ioBroker JsonExplorer

How to prepare

Create file /lib/stateAttr.js in your adapter directory based on template _template/stateAttr.jsand add

const jsonExplorer = require('iobroker-jsonexplorer');
const stateAttr = require(__dirname + '/lib/stateAttr.js'); // Load attribute library
in section "Load your modules here"
Install iobroker-jsonexplorer by using npm i iobroker-jsonexplorer

Add line jsonExplorer.init(this, stateAttr); to the adapter constructor, where "this" is your adapter class object.

How to use

Call await JsonExplorer.TraverseJson(result, parent, replaceName, replaceID);
result: JSON object to be added as states
parent: name of the parent state; null results in root
replaceName: true|false; if true, the description of a channel will be replaced by the name of a leaf-state if available (search for a state with id "name")
replaceID: true|false; if true, the description of a channel will be replaced by the id of a leaf-state if available (search for a state with id "id")

Expire management (optional)

All states can be monitored and set to NULL if it is not updated in the last run by calling jsonExplorer.setLastStartTime() before calling jsonExplorer.traverseJson() and jsonExplorer.checkExpire('*') after caling JsonExplorer.TraverseJson()

Reference implementation

https://github.com/HGlab01/ioBroker.fuelpricemonitor

Changelog

0.1.15 (2023-12-11)

(HGlab01) fix coding-typo

0.1.14 (2023-10-08)

(HGlab01) add versionInfo
(HGlab01) add modify-methods 'toFloat' and 'toInteger'
(DutchmanNL) couple of code improvements

0.1.13 (2023-10-03)

(HGlab01) fix #113 "Cannot read properties of undefined (reading 'Warning')"

0.1.12 (2023-07-03)

(HGlab01) Improve statename verification

0.1.11 (2023-04-12)

(HGlab01) Improve stateSetCreate
(HGlab01) no longer support for state expire
(HGlab01) TraverseJson() --> traverseJson()
(HGlab01) provide sleep()

License

MIT License

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.