Domoticz

• Each script that you bind to an event (device or timer) is a Lua module with a main function. See the example script. The main function receives the value of the changed device (just a convenience). Every script has access to all global tables created by Domoticz like devicechanged etc.
• Each script returns his part of the commandArray and an optional boolean value that can stop any further processing of scripts when set to false.
• Event bindings can use device ids instead of the device name since the name may change, the id stays the same. You need one of the newer versions of Domoticz for this because it uses the otherdevices_idx table. See the explanation in event_bindings.lua.
• In the logs you can see exactly what script runs and what the final list of commands is that is sent back to Domoticz
• Each cycle can define one or more preprocess and postprocess scripts. So, at the beginning of each cycle (e.g. device change) you can run a script that may do some checking. Perhaps make a switch 'Run scripts' that is checked and when active, the script returns false and execution of all scripts stop. Same for postprocess. It's optional but might be handy.
• You can bind multiple scripts to one event and use the same script for different events.

• The zip contains 5 files: copy them over to the Lua script folder inside your Domoticz folder: e.g. /home/pi/domoticz/scripts/lua.
• The idea is that the two main scripts script_device_main.lua and script_time_main.lua, are the only scripts that are started by Domoticz event system. So you should rename all your other scripts to something with _demo in the name so that Domoticz ignores them. Or move them out of the way. Of course you can do this at a later stage. This system doesn't conflict with what you already have in place!
• Edit event_bindings.lua. This file is the glue between the event system and your event scripts. You have a section for timer events and for device events. The file contains lots of information and instructions but basically it is a list of timer scripts and device+script combinations. It looks like this:

  Code: Select all

  return {
  	device = {
  		preprocess = {'myPreprocessScript1', 'myPrepocessScript2'},
  		postprocess = {'doSomeStuffAtTheEnd'},
  		devices = {
  			['Kitchen light'] = {'handle_kitchen_lights', 'notify_me'},
  			['125'] = {'calculate_energy_usage', 'notify_me'}
  		}
  	},
  	timer = {
  		preprocess = {},
  		postprocess = {},
  		scripts = {
  			'control_bathroom_humidity',
  			'check_windows',
  			'another script'
  		}
  	}
  }
  

  Note that you do not have to add .lua to the script names.
  I have considered using XML or something like that but this is pure Lua and is always faster. All sections in this bindings file are optional.
• Change your existing scripts into 'requireable' lua modules. This is very simple and you can use example_module.lua as the base. Basically you rename your script into something like 'handle_button_blabla.lua' and put some code around your existing code:

  Code: Select all

  return {
  	main = function(value)
  		local commandArray = {}
  		
  		-- your code here
  		
  		return commandArray, true -- return false if you want to stop further script processing  
  	end
  }
  

  
  Maybe you can remove your devicechanged checks that you may have in your existing scripts because they are likely not needed anymore since script_device_main.lua does that for you.

dannybloe wrote:So, I decided to make something just like and move it a step further and make it simple and generic so everybody can use it. I must say it works like a charm and fast (for me course).

-- /home/pi/domoticz/scripts/lua/script_device_framework.lua

function doit(scriptname)
    print('Executing '..scriptname)
    dofile('/home/pi/domoticz/scripts/lua/resources/'..scriptname)
end

commandArray = {}

if devicechanged['Owl'] then
    doit('script_device_owl_log.lua')
elseif (tostring(next(devicechanged)):sub(1,3) == 'PIR') then
    doit('script_device_aapirs.lua')
elseif (tostring(devicechanged[next(devicechanged)]):sub(1,5) == 'Group') then
    doit('script_device_moodscene.lua')
elseif devicechanged['Alarm Set'] then
    doit('script_device_alarm.lua')
elseif (tostring(next(devicechanged)):sub(1,3) == 'Hue') then
    doit('script_device_hue.lua')
elseif (devicechanged[uservariables['PhilipsHueOnCaptureSwitch']]) then
    doit('script_device_hue_scene_capture.lua')
elseif (devicechanged['Hue Effect']) then
    doit('script_device_hue_scene_random.lua')
elseif (devicechanged[uservariables['PhilipsHueIncrementSwitch']]) then
    doit('script_device_hue_scene_increment.lua')
end

return commandArray

nayr wrote:this looks pretty nice, subscribed to check out at a later time..

can yeh make it so it just loads up everything out of a 'event' and 'time' folder so dont have to edit multiple files when creating a script?

return {
	main = function (
		local commandArray = {}
		-- do your stuff		
		return commandArray
	end,
	getTriggers = function()
		return { 'hourly', 'every-other-minute', '12:00', '10:00', 'odd minutes' }
	end
}

dannybloe wrote: We could define a nice list of predefined time triggers here.

dannybloe wrote:... and I'm thinking of a persistent storage mechanism per script where each script receives his own storage and writes back to that storage so you don't need those nasty uservariable storage anymore to keep state between script runs. Allows you to create arrays, dictionaries, temporary values, history data etc. Shouldn't be too hard to make.

1. A on section listing all the triggers
2. An execute method which is called when on of the tirggers occurs.

return {
	on = {
		'<device name>', -- name of the device
		258, -- index of the device
		'timer'  -- causes this script to be called every minute
	},
	execute = function(value)
		local commandArray = {}

		-- do your stuff

		return commandArray, true
	end
}

return {
	on = {
		'Danny@home', 'Thyrsa@home', 'Heleen@home'
	},
	execute = function(value)
		--
	end

nayr wrote:this looks pretty nice, subscribed to check out at a later time..

can yeh make it so it just loads up everything out of a 'event' and 'time' folder so dont have to edit multiple files when creating a script?

Nice, going to try this

For my old and slowly decaying grey mass inside my head:

In the "on" part of my own script I only have to put the index of the device?
or only the name?
or both?

So it's not good to have a device named "timer"

NietGiftig wrote:I'm programming in LUA now for 2 weeks, so i'm rather blanco on this subject

Would you be so kind to put this small (working for me in Domoticz) script in your example so that i can see if I understand the format.
Assume that the idx from the lux sensor is 999

-- Function to strip charachters
function stripchars(str, chrs)
	local s = str:gsub("["..chrs.."]", '')
	return s
end

return {
	active = true,
	on = {
		999   --'LUX Achter'
	},

	execute = function(value)
		
		-- you may check what value is here.. could be that 
		-- you don't have to fetch it from otherdevices_svalues at all

		local V = otherdevices_svalues[lux_sensor]
		
		print('value: ' .. value)
		print('svalue: ' .. V)

		local commandArray = {}
		
		commandArray['Variable:LuxNow'] = stripchars( V, " Lux" )

		return commandArray
	end
}