Skip to content

Timeouts and Other Improvements #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asantaga merged 10 commits into from
Jan 12, 2020
Merged

Timeouts and Other Improvements #7

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fdcab63
Updated: Added timeout setting to all requests
msp1974 Jan 11, 2020
1c46e8e
Merge pull request #1 from msp1974/timeout
msp1974 Jan 11, 2020
06e8370
Added: Functions to convert between wiser temp value and decimal temp…
msp1974 Jan 11, 2020
3698855
Updated: Added function descriptions
msp1974 Jan 11, 2020
4b71fb0
Merge pull request #2 from msp1974/MinorImprovements
msp1974 Jan 11, 2020
8fb20da
Corrected typo in setRoomMode
msp1974 Jan 11, 2020
2d28fc4
Fix for issue #1. Only shows warning if room has no TRVs or RoomStats
msp1974 Jan 11, 2020
87e46eb
Merge pull request #3 from msp1974/MinorImprovements
msp1974 Jan 11, 2020
c51b4a7
Fixed: Error calling temp range check
msp1974 Jan 11, 2020
de04a25
Merge pull request #4 from msp1974/MinorImprovements
msp1974 Jan 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 83 additions & 39 deletions wiserHeatingAPI/wiserHub.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@
WISERSETROOMTEMP= "http://{}//data/domain/Room/{}"
WISERROOM="http://{}//data/domain/Room/{}"

TEMP_MINIMUM = 5
TEMP_MAXIMUM = 30
TEMP_OFF = -20

TIMEOUT=10


class wiserHub():

Expand All @@ -36,31 +42,67 @@ def __init__(self,hubIP,secret):
self.device2roomMap={} # Dict holding Valve2Room mapping convinience variable
self.refreshData() # Issue first refresh in init

def __toWiserTemp(self,temp):
"""
Converts from temperature to wiser hub format
param temp: The temperature to convert
return: Integer
"""
temp = int(temp*10)
return temp

def __fromWiserTemp(self,temp):
"""
Conerts from wiser hub temperature format to decimal value
param temp: The wiser temperature to convert
return: Float
"""
temp = round(temp/10,1)
return temp

def __checkTempRange(self,temp):
"""
Validates temperatures are within the allowed range for the wiser hub
param temp: The temperature to check
return: Boolean
"""
if (temp != TEMP_OFF and (temp < TEMP_MINIMUM or temp > TEMP_MAXIMUM)):
return False
else:
return True

def refreshData(self):
"""
Forces a refresh of data
return: JSON Data
"""
smartValves=[]
_LOGGER.info("Updating Wiser Hub Data")
self.wiserHubData = requests.get(WISERHUBURL.format(
self.hubIP), headers=self.headers).json()
_LOGGER.debug("Wiser Hub Data received {} ".format(self.wiserHubData))
if self.getRooms()!=None:
for room in self.getRooms():
roomStatId=room.get("RoomStatId")
if roomStatId!=None:
#RoomStat found add it to the list
self.device2roomMap[roomStatId]={"roomId":room.get("id"), "roomName":room.get("Name")}
smartValves=room.get("SmartValveIds")
if smartValves!=None:
for valveId in smartValves:
try:
self.wiserHubData = requests.get(WISERHUBURL.format(
self.hubIP), headers=self.headers, timeout=TIMEOUT).json()
_LOGGER.debug("Wiser Hub Data received {} ".format(self.wiserHubData))
if self.getRooms()!=None:
for room in self.getRooms():
roomStatId=room.get("RoomStatId")
if roomStatId!=None:
#RoomStat found add it to the list
self.device2roomMap[roomStatId]={"roomId":room.get("id"), "roomName":room.get("Name")}
smartValves=room.get("SmartValveIds")
if smartValves!=None:
for valveId in smartValves:
self.device2roomMap[valveId]={"roomId":room.get("id"), "roomName":room.get("Name")}
else:
_LOGGER.warning(" Room doesnt contain any smart valves, maybe an error/corruption?? ")
_LOGGER.debug(" valve2roomMap{} ".format(self.device2roomMap))
else:
_LOGGER.warning("Wiser found no rooms")
#Show warning if room contains no devices.
if roomStatId is None and smartValves is None:
#No devices in room
_LOGGER.warning("Room {} doesn't contain any smart valves or thermostats.".format(room.get("Name")))
_LOGGER.debug(" valve2roomMap{} ".format(self.device2roomMap))
else:
_LOGGER.warning("Wiser found no rooms")
except requests.Timeout:
_LOGGER.debug("Connection timed out trying to update from Wiser Hub")
except requests.ConnectionError:
_LOGGER.debug("Connection error trying to update from Wiser Hub")
return self.wiserHubData


Expand Down Expand Up @@ -233,16 +275,16 @@ def setHomeAwayMode(self,mode,temperature=10):
if (mode=="AWAY"):
if temperature==None:
raise Exception("setAwayHome set to AWAY but not temperature set")
if temperature== -20 or temperature <0 or temperature>30:
raise Exception("setAwayHome temperature can only be between 5 and 30 or -20(Off)")
if not (self.__checkTempRange(temperature)):
raise Exception("setAwayHome temperature can only be between 5 and 30 or -20(Off)")
_LOGGER.info("Setting Home/Away : {}".format(mode))
temperature=temperature*10

if (mode=="AWAY"):
self.patchData={"type":2,"setPoint":temperature}
self.patchData={"type":2,"setPoint":self.__toWiserTemp(temperature)}
else:
self.patchData={"type":0,"setPoint":0}
_LOGGER.debug ("patchdata {} ".format(self.patchData))
self.response = requests.patch(url=WISERMODEURL.format(self.hubIP), headers=self.headers,json =self.patchData )
self.response = requests.patch(url=WISERMODEURL.format(self.hubIP), headers=self.headers, json=self.patchData, timeout=TIMEOUT)
if (self.response.status_code!=200):
_LOGGER.debug("Set Home/Away Response code = {}".format(self.response.status_code))
raise Exception("Error setting Home/Away , error {} {}".format(self.response.status_code, self.response.text))
Expand All @@ -256,12 +298,12 @@ def setRoomTemperature(self, roomId, temperature):
param temperature: The temperature in celcius from 5 to 30, -20 for Off
"""
_LOGGER.info("Set Room {} Temperature to = {} ".format(roomId,temperature))
if ((temperature!=-20) and (temperature<5 or temperature>30)):
if not (self.__checkTempRange(temperature)):
raise Exception("SetRoomTemperature : value of temperature must be between 5 and 30 OR -20 (off)")
apitemp=temperature*10
patchData={"RequestOverride":{"Type":"Manual","SetPoint":apitemp}}

patchData={"RequestOverride":{"Type":"Manual","SetPoint":self.__toWiserTemp(temperature)}}
self.response = requests.patch(WISERSETROOMTEMP.format(
self.hubIP,roomId), headers=self.headers,json=patchData)
self.hubIP,roomId), headers=self.headers, json=patchData, timeout=TIMEOUT)

if self.response.status_code != 200:
_LOGGER.error("Set Room {} Temperature to = {} resulted in {}".format(roomId,temperature,self.response.status_code))
Expand Down Expand Up @@ -293,38 +335,40 @@ def setRoomMode(self,roomId, mode,boost_temp=20,boost_temp_time=30):
#Do Auto
patchData= {"Mode":"Auto"}
elif (mode.lower()=="boost"):
temp=boost_temp*10
_LOGGER.debug("Setting Boost Temp to {}".format(temp))
patchData={"RequestOverride":{"Type":"Manual","DurationMinutes": boost_temp_time, "SetPoint":temp, "Originator":"App"}}
if (boost_temp < TEMP_MINIMUM or boost_temp > TEMP_MAXIMUM):
raise Exception("Boost temperature is set to {}. Boost temperature can only be between 5 and 30.".format(boost_temp))
_LOGGER.debug("Setting room {} to boost mode with temp of {} for {} mins".format(roomId, boost_temp, boost_temp_time))
patchData={"RequestOverride":{"Type":"Manual","DurationMinutes": boost_temp_time, "SetPoint":self.__toWiserTemp(boost_temp), "Originator":"App"}}
elif (mode.lower()=="manual"):
# When setting back to manual , set the temp to the scheduled temp
newTemp=self.getRoom(roomId).get("ScheduledSetPoint")
# When setting to manual , set the temp to the current scheduled temp
setTemp=self.__fromWiserTemp(self.getRoom(roomId).get("ScheduledSetPoint"))
#If current scheduled temp is less than 5C then set to min temp
setTemp = setTemp if setTemp >= TEMP_MINIMUM else TEMP_MINIMUM
patchData = {"Mode": "Manual",
"RequestOverride": {"Type": "Manual",
"SetPoint": newTemp}}


"SetPoint": self.__toWiserTemp(setTemp)}}
# Implement trv off as per https://github.com/asantaga/wiserheatingapi/issues/3
elif (mode.lower()=="off"):
patchData = {"Mode": "Manual","RequestOverride": {"Type": "Manual","SetPoint": -200}}
patchData = {"Mode": "Manual","RequestOverride": {"Type": "Manual","SetPoint": self.__toWiserTemp(TEMP_OFF)}}
else:
raise Exception("Error setting setting room mode, received {} but should be auto,boost,off or manual ".format(mode))

# if not a boost operation cancel any current boost
if (mode.lower()!="boost"):
cancelBoostPostData={"RequestOverride":{"Type":"None","DurationMinutes": 0, "SetPoint":0, "Originator":"App"}}

self.response = requests.patch(WISERROOM.format(self.hubIP,roomId), headers=self.headers,json=cancelBoostPostData)
self.response = requests.patch(WISERROOM.format(self.hubIP,roomId), headers=self.headers, json=cancelBoostPostData, timeout=TIMEOUT)
if (self.response.status_code != 200):
_LOGGER.error("Cancelling boost resulted in {}".format(self.response.status_code))
raise Exception("Error cancelling boost {} ".format(mode))

# Set new mode
self.response = requests.patch(WISERROOM.format(
self.hubIP,roomId), headers=self.headers,json=patchData)
self.hubIP,roomId), headers=self.headers, json=patchData, timeout=TIMEOUT)
if self.response.status_code != 200:
_LOGGER.error("Set Room mode to {} resulted in {}".format(mode,self.response.status_code))
raise Exception("Error setting mode to error {} ".format(mode))
_LOGGER.error("Set Room {} to Mode {} resulted in {}".format(roomId,mode,self.response.status_code))
raise Exception("Error setting mode to {}, error {} ".format(mode, self.response.text))
_LOGGER.debug("Set room mode, error {} ({})".format(self.response.status_code, self.response.text))



Expand Down