driver.lua

--[[=============================================================================
    Enphase IQ/Envoy Gateway Solar Driver
===============================================================================]]

JSON = require("drivers-common-public.module.json")
require("drivers-common-public.global.handlers")
require("drivers-common-public.global.lib")
require("drivers-common-public.global.url")
require("drivers-common-public.global.timer")
require("drivers-common-public.module.mdns")

--[[=============================================================================
    Constants
===============================================================================]]

do	--Globals
	PRODUCTION = false
	ENPHASE = {}
	HEADERS = HEADERS or {}
	OPTIONS = {
		["ssl_verify_host"] = false,
		["ssl_verify_peer"] = false,
	}
	gPollInterval = 30
	gEnvoyAddress = "0.0.0.0"
	gEnvoySerial = nil
	gDiscoveryMode = "auto"
	gDiscovered = false
	gAuth = false
	gNeedAuth = true
	gAuthUser = nil
	gAuthPass = nil
	gAuthSessionID = nil
	gAuthToken = nil
	APIBase = "http://" .. gEnvoyAddress
	SessionURI = "https://enlighten.enphaseenergy.com/login/login.json?"
	TokenURI = "https://entrez.enphaseenergy.com/tokens"
	ReadingsURI = nil
end

--[[=============================================================================
    Driver initialization and destruction
===============================================================================]]

function OnDriverLateInit()
	if (Properties["Discovery Mode"] == "Manual") then
		C4:SetPropertyAttribs("Envoy IP", 0)
	else
		C4:SetPropertyAttribs("Envoy IP", 1)
	end
	KillAllTimers()
	C4:urlSetTimeout(20)
	C4:UpdateProperty("Driver Name", C4:GetDriverConfigInfo("name"))
	C4:UpdateProperty("Driver Version", C4:GetDriverConfigInfo("version"))
	if (Select (PersistData, "PollInterval")) then
		gPollInterval = PersistData.PollInterval or 30
	end
	if (Select (PersistData, "IP")) then
		gEnvoyAddress = PersistData.IP
	end
	if (Select (PersistData, "Serial")) then
		gEnvoySerial = PersistData.Serial
	end
	if (Select (PersistData, "User")) then
		gAuthUser = PersistData.User
	end
	if (Select (PersistData, "Pass")) then
		gAuthPass = PersistData.Pass
	end
	if (Select (PersistData, "SessionID")) then
		gAuthSessionID = PersistData.SessionID
	end
	if (Select (PersistData, "Token")) then
		gAuthToken = PersistData.Token
	end
	if (Select (PersistData, "Version")) then
		if (PersistData.Version < 7) then
			gAuth = true
			gNeedAuth = false
			APIBase = "http://" .. gEnvoyAddress
			ReadingsURI = "/production.json"
		else
			gAuth = false
			gNeedAuth = true
			APIBase = "https://" .. gEnvoyAddress
			ReadingsURI = "/ivp/meters/readings"
		end
	end
	if (not (Variables and Variables.PRODUCTION_KW)) then
		C4:AddVariable("PRODUCTION_KW", "", "INT", true, false)
		C4:SetVariable("PRODUCTION_KW", "")
	end
	if (not (Variables and Variables.CONSUMPTION_KW)) then
		C4:AddVariable("CONSUMPTION_KW", "", "INT", true, false)
		C4:SetVariable("CONSUMPTION_KW", "")
	end
	if (not (Variables and Variables.GRID_POWER_KW)) then
		C4:AddVariable("GRID_POWER_KW", "", "INT", true, false)
		C4:SetVariable("GRID_POWER_KW", "")
	end
	if (not (Variables and Variables.DAILY_ENERGY_PRODUCTION_KWH)) then
		C4:AddVariable("DAILY_ENERGY_PRODUCTION_KWH", "", "INT", true, false)
		C4:SetVariable("DAILY_ENERGY_PRODUCTION_KWH", "")
	end
	if (not (Variables and Variables.DAILY_ENERGY_CONSUMPTION_KWH)) then
		C4:AddVariable("DAILY_ENERGY_CONSUMPTION_KWH", "", "INT", true, false)
		C4:SetVariable("DAILY_ENERGY_CONSUMPTION_KWH", "")
	end
	if (not (Variables and Variables.EXCESS_SOLAR)) then
		C4:AddVariable("EXCESS_SOLAR", "0", "BOOL", true, false)
		C4:SetVariable("EXCESS_SOLAR", "0")
	end
	if (not (Variables and Variables.EXCESS_SOLAR_KW)) then
		C4:AddVariable("EXCESS_SOLAR_KW", "", "INT", true, false)
		C4:SetVariable("EXCESS_SOLAR_KW", "")
	end
	if (not (Variables and Variables.CURRENT_VOLTAGE)) then
		C4:AddVariable("CURRENT_VOLTAGE", "", "INT", true, false)
		C4:SetVariable("CURRENT_VOLTAGE", "")
	end
	if (not (Variables and Variables.ENPOWER_CONNECTED)) then
		C4:AddVariable("ENPOWER_CONNECTED", "", "BOOL", true, false)
		C4:SetVariable("ENPOWER_CONNECTED", "")
	end
	if (not (Variables and Variables.GRID_STATUS)) then
		C4:AddVariable("GRID_STATUS", "", "STRING", true, false)
		C4:SetVariable("GRID_STATUS", "")
	end
	for property, _ in pairs(Properties) do
		OnPropertyChanged(property)
	end
	SetTimer("PollGateway", gPollInterval * ONE_SECOND)
	InitGateway()
end

function OnDriverDestroyed()
	KillAllTimers()
end

--[[=============================================================================
    Properties
===============================================================================]]

function OPC.Driver_Version (value)
	local version = C4:GetDriverConfigInfo("version")
	if (not(PRODUCTION)) then
		version = version .. " [BETA Version]"
	end
	C4:UpdateProperty("Driver Version", version)
end

function OPC.Debug_Mode(value)
	if (DEBUGPRINT) then
		DEBUGPRINT = CancelTimer(DEBUGPRINT)
	end
	if (value == "On") then
		local _timer = function(timer)
			C4:UpdateProperty("Debug Mode", "Off")
			OnPropertyChanged("Debug Mode")
		end
		DEBUGPRINT = SetTimer(DEBUGPRINT, 36000000, _timer)
	end
end

function OPC.Discovery_Mode(value)
	gDiscoveryMode = string.lower(value)
	C4:UpdateProperty("Serial Number", "")
	C4:UpdateProperty("Part Number", "")
	C4:UpdateProperty("Software Version", "")
	C4:UpdateProperty("Production (kW)", "")
	C4:UpdateProperty("Consumption (kW)", "")
	C4:UpdateProperty("Grid (kW)", "")
	C4:UpdateProperty("Production Today (kWh)", "")
	C4:UpdateProperty("Consumption Today (kWh)", "")
	C4:UpdateProperty("Excess Solar (kW)", "")
	C4:UpdateProperty("Current Voltage (v)", "")
	C4:UpdateProperty("Enpower Connected", "")
	C4:UpdateProperty("Grid Status", "")
	if (gDiscoveryMode == "manual") then
		gDiscovered = false
		C4:SetPropertyAttribs("Envoy IP", 0)
	else
		C4:SetPropertyAttribs("Envoy IP", 1)
		if (gEnvoyAddress ~= "0.0.0.0") then
			C4:UpdateProperty("Envoy IP", "0.0.0.0")
			gEnvoyAddress = "0.0.0.0"
			gDiscovered = false
			PersistData.IP = nil
			InitGateway()
		end
	end
end

function OPC.Envoy_IP(value)
	if (value == "0.0.0.0") then
		return
	end
	dbg("Gateway manually set to: " .. value)
	gEnvoyAddress = value
	APIBase = "http://" .. gEnvoyAddress
	PersistData.IP = gEnvoyAddress
	gDiscovered = true
	PollGateway()
end

function OPC.Polling_Interval(value)
	if (value) then
		gPollInterval = value
		PersistData.PollInterval = gPollInterval
		PollGateway()
		SetTimer("PollGateway", gPollInterval * ONE_SECOND)
	end
end

function OPC.Username(value)
	if (value) then
		gAuthUser = value
		PersistData.User = gAuthUser
	end
	if (gAuthUser ~= nil) and (gAuthPass ~= nil) then
		PollGateway()
	end
end

function OPC.Password(value)
	if (value) then
		gAuthPass = value
		PersistData.Pass = gAuthPass
	end
	if (gAuthUser ~= nil) and (gAuthPass ~= nil) then
		PollGateway()
	end
end

--[[=============================================================================
    Received From Proxy
===============================================================================]]

function RFP.SELECT()
	C4:SetTimer(500,function(timer) updateWebUI() end, false)
end

--[[=============================================================================
    Enphase Gateway data functions
===============================================================================]]

function PollGateway()
	if (gDiscovered == false) then 
		InitGateway()
		return 
	end
	GetGatewayInfo()
	GetProductionData()
	GetTotals()
	GetGridStatus()
	SetTimer("PollGateway", gPollInterval * ONE_SECOND)
end

function InitGateway()
	if (gDiscoveryMode == "auto") then
		local serviceName = "_enphase-envoy._tcp.local"
		dbg("Starting MDNS query of " .. serviceName)
		local res = mdns_query(serviceName)
		if (res) then
			for k,v in pairs(res) do
				for k1,v1 in pairs(v) do
					if (k1 == "ipv4") then
						dbg("Gateway found: " .. v1)
						gEnvoyAddress = v1
						APIBase = "http://" .. gEnvoyAddress
						PersistData.IP = gEnvoyAddress
						gDiscovered = true
						PollGateway()
					end
				end
			end
		else
			dbg("No MDNS result")
			gDiscovered = false
		end
	else
		if (gDiscovered == false) then
			dbg("Discovery Mode is Manual, please set Envoy IP address in Properties. Otherwise set to Auto.")
		end
		return
	end
end

function GetGatewayInfo()
	local url = MakeURL("/info")
	HEADERS["Content-Type"] = "application/xml"
	urlGet(url, HEADERS, GetDataResponse, { data_type = "gateway-info" }, OPTIONS)
end

function GetProductionData()
	if (gNeedAuth == true) and (gAuth == false) then 
		gAuthToken = nil
		CreateAuth()
		return
	end
	if (gNeedAuth == true) and (gAuth == true) then
		if (gAuthToken == nil) then
			dbg("GetProductionData(): No Auth Token yet, not continuing.")
			gAuth = false
			return
		elseif (type(gAuthToken) ~= "string") then
			dbg("GetProductionData(): No Auth Token yet, not continuing.")
			gAuth = false
			gAuthToken = nil
			return
		else
			HEADERS["Authorization"] = "Bearer " .. gAuthToken
		end
	end
	local url = MakeURL(ReadingsURI)
	HEADERS["Content-Type"] = "application/json"
	urlGet(url, HEADERS, GetDataResponse, { data_type = "solar-production" }, OPTIONS)
end

function GetTotals()
	if (gNeedAuth == true) and (gAuth == false) then
		gAuthToken = nil
		CreateAuth()
		return
	end
	if (gNeedAuth == true) and (gAuth == true) then
		if (gAuthToken == nil) then
			dbg("GetTotals(): No Auth Token yet, not continuing.")
			gAuth = false
			return
		elseif (type(gAuthToken) ~= "string") then
			dbg("GetTotals(): No Auth Token yet, not continuing.")
			gAuth = false
			gAuthToken = nil
			return
		else
			HEADERS["Authorization"] = "Bearer " .. gAuthToken
		end
	end
	local url = MakeURL("/production.json")
	HEADERS["Content-Type"] = "application/json"
	urlGet(url, HEADERS, GetDataResponse, { data_type = "solar-totals" }, OPTIONS)
end

function GetGridStatus()
	if (gNeedAuth == true) and (gAuth == false) then
		gAuthToken = nil
		CreateAuth()
		return
	end
	if (gNeedAuth == true) and (gAuth == true) then
		if (gAuthToken == nil) then
			dbg("GetGridStatus(): No Auth Token yet, not continuing.")
			gAuth = false
			return
		elseif (type(gAuthToken) ~= "string") then
			dbg("GetTotals(): No Auth Token yet, not continuing.")
			gAuth = false
			gAuthToken = nil
			return
		else
			HEADERS["Authorization"] = "Bearer " .. gAuthToken
		end
	end
	local url = MakeURL("/home.json")
	HEADERS["Content-Type"] = "application/json"
	urlGet(url, HEADERS, GetDataResponse, { data_type = "grid-status" }, OPTIONS)
end

function GetDataResponse(strError, responseCode, tHeaders, data, context, url)
	if (strError) then
		dbg("Error GetDataResponse: " .. strError)
		return
	end
	if (responseCode == 200) then
		if (context["data_type"] == "gateway-info") then
			local t = C4:ParseXml(data)
			local sn = ""
			local pn = ""
			local ver = ""
			for _, v in pairs(t.ChildNodes) do
				if (v.Name == "device") then
					for _, value in pairs(v.ChildNodes) do
						if (value.Name == "sn") then
							sn = value.Value
							gEnvoySerial = sn
							PersistData.Serial = gEnvoySerial
							ENPHASE.SerialNumber(sn)
						elseif (value.Name == "pn") then
							pn = value.Value
							ENPHASE.PartNumber(pn)
						elseif (value.Name == "software") then
							ver = value.Value
							check_ver = tonumber(string.sub(ver, 2, 2))
							if (check_ver < 7) then -- version 4/5 doesnt require https or auth
								PersistData.Version = 4
								APIBase = "http://" .. gEnvoyAddress
								ReadingsURI = "/production.json"
								gAuth = true
								gNeedAuth = false
							else -- version 7 or higher requires https and auth
								PersistData.Version = 7
								APIBase = "https://" .. gEnvoyAddress
								ReadingsURI = "/ivp/meters/readings"
								gNeedAuth = true
								if (gAuthToken == nil) then CreateAuth() end
							end
							if (gInit == false) then gInit = true end
							ENPHASE.SoftwareVersion(ver)
						end
					end
				end
			end
		elseif (context["data_type"] == "solar-production") then
			local production_now
			local consumption_now
			local voltage_now
			if (ReadingsURI == "/production.json") then
				production_now = data["production"][2]["wNow"]
				consumption_now = data["consumption"][1]["wNow"]
				voltage_now = data["production"][2]["rmsVoltage"]
				ENPHASE.Production(production_now)
				ENPHASE.Consumption(consumption_now)
				ENPHASE.Grid(production_now, consumption_now)
				ENPHASE.Excess(production_now, consumption_now)
				ENPHASE.Voltage(voltage_now)
			else
				data = C4:JsonDecode(data)
				production_now = data[1]["activePower"]
				consumption_now = data[2]["activePower"]
				voltage_now = data[1]["voltage"]
				ENPHASE.Production(production_now)
				local consumption_calc = tonumber(production_now) + tonumber(consumption_now)
				ENPHASE.Consumption(consumption_calc)
				ENPHASE.Grid(consumption_calc, production_now)
				ENPHASE.Excess(production_now, consumption_calc)
				ENPHASE.Voltage(voltage_now)
			end
		elseif (context["data_type"] == "solar-totals") then
			local production_today = data["production"][2]["whToday"]
			local consumption_today = data["consumption"][1]["whToday"]
			ENPHASE.DailyProduction(production_today)
			ENPHASE.DailyConsumption(consumption_today)
		elseif (context["data_type"] == "grid-status") then
			if (data["enpower"]) then
				local enpower_connected = data["enpower"]["connected"]
				local grid_status = data["enpower"]["grid_status"]
				ENPHASE.GridStatus(enpower_connected, grid_status)
			end
		end
	elseif (responseCode == 400) then
		dbg("GetDataResponse: " .. context.data_type .. " Error 400.")
	elseif (responseCode == 401) then
		dbg("GetDataResponse: " .. context.data_type .. " Error 401.")
		gAuth = false
		gAuthToken = nil
		CreateAuth()
	elseif (responseCode == 404) then
		dbg("GetDataResponse: " .. context.data_type .. " Error 404.")
	end
end

function CreateAuth()
	if (gEnvoySerial == nil) or (gEnvoySerial == "") then return end
	if (gAuthUser == nil) or (gAuthPass == nil) then return end
	if (gAuthUser == "") or (gAuthPass == "") then return end
	if (gAuthToken) then
		gAuth = true
		return
	end
	local sessionTable = {
		user = {
			email = gAuthUser,
			password = gAuthPass
		}
	}
	local sessionData = C4:JsonEncode(sessionTable)
	HEADERS["Content-Type"] = "application/json"
	urlPost(SessionURI, sessionData, HEADERS, function(strError, responseCode, tHeaders, responseData, context, url)
			if (strError) then
				print("Error getting Session ID: " .. strError)
				return
			end
			gSessionID = responseData['session_id']
			PersistData.SessionID = gSessionID
			local tokenTable = {
				session_id = responseData['session_id'],
				serial_num = gEnvoySerial,
				username = gAuthUser
			}
			local tokenData = C4:JsonEncode(tokenTable)
			urlPost(TokenURI, tokenData, HEADERS, function(strError, responseCode, tHeaders, responseData, context, url)
					if (strError) then
						print("Error getting Token: " .. strError)
						return
					end
					gAuthToken = responseData
					PersistData.Token = gAuthToken
					gAuth = true
					gNeedAuth = true
				end, nil, nil)
		end, nil, nil)
end

function ENPHASE.SerialNumber(data)
	C4:UpdateProperty("Serial Number", data)
end

function ENPHASE.PartNumber(data)
	C4:UpdateProperty("Part Number", data)
end

function ENPHASE.SoftwareVersion(data)
	C4:UpdateProperty("Software Version", data)
end

function ENPHASE.Production(data)
	local value = string.format("%.2f", data / 1000)
	C4:SetVariable("PRODUCTION_KW", value)
	C4:UpdateProperty("Production (kW)", tostring(value))
	updateWebUI()
end

function ENPHASE.Consumption(data)
	local value = string.format("%.2f", data / 1000)
	C4:SetVariable("CONSUMPTION_KW", value)
	C4:UpdateProperty("Consumption (kW)", tostring(value))
	updateWebUI()
end

function ENPHASE.Grid(consumption_now, production_now)
	if (consumption_now and production_now) then
		local data = 0
		if (ReadingsURI == "/production.json") then
			data = tonumber(production_now) - tonumber(consumption_now)
		else
			data = tonumber(consumption_now) - tonumber(production_now)
		end
		local value = string.format("%.2f", data / 1000)
		C4:SetVariable("GRID_POWER_KW", value)
		C4:UpdateProperty("Grid (kW)", tostring(value))
		updateWebUI()
	end
end

function ENPHASE.DailyProduction(data)
	local value = string.format("%.2f", data / 1000)
	C4:SetVariable("DAILY_ENERGY_PRODUCTION_KWH", value)
	C4:UpdateProperty("Production Today (kWh)", tostring(value))
	updateWebUI()
end

function ENPHASE.DailyConsumption(data)
	local value = string.format("%.2f", data / 1000)
	C4:SetVariable("DAILY_ENERGY_CONSUMPTION_KWH", value)
	C4:UpdateProperty("Consumption Today (kWh)", tostring(value))
	updateWebUI()
end

function ENPHASE.Excess(consumption_now, production_now)
	if (consumption_now and production_now) then
		local value = tonumber(consumption_now) - tonumber(production_now)
		local excess = "0"
		if (value < 0) then
			excess = "0"
			value = "0.00"
		else
			excess = "1"
			value = string.format("%.2f", value / 1000)
		end
		C4:SetVariable("EXCESS_SOLAR", excess)
		C4:SetVariable("EXCESS_SOLAR_KW", value)
		C4:UpdateProperty("Excess Solar (kW)", tostring(value))
		updateWebUI()
	end
end

function ENPHASE.Voltage(data)
	C4:SetVariable("CURRENT_VOLTAGE", data)
	C4:UpdateProperty("Current Voltage (v)", tostring(data))
end

function ENPHASE.GridStatus(enpower_connected, grid_status)
	local enpower = "0"
	if (enpower_connected == false) then
		enpower = "0"
	else
		enpower = "1"
	end
	C4:SetVariable("ENPOWER_CONNECTED", enpower)
	C4:SetVariable("GRID_STATUS", tostring(grid_status))
	C4:UpdateProperty("Enpower Connected", tostring(enpower_connected))
	C4:UpdateProperty("Grid Status", tostring(grid_status))
end

--[[=============================================================================
    Send Data to the Web UI
===============================================================================]]

function updateWebUI()
	local xml = BuildXmlPacket()
	C4:SendDataToUI(xml)
end

function BuildXmlPacket()
	local properties = {
		{ id = "PRODUCTION_KW", value = Variables.PRODUCTION_KW },
		{ id = "CONSUMPTION_KW", value = Variables.CONSUMPTION_KW },
		{ id = "GRID_POWER_KW", value = Variables.GRID_POWER_KW },
		{ id = "DAILY_ENERGY_PRODUCTION_KWH", value = Variables.DAILY_ENERGY_PRODUCTION_KWH },
		{ id = "DAILY_ENERGY_CONSUMPTION_KWH", value = Variables.DAILY_ENERGY_CONSUMPTION_KWH },
		{ id = "EXCESS_SOLAR_KW", value = Variables.EXCESS_SOLAR_KW }
	}
	local xml = "<data>"
	for _, property in ipairs(properties) do
		xml = xml .. BuildSimpleXml(property.id, property.value)
	end
	xml = xml .. "</data>"
	return xml
end

function BuildSimpleXml(id, value)
	if not value then
		return ""
	end
	local xml = ""
	xml = xml .. "<" .. id .. ">" .. value .. "</" .. id .. ">"
	return xml
end