Domoticz

Code: Select all

--[[ getGarbageDates.lua for [ dzVents >= 2.4 ]

this script is only useful in those  areas of the Netherlands where circulus-berkel is the garbage collector

Enter your zipcode and housenumber and your virtual text and or virtual alert device in the 
appropriate place between the lines starting with --++++

the text device will contain the most nearby collectdates for the four types of household garbage
the alert device will contain the date and type for the garbagecollection that will arrive first
]]--

local prefix        = "getGarbageDates"
local httpresponse  = prefix .. "Response"
local triggerDevice = prefix .. "Trigger"
local logMarker     = prefix .. "Marker"

return 
        {
     on      =  {   devices        =   { triggerDevice },            -- Just for development and test ; ignored when live
                    timer          =   { "at 00:05","at 08:00" },    -- daily run twice
                    httpResponses  =  { httpresponse }               -- Trigger the handle Json part
                },

--    logging =   {   level       =   domoticz.LOG_DEBUG,              -- Remove the "-- at the beginning of this and next line for debugging the script
--                  marker        =   logMarker      },

    data    =   {   garbage     = { initial = {} },                  -- Keep a copy of last json just in case
                    bagID       = { initial = "Not set yet" },           
                    ZipCode     = { initial = "not set yet" },
                    HouseNumber = { initial = "not set yet" },
                },

    execute = function(dz, triggerObject)

        --++++--------------------- Mandatory: Set your values and device names below this Line --------------------------------------
        local myZipCode     = "7328CK"
        local myHouseNumber = 46
        local myTextDevice  = "GarbageText"       -- Name with quotes or idx without when created as virtual text device
        local myAlertDevice = "GarbageAlert"      -- Name with quotes or idx without when created as virtual alert device
        --++++---------------------------- Set your values and device names above this Line --------------------------------------------
        
        local myProvider    = "https://afvalkalender.circulus-berkel.nl" 
        local myYear        = os.date("%Y")

        garbageTypes  = {13,7,8,10}                -- Valid for circulus-berkelfor but these numbers vary per garbageCollector; Why ??
         -- ("13","  Boeken, Elektrische apparaten, Speelgoed en Textiel  ")
         -- ("7","  Groente-, fruit- en tuin afval            ")
         --  ("10","  Papier en kartonnen verpakkingen          ")
         --  ("8","  Restafval                                ")

        -- get BagId based on Zipcode / Housenumber 
        local function collectBagId(secondsFromNow)
            local getBagId_url  = myProvider .. "/rest/adressen/" .. myZipCode .."-" .. myHouseNumber
            dz.openURL  ({  url         = getBagId_url ,
                            method      = "GET",
                            callback    = httpresponse}).afterSec(secondsFromNow)
        end
        
        -- get garbage collect Year calendar 
        local function collectGarbageDates(secondsFromNow)
            local getGarbage_url  = myProvider .. "/rest/adressen/" .. dz.data.bagID .. "/kalender/" .. myYear
            dz.openURL  ({  url         = getGarbage_url ,
                            method      = "GET",
                            callback    = httpresponse}).afterSec(secondsFromNow)
        end

        -- Add entry to log and notify to all subsystems
        local function errorMessage(message)
            dz.log(message,dz.LOG_ERROR)
            dz.notify(message)
        end

        local function string2Epoch(dateString) -- seconds from epoch based on stringdate (used by string2Date)
            -- Assuming a date pattern like: yyyy-mm-dd
            local pattern = "(%d+)-(%d+)-(%d+)"
            local runyear, runmonth, runday= dateString:match(pattern)
            local convertedTimestamp = os.time({year = runyear, month = runmonth, day = runday})
            return convertedTimestamp
        end

        local function string2Date(str,fmt)             -- convert string from json into datevalue
            if fmt then return os.date(fmt,string2Epoch(str)) end
            return os.date(" %A %d %B, %Y",string2Epoch(str))
        end

        local function alertLevel(delta)
            if delta < 2 then return dz.ALERTLEVEL_RED end
            if delta < 3 then return dz.ALERTLEVEL_YELLOW end
            if delta < 4 then return dz.ALERTLEVEL_ORANGE end
            return dz.ALERTLEVEL_GREEN
        end

        local function setGarbageAlertDevice(alertDevice,alertText,alertDate)
            local delta = tonumber(string2Date(alertDate,"%d")) - tonumber(os.date("%d"))  -- delta in days between today and first garbage collection date
            dz.devices(alertDevice).updateAlertSensor(alertLevel(delta),alertText)
            return (delta == 0)
        end

        local function longGarbageName(str)                                        -- Use descriptive strings
            str = tostring(str)
            str = str:gsub("13","  Boeken, Elektrische apparaten, Speelgoed en Textiel  ")
            str = str:gsub("7","  Groente-, fruit- en tuin afval            ")
            str = str:gsub("10","  Papier en kartonnen verpakkingen          ")
            str = str:gsub("8","  Restafval                                ")
            return str
        end
        
        -- extract bafId from json and store in persistent data
        local function getBagID()
            rt = dz.utils.fromJSON(triggerObject.data)
            dz.data.bagID = rt[1].bagId
            collectGarbageDates(1)
        end
        
        -- 
        local function handleResponse()
            dz.log(dz.data.bagID,dz.LOG_DEBUG)
            
            if dz.data.bagID == "Not set yet"  then
               getBagID()
               return
            end   
            rt , rtRaw = {}
            rtRaw = dz.utils.fromJSON(triggerObject.data)         -- dzVents does nor recognize the response as pure JSON so conversion is required
            
            if rtRaw["1"] ~=  nil then
                for k, v in pairs(rtRaw) do                        -- Extra step is necessary because json is not standard and some records are missing 
                    table.insert( rt, { ophaaldatum = v.ophaaldatum , afvalstroom_id = v.afvalstroom_id })
                end    
                dz.data.garbage = rt
            else
                errorMessage("Problem with response from  (no data) using data from earlier run")
                rt  = dz.data.garbage                       -- json empty. Get last valid from dz.data
                if #rt < 1 then                              -- No valid data in dz.data either
                    errorMessage("No previous data. are zipcode and housenumber ok and in circulus-berkel area?")
                    return false
                end
            end
            
            local garbageLines = ""
            local typeEarliestDate
            local typeEarliestKind
            local overallEarliestDate   = "2999-12-31"       -- Hopefully we will have a different garbage collection system by then
            local garbageToday = false
            local today = os.date("%Y-%m-%d")
            
            for i = 1,#garbageTypes do --walk the the type Table
                 dz.log("Checking " .. garbageTypes[i],dz.LOG_DEBUG)
                typeEarliestDate      = "2999-12-31"
                for j = 1, #rt do                                 -- walk the result Table
                            -- walk the response table
                    if  rt[j].ophaaldatum >= today and rt[j].ophaaldatum < typeEarliestDate and
                        rt[j].afvalstroom_id == garbageTypes[i] then  -- Keep date closest to today per type
                        typeEarliestDate =  rt[j].ophaaldatum
                        typeEarliestKind =  rt[j].afvalstroom_id
                        if  typeEarliestDate < overallEarliestDate then  -- date closest to today overall ?
                            overallEarliestDate = typeEarliestDate      -- keep date
                            overallEarliestType =  garbageTypes[i]            -- keep type
                        end
                    end
                end
                garbageLines = garbageLines .. string2Date(typeEarliestDate,"%a %e %b" ) .. longGarbageName(typeEarliestKind) .. " " .. "\n"
            end

            if myAlertDevice then   -- Update AlertDevice with nearby date / type
                garbageToday = setGarbageAlertDevice(  myAlertDevice,
                                                        longGarbageName(overallEarliestType) .. "\n" ..
                                                        string2Date(overallEarliestDate),
                                                        overallEarliestDate)
            end

            if myTextDevice then       -- Update defined virtual text device with dates / types
                dz.devices(myTextDevice).updateText(garbageLines)
            end

            if dz.time.matchesRule("at 08:00-17:00") and garbageToday then
                dz.notify(longGarbageName(overallEarliestType) .. "will be collected today")
            end
        end

        -- Main
        if triggerObject.isHTTPResponse then
            if triggerObject.ok then
                handleResponse()
            else
                errorMessage("Problem with response from " .. myProvider .. " (not ok)")
                collectGarbageDates(600)                            -- response not OK, try again after 10 minutes
            end
        else
            if dz.data.bagID == "Not set yet"  or dz.data.ZipCode ~= myZipCode or dz.data.HouseNumber ~= myHouseNumber then
            -- Initial or something changed in zipCode / HouseNumebr
                dz.data.ZipCode     = myZipCode  
                dz.data.HouseNumber = myHouseNumber
                dz.data.bagID       = "Not set yet"
                collectBagId(1)
            else
                collectGarbageDates(1)
            end
        end
    end
}

Code: Select all

curl -v --cookie "RovaLc_inwoners={\"Id\":160267,\"ZipCode\":\"8103JB\",\"HouseNumber\":\"15\",\"HouseAddition\":null,\"Municipality\":\"Raalte\",\"Province\":null,\"Firstname\":null,\"Lastname\":null,\"UserAgent\":\"\",\"School\":null,\"Street\":null,\"Country\":null,\"Portal\":null,\"AreaLevel\":5,\"City\":\"Raalte\",\"Ip\":null}" https://www.rova.nl/api/TrashCalendar/GetCalendarItems?portal=inwoners

Code: Select all

*   Trying 141.138.194.225...
* TCP_NODELAY set
* Connected to www.rova.nl (141.138.194.225) port 443 (#0)
* ALPN, offering h2
* ALPN, offering http/1.1
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
*   CAfile: /etc/ssl/certs/ca-certificates.crt
  CApath: /etc/ssl/certs
* TLSv1.2 (OUT), TLS header, Certificate Status (22):
* TLSv1.2 (OUT), TLS handshake, Client hello (1):
* TLSv1.2 (IN), TLS handshake, Server hello (2):
* TLSv1.2 (IN), TLS handshake, Certificate (11):
* TLSv1.2 (IN), TLS handshake, Server key exchange (12):
* TLSv1.2 (IN), TLS handshake, Server finished (14):
* TLSv1.2 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.2 (OUT), TLS change cipher, Client hello (1):
* TLSv1.2 (OUT), TLS handshake, Finished (20):
* TLSv1.2 (IN), TLS change cipher, Client hello (1):
* TLSv1.2 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.2 / ECDHE-RSA-AES256-SHA384
* ALPN, server did not agree to a protocol
* Server certificate:
*  subject: CN=www.rova.nl
*  start date: Oct 30 06:51:49 2018 GMT
*  expire date: Jan 28 06:51:49 2019 GMT
*  subjectAltName: host "www.rova.nl" matched cert's "www.rova.nl"
*  issuer: C=US; O=Let's Encrypt; CN=Let's Encrypt Authority X3
*  SSL certificate verify ok.
> GET /api/TrashCalendar/GetCalendarItems?portal=inwoners HTTP/1.1
> Host: www.rova.nl
> User-Agent: curl/7.52.1
> Accept: */*
> Cookie: RovaLc_inwoners={"Id":160267,"ZipCode":"8103JB","HouseNumber":"15","HouseAddition":null,"Municipality":"Raalte","Province":null,"Firstname":null,"Lastname":null,"UserAgent":"","School":null,"Street":null,"Country":null,"Portal":null,"AreaLevel":5,"City":"Raalte","Ip":null}
>
< HTTP/1.1 200 OK
< Cache-Control: no-cache
< Pragma: no-cache
< Content-Type: application/json; charset=utf-8
< Expires: -1
< Server: Microsoft-IIS/8.5
< X-AspNet-Version: 4.0.30319
< X-Powered-By: ASP.NET
< Date: Wed, 07 Nov 2018 10:20:55 GMT
< Content-Length: 286
<
* Curl_http_done: called premature == 0
* Connection #0 to host www.rova.nl left intact
[{"GarbageTypeCode":"GFT","GarbageType":"GFT","Date":"2018-11-12T00:00:00","Regular":true},{"GarbageTypeCode":"REST","GarbageType":"Restafval","Date":"2018-11-16T00:00:00","Regular":true},{"GarbageTypeCode":"PLASTICPLUS","GarbageType":"PMD","Date":"2018-11-19T00:00:00","Regular":true}]

Code: Select all

--[[ getGarbage.lua for [ dzVents >= 2.4 ]

    this script is only useful in those  areas of the Netherlands where the household garbage collector is rova
    Tested on debian stretch but probably also working on other Linux variants.

    needs curl command 
    needs to be able to process commands in the background ( by using leading &)

    Enter your zipcode, housenumber and garbageID in the appropriate places between the lines starting with -- ***
    Next is to set your virtual text and or virtual alert device.

    the text device will contain the most nearby collectdates for the types of household garbage
    the alert device will contain the date and type for the garbagecollection that will arrive first
    notification system will be called when collect will be today

]]-- 
 return {
         on =   {   timer           =   { "at 00:05","at 08:00" },    -- daily run twice
                    devices         =   { "getGarbage"          },    -- Ignore just for test  
                    httpResponses   =   { "delay_Response"      },    -- (re)triggers the script
                },
                
    logging =   {   level   = domoticz.LOG_DEBUG ,              -- Change to ERROR when script is behaving as expected  
                    marker  = ""},                              -- Will be set in execute = function block 
            
    data    =   {   delay           =  { initial = 0 },
                },

    execute = function(dz, item, info)

    -- ************************* Mandatory: Set your values and device names below this Line 
        
        local myZipcode     = "0000AA"            -- Your zipcode like "3085RA"
        local myHousenumber = "99"                -- Your housenumber like 38
        local myGarbageID   = "9999999"            -- Your GarbageID
        local myTextDevice  = "GarbageText"       -- Name with quotes or idx without when created as virtual text device
        local myAlertDevice = "GarbageAlert"      -- Name with quotes or idx without when created as virtual alert device
        
    -- **************************************************************** No changes required below this  
       local initialDelay           = 2 
       local repeatDelay            = 10
       local maxDelay               = 60
       local outFile                = "/tmp/garbageCollectionDates.json"
       local catCommand             = "cat"
       local garbageToday           = false
       
        _G.logMarker                = info.scriptName     -- sets the logmarker for dz.log
       
        local function logWrite(str,level)
            dz.log(str,level or dz.LOG_DEBUG)
        end
        
        local function alertLevel(delta)
            if delta < 2 then return dz.ALERTLEVEL_RED end
            if delta < 3 then return dz.ALERTLEVEL_YELLOW end
            if delta < 4 then return dz.ALERTLEVEL_ORANGE end
            return dz.ALERTLEVEL_GREEN
        end

        local function setGarbageAlertDevice(alertDevice,alertText, delta)
            dz.devices(alertDevice).updateAlertSensor(alertLevel(delta),alertText)
            return (delta == 0)
        end

        local function longGarbageName(str)                                        -- Use descriptive strings
            str = tostring(str)
            str = str:gsub("PMD","  Plastic verpakkingen, blik en drinkpakken ")
            str = str:gsub("GFT","  Groente-, fruit- en tuin afval ")
            str = str:gsub("Restafval" ,"  Restafval ")
            return str
        end
        
        local function retriggerAfterSec(seconds)
            dz.openURL({
                url =  dz.settings['Domoticz url'] .. "/json.htm?type=command&param=getversion",
                method = "GET",
                callback = "delay_Response" }).afterSec(seconds)
        end  
        
        local function osCommand(cmd)
            local fileHandle     = assert(io.popen(cmd, 'r'))
            local commandOutput  = assert(fileHandle:read('*a'))
            local returnTable    = {fileHandle:close()}
            return commandOutput,returnTable[3]            -- rc[3] contains returnCode
        end
       
        function makeTimeStamp(dateString)
            local pattern = "(%d+)%-(%d+)%-(%d+)T(%d+):(%d+):(%d+)"
            local xyear, xmonth, xday, xhour, xminute, xseconds = dateString:match(pattern)
            local convertedTimestamp  = os.time({year = xyear, month = xmonth, day = xday, hour = xhour, min = xminute, sec = xseconds})
            return convertedTimestamp 
        end
       
        local function procesJSON(resultJSON)
            keep    = {}
            rt      = dz.utils.fromJSON(resultJSON)
            
            local today = os.date("%Y-%m-%d")
            local garbageLines =  "" 
            local earliestDate   = "2999-12-31"       -- Hopefully we will have a different garbage collection system by then
            
            for i = 1,#rt do
                local fmtDate                 = os.date(" %A %d %B, %Y", makeTimeStamp(rt[i].Date))
                if  rt[i].Date >= today and rt[i].Date < earliestDate then
                    fmtDate             = os.date(" %A %d %B, %Y", makeTimeStamp(rt[i].Date))
                    keep.Date           = rt[i].Date
                    keep.fmtDate        = fmtDate
                    keep.GarbageType    = longGarbageName(rt[i].GarbageType)
                    earliestDate        = rt[i].Date
                end
                garbageLines = garbageLines .. fmtDate .. longGarbageName(rt[i].GarbageType) .. " " .. "\n"
            end

            if myTextDevice then       -- Update defined virtual text device with dates / types
                dz.devices(myTextDevice).updateText(garbageLines)
            end
            
            if myAlertDevice then   -- Update AlertDevice with nearby date / type
                local delta  = os.date("%d",tonumber(makeTimeStamp(keep.Date))) - os.date("%d") 
                garbageToday = setGarbageAlertDevice(  myAlertDevice, keep.GarbageType .. "\n" .. keep.fmtDate, delta )
            end  
            
            if dz.time.matchesRule("at 08:00-17:00") and garbageToday then
                dz.notify(keep.GarbageType .. "will be collected today")
            end
        end

        local function triggerCurlInBackGround()
            local curlCommand  = "curl -v --cookie" 
            local curlCookie  =  'RovaLc_inwoners={' ..
                                 '\\"Id\\":' ..             myGarbageID .. ',' .. 
                                 '\\"ZipCode\\":\\"' ..     myZipcode .. '\\",' .. 
                                 '\\"HouseNumber\\":\\"' .. myHousenumber .. '\\"}' 
            local curlHTTP    = "https://www.rova.nl/api/TrashCalendar/GetCalendarItems?portal=inwoners"
            local backGround  = " & "  -- We don't want the script to wait for the result so process curl in background

            getGarbageCollectionDatesCommand = curlCommand .. " " .. curlCookie  .. " " .. curlHTTP .. " > " .. outFile .. backGround 
            osCommand(getGarbageCollectionDatesCommand)
        end
        
        local function waitForAndProcessResult()
            local result, returnCode = osCommand(catCommand .. " " .. outFile) -- is the output there ?
            if returnCode == 0 then                                 -- Yes
                -- logWrite(result) 
                osCommand("rm " .. outFile)
                procesJSON(result)
            else                                                    -- Not yet. Come back in repeatDelay seconds 
                logWrite("No result yet")
                dz.data.delay = dz.data.delay + repeatDelay                    -- Keep track of the delays 
                if dz.data.delay > maxDelay then
                    logWrite("We are waiting > maxDelay seconds for the result. Giving up now",dz.LOG_ERROR)
                else
                    retriggerAfterSec(repeatDelay)
                end
            end 
        end
        
        -- main 
        if item.isDevice or item.isTimer then
            triggerCurlInBackGround()
            retriggerAfterSec(initialDelay) -- We will come back in initialDelay seconds to check if output has already arrived
            dz.data.delay = initialDelay 
        else
            waitForAndProcessResult()
        end
    end
}

Code: Select all

return {
	on = {
		timer = {
		    'at 20:00',                -- The notification will be sent at this time on the day before ROVA arrives
		    'every 8 hours' ,           -- Update frequency of the  virtual device  
	    }
    },
    logging = {
	        level = domoticz.LOG_DEBUG,  -- adjust to your needs
	        marker = "Rova"
    },
	execute = function(domoticz, item)
	    -- The name of your virtual text device which will contain the Afvalkalender
	    local DeviceName="Rova Afvalkalender" 
	    
	    -- Adress vars
	    local ZipCode="8103JB"  
	    local HouseNumber="15"
	    local HouseAddition="null"
	    local Municipality="Raalte"
	    
	    -- Notification params
	    local NotifyTitle="Rova"
	    local NotifyLine1="Zet container bij de weg, "
	    local NotifyLine2=" wordt opgehaald op "
	    
	    
		-- Get ROVA kalender by accessing the API using  curl 
	    local command = 'curl --cookie "RovaLc_inwoners={\\"Id\\":160266,\\"ZipCode\\":\\"'..ZipCode..'\\",\\"HouseNumber\\":\\"'..HouseNumber..'\\",\\"HouseAddition\\":'..HouseAddition..',\\"Municipality\\":\\"'..Municipality..'\\",\\"Province\\":null,\\"Firstname\\":null,\\"Lastname\\":null,\\"UserAgent\\":\\"\\",\\"School\\":null,\\"Street\\":null,\\"Country\\":null,\\"Portal\\":null,\\"AreaLevel\\":5,\\"City\\":\\"Zwolle\\",\\"Ip\\":null}" https://www.rova.nl/api/TrashCalendar/GetCalendarItems?portal=inwoners'
	    domoticz.log("Command is ["..command.."]",domoticz.LOG_DEBUG)
	    local handle=io.popen(command..' || echo error')
        local result = handle:read("*a")
        handle:close()

        -- For debugging purposes: Log result
        domoticz.log ("JSON output Rova is "..result, domoticz.LOG_DEBUG)
        
        if(result ~= 'error\n') then
            -- convert JSON object to readable format
    	    local json = domoticz.utils.fromJSON(result)

            -- convert dates
    	    local RovaDate=string.sub(json[1].Date,1,-10)
    	    local RovaDate2=string.sub(json[2].Date,1,-10)
    	    local RovaDate3=string.sub(json[3].Date,1,-10)

            -- log result
    	    domoticz.log("Next Garbage Collection: ["..json[1].GarbageTypeCode..' at '..RovaDate..']',domoticz.LOG_FORCE)
    	    
    	    -- update device
    	    domoticz.devices(DeviceName).updateText(json[1].GarbageTypeCode.." "..RovaDate..", "..json[2].GarbageTypeCode.." "..RovaDate2..", "..json[3].GarbageTypeCode.." "..RovaDate3)
    	    
    	    -- check if we have to send notification
    	    if (item.isTimer) then
    	        local twoletters = string.sub(item.trigger,1,2)
    	        domoticz.log("1st to trigger letters are ["..twoletters.."]",domoticz.LOG_DEBUG)
    	        domoticz.log("Item is timer ("..item.trigger..")",domoticz.LOG_DEBUG)
    	        
        	    if (twoletters=="at") then -- we are at the notification timestamp
        	        -- prepare time comparison
            	    local Time = require('Time')
                    local t = Time(RovaDate..' 00:00:00')
                    domoticz.log("Secondsago = "..t.secondsAgo..", minutesAgo="..t.minutesAgo..", hoursago="..t.hoursAgo..", daysago="..t.daysAgo,domoticz.LOG_DEBUG)
                    
                    -- check if we have to notify
                    if (t.daysAgo==0 and t.secondsAgo<0) then -- timestamp is within 1 day
                        -- Yes we do: notify
                        domoticz.log("Rova will be there within 1 day, sending notification", domoticz.LOG_DEBUG) 
                        domoticz.notify(NotifyTitle,NotifyLine1..json[1].GarbageTypeCode..NotifyLine2..RovaDate,domoticz.PRIORITY_NORMAL)
                    else
                        -- no we don't 
                        domoticz.log("no need to notify",domoticz.LOG_DEBUG)
                    end
                end
            end
	    else
	        domoticz.log("some kind of error accessing the Rova data API",domoticz.LOG_ERROR)
	    end
	end
}

Code: Select all

dz.log(triggerObject.data,dz.LOG_FORCE)

Code: Select all

rtRaw = dz.utils.fromJSON(triggerObject.data)         -- dzVents does nor recognize the response as pure JSON so conversion is required
      

Code: Select all

2018-12-19 11:58:00.423 Status: dzVents: Info: getGarbageDatesMarker: ------ Start internal script: Script #1:, trigger: at 11:58
2018-12-19 11:58:00.455 Status: dzVents: Debug: getGarbageDatesMarker: OpenURL: url = https://afvalkalender.circulus-berkel.nl/rest/adressen/0200200000011954/kalender/2018
2018-12-19 11:58:00.455 Status: dzVents: Debug: getGarbageDatesMarker: OpenURL: method = GET
2018-12-19 11:58:00.455 Status: dzVents: Debug: getGarbageDatesMarker: OpenURL: post data = nil
2018-12-19 11:58:00.455 Status: dzVents: Debug: getGarbageDatesMarker: OpenURL: headers = nil
2018-12-19 11:58:00.455 Status: dzVents: Debug: getGarbageDatesMarker: OpenURL: callback = getGarbageDatesResponse
2018-12-19 11:58:00.456 Status: dzVents: Info: getGarbageDatesMarker: ------ Finished Script #1
2018-12-19 11:58:00.598 Status: EventSystem: Script event triggered: /home/pi/domoticz/dzVents/runtime/dzVents.lua
2018-12-19 11:58:02.869 Status: dzVents: Info: Handling httpResponse-events for: "getGarbageDatesResponse
2018-12-19 11:58:02.869 Status: dzVents: Info: getGarbageDatesMarker: ------ Start internal script: Script #1: HTTPResponse: "getGarbageDatesResponse"
2018-12-19 11:58:02.879 Status: dzVents: Debug: getGarbageDatesMarker: 0200200000011954
2018-12-19 11:58:02.883 Status: dzVents: !Info: getGarbageDatesMarker: [{"afvalstroom_id":4,"ophaaldatum":"2018-01-04"},{"afvalstroom_id":55,"ophaaldatum":"2018-01-06"},{"afvalstroom_id":55,"ophaaldatum":"2018-01-15"},{"afvalstroom_id":55,"ophaaldatum":"2018-01-29"},{"afvalstroom_id":4,"ophaaldatum":"2018-02-01"},{"afvalstroom_id":55,"ophaaldatum":"2018-02-12"},{"afvalstroom_id":55,"ophaaldatum":"2018-02-26"},{"afvalstroom_id":4,"ophaaldatum":"2018-03-01"},{"afvalstroom_id":55,"ophaaldatum":"2018-03-12"},{"afvalstroom_id":55,"ophaaldatum":"2018-03-26"},{"afvalstroom_id":12,"ophaaldatum":"2018-04-04"},{"afvalstroom_id":4,"ophaaldatum":"2018-04-05"},{"afvalstroom_id":55,"ophaaldatum":"2018-04-09"},{"afvalstroom_id":55,"ophaaldatum":"2018-04-23"},{"afvalstroom_id":4,"ophaaldatum":"2018-05-03"},{"afvalstroom_id":55,"ophaaldatum":"2018-05-07"},{"afvalstroom_id":55,"ophaaldatum":"2018-05-19"},{"afvalstroom_id":55,"ophaaldatum":"2018-06-04"},{"afvalstroom_id":4,"ophaaldatum":"2018-06-07"},{"afvalstroom_id":55,"ophaaldatum":"2018-06-18"},{"afvalstroom_id":55,"ophaaldatum":"2018-07-02"},{"afvalstroom_id":4,"ophaaldatum":"2018-07-05"},{"afvalstroom_id":55,"ophaaldatum":"2018-07-16"},{"afvalstroom_id":55,"ophaaldatum":"2018-07-30"},{"afvalstroom_id":12,"ophaaldatum":"2018-08-01"},{"afvalstroom_id":4,"ophaaldatum":"2018-08-02"},{"afvalstroom_id":55,"ophaaldatum":"2018-08-13"},{"afvalstroom_id":55,"ophaaldatum":"2018-08-27"},{"afvalstroom_id":4,"ophaaldatum":"2018-09-06"},{"afvalstroom_id":55,"ophaaldatum":"2018-09-10"},{"afvalstroom_id":55,"ophaaldatum":"2018-09-24"},{"afvalstroom_id":4,"ophaaldatum":"2018-10-04"},{"afvalstroom_id":55,"ophaaldatum":"2018-10-08"},{"afvalstroom_id":55,"ophaaldatum":"2018-10-22"},{"afvalstroom_id":4,"ophaaldatum":"2018-11-01"},{"afvalstroom_id":55,"ophaaldatum":"2018-11-05"},{"afvalstroom_id":55,"ophaaldatum":"2018-11-19"},{"afvalstroom_id":55,"ophaaldatum":"2018-12-03"},{"afvalstroom_id":12,"ophaaldatum":"2018-12-05"},{"afvalstroom_id":4,"ophaaldatum":"2018-12-06"},{"afvalstroom_id":11,"ophaaldatum":"2018-12-11"},{"afvalstroom_id":55,"ophaaldatum":"2018-12-17"},{"afvalstroom_id":11,"ophaaldatum":"2018-12-22"},{"afvalstroom_id":55,"ophaaldatum":"2018-12-31"}]
2018-12-19 11:58:02.883 Status: dzVents: Error (2.4.9): getGarbageDatesMarker: Problem with response from (no data) using data from earlier run
2018-12-19 11:58:02.884 Status: dzVents: Error (2.4.9): getGarbageDatesMarker: No previous data. are zipcode and housenumber ok and in circulus-berkel area?
2018-12-19 11:58:02.884 Status: dzVents: Info: getGarbageDatesMarker: ------ Finished Script #1
2018-12-19 11:58:02.884 Status: EventSystem: Script event triggered: /home/pi/domoticz/dzVents/runtime/dzVents.lua
2018-12-19 11:58:02.924 Status: Notification: Problem with response from (no data) using data from earlier run
2018-12-19 11:58:02.925 Status: Notification: No previous data. are zipcode and housenumber ok and in circulus-berkel area?

Code: Select all

--[[ getGarbageDates.lua for [ dzVents >= 2.4 ]

this script is only useful in those  areas of the Netherlands where circulus-berkel is the garbage collector

Enter your zipcode and housenumber and your virtual text and or virtual alert device in the 
appropriate place between the lines starting with --++++

the text device will contain the most nearby collectdates for the four types of household garbage
the alert device will contain the date and type for the garbagecollection that will arrive first
]]-- 

local prefix        = "getGarbageDates"
local httpresponse  = prefix .. "Response"
local triggerDevice = prefix .. "Trigger"
local logMarker     = prefix .. "Marker"

return 
        {
     on      =  {   devices        =   { triggerDevice },            -- Just for development and test ; ignored when live
                    timer          =   { "at 00:05","at 08:00" },    -- daily run twice
                    httpResponses  =  { httpresponse }               -- Trigger the handle Json part
                },

 --   logging =   {   level       =   domoticz.LOG_DEBUG,              -- Remove the "-- at the beginning of this and next line for debugging the script
 --                   marker        =   logMarker      },

    data    =   {   garbage     = { initial = {} },                  -- Keep a copy of last json just in case
                    bagID       = { initial = "Not set yet" },           
                    ZipCode     = { initial = "not set yet" },
                    HouseNumber = { initial = "not set yet" },
                },

    execute = function(dz, triggerObject)

        --++++--------------------- Mandatory: Set your values and device names below this Line --------------------------------------
        local myZipCode     = "7328CK"
        local myHouseNumber = 46
        local myTextDevice  = "GarbageText"       -- Name with quotes or idx without when created as virtual text device
        local myAlertDevice = "GarbageAlert"      -- Name with quotes or idx without when created as virtual alert device
        --++++---------------------------- Set your values and device names above this Line --------------------------------------------
        
        local myProvider    = "https://afvalkalender.circulus-berkel.nl" 
        local myYear        = os.date("%Y")

        garbageTypes  = {1,4,11,12,55}                -- Valid for circulus-berkelfor but these numbers vary per garbageCollector; Why ??
         -- ("55","  Groente-, fruit- en tuin afval            ")
         -- ("4", "  Papier en kartonnen verpakkingen          ")
         -- ("11","  Plastic, blik drankpakken                 ")
         -- ("12","  Boeken, speelgoed en textiel              ") 
         -- ("1", "  Restafval                                 ") 

        -- get BagId based on Zipcode / Housenumber 
        local function collectBagId(secondsFromNow)
            local getBagId_url  = myProvider .. "/rest/adressen/" .. myZipCode .."-" .. myHouseNumber
            dz.openURL  ({  url         = getBagId_url ,
                            method      = "GET",
                            callback    = httpresponse}).afterSec(secondsFromNow)
        end
        
        -- get garbage collect Year calendar 
        local function collectGarbageDates(secondsFromNow)
            local getGarbage_url  = myProvider .. "/rest/adressen/" .. dz.data.bagID .. "/kalender/" .. myYear
            dz.openURL  ({  url         = getGarbage_url ,
                            method      = "GET",
                            callback    = httpresponse}).afterSec(secondsFromNow)
        end

        -- Add entry to log and notify to all subsystems
        local function errorMessage(message)
            dz.log(message,dz.LOG_ERROR)
            dz.notify(message)
        end

        local function string2Epoch(dateString) -- seconds from epoch based on stringdate (used by string2Date)
            -- Assuming a date pattern like: yyyy-mm-dd
            local pattern = "(%d+)-(%d+)-(%d+)"
            local runyear, runmonth, runday= dateString:match(pattern)
            local convertedTimestamp = os.time({year = runyear, month = runmonth, day = runday})
            return convertedTimestamp
        end

        local function string2Date(str,fmt)             -- convert string from json into datevalue
            if fmt then return os.date(fmt,string2Epoch(str)) end
            return os.date(" %A %d %B, %Y",string2Epoch(str))
        end

        local function alertLevel(delta)
            if delta < 2 then return dz.ALERTLEVEL_RED end
            if delta < 3 then return dz.ALERTLEVEL_YELLOW end
            if delta < 4 then return dz.ALERTLEVEL_ORANGE end
            return dz.ALERTLEVEL_GREEN
        end

        local function setGarbageAlertDevice(alertDevice,alertText,alertDate)
            local delta = tonumber(string2Date(alertDate,"%d")) - tonumber(os.date("%d"))  -- delta in days between today and first garbage collection date
            dz.devices(alertDevice).updateAlertSensor(alertLevel(delta),alertText)
            return (delta == 0)
        end

        local function longGarbageName(str)                                        -- Use descriptive strings
            str = tostring(str)
            dz.log(str,dz.LOG_DEBUG)
            str = str:gsub("12","  Boeken, Elektrische apparaten, Speelgoed en Textiel")
            str = str:gsub("55","  Groente-, fruit- en tuin afval     ")
            str = str:gsub("4", "  Papier en kartonnen verpakkingen    ")
            str = str:gsub("11","  Plastic, blik drankpakken          ")
            str = str:gsub("1", "  Rest afval                          ")
            
            dz.log(str,dz.LOG_DEBUG)
            return str
        end
        
        -- extract bafId from json and store in persistent data
        local function getBagID()
            rt = dz.utils.fromJSON(triggerObject.data)
            dz.data.bagID = rt[1].bagId
            collectGarbageDates(1)
        end
           
           local function dumpTable(t, level)
            for attr, value in pairs(t) do
                if (type(value) ~= 'function') then
                    if (type(value) == 'table') then
                        io.write(level .. attr .. ':\n')
                        print(level .. attr )
                        dumpTable(value, level .. '    ')
                    else
                        io.write(level .. attr .. ': ' .. tostring(value) .. "\n")
                        print(level .. attr .. ': ' .. tostring(value) )
                    end
                else
                    io.write(level .. attr .. '()\n')
                    print(level .. attr .. '()')
                end
            end
        end
        -- 
        local function handleResponse()
            dz.log(dz.data.bagID,dz.LOG_DEBUG)
            
            if dz.data.bagID == "Not set yet"  then
               getBagID()
               return
            end   
            rt , rtRaw = {}, {}
            rtRaw = dz.utils.fromJSON(triggerObject.data)         -- dzVents does nor recognize the response as pure JSON so conversion is required

            if rtRaw[1] ~=  nil then
                 for k, v in pairs(rtRaw) do                        -- Extra step is necessary because json is not standard and some records are missing 
                     table.insert( rt, { ophaaldatum = v.ophaaldatum , afvalstroom_id = v.afvalstroom_id })
                 end    
                dz.data.garbage = rt
            else
                errorMessage("Problem with response from  (no data) using data from earlier run")
                rt  = dz.data.garbage                       -- json empty. Get last valid from dz.data
                if #rt < 1 then                              -- No valid data in dz.data either
                    errorMessage("No previous data. are zipcode and housenumber ok and in circulus-berkel area?")
                    return false
                end
            end
            
            local garbageLines = ""
            local typeEarliestDate
            local typeEarliestKind
            local overallEarliestDate   = "2999-12-31"       -- Hopefully we will have a different garbage collection system by then
            local garbageToday = false
            local today = os.date("%Y-%m-%d")
            local foundFirst = false
            
            for i = 1,#garbageTypes do --walk the the type Table
                 dz.log("Checking " .. garbageTypes[i],dz.LOG_DEBUG)
                typeEarliestDate      = "2999-12-31"
                local foundOne = false
                for j = 1, #rt do                                 -- walk the result Table
                            -- walk the response table
                    if  rt[j].ophaaldatum >= today and rt[j].ophaaldatum < typeEarliestDate and
                        rt[j].afvalstroom_id == garbageTypes[i] then  -- Keep date closest to today per type
                        foundOne = true
                        typeEarliestDate =  rt[j].ophaaldatum
                        typeEarliestKind =  rt[j].afvalstroom_id
                        if  typeEarliestDate < overallEarliestDate then  -- date closest to today overall ?
                            foundFirst = true
                            overallEarliestDate = typeEarliestDate      -- keep date
                            overallEarliestType =  garbageTypes[i]            -- keep type
                        end
                    end
                    
                end
                if foundOne then 
                    garbageLines = garbageLines .. string2Date(typeEarliestDate,"%a %e %b" ) .. longGarbageName(typeEarliestKind) .. " " .. "\n"
                end    
            end

            if myAlertDevice and foundFirst then   -- Update AlertDevice with nearby date / type
                garbageToday = setGarbageAlertDevice(  myAlertDevice,
                                                        longGarbageName(overallEarliestType) .. "\n" ..
                                                        string2Date(overallEarliestDate),
                                                        overallEarliestDate)
            end

            if myTextDevice then       -- Update defined virtual text device with dates / types
                dz.devices(myTextDevice).updateText(garbageLines)
            end

            if dz.time.matchesRule("at 08:00-17:00") and garbageToday then
                dz.notify(longGarbageName(overallEarliestType) .. "will be collected today")
            end
        end

        -- Main
        if triggerObject.isHTTPResponse then
            if triggerObject.ok then
                handleResponse()
            else
                errorMessage("Problem with response from " .. myProvider .. " (not ok)")
                collectGarbageDates(600)                            -- response not OK, try again after 10 minutes
            end
        else
            if dz.data.bagID == "Not set yet"  or dz.data.ZipCode ~= myZipCode or dz.data.HouseNumber ~= myHouseNumber then
            -- Initial or something changed in zipCode / HouseNumebr
                dz.data.ZipCode     = myZipCode  
                dz.data.HouseNumber = myHouseNumber
                dz.data.bagID       = "Not set yet"
                collectBagId(1)
            else
                collectGarbageDates(1)
            end
        end
    end
}