[Vorlage] Skript: Erstellen von User-Datenpunkten

Patchwork 3001

@xbow42 sagte in [Vorlage] Skript: Erstellen von User-Datenpunkten:

ein paar eigene Datenpunkte anlegen die du in deinen Scripten verwenden will.
Da würde ich den Weg über ioBroker/Objekte gehen und diese unter dem Pfad "0_userdata.0" selbst anlegen.

du willst in deinen Scripten eigene DP erstellen und kennst dich schon mit den {common}-Eigenschaften der DP aus.
erst mal die Doku von @Mic lesen und am besten auch hier abstimmen, damit die Funktion schnell zum ioBroker-Standard wird
<wenn du gleich loslegen willst, um die Funktion->
2.1 in einem eigenen Script zu verwenden: JScript im Scripte-Ordner anlegen (nicht unter global), Code in dein Javascript kopieren, weiter bei 2..
2.2 in vielen eigenen Scripten zu verwenden: unter dem Scripte-Ordner global ein JS-Script anlegen z.B. mit dem Namen createUserStates und den Code dort abspeichern
2.. Im eigenen Script kannst du nun mit dem Funktionsaufruf createUserStates(...); deine DP anlegen. Bsp s. Doku.

danke schön

marcuskl

Ich habe mit dem Skript ein Datenpunkt erstellt, aber ich kann den Datenpunkt nicht auf true setzen, der bleibt immer auf false?
Warum ? Was mach ich falsch ?

let statesToCreate = [
    ['Astro.sonnenuntergang', {'name':'Sonnenuntergang', 'type':'boolean', 'read':true, 'write':true, 'role':'switch' }],
];
createUserStates('0_userdata.0', false, statesToCreate, function(){
    log('Jetzt sind alle States abgearbeitet und wir können nun fortfahren, z.B. nächste Funktion main() aufrufen.');
    main();
});

function main() {
    // Hier dann alles weitere.
    log('Nun sind wir in der main()-Funktion.')

    // Hier der weitere Code...
    
};
/**
 * Create states under 0_userdata.0 or javascript.x
 * Current Version:     https://github.com/Mic-M/iobroker.createUserStates
 * Support:             https://forum.iobroker.net/topic/26839/
 * Autor:               Mic (ioBroker) | Mic-M (github)
 * Version:             1.1 (26 January 2020)
 * Example:             see https://github.com/Mic-M/iobroker.createUserStates#beispiel
 * -----------------------------------------------
 * PLEASE NOTE: Per https://github.com/ioBroker/ioBroker.javascript/issues/474, the used function setObject() 
 *              executes the callback PRIOR to completing the state creation. Therefore, we use a setTimeout and counter. 
 * -----------------------------------------------
 * @param {string} where          Where to create the state: '0_userdata.0' or 'javascript.x'.
 * @param {boolean} force         Force state creation (overwrite), if state is existing.
 * @param {array} statesToCreate  State(s) to create. single array or array of arrays
 * @param {object} [callback]     Optional: a callback function -- This provided function will be executed after all states are created.
 */
function createUserStates(where, force, statesToCreate, callback = undefined) {
 
    const WARN = false; // Only for 0_userdata.0: Throws warning in log, if state is already existing and force=false. Default is false, so no warning in log, if state exists.
    const LOG_DEBUG = false; // To debug this function, set to true
    // Per issue #474 (https://github.com/ioBroker/ioBroker.javascript/issues/474), the used function setObject() executes the callback 
    // before the state is actual created. Therefore, we use a setTimeout and counter as a workaround.
    const DELAY = 50; // Delay in milliseconds (ms). Increase this to 100, if it is not working.

    // Validate "where"
    if (where.endsWith('.')) where = where.slice(0, -1); // Remove trailing dot
    if ( (where.match(/^((javascript\.([1-9][0-9]|[0-9]))$|0_userdata\.0$)/) == null) ) {
        log('This script does not support to create states under [' + where + ']', 'error');
        return;
    }

    // Prepare "statesToCreate" since we also allow a single state to create
    if(!Array.isArray(statesToCreate[0])) statesToCreate = [statesToCreate]; // wrap into array, if just one array and not inside an array

    // Add "where" to STATES_TO_CREATE
    for (let i = 0; i < statesToCreate.length; i++) {
        let lpPath = statesToCreate[i][0].replace(/\.*\./g, '.'); // replace all multiple dots like '..', '...' with a single '.'
        lpPath = lpPath.replace(/^((javascript\.([1-9][0-9]|[0-9])\.)|0_userdata\.0\.)/,'') // remove any javascript.x. / 0_userdata.0. from beginning
        lpPath = where + '.' + lpPath; // add where to beginning of string
        statesToCreate[i][0] = lpPath;
    }

    if (where != '0_userdata.0') {
        // Create States under javascript.x
        let numStates = statesToCreate.length;
        statesToCreate.forEach(function(loopParam) {
            if (LOG_DEBUG) log('[Debug] Now we are creating new state [' + loopParam[0] + ']');
            let loopInit = (loopParam[1]['def'] == undefined) ? null : loopParam[1]['def']; // mimic same behavior as createState if no init value is provided
            createState(loopParam[0], loopInit, force, loopParam[1], function() {
                numStates--;
                if (numStates === 0) {
                    if (LOG_DEBUG) log('[Debug] All states processed.');
                    if (typeof callback === 'function') { // execute if a function was provided to parameter callback
                        if (LOG_DEBUG) log('[Debug] Function to callback parameter was provided');
                        return callback();
                    } else {
                        return;
                    }
                }
            });
        });
    } else {
        // Create States under 0_userdata.0
        let numStates = statesToCreate.length;
        let counter = -1;
        statesToCreate.forEach(function(loopParam) {
            counter += 1;
            if (LOG_DEBUG) log ('[Debug] Currently processing following state: [' + loopParam[0] + ']');
            if( ($(loopParam[0]).length > 0) && (existsState(loopParam[0])) ) { // Workaround due to https://github.com/ioBroker/ioBroker.javascript/issues/478
                // State is existing.
                if (WARN && !force) log('State [' + loopParam[0] + '] is already existing and will no longer be created.', 'warn');
                if (!WARN && LOG_DEBUG) log('[Debug] State [' + loopParam[0] + '] is already existing. Option force (=overwrite) is set to [' + force + '].');
                if(!force) {
                    // State exists and shall not be overwritten since force=false
                    // So, we do not proceed.
                    numStates--;
                    if (numStates === 0) {
                        if (LOG_DEBUG) log('[Debug] All states successfully processed!');
                        if (typeof callback === 'function') { // execute if a function was provided to parameter callback
                            if (LOG_DEBUG) log('[Debug] An optional callback function was provided, which we are going to execute now.');
                            return callback();
                        }
                    } else {
                        // We need to go out and continue with next element in loop.
                        return; // https://stackoverflow.com/questions/18452920/continue-in-cursor-foreach
                    }
                } // if(!force)
            }

            // State is not existing or force = true, so we are continuing to create the state through setObject().
            let obj = {};
            obj.type = 'state';
            obj.native = {};
            obj.common = loopParam[1];
            setObject(loopParam[0], obj, function (err) {
                if (err) {
                    log('Cannot write object for state [' + loopParam[0] + ']: ' + err);
                } else {
                    if (LOG_DEBUG) log('[Debug] Now we are creating new state [' + loopParam[0] + ']')
                    let init = null;
                    if(loopParam[1].def === undefined) {
                        if(loopParam[1].type === 'number') init = 0;
                        if(loopParam[1].type === 'boolean') init = false;
                        if(loopParam[1].type === 'string') init = '';
                    } else {
                        init = loopParam[1].def;
                    }
                    setTimeout(function() {
                        setState(loopParam[0], init, true, function() {
                            if (LOG_DEBUG) log('[Debug] setState durchgeführt: ' + loopParam[0]);
                            numStates--;
                            if (numStates === 0) {
                                if (LOG_DEBUG) log('[Debug] All states processed.');
                                if (typeof callback === 'function') { // execute if a function was provided to parameter callback
                                    if (LOG_DEBUG) log('[Debug] Function to callback parameter was provided');
                                    return callback();
                                }
                            }
                        });
                    }, DELAY + (20 * counter) );
                }
            });
        });
    }
}

Mic-M created this issue in ioBroker/ioBroker.javascript

closed setObject() function: callback not working as intended. #474

Mic-M created this issue in ioBroker/ioBroker.javascript

closed setObject() function: callback not working as intended. #474

Mic-M created this issue in ioBroker/ioBroker.javascript

closed 0_userdata.0: existsState() vs. $-Selector $().length after state deletion #478

xbow42

@marcuskl dieses seltsame Verhalten hatte ich auch mal. Lade mal die Objekte-Seite neu, kontolliere mal ob ['write':true] passt oder starte ggf. den iobroker mal neu. Bei mir ging es dann aufeinmal.
Ich nehme mal an dass es auch im Script funktioniert und nur bei der Darstellung im Browser der neue Wert nicht anzeigt wird.

CruziX

@marcuskl Ist doch glaube beim Alias Skript auch so.
Admin neustarten (wichtig, neustarten nicht aus und wieder einschalten) oder iobroker neustart

marcuskl

Ok danke, versuche ich später mal

marcuskl

@CruziX @xbow42 Den Admin Adapter neu zu starten hatte nichts geändert, ich musste Iobroker komplett neu starten, danach hat es funktioniert

oFbEQnpoLKKl6mbY5e13

@paul53 sagte in [Vorlage] Skript: Erstellen von User-Datenpunkten:

@dslraser sagte:

Es wird jedenfalls dann nicht mit "noch leer" initialisiert ?

Initialisierung mit "noch leer" erfolgt nur, wenn kein common.def vorhanden ist (undefined).

Was ist der Grund dafür?

D3ltoroxp

Kann ich mit diesem Script, solche Einträge irgendwie mit wenig Aufwand erstellen lassen ?

createState('javascript.0.Rasemmaeher.07_Sonntag_Kantenschnitt', {name: "07_Sonntag_Kantenschnitt"});

Mic

@D3ltoroxp

Klar, geht einfach, siehe:
https://github.com/Mic-M/iobroker.createUserStates

Aber:

Hinweis (für alle )

Mit JavaScript-Adapter ab Version 4.6.1 können mittels createState() auch Datenpunkte unterhalb 0_userdata.0 angelegt werden.

https://github.com/ioBroker/ioBroker.javascript#461-2020-05-11
add support for 0_userdata.0 to createState and deleteState

Schranzistor

Guten Morgen

Ist es dann möglich mit dem Baustein CreateState() auch den Datenpunkt nur zu erstellen,
und nicht zu Aktualisieren wen er schon vorhanden ist ? ( wenn zb. 10 drin steht, ihn nicht wieder auf 0 zu setzen Initialwert)

Arbeite mit Blockly, habe gelesen es gibt die forceCreation muss ich die deaktivieren ?

Wenn es so eine Funktion gibt wie müsste ich das in den Datenpunkt erzeugen Blockly Block schreiben ?

Vielen Dank
MFG

paul53

@Schranzistor sagte:

nicht zu Aktualisieren wen er schon vorhanden ist ?

Der Javascript-Adapter enthält an dieser Stelle noch einen Fehler (Issue#597).

Schranzistor

Hallo

vielen dank für die Info

Also wird das Skript von Mic auch nichts helfen da, dort wahrscheinlich der gleiche Fehler greift oder?

Mfg

paul53

@Schranzistor sagte:

Skript von Mic auch nichts helfen

Das Skript von @Mic verwendet für Datenpunkte unter "0_userdata.0" nicht createState(), sollte also funktionieren.

J_Paul

@Mic @paul53
Versuche mich gerade einzulesen, verstehe aber leider (noch) nicht alles, deswegen:
Ich suche gerade eine Möglichkeit aus einem Blockly heraus States in 0_userdata.0 zu erzeugen in der Art (number string boolean):
0_userdata.0.traccar.{"NAME"}.Zuhause.entry
0_userdata.0.traccar.{"NAME"}.Zuhause.lastEnter
0_userdata.0.traccar.{"NAME"}.Zuhause.lastLeave
0_userdata.0.traccar.{"NAME"}.BatterieLevel
0_userdata.0.traccar.{"NAME"}.Position usw.
wobei {"NAME"} idealerweise eine Variable sein sollte. Geht das mit dem Script, oder (mittlerweile) auch direkt im Blockly?

paul53

@J_Paul sagte:

auch direkt im Blockly?

Beispiel, aber nicht mit einer ID, die aus einer Variablen gebildet wird.

stan23

Vielen Dank für das Skript!

Gibt es einen eleganten Weg um eine dynamische Anzahl von Datenpunkten zu erstellen?

/* create datapoints once */
for (let region of listRegion) {
    let statesToCreate = [
        [`${prefixDp}.${region[1]}.${dpToday}`,     {   'name': 'Cases per 100k in the last 7 days, value from today', 
                                                        'type': 'number', 
                                                        'read': true, 'write': true, 
                                                        'min': 0, 'max': 100000}],
        [`${prefixDp}.${region[1]}.${dpYesterday}`, {   'name': 'Cases per 100k in the last 7 days, value from yesterday', 
                                                        'type': 'number', 
                                                        'read': true, 'write': true, 
                                                        'min': 0, 'max': 100000}]
    ]
    createUserStates(prefixUserdata, false, statesToCreate);
}

Jetzt habe ich das Problem dass ich das globale Skript createUserStates zu schnell hintereinander aufrufe, und mir dadurch der dpYesterday mit 0 überschreiben oder gelöscht und neu erstellt wird (das ich mir nicht klar).

Arrays kann man ja nicht dynamisch in der Schleife enzeugen

stan23

Jetzt habe ich das Problem dass ich das globale Skript createUserStates zu schnell hintereinander aufrufe, und mir dadurch der dpYesterday mit 0 überschreiben oder gelöscht und neu erstellt wird (das ich mir nicht klar).

Jetzt ist es mir klar: da ist ein Bug im Skript

Wenn kann Callback angegeben ist, wird das letzte Element im Array immer neu erstellt und damit überschrieben.

@Mic PR ist gestellt:
https://github.com/Mic-M/iobroker-createUserStates/pull/3

stan23 created this issue in Mic-M/iobroker-createUserStates

closed return after last element if there's no callback #3

Mic

@stan23

Vielen Dank für deinen PR, ist jetzt drin

Ich bin ehrlich gesagt nicht glücklich mit diesem Script, im Zuge meiner zwischenzeitlichen Adapter-Entwicklungen und deutlichem Wissensaufbau auch hinsichtlich Promises usw. steckt da noch sehr viel Potenzial drin (positiv ausgedrückt ), zumal ja auch mit createState() ab JavaScript-Adapter ab Version 4.6.1 auch Datenpunkte unterhalb 0_userdata.0 angelegt werden können, und auch das ist noch nicht in diesem Script implementiert.

Der Bedarf für dieses Script scheint aber nach wie vor da zu sein, also in eine Routine mal ein paar Hände voll Datenpunkt-Pfade zu werfen, und diese legt diese für uns an, und erst danach machen wir weiter.
Perfekt für async/await eigentlich.

Mir fehlt gerade etwas die Zeit hierfür, aber möchte euch gerne ermuntern, das zu implementieren. Das auch für Einsteiger m.E. sehr gut geeignet, um in die async/await-Welt einzutauchen

Siehe auch: https://forum.iobroker.net/topic/36999/neu-diverse-async-funktionen-im-javascript-adapter

Falls ein vielfacher Usecase, wäre das auch ein Issue wert für den JavaScript-Adapter selbst. Also dass hier eine Funktion bereit gestellt wird, sofern nicht eh schon über eine simple Schleife abbildbar jetzt dank der neuen Funktionalitäten.

Spegeli

//Edit: Mein Problem hat sich mittlerweile erledigt

passuff

Ich habe das Skript lange Zeit erfolgreich genutzt. Kürzlich habe ich die Datenpunkte neu erstellen wollen, nachdem ich iobroker neu aufgesetzt hatte. Wie es scheint, kann das System die mit dem Skript erstellten Datenpunkte nicht lesen. Zumindest triggern skripte nicht auf Änderungen der Datenpunkte. Wenn ich über die Admin Oberfläche Datenpunkte erstelle, funktioniert es aber tadellos.
Ich habe versucht die Eigenschaften zu vergleichen, konnte jedoch nichts ungewöhnliches feststellen. Hat jemand eine Idee?

NEWS

[Vorlage] Skript: Erstellen von User-Datenpunkten

closed setObject() function: callback not working as intended. #474

closed setObject() function: callback not working as intended. #474

closed 0_userdata.0: existsState() vs. $-Selector $().length after state deletion #478

Hinweis (für alle )

closed return after last element if there's no callback #3

Support us

461
Online

31.6k
Users

79.5k
Topics

1.3m
Posts

NEWS

[Vorlage] Skript: Erstellen von User-Datenpunkten

closed setObject() function: callback not working as intended. #474

closed setObject() function: callback not working as intended. #474

closed 0_userdata.0: existsState() vs. $-Selector $().length after state deletion #478

Hinweis (für alle )

closed return after last element if there's no callback #3

Support us

461Online

31.6kUsers

79.5kTopics

1.3mPosts

461
Online

31.6k
Users

79.5k
Topics

1.3m
Posts