Merge pull request #3799 from rwaaren/development

rwaaren · web-flow · commit 30eab4f5d72b · 2019-12-17T12:44:24.000+01:00
Update dzVents to V2.5.3 (add triggerHTTPResponse and long runtime warnings)
diff --git a/History.txt b/History.txt
@@ -1,8 +1,9 @@
-Version 4.xxxxx (xxx 2019)
+Version 4.1xxxx (xxx 20xx) see https://www.domoticz.com/wiki/Domoticz_versions_-_Commits for details
 - Implemented: DarkSky CloudCover sensor
 - Implemented: EventSystem, option in Settings to enable/disable URL call logging containing full URL path
 - Implemented: Floorplan, add support for SVG
 - Implemented: GUI, OpenZWave added Refresh Node Information button, styling
+- Implemented: Hue, Add Support for Geo fence sensor, dimmer switches and Hue LCG002 GU10 spot
 - Implemented: RTL433, added Power (Watt) type
 - Implemented: RTL433, added rainfall_mm type
 - Implemented: OZW, JSON call to retrieve current battery levels for all nodes
@@ -12,7 +13,9 @@ Version 4.xxxxx (xxx 2019)
 - Implemented: OZW, Support for Volatile_Organic_Compound (CO2, ppm)
 - Implemented: BuienRadar
 - Implemented: Sun/Rain icons
-- Fixed: Gui, Choosing Icon for ARC type switches
+- Implemented: Add support for Belgian and Luxembourgian P1 meters
+- Fixed: API, allow variabletype to be entered as text or integer in adduservariable and updateuservariable (#3320)
+- Fixed: GUI, Choosing Icon for ARC type switches
 - Fixed: GUI, Dashboard icon incremental counter (energy generated) not correct (#3231)
 - Fixed: GUI, device table initial order column
 - Fixed: GUI, Switch Log, date parsing in device log (#3206)
@@ -22,11 +25,16 @@ Version 4.xxxxx (xxx 2019)
 - Fixed: GUI, Weight Log now displays correct Unit (#3211)
 - Fixed: GUI, OpenZWave Abort Include/Exclude button
 - Fixed: Blockly, handling incorrect time field
-- Fixed: YouLess, possible buffer overflow (#3261)
-- Fixed: notification, Telegram error when odd number of underscores in text
-- Fixed: API, allow variabletype to be entered as text or integer in adduservariable and updateuservariable (#3320)
+- Fixed: Youless, possible buffer overflow (#3261)
+- Fixed: Evohome Web for updated library
+- Fixed: Telegram notification when odd number of underscores in text
+- Fixed: PhilipsHue
+- Updated: Translations
+- Updated: Update domoticz script now running directly in background
+- Updated: Mosquitto to 1.68
 - Updated: OpenZWave version 1.6
-- Updated: dzVents (version 2.5.2 for Lua 5.3) See dzVents/documentation/history.md)
+- Updated: Lua version 5.3
+- Updated: dzVents version 2.5.3 ( https://www.domoticz.com/wiki/DzVents:_next_generation_LUA_scripting )
 
 Version 4.10717 (May 9th 2019)
 - Fixed: dzVents, Allowing no error message for HTTP calls (#3191)
diff --git a/dzVents/documentation/README.md b/dzVents/documentation/README.md
diff --git a/dzVents/documentation/README.wiki b/dzVents/documentation/README.wiki
diff --git a/dzVents/documentation/history.md b/dzVents/documentation/history.md
@@ -1,3 +1,7 @@
+[2.5.3]
+- Add timealert / errors for long running scripts
+- Add triggerHTTPResponse()
+
 [2.5.2]
 - Add actualWatt to replace WhActual (left in WhActual for compatibility reasons)
 - Add toBase64 and fromBase64 function in utils
diff --git a/dzVents/runtime/Domoticz.lua b/dzVents/runtime/Domoticz.lua
@@ -321,6 +321,20 @@ local function Domoticz(settings)
 		end
 	end
 
+	function self.triggerHTTPResponse(httpResponse, delay, message)
+		local httpResponse = httpResponse or _G.moduleLabel
+		local delay = delay or 0
+		local message = 'triggerHTTPResponse: ' .. (message or httpResponse)
+		local url = self.settings['Domoticz url'] .. '/json.htm?type=command&param=addlogmessage&message=' .. self.utils.urlEncode(message)
+				self.openURL  
+				(
+					{
+						url = url,
+						callback = httpResponse,
+					}
+				).afterSec(delay)
+	end
+
 	-- have domoticz send snapshot
 	function self.snapshot(cameraID, subject)
 		if tostring(cameraID):match("%a") then
diff --git a/dzVents/runtime/EventHelpers.lua b/dzVents/runtime/EventHelpers.lua
@@ -29,7 +29,7 @@ local function EventHelpers(domoticz, mainMethod)
 	local _url = 'http://127.0.0.1:' .. (tostring(globalvariables['domoticz_listening_port']) or "8080")
 
 	local settings = {
-		['Log level'] = tonumber(globalvariables['dzVents_log_level']) or  1,
+		['Log level'] = tonumber(globalvariables['dzVents_log_level']) or 1,
 		['Domoticz url'] = _url,
 		url = url,
 		webRoot = tostring(webRoot),
@@ -392,10 +392,19 @@ local function EventHelpers(domoticz, mainMethod)
 			end
 
 			triggerInfo = eventHandler.trigger and ', trigger: ' .. eventHandler.trigger or ''
-
-			utils.log('------ Start ' ..  scriptType ..  moduleLabel ..':' .. moduleLabelInfo .. triggerInfo, utils.LOG_MODULE_EXEC_INFO)
+			local clockTimeStampAtStart = os.clock()
+			local timeStampAtStart = os.time()
+			utils.log('------ Start ' .. scriptType .. moduleLabel ..':' .. moduleLabelInfo .. triggerInfo, utils.LOG_MODULE_EXEC_INFO)
 			self.callEventHandler(eventHandler, device, variable, security, scenegroup, httpResponse)
-			utils.log('------ Finished ' .. moduleLabel, utils.LOG_MODULE_EXEC_INFO)
+			local clockTimeSpend = os.clock() - clockTimeStampAtStart
+			local realTimeSpend = os.time() - timeStampAtStart
+			if realTimeSpend > 9 or clockTimeSpend > 7 then
+				utils.log('------ Finished ' .. moduleLabel .. ' after >' .. realTimeSpend .. ' seconds. (using '.. tostring(clockTimeSpend):sub(1,5) .. ' seconds CPU time !)' , utils.LOG_ERROR)
+			elseif realTimeSpend > 6 or clockTimeSpend > 5 then
+				utils.log('------ Finished ' .. moduleLabel .. ' after >' .. realTimeSpend .. ' seconds. (using '.. tostring(clockTimeSpend):sub(1,5) .. ' seconds CPU time !)' , utils.LOG_FORCE)
+			else
+				utils.log('------ Finished ' .. moduleLabel , utils.LOG_MODULE_EXEC_INFO)
+			end
 
 			restoreLogging()
 		end
diff --git a/dzVents/runtime/Utils.lua b/dzVents/runtime/Utils.lua
@@ -8,7 +8,7 @@ local self = {
 	LOG_MODULE_EXEC_INFO = 2,
 	LOG_INFO = 3,
 	LOG_DEBUG = 4,
-	DZVERSION = '2.5.2', 
+	DZVERSION = '2.5.3', 
 }
 
 function math.pow(x, y)
diff --git a/dzVents/runtime/integration-tests/httpResponseScript.lua b/dzVents/runtime/integration-tests/httpResponseScript.lua
@@ -25,7 +25,7 @@ end
 return {
 	on = {
 		devices = { 'vdHTTPSwitch' },
-		httpResponses = {'trigger1', 'trigger2','trigger3'}
+		httpResponses = {'trigger1', 'trigger2','trigger3', 'vdHTTPSwitch'}
 	},
 	execute = function(domoticz, item)
 
@@ -61,9 +61,15 @@ return {
 				res = res and expectEql(item.statusCode, 6, 'statusCode')
 				if (res) then domoticz.globalData.httpTrigger = domoticz.globalData.httpTrigger .. "OK"  end
 		
+            elseif (item.callback == 'vdHTTPSwitch') then
+				res = res and expectEql(item.statusCode, 200, 'statusCode')
+				if (res) then domoticz.globalData.httpTrigger = domoticz.globalData.httpTrigger .. "OK"  end
+		
 			end
 		
 		elseif item.isDevice then
+            domoticz.triggerHTTPResponse(item.name, 4, item.state )
+            
 			domoticz.openURL({
 				url = 'http://localhost:4000/testget?p=1',
 				method = 'GET',
diff --git a/dzVents/runtime/integration-tests/stage2.lua b/dzVents/runtime/integration-tests/stage2.lua
@@ -780,7 +780,7 @@ end
 local testHTTPSwitch = function(name)
 	local res = true
 	local trigger = dz.globalData.httpTrigger
-	res = res and expectEql('OKOKOK', trigger)
+	res = res and expectEql('OKOKOKOK', trigger)
 	handleResult('Test http trigger switch device', res)
 	return res
 end
diff --git a/dzVents/runtime/misc/testdzVents.sh b/dzVents/runtime/misc/testdzVents.sh
@@ -133,7 +133,7 @@ function fillTimes
 function fillNumberOfTests
 	{
 		Device_ExpectedTests=113
-		Domoticz_ExpectedTests=70
+		Domoticz_ExpectedTests=71
 		EventHelpers_ExpectedTests=32
 		EventHelpersStorage_ExpectedTests=50
 		HTTPResponse_ExpectedTests=6
diff --git a/dzVents/runtime/tests/testDomoticz.lua b/dzVents/runtime/tests/testDomoticz.lua
@@ -227,6 +227,17 @@ describe('Domoticz', function()
 			assert.is_same({ { ['SendSMS'] = 'mes' } }, domoticz.commandArray)
 		end)
 
+	it('should create a url call when triggerHTTPResponse is called', function()
+		domoticz.commandArray = {}
+		domoticz.triggerHTTPResponse('call me Back',12,'hi there')
+		assert.is_same( { OpenURL = {	URL = 'http://127.0.0.1:8080/json.htm?type=command&param=addlogmessage&message=triggerHTTPResponse%3A+hi+there' ,
+										_after = 12,
+										_trigger = 'call me Back',
+										method = 'GET' 
+									} 
+						} , domoticz.commandArray[1])
+	end)
+
 		describe('openURL', function()
 
 			it('should open a simple url', function()
@@ -398,7 +409,6 @@ describe('Domoticz', function()
 			end)
 			assert.is_same({ "device1", "device2", "device3", "device4", "device5", "device6", "device7", "device8", "device9", "device9" }, res)
 
-
 			local found = collection.find(function(device)
 				return device.name == 'device8'
 			end)
@@ -504,7 +514,6 @@ describe('Domoticz', function()
 			end)
 			assert.is_same({ "Scene1", "Scene2" }, res)
 
-
 			local filtered = collection.filter(function(scene)
 				return scene.id < 2
 			end)
@@ -519,7 +528,6 @@ describe('Domoticz', function()
 
 			assert.is_same({ 1 }, res2)
 
-
 			local reduced = collection.reduce(function(acc, device)
 				acc = acc + device.id
 
@@ -566,7 +574,6 @@ describe('Domoticz', function()
 			end)
 			assert.is_same({ "Group1", "Group2" }, values(res))
 
-
 			local filtered = collection.filter(function(group)
 				return group.id < 4
 			end)
@@ -627,7 +634,6 @@ describe('Domoticz', function()
 			end)
 			assert.is_same({ "a", "b", "c", "var with spaces", "x", "y", "z"}, values(res))
 
-
 			local filtered = collection.filter(function(variable)
 				return variable.id < 4
 			end)
@@ -642,7 +648,6 @@ describe('Domoticz', function()
 
 			assert.is_same({ 1, 2, 3 }, values(res2))
 
-
 			local reduced = collection.reduce(function(acc, device)
 				acc = acc + device.id
 
@@ -689,7 +694,6 @@ describe('Domoticz', function()
 			end)
 			assert.is_same({ "device1", "device2", "device5", "device6", "device7", "device8", "device9", "device9" }, values(res))
 
-
 			local filtered = collection.filter(function(device)
 				return device.id < 4
 			end)
@@ -704,7 +708,6 @@ describe('Domoticz', function()
 
 			assert.is_same({ 1, 2}, res2)
 
-
 			local reduced = collection.reduce(function(acc, device)
 				acc = acc + device.id
 
@@ -751,7 +754,6 @@ describe('Domoticz', function()
 			end)
 			assert.is_same({ "a", "b", "c", "var with spaces", "x", "z",  }, values(res))
 
-
 			local filtered = collection.filter(function(var)
 				return var.id < 4
 			end)
@@ -766,7 +768,6 @@ describe('Domoticz', function()
 
 			assert.is_same({ 1, 3 }, values(res2))
 
-
 			local reduced = collection.reduce(function(acc, var)
 				acc = acc + var.id
 
@@ -990,7 +991,7 @@ describe('Domoticz', function()
 		local res = domoticz.utils.toJSON(t)
 		assert.is_same('{"a":1}', res)
 	end)
-	
+
 	it('should dump a table to log', function()
 		local t = { a=1,b=2,c={d=3,e=4, "test"} }
 		local res = domoticz.utils.dumpTable(t,"> ")
@@ -1002,5 +1003,4 @@ describe('Domoticz', function()
 		assert.is_same(domoticz.utils.stringSplit("I forgot to include this in Domoticz.lua")[7],"Domoticz.lua")
 	end)
 
-
 end)
diff --git a/dzVents/runtime/tests/testUtils.lua b/dzVents/runtime/tests/testUtils.lua
@@ -112,14 +112,12 @@ describe('event helpers', function()
 		assert.is_same(utils.leftPad('string',2),'string')
 	end)
 
-
 	it('should center and pad a string', function()
 		assert.is_same(utils.centerPad('string',8),' string ')
 		assert.is_same(utils.centerPad('string',8,'@'),'@string@')
 		assert.is_same(utils.centerPad('string',2),'string')
 	end)
 
-
 	it('should pad a number with leading zeros', function()
 		assert.is_same(utils.leadingZeros(99,3),'099')
 		assert.is_same(utils.leadingZeros(999,2),'999')
@@ -136,7 +134,6 @@ describe('event helpers', function()
 	it('should return false if a file does not exist', function()
 		assert.is_false(utils.fileExists('blatestfile'))
 	end)
-
 	it('should convert a json to a table', function()
 		local json = '{ "a": 1 }'
 		local t = utils.fromJSON(json)
@@ -149,12 +146,12 @@ describe('event helpers', function()
 		assert.is_same(1, t['a'])
 
 		json = nil
-		local fallback  = { a=1 }
+		local fallback = { a=1 }
 		local t = utils.fromJSON(json, fallback)
 		assert.is_same(1, t['a'])
 
 		json = nil
-		fallback  = nil
+		fallback = nil
 		local t = utils.fromJSON(json, fallback)
 		assert.is_nil(t)
 
@@ -166,12 +163,12 @@ describe('event helpers', function()
 		assert.is_same('What a nice feature!', t.testXML)
 
 		local xml = nil
-		local fallback  = { a=1 }
+		local fallback = { a=1 }
 		local t = utils.fromXML(xml, fallback)
 		assert.is_same(1, t['a'])
 
 		local xml = nil
-		fallback  = nil
+		fallback = nil
 		local t = utils.fromXML(xml, fallback)
 		assert.is_nil(t)
 
diff --git a/main/dzVents.cpp b/main/dzVents.cpp
@@ -16,7 +16,7 @@ extern http::server::CWebServerHelper m_webservers;
 CdzVents CdzVents::m_dzvents;
 
 CdzVents::CdzVents(void) :
-	m_version("2.5.2")
+	m_version("2.5.3")
 {
 	m_bdzVentsExist = false;
 }

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ local self = {`
`8`	`8`	`LOG_MODULE_EXEC_INFO = 2,`
`9`	`9`	`LOG_INFO = 3,`
`10`	`10`	`LOG_DEBUG = 4,`
`11`		`- DZVERSION = '2.5.2',`
	`11`	`+ DZVERSION = '2.5.3',`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`function math.pow(x, y)`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ function fillTimes`
`133`	`133`	`function fillNumberOfTests`
`134`	`134`	`{`
`135`	`135`	`Device_ExpectedTests=113`
`136`		`- Domoticz_ExpectedTests=70`
	`136`	`+ Domoticz_ExpectedTests=71`
`137`	`137`	`EventHelpers_ExpectedTests=32`
`138`	`138`	`EventHelpersStorage_ExpectedTests=50`
`139`	`139`	`HTTPResponse_ExpectedTests=6`