Domoticz

Code: Select all

{
"auto_off_minutes": 2
}

Code: Select all

2020-09-23 20:46:00.363 Status: dzVents: Info: Generic Auto Off v2.03: ------ Start external script: autoOff.lua:, trigger: every minute
2020-09-23 20:46:00.363 Status: dzVents: Info: Generic Auto Off v2.03: Generic Auto Off v2.03, Domoticz v4.10717, Dzvents v2.4.19.
2020-09-23 20:46:00.416 Status: dzVents: Info: Generic Auto Off v2.03: Device description for XBMC (keuken) is not in json format. Ignoring this device.
2020-09-23 20:46:00.440 Status: dzVents: Info: Generic Auto Off v2.03: Device description for Printer (zolder) is not in json format. Ignoring this device.
2020-09-23 20:46:00.440 Status: dzVents: Info: Generic Auto Off v2.03: Scanned 21 devices.
2020-09-23 20:46:00.440 Status: dzVents: Info: Generic Auto Off v2.03: ------ Finished autoOff.lua

Code: Select all

	[21] = {
		["rawData"] = {
			[1] = "0";
		};
		["lastLevel"] = 0;
		["baseType"] = "device";
		["name"] = "Printer";
		["switchTypeValue"] = 0;
		["description"] = "{\
\"auto_off_minutes\": 2\
}";
		["deviceType"] = "Light/Switch";
		["subType"] = "Switch";
		["changed"] = false;
		["timedOut"] = false;
		["data"] = {
			["usedByCamera"] = false;
			["hardwareID"] = 7;
			["levelVal"] = 0;
			["_nValue"] = 1;
			["maxDimLevel"] = 100;
			["icon"] = "lightbulb";
			["hardwareType"] = "OpenZWave USB";
			["hardwareTypeValue"] = 21;
			["hardwareName"] = "Z-Stick GEN5";
			["unit"] = 1;
			["protected"] = false;
			["_state"] = "On";
		};
		["switchType"] = "On/Off";
		["batteryLevel"] = 255;
		["id"] = 149;
		["lastUpdate"] = "2020-09-24 09:14:27";
		["deviceID"] = "00001001";
		["signalLevel"] = 12;
	};

Code: Select all

["description"] = "{\
\"auto_off_minutes\": 2\
}";

Code: Select all

{"auto_off_minutes": 2}

Code: Select all

2020-09-24 12:18:00.648 Status: dzVents: Error (2.4.19): Device description for Printer is not in json format. Ignoring this device.

Code: Select all

["description"] = "{\"auto_off_minutes\": 2}";

Code: Select all

                    else
                        domoticz.log( 'Device description for '.. device.name ..' is not in json format. Ignoring this device.', domoticz.LOG_WARNING)
                    end

Code: Select all

                    else
                        domoticz.log( 'Device description for '.. device.name ..' is not in json format. Ignoring this device.', domoticz.LOG_WARNING)
                        domoticz.log( 'Device description for '.. device.name ..' = |' .. device.description ..'|', domoticz.LOG_ERROR)
                    end

Code: Select all

--[[
        AutoOff without JSON

        This script will run every minute and can automatically send an 'Off' command to turn off any device after
        it has been on for some specified time. Each device can be individually configured by adding 
        somewhere in the description field of a device.

        <dzAutoOff>maxOnTime:17</dzAutoOff> -- 17 is an example; any integer can be entered 

-- ]]

return {
    on = 
    {
        timer = 
        {
            'every minute'
        },
    },

    logging = 
    {
        marker = 'AutoOff without JSON',
        level = domoticz.LOG_INFO, -- switch to domoticz.LOG_ERROR to silence the log or to domoticz.LOG_DEBUG for locating a potential issue
    },

    execute = function(dz, item)
        local counter = {}

        local function inc(value)
            counter[value] = counter[value] and counter[value] + 1 or 1
        end

        local function getMatchingDescription(description)
            if description == nil or description == '' then return false end
            open = '<dzAutoOff>'
            close = '</dzAutoOff>'
            return description:match(open .. "(.*)" .. close)
        end

        local function mustSwitchOff(minutes, control)
            return tonumber(control:match('maxOnTime:%s*(%d+)')) <= minutes
        end

        dz.devices().filter( function(dv) return dv.active end).forEach( function(dv)
            inc('allActiveDevices')
            local matchingDescription = getMatchingDescription(dv.description)
            if matchingDescription then
                inc('matchingDevices')
                local switchOff = mustSwitchOff((dv.lastUpdate.minutesAgo or math.maxInt), matchingDescription)
                if switchOff then
                    inc('timePassed')
                    dv.switchOff()
                    dz.log(dv.name .. ' is switched off because it has been on for > ' .. dv.lastUpdate.minutesAgo.. ' minutes.', dz.LOG_FORCE)
                end
            end
        end
        )

        dz.log('Scanned: ' .. ( counter.allActiveDevices or 0 ).. ' active devices.',dz.LOG_INFO)
        dz.log('Matching: ' .. ( counter.matchingDevices or 0) .. ' devices.',dz.LOG_INFO)
        dz.log('Max. on time passed: ' .. ( counter.timePassed or 0) .. ' devices.',dz.LOG_INFO)
    end
}

Code: Select all

-- This script will run every minute and can automatically send an 'Off' command to turn off any device after
-- it has been on for some specified time. Each device can be individually configured by putting json coded 
-- settings into the device's description field. The settings currently supported are:
-- - "auto_off_minutes" : <time in minutes>
-- - "auto_off_motion_device" : "<name of a motion detection device>"
-- If "auto_off_minutes" is not set, the device will never be turned off by this script. If 
-- "auto_off_minutes" is set and <time in minutes> is a valid number, the device will be turned off when it 
-- is found to be on plus the device's lastUpdate is at least <time in minutes> minutes old. This behavior 
-- can be further modified by specifying a valid device name after "auto_off_motion_device". When a motion 
-- device is specified and the device's lastUpdate is at least <time in minutes> old, the device will not 
-- be turned off until the motion device is off and it's lastUpdate is also <time in minutes> old. 
-- Specifying "auto_off_motion_device" without specifying "auto_off_minutes" does nothing.
--
-- Example 1: turn off the device after 2 minutes:
-- {
-- "auto_off_minutes": 2
-- }
--
-- Example 2: turn off the device when it has been on for 5 minutes and no motion has been detected for 
-- at least 5 minutes:
-- {
-- "auto_off_minutes": 5,
-- "auto_off_motion_device": "Overloop: Motion"
-- }
--
-- Example 3: turn off the device when it has been on for 1 minute and not motion was detected for at least 1 
-- minute on either one of a set of motion sensors.
--{
--"auto_off_minutes": 1,
--"auto_off_motion_device": ["Overloop 1: Motion 1", "Overloop 1: Motion 2"]
--}

local AUTOOFFVERSION = '2.03'

return {
	on = {

		timer = {
			'every minute'
		}
	},
	logging = {
        level = domoticz.LOG_WARNING,
        marker = 'Generic Auto Off v' .. AUTOOFFVERSION
    },
	execute = function(domoticz, triggeredItem, info)
        local cnt = 0
        
        domoticz.log( 'Generic Auto Off v' .. AUTOOFFVERSION .. ', Domoticz v' .. domoticz.settings.domoticzVersion .. ', Dzvents v' .. domoticz.settings.dzVentsVersion .. '.', domoticz.LOG_INFO)
        
        local now = domoticz.time
        
        domoticz.devices().forEach(
	        function(device)
	            cnt = cnt + 1
	            local description
                local motion_device_names  -- If no settings are found we may still have to
                                           -- remove some device's motion devices from the 
                                           -- trigger lists. So we start with an empty list.

                motion_device_names = {}
                description = device.description

                if description ~= nil and description ~= '' then
                    local ok, settings = pcall( domoticz.utils.fromJSON, description)
                    if ok and settings ~= nil then
                        -- Determine highest level available in the settings that is 
                        -- lower than the current level where 'Off' equals level 0.
                        local dimlevel = nil;

                        -- Determine the list of motion devices configured for this
                        -- device in the settings.
                        if type(settings.auto_off_motion_device) == "string" then
                            table.insert( motion_device_names, settings.auto_off_motion_device)
                        elseif type(settings.auto_off_motion_device) == "table" then
                            for i,v in ipairs(settings.auto_off_motion_device) do
                                table.insert( motion_device_names, v)
                            end
                        end
                    
                        -- Lowest dim level is 'Off', this I will represent as level == 0.
                        -- If auto_off_minutes was specified and the device is not off, I 
                        -- will use this to initialise the dimlevel variable with a level 
                        -- of 0. If the device is off already, we don't need to change it.
                        if settings.auto_off_minutes ~= nil and device.bState then
                            dimlevel = { level = 0, minutes = settings.auto_off_minutes}
                        end
                        
                        -- If one or more dimlevels were specified, the user must think our
                        -- device is a dimmer switch, so it should be safe to reference
                        -- its level attribute. We search for the dimlevel that has the
                        -- highest level below that of our device's level.
                        if settings.auto_off_dimlevel ~= nil and type(settings.auto_off_dimlevel) == "table" then
                            -- if a single dimlevel was specified...
                            if settings.auto_off_dimlevel.level ~= nil then
                                if settings.auto_off_dimlevel.level < 0 then
                                    settings.auto_off_dimlevel.level = 0
                                elseif settings.auto_off_dimlevel.level > 100 then
                                    settings.auto_off_dimlevel.level = 100
                                end
                                    
                                if settings.auto_off_dimlevel.level < device.level then
                                    if dimlevel == nil or settings.auto_off_dimlevel.level > dimlevel.level then
                                        dimlevel = settings.auto_off_dimlevel
                                    end
                                end
                            else
                                -- or when multiple dimlevels were specified as a table of tables.
                                for i,v in ipairs(settings.auto_off_dimlevel) do
                                    if v.level < 0 then
                                        v.level = 0
                                    elseif v.level > 100 then
                                        v.level = 100
                                    end
                                    
                                    if v.level < device.level then
                                        if dimlevel == nil or v.level > dimlevel.level then
                                            dimlevel = v
                                        end
                                    end
                                end
                            end
                        end

                        -- If we have found a new dim level then see if it is time yet to
                        -- set this new level.
                        if dimlevel ~= nil then
                            local minutes = dimlevel.minutes
                            
                            -- Find the latest last modified date from our device plus
                            -- any motion devices that may have been specified. Initially
                            -- assume our device has the latest last modified date.
                            local lastUpdate = device.lastUpdate
                            
                            -- We will skip setting a new level if either of the following is true: 
                            -- at least one of the motion devices has state 'On' or the lastUpdate 
                            -- on our device or any of the specified motion devices is less than 
                            -- <minutes> ago. To accomplish this, lets find out if any of the 
                            -- motion devices has a more recent lastUpdate than that of our device.
                            -- If a motion device has state 'On', we will set lastUpdate to nil,
                            -- indicating we can skip the check for lastUpdate completely.
                            local motion_devices = domoticz.devices().filter(motion_device_names)
                            lastUpdate = motion_devices.reduce(
                                    function(acc, md)
                                        if md.timedOut ~= true then -- Ignore motion devices that have timed out, to 
                                                                    -- avoid leaving the light on because a sensor that 
                                                                    -- has an empty battery isn't updated to 'Off'.
                                            if acc ~= nil then      -- If a previous sensor was 'On', we will have set 
                                                                    -- lastUpdate to nil and we don't want to overwrite
                                                                    -- this.
                                                if md.bState then
                                                    --domoticz.utils._.print( 'Sensor ' .. md.name .. ' is on')
                                                    domoticz.log( 'Motion device ' .. md.name .. ' is On.', domoticz.LOG_DEBUG)

                                                    acc = nil               -- Set lastUpdate to nil to indicate at least 
                                                                            -- one sensor is 'On'.
                                                elseif md.lastUpdate.compare(acc).compare < 0 then  -- If acc < lastUpdate
                                                    domoticz.log( 'Motion device ' .. md.name .. ' was last modified ' .. md.lastUpdate.raw .. '.', domoticz.LOG_DEBUG)
                                                    acc = md.lastUpdate     -- We've found a more recent lastUpdate.
                                                end
                                            end
                                        else
                                            domoticz.log( 'Motion device ' .. md.name .. ' ignored because it timed out. Do you need to replace the battery?', domoticz.LOG_WARNING)
                                        end
                                        return acc -- Always return the accumulator.
                                    end, lastUpdate)

                            if lastUpdate ~= nil and lastUpdate.secondsAgo > tonumber(minutes * 60) then
                                if dimlevel.level > 0 then
            		                domoticz.log(device.name .. ' is dimmed to level ' .. dimlevel.level .. ' after ' .. dimlevel.minutes .. ' minutes.', domoticz.LOG_DEBUG)
                                    device.setLevel(tonumber(dimlevel.level))
                                else
            		                domoticz.log(device.name .. ' is switched off after ' .. dimlevel.minutes .. ' minutes.', domoticz.LOG_DEBUG)
                                    device.switchOff()
                                end
                            end
                        end
                    else
                        domoticz.log( 'Device description for '.. device.name ..' is not in json format. Ignoring this device.', domoticz.LOG_WARNING)
                        domoticz.log( 'Device description for '.. device.name ..' = |' .. device.description ..'|', domoticz.LOG_ERROR)
                    end
                end
            end
        )
    
        domoticz.log('Scanned ' .. tostring(cnt) .. ' devices.', domoticz.LOG_INFO)
	end
}

Code: Select all

{
"auto_off_minutes": 2
}

Code: Select all

2020-09-25 18:12:00.629 Status: dzVents: Debug: Generic Auto Off v2.03: Processing device-adapter for Printer (zolder): Switch device adapter
2020-09-25 18:12:00.630 Status: dzVents: Info: Generic Auto Off v2.03: Device description for Printer (zolder) is not in json format. Ignoring this device.
2020-09-25 18:12:00.631 Status: dzVents: Error (2.4.19): Generic Auto Off v2.03: Device description for Printer (zolder) = |{
2020-09-25 18:12:00.631 "auto_off_minutes": 2
2020-09-25 18:12:00.631 }|
2020-09-25 18:12:00.631 Status: dzVents: Info: Generic Auto Off v2.03: Scanned 21 devices.
2020-09-25 18:12:00.631 Status: dzVents: Info: Generic Auto Off v2.03: ------ Finished autoOff.lua