238 lines
13 KiB
Plaintext
Executable File
238 lines
13 KiB
Plaintext
Executable File
--[[ Virtual Lux sensor and other real-time solar data
|
|
|
|
~/domoticz/scripts/lua/script_time_SolarSensor.lua
|
|
|
|
-- http://www.domoticz.com/wiki/Real-time_solar_data_without_any_hardware_sensor_:_azimuth,_Altitude,_Lux_sensor...#Installation_instructions
|
|
|
|
-- Autors ----------------------------------------------------------------
|
|
V1.0 - Sébastien Joly - Great original work
|
|
V1.1 - Neutrino - Adaptation to Domoticz
|
|
V1.2 - Jmleglise - An acceptable approximation of the lux below 1° altitude for Dawn and dusk + translation + several changes to be more userfriendly.
|
|
V1.3 - Jmleglise - No update of the Lux data when <=0 to get the sunset and sunrise with lastUpdate
|
|
V1.4 - use the API instead of updateDevice to update the data of the virtual sensor to be able of using devicechanged['Lux'] in our scripts. (Due to a bug in Domoticz that doesn't catch the devicechanged event of the virtual sensor)
|
|
]]--
|
|
|
|
-- Variables to customize ------------------------------------------------
|
|
local localhost = '127.0.0.1:81' -- Set your port. (Not the universal IP).
|
|
local city = "Redon" -- Your city for Wunderground API
|
|
local countryCode = "FR" -- Your country code for Wunderground API
|
|
local idxLux ='653' -- Your virtual Lux Device ID
|
|
local idxSolarAzimuth ='321' -- Your virtual Azimuth Device ID
|
|
local idxSolarAltitude ='322' -- Your virtual Solar Altitude Device ID
|
|
local idxUserVarOcta='31' -- Your user variable ID , named octa
|
|
local wuAPIkey = "48a08328a93a18a1" -- Your Weather Underground API Key
|
|
local latitude = 47.726872 -- your home
|
|
local longitude = -2.131937 -- your home
|
|
local altitude = 19 -- Your home altitude : run once in debug = 1 to found your altitude in Log and write it here
|
|
local WMOID = '07130' --Rennes -- Your nearest SYNOP Station for ogimet. Very important ! http://www.ogimet.com/
|
|
local DEBUG = 0
|
|
if (otherdevices['Debug'] == 'On') then
|
|
DEBUG = 1 -- 0 , 1 for domoticz log , 2 for file log
|
|
end
|
|
-- and customize the URL of api.wunderground around line 104 according to your country.
|
|
|
|
-- Below , edit at your own risk ------------------------------------------
|
|
|
|
function leapYear(year)
|
|
return year%4==0 and (year%100~=0 or year%400==0)
|
|
end
|
|
|
|
function split(s, delimiter)
|
|
result = {};
|
|
for match in (s..delimiter):gmatch("(.-)"..delimiter) do
|
|
table.insert(result, match);
|
|
end
|
|
return result;
|
|
end
|
|
|
|
function pow(num, dec)
|
|
return num^dec
|
|
end
|
|
function round(num, dec)
|
|
if num == 0 then
|
|
return 0
|
|
else
|
|
local mult = 10^(dec or 0)
|
|
return math.floor(num * mult + 0.5) / mult
|
|
end
|
|
end
|
|
|
|
commandArray = {}
|
|
|
|
time = os.date("*t")
|
|
if ((time.min % 10)==0) then -- Run every n minutes. Check the wundergroud API limitation before changing this
|
|
|
|
json = (loadfile "/opt/domoticz/scripts/lua/JSON.lua")() -- For Linux
|
|
--json = (loadfile "D:\\Domoticz\\scripts\\lua\\json.lua")() -- For Windows
|
|
|
|
local arbitraryTwilightLux=6.32 -- W/m² egal 800 Lux (the theoritical value is 4.74 but I have more accurate result with 6.32...)
|
|
local constantSolarRadiation = 1361 -- Solar Constant W/m²
|
|
|
|
if (uservariables['octa'] == nil) then print("Error : Did you create the Uservariable octa ?") end
|
|
-- API Wunderground
|
|
local url_json = 'curl http://api.wunderground.com/api/'..wuAPIkey..'/conditions/q/'..countryCode..'/'..city..'.json'
|
|
print('url_json='..url_json)
|
|
--local config=assert(io.popen('curl http://api.wunderground.com/api/'..wuAPIkey..'/conditions/q/'..countryCode..'/'..city..'.json'))
|
|
--local location = config:read('*all')
|
|
--config:close()
|
|
--local jsonLocation = json:decode(location)
|
|
--if( DEBUG == 1) then
|
|
-- local latitude = jsonLocation.current_observation.display_location.latitude
|
|
-- local longitude = jsonLocation.current_observation.display_location.longitude
|
|
-- local altitude = jsonLocation.current_observation.display_location.elevation
|
|
-- print('Lat: '..latitude..'Long: '..longitude..'Alt: '..altitude)
|
|
-- end
|
|
--relativePressure = jsonLocation.current_observation.pressure_mb -- if you have an another way to get the Pressure, (local barometer ...) then you may optimize the script and avoid the call to api.wunderground)
|
|
----------------------------------
|
|
print("valeurs"..otherdevices_svalues['BarometreLaGacilly'])
|
|
local tab = split(otherdevices_svalues['BarometreLaGacilly'], ";")
|
|
print("Pressure="..tostring(tab[4]))
|
|
relativePressure = tonumber(tab[4])
|
|
|
|
local year = os.date("%Y")
|
|
local numOfDay = os.date("%j")
|
|
if leapYear(year) == true then
|
|
nbDaysInYear = 366 -- How many days in the year ?
|
|
else
|
|
nbDaysInYear = 365
|
|
end
|
|
|
|
angularSpeed = 360/365.25
|
|
local Declinaison = math.deg(math.asin(0.3978 * math.sin(math.rad(angularSpeed) *(numOfDay - (81 - 2 * math.sin((math.rad(angularSpeed) * (numOfDay - 2))))))))
|
|
timeDecimal = (os.date("!%H") + os.date("!%M") / 60) -- Coordinated Universal Time (UTC)
|
|
solarHour = timeDecimal + (4 * longitude / 60 ) -- The solar Hour
|
|
hourlyAngle = 15 * ( 12 - solarHour ) -- hourly Angle of the sun
|
|
sunAltitude = math.deg(math.asin(math.sin(math.rad(latitude))* math.sin(math.rad(Declinaison)) + math.cos(math.rad(latitude)) * math.cos(math.rad(Declinaison)) * math.cos(math.rad(hourlyAngle))))-- the height of the sun in degree, compared with the horizon
|
|
|
|
local azimuth = math.acos((math.sin(math.rad(Declinaison)) - math.sin(math.rad(latitude)) * math.sin(math.rad(sunAltitude))) / (math.cos(math.rad(latitude)) * math.cos(math.rad(sunAltitude) ))) * 180 / math.pi -- deviation of the sun from the North, in degree
|
|
local sinAzimuth = (math.cos(math.rad(Declinaison)) * math.sin(math.rad(hourlyAngle))) / math.cos(math.rad(sunAltitude))
|
|
if(sinAzimuth<0) then azimuth=360-azimuth end
|
|
sunstrokeDuration = math.deg(2/15 * math.acos(- math.tan(math.rad(latitude)) * math.tan(math.rad(Declinaison)))) -- duration of sunstroke in the day . Not used in this calculation.
|
|
RadiationAtm = constantSolarRadiation * (1 +0.034 * math.cos( math.rad( 360 * numOfDay / nbDaysInYear ))) -- Sun radiation (in W/m²) in the entrance of atmosphere.
|
|
-- Coefficient of mitigation M
|
|
absolutePressure = relativePressure - round((altitude/ 8.3),1) -- hPa
|
|
sinusSunAltitude = math.sin(math.rad(sunAltitude))
|
|
|
|
|
|
if (DEBUG == 1) then
|
|
print('<b style="color:Blue"============== SUN LOG ==================</b>')
|
|
print(os.date("%Y-%m-%d %H:%M:%S", os.time()))
|
|
print(city .. ", latitude:" .. latitude .. ", longitude:" .. longitude)
|
|
print("Home altitude = " .. tostring(altitude) .. " m")
|
|
print("number Of Day = " .. numOfDay)
|
|
if nbDaysInYear==366 then
|
|
print(year .." is a leap year !")
|
|
else
|
|
print(year.." is not a leap year")
|
|
end
|
|
print("Angular Speed = " .. angularSpeed .. " per day")
|
|
print("Declinaison = " .. Declinaison .. "°")
|
|
print("Universel Coordinated Time (UTC)".. timeDecimal .." H.dd")
|
|
print("Solar Hour ".. solarHour .." H.dd")
|
|
print("Altitude of the sun = " .. sunAltitude .. "°")
|
|
print("Angular hourly = ".. hourlyAngle .. "°")
|
|
print("Azimuth of the sun = " .. azimuth .. "°")
|
|
print("Duration of the sunstroke of the day = " .. round(sunstrokeDuration,2) .." H.dd") -- not used
|
|
print("Radiation max in atmosphere = " .. round(RadiationAtm,2) .. " W/m²")
|
|
print("Local relative pressure = " .. relativePressure .. " hPa")
|
|
print("Absolute pressure in atmosphere = " .. absolutePressure .. " hPa")
|
|
end
|
|
local sun = 614 * sinusSunAltitude * 614 * sinusSunAltitude
|
|
M0 = math.sqrt(1229 + sun) - 614 * sinusSunAltitude
|
|
M = M0 * relativePressure/absolutePressure
|
|
print("Coefficient of mitigation M = " .. M .." M0:"..M0)
|
|
|
|
-- Get SYNOP message from Ogimet web site
|
|
hourUTCminus1 = math.floor(os.date("!%H")-1)
|
|
print("hourUTCminus1 = " .. tostring(hourUTCminus1))
|
|
if string.len(hourUTCminus1) == 1 then
|
|
hourUTCminus1 = "0" .. hourUTCminus1
|
|
print("hourUTCminus1 = " .. tostring(hourUTCminus1))
|
|
end
|
|
UTC = os.date("%Y%m%d").. hourUTCminus1.."00" -- os.date("!%M")
|
|
-- if (DEBUG == 1) then
|
|
-- local WMOID = jsonLocation.current_observation.display_location.wmo
|
|
-- end
|
|
|
|
cmd='curl "http://www.ogimet.com/cgi-bin/getsynop?block='..WMOID..'&begin='..UTC..'"'
|
|
print(cmd)
|
|
local ogimet=assert(io.popen(cmd))
|
|
local synop = ogimet:read('*all')
|
|
ogimet:close()
|
|
if( DEBUG == 1) then print('ogimet:'..synop) end
|
|
|
|
if string.find(synop,"Status: 500") == nil
|
|
then
|
|
rslt = split(synop,",")
|
|
CodeStation = rslt[1]
|
|
rslt = split(synop, " "..CodeStation.. " ")
|
|
Trame = string.gsub(rslt[2], "=", "")
|
|
Trame = CodeStation .." ".. Trame
|
|
rslt = split(Trame, " ")
|
|
Octa = string.sub(rslt[3], 1, 1) -- 3rd char is the cloud layer. 0=no cloud , 1-8= cloudy from 1 to 8 max , 9 =Fog , / = no data
|
|
if Octa == "/" then -- not defined ? take the previous value
|
|
Octa = uservariables['octa']
|
|
elseif Octa == "9" then
|
|
Octa = 8
|
|
end
|
|
else
|
|
Octa = uservariables['octa']
|
|
end
|
|
|
|
--os.execute('curl "http://127.0.0.1:8081/json.htm?type=command¶m=updateuservariable&idx='..idxUserVarOcta..'&vname=octa&vtype=0&vvalue='..tostring(Octa)..'"')
|
|
commandArray[#commandArray + 1] = {['Variable:octa'] = tostring(Octa)}
|
|
|
|
Kc=1-0.75*pow(Octa/8,3.4) -- Factor of mitigation for the cloud layer
|
|
|
|
if sunAltitude > 1 then -- Below 1° of Altitude , the formulae reach their limit of precision.
|
|
directRadiation = RadiationAtm * pow(0.6,M) * sinusSunAltitude
|
|
scatteredRadiation = RadiationAtm * (0.271 - 0.294 * pow(0.6,M)) * sinusSunAltitude
|
|
totalRadiation = scatteredRadiation + directRadiation
|
|
Lux = totalRadiation / 0.0079 -- Radiation in Lux. 1 Lux = 0,0079 W/m²
|
|
weightedLux = Lux * Kc -- radiation of the Sun with the cloud layer
|
|
elseif sunAltitude <= 1 and sunAltitude >= -7 then -- apply theoretical Lux of twilight
|
|
directRadiation = 0
|
|
scatteredRadiation = 0
|
|
arbitraryTwilightLux=arbitraryTwilightLux-(1-sunAltitude)/8*arbitraryTwilightLux
|
|
totalRadiation = scatteredRadiation + directRadiation + arbitraryTwilightLux
|
|
Lux = totalRadiation / 0.0079 -- Radiation in Lux. 1 Lux = 0,0079 W/m²
|
|
weightedLux = Lux * Kc -- radiation of the Sun with the cloud layer
|
|
elseif sunAltitude < -7 then -- no management of nautical and astronomical twilight...
|
|
directRadiation = 0
|
|
scatteredRadiation = 0
|
|
totalRadiation = 0
|
|
Lux = 0
|
|
weightedLux = 0 -- should be around 3,2 Lux for the nautic twilight. Nevertheless.
|
|
end
|
|
|
|
if (DEBUG == 1) then
|
|
print("Station SYNOP = " .. WMOID)
|
|
print( Octa .. " Octa")
|
|
print("Kc = " .. Kc)
|
|
print("Direct Radiation = ".. round(directRadiation,2) .." W/m²")
|
|
print("Scattered Radiation = ".. round(scatteredRadiation,2) .." W/m²")
|
|
print("Total radiation = " .. round(totalRadiation,2) .." W/m²")
|
|
print("Total Radiation in lux = ".. round(Lux,2).." Lux")
|
|
print("and at last, Total weighted lux = ".. round(weightedLux,2).." Lux")
|
|
end
|
|
|
|
if tonumber(otherdevices_svalues['Lux'])+round(weightedLux,0)>0 -- No update if Lux is already 0. So lastUpdate of the Lux sensor will keep the time when Lux has reached 0. (Kind of timeofday['SunsetInMinutes'])
|
|
then
|
|
-- commandArray[#commandArray + 1] = {['UpdateDevice'] = idxLux..'|0|'..tostring(round(weightedLux,0))} -- THis form is not recommended. due to limitation of the eventsystem of Domoticz
|
|
commandArray[#commandArray + 1]={['OpenURL']="http://"..localhost.."/json.htm?type=command¶m=udevice&idx="..idxLux.."&nvalue=0&svalue="..tostring(round(weightedLux,0)) }
|
|
end
|
|
-- commandArray[#commandArray + 1] = {['UpdateDevice'] = idxSolarAzimuth..'|0|'..tostring(round(azimuth,0))}
|
|
commandArray[#commandArray + 1]={['OpenURL']="http://"..localhost.."/json.htm?type=command¶m=udevice&idx="..idxSolarAzimuth.."&nvalue=0&svalue="..tostring(round(azimuth,0)) }
|
|
-- commandArray[#commandArray + 1] = {['UpdateDevice'] = idxSolarAltitude..'|0|'..tostring(round(sunAltitude,0))}
|
|
commandArray[#commandArray + 1]={['OpenURL']="http://"..localhost.."/json.htm?type=command¶m=udevice&idx="..idxSolarAltitude.."&nvalue=0&svalue="..tostring(round(sunAltitude,0)) }
|
|
|
|
if (DEBUG == 2) then
|
|
logDebug=os.date("%Y-%m-%d %H:%M:%S",os.time())
|
|
logDebug=logDebug.." Azimuth:" .. azimuth .. " Height:" .. sunAltitude
|
|
logDebug=logDebug.." Octa:" .. Octa.." KC:".. Kc
|
|
logDebug=logDebug.." Direct:"..directRadiation.." inDirect:"..scatteredRadiation.." TotalRadiation:"..totalRadiation.." LuxCloud:".. round(weightedLux,2)
|
|
os.execute('echo '..logDebug..' >>logSun.txt') -- compatible Linux & Windows
|
|
end
|
|
end
|
|
return commandArray
|