/**
* 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.
*/
/**
* Hier bitte den Speicherort und denPfad eintragen
* Beispiele:
speicherort = '0_userdata.0.'
speicherort = 'javascript.0'
pfad = 'bewasserung.'
pfad = 'Gardena.Bewaesserung.'
*/
speicherort = 'javascript.0'
pfad = 'bewaesserung.'
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) );
}
});
});
}
}
let statesToCreate = [
//Bewässerung
[pfad+'bewaesserung_aktiv', {'name':'bewaesserung_aktiv', 'type':'boolean'} ],
[pfad+'bewaesserung_automatik', {'type': 'boolean','name': 'bewaesserung_automatik'} ],
// Timer
[pfad+'lautzeit_gesamt_in_sek', {'type': 'number','name': 'lautzeit_gesamt_in_sek', 'unit': 'Sekunden'} ],
[pfad+'lautzeit_ende_uhrzeit', {'type': 'string','name': 'lautzeit_ende_uhrzeit', 'unit': 'Uhr'} ],
[pfad+'restlautzeit', {'type': 'string','name': 'restlautzeit', 'unit': "Minuten"} ],
[pfad+'restlautzeit_in_sek', {'type': 'number','name': 'restlautzeit_in_sek', 'unit': 'Sekunden'} ],
// Ventile
[pfad+'ventile.aktives_ventil', {'type': 'string','name': 'aktives_ventil'} ],
[pfad+'ventile.anzahl_aktive_ventile', {'type': 'number','name': 'anzahl_aktive_ventile'} ],
// Ventil 1
[pfad+'ventile.ventil_1.ventil_1', {'type': 'boolean','name': 'ventil_1'} ],
[pfad+'ventile.ventil_1.ventil_1_dauer', {'type': 'number','name': 'ventil_1_dauer','unit': 'Sekunden'} ],
[pfad+'ventile.ventil_1.ventil_1_ende', {'type': 'string','name': 'ventil_1_ende','unit': 'Uhr'} ],
[pfad+'ventile.ventil_1.ventil_1_name', 'Hecke', {'type': 'string','name': 'ventil_1_name'} ],
[pfad+'ventile.ventil_1.ventil_1_restzeit', {'type': 'string','name': 'ventil_1_restzeit','unit': 'Minuten'} ],
[pfad+'ventile.ventil_1.ventil_1_restzeit_in_sek', {'type': 'number','name': 'ventil_1_restzeit_in_sek','unit': 'Sekunden'} ],
// Ventil 2
[pfad+'ventile.ventil_2.ventil_2', {'type': 'boolean','name': 'ventil_2'} ],
[pfad+'ventile.ventil_2.ventil_2_dauer', {'type': 'number','name': 'ventil_2_dauer','unit': 'Sekunden'} ],
[pfad+'ventile.ventil_2.ventil_2_ende', {'type': 'string','name': 'ventil_2_ende','unit': 'Uhr'} ],
[pfad+'ventile.ventil_2.ventil_2_name', 'Rasen', {'type': 'string','name': 'ventil_2_name'} ],
[pfad+'ventile.ventil_2.ventil_2_restzeit', {'type': 'string','name': 'ventil_2_restzeit','unit': 'Minuten'} ],
[pfad+'ventile.ventil_2.ventil_2_restzeit_in_sek', {'type': 'number','name': 'ventil_2_restzeit_in_sek','unit': 'Sekunden'} ],
// Ventil 3
[pfad+'ventile.ventil_3.ventil_3', {'type': 'boolean','name': 'ventil_3'} ],
[pfad+'ventile.ventil_3.ventil_3_dauer', {'type': 'number','name': 'ventil_3_dauer','unit': 'Sekunden'} ],
[pfad+'ventile.ventil_3.ventil_3_ende', {'type': 'string','name': 'ventil_3_ende','unit': 'Uhr'} ],
[pfad+'ventile.ventil_3.ventil_3_name', 'Beet', {'type': 'string','name': 'ventil_4_name'} ],
[pfad+'ventile.ventil_3.ventil_3_restzeit', {'type': 'string','name': 'ventil_3_restzeit','unit': 'Minuten'} ],
[pfad+'ventile.ventil_3.ventil_3_restzeit_in_sek', {'type': 'number','name': 'ventil_3_restzeit_in_sek','unit': 'Sekunden'} ],
// Ventil 4
[pfad+'ventile.ventil_4.ventil_4', {'type': 'boolean','name': 'ventil_4'} ],
[pfad+'ventile.ventil_4.ventil_4_dauer', {'type': 'number','name': 'ventil_4_dauer','unit': 'Sekunden'} ],
[pfad+'ventile.ventil_4.ventil_4_ende', {'type': 'string','name': 'ventil_4_ende','unit': 'Uhr'} ],
[pfad+'ventile.ventil_4.ventil_4_name', 'kl. Rasen', {'type': 'string','name': 'ventil_4_name'} ],
[pfad+'ventile.ventil_4.ventil_4_restzeit', {'type': 'string','name': 'ventil_4_restzeit','unit': 'Minuten'} ],
[pfad+'ventile.ventil_4.ventil_4_restzeit_in_sek', {'type': 'number','name': 'ventil_4_restzeit_in_sek','unit': 'Sekunden'} ],
// Zeitplan
// Morgens
[pfad+'zeitplan.morgens_aktiv', {'type': 'boolean','name': 'morgens_aktiv'} ],
[pfad+'zeitplan.morgens_uhrzeit_start', {'type': 'string','name': 'morgens_uhrzeit_start','unit': 'Uhr'} ],
[pfad+'zeitplan.morgens_uhrzeit_start_stunde', {'type': 'string','name': 'morgens_uhrzeit_start_stunde'} ],
[pfad+'zeitplan.morgens_uhrzeit_start_minute', {'type': 'string','name': 'morgens_uhrzeit_start_minute'} ],
[pfad+'zeitplan.morgens_verzoegerung_sonnenaufgang', {'type': 'string','name': 'morgens_verzoegerung_sonnenaufgang','unit': 'Minuten'} ],
// Abends
[pfad+'zeitplan.abends_aktiv', {'type': 'boolean','name': 'abends_aktiv'} ],
[pfad+'zeitplan.abends_uhrzeit_start', {'type': 'string','name': 'abends_uhrzeit_start','unit': 'Uhr'} ],
[pfad+'zeitplan.abends_uhrzeit_start_stunde', {'type': 'string','name': 'abends_uhrzeit_start_stunde'} ],
[pfad+'zeitplan.abends_uhrzeit_start_minute', {'type': 'string','name': 'abends_uhrzeit_start_minute'} ],
[pfad+'zeitplan.abends_verzoegerung_sonnenuntergang', {'type': 'string','name': 'abends_verzoegerung_sonnenuntergang','unit': 'Minuten'} ],
// Feste Startzeit
[pfad+'zeitplan.feste_startzeit_aktiv', {'type': 'boolean','name': 'feste_startzeit_aktiv'} ],
[pfad+'zeitplan.feste_startzeit_uhrzeit_start', {'type': 'string','name': 'feste_startzeit_uhrzeit_start','unit': 'Uhr'} ],
[pfad+'zeitplan.feste_startzeit_uhrzeit_start_stunde', {'type': 'string','name': 'feste_startzeit_uhrzeit_start_stunde'} ],
[pfad+'zeitplan.feste_startzeit_uhrzeit_start_minute', {'type': 'string','name': 'feste_startzeit_uhrzeit_start_minute'} ],
];
createUserStates(speicherort, false, statesToCreate);
