def __init__(self,
username,
password,
token_file=None,
circuit=0,
cacheDuration=0):
"""Init function. Create the necessary oAuth2 sessions
Parameters
----------
username : str
e-mail address
password : str
password
Returns
-------
"""
if cacheDuration == 0:
self.service = ViCareService(username, password, token_file,
circuit)
else:
self.service = ViCareCachedService(username, password,
cacheDuration, token_file,
circuit)
class Device:
"""This class connects to the Viesmann ViCare API.
The authentication is done through OAuth2.
Note that currently, a new token is generate for each run.
"""
# TODO cirtcuit management should move at method level
def __init__(self,
username,
password,
token_file=None,
circuit=0,
cacheDuration=0):
"""Init function. Create the necessary oAuth2 sessions
Parameters
----------
username : str
e-mail address
password : str
password
Returns
-------
"""
if cacheDuration == 0:
self.service = ViCareService(username, password, token_file,
circuit)
else:
self.service = ViCareCachedService(username, password,
cacheDuration, token_file,
circuit)
""" Set the active mode
Parameters
----------
mode : str
Valid mode can be obtained using getModes()
Returns
-------
result: json
json representation of the answer
"""
def setMode(self, mode):
r = self.service.setProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.modes.active", "setMode",
"{\"mode\":\"" + mode + "\"}")
return r
# Works for normal, reduced, comfort
# active has no action
# exetenral , standby no action
# holiday, sheculde and unscheduled
# activate, decativate comfort,eco
""" Set the target temperature for the target program
Parameters
----------
program : str
Can be normal, reduced or comfort
temperature: int
target temperature
Returns
-------
result: json
json representation of the answer
"""
def setProgramTemperature(self, program: str, temperature: int):
return self.service.setProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.programs." + program, "setTemperature",
"{\"targetTemperature\":" + str(temperature) + "}")
def setReducedTemperature(self, temperature):
return self.setProgramTemperature("reduced", temperature)
def setComfortTemperature(self, temperature):
return self.setProgramTemperature("comfort", temperature)
def setNormalTemperature(self, temperature):
return self.setProgramTemperature("normal", temperature)
""" Activate a program
NOTE
DEVICE_COMMUNICATION_ERROR can just mean that the program is already on
Parameters
----------
program : str
Appears to work only for comfort
Returns
-------
result: json
json representation of the answer
"""
# optional temperature parameter could be passed (but not done)
def activateProgram(self, program):
return self.service.setProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.programs." + program, "activate", "{}")
def activateComfort(self):
return self.activateProgram("comfort")
""" Deactivate a program
Parameters
----------
program : str
Appears to work only for comfort and eco (coming from normal, can be reached only by deactivating another state)
Returns
-------
result: json
json representation of the answer
"""
def deactivateProgram(self, program):
return self.service.setProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.programs." + program, "deactivate", "{}")
def deactivateComfort(self):
return self.deactivateProgram("comfort")
def getMonthSinceLastService(self):
try:
return self.service.getProperty("heating.service.timeBased")[
"properties"]["activeMonthSinceLastService"]["value"]
except KeyError:
return "error"
def getLastServiceDate(self):
try:
return self.service.getProperty("heating.service.timeBased")[
"properties"]["lastService"]["value"]
except KeyError:
return "error"
def getOutsideTemperature(self):
try:
return self.service.getProperty(
"heating.sensors.temperature.outside"
)["properties"]["value"]["value"]
except KeyError:
return "error"
def getSupplyTemperature(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".sensors.temperature.supply")["properties"]["value"]["value"]
except KeyError:
return "error"
def getRoomTemperature(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".sensors.temperature.room")["properties"]["value"]["value"]
except KeyError:
return "error"
def getModes(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.modes.active")["actions"][0]["fields"][0]["enum"]
except KeyError:
return "error"
def getActiveMode(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.modes.active")["properties"]["value"]["value"]
except KeyError:
return "error"
def getHeatingCurveShift(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".heating.curve")["properties"]["shift"]["value"]
except KeyError:
return "error"
def getHeatingCurveSlope(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".heating.curve")["properties"]["slope"]["value"]
except KeyError:
return "error"
def getActiveProgram(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.programs.active")["properties"]["value"]["value"]
except KeyError:
return "error"
def getPrograms(self):
try:
return self.service.getProperty("heating.circuits." +
str(self.service.circuit) +
".operating.programs")["entities"][
9]["properties"]["components"]
except KeyError:
return "error"
def getDesiredTemperatureForProgram(self, program):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.programs." +
program)["properties"]["temperature"]["value"]
except KeyError:
return "error"
def getCurrentDesiredTemperature(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".operating.programs." +
self.getActiveProgram())["properties"]["temperature"]["value"]
except KeyError:
return "error"
def getErrorHistory(self):
try:
return self.service.getProperty(
"heating.errors.history")["properties"]["entries"]["value"]
except KeyError:
return "error"
def getActiveError(self):
try:
return self.service.getProperty(
"heating.errors.active")["properties"]["entries"]["value"]
except KeyError:
return "error"
def getDomesticHotWaterConfiguredTemperature(self):
try:
return self.service.getProperty(
"heating.dhw.temperature")["properties"]["value"]["value"]
except KeyError:
return "error"
def getDomesticHotWaterConfiguredTemperature2(self):
try:
return self.service.getProperty("heating.dhw.temperature.temp2"
)["properties"]["value"]["value"]
except KeyError:
return "error"
def getDomesticHotWaterActiveMode(self):
schedule = self.getDomesticHotWaterSchedule()
if schedule == "error" or schedule["active"] != True:
return None
currentDateTime = datetime.now()
currentTime = currentDateTime.time()
try:
daySchedule = schedule[VICARE_DAYS[currentDateTime.weekday()]]
except KeyError: # no schedule for day configured
return None
tempMode = None
for s in daySchedule:
startTime = time.fromisoformat(s["start"])
endTime = time.fromisoformat(s["end"])
if startTime <= currentTime and currentTime <= endTime:
if s["mode"] == VICARE_DHW_TEMP2: # temp-2 overrides all other modes
return s["mode"]
else:
mode = s["mode"]
return mode
def getDomesticHotWaterDesiredTemperature(self):
mode = self.getDomesticHotWaterActiveMode()
if mode != None:
if mode == VICARE_DHW_TEMP2:
return self.getDomesticHotWaterConfiguredTemperature2()
else:
return self.getDomesticHotWaterConfiguredTemperature()
return None
def getDomesticHotWaterStorageTemperature(self):
try:
return self.service.getProperty(
"heating.dhw.sensors.temperature.hotWaterStorage"
)["properties"]["value"]["value"]
except KeyError:
return "error"
def getDomesticHotWaterPumpActive(self):
try:
return self.service.getProperty(
"heating.dhw.pumps.primary")["properties"]["status"]["value"]
except KeyError:
return "error"
def getDomesticHotWaterMaxTemperature(self):
try:
return self.service.getProperty(
"heating.dhw.temperature")["actions"][0]["fields"][0]["max"]
except KeyError:
return "error"
def getDomesticHotWaterMinTemperature(self):
try:
return self.service.getProperty(
"heating.dhw.temperature")["actions"][0]["fields"][0]["min"]
except KeyError:
return "error"
""" Set the target temperature for domestic host water
Parameters
----------
temperature : int
Target temperature
Returns
-------
result: json
json representation of the answer
"""
def setDomesticHotWaterTemperature(self, temperature):
return self.service.setProperty(
"heating.dhw.temperature", "setTargetTemperature",
"{\"temperature\":" + str(temperature) + "}")
""" Set the target temperature 2 for domestic host water
Parameters
----------
temperature : int
Target temperature
Returns
-------
result: json
json representation of the answer
"""
def setDomesticHotWaterTemperature2(self, temperature):
return self.service.setProperty(
"heating.dhw.temperature.temp2", "setTargetTemperature",
"{\"temperature\":" + str(temperature) + "}")
def getCirculationPumpActive(self):
try:
return self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".circulation.pump")["properties"]["status"]["value"]
except KeyError:
return "error"
def getHeatingSchedule(self):
try:
properties = self.service.getProperty(
"heating.circuits." + str(self.service.circuit) +
".heating.schedule")["properties"]
return {
"active": properties["active"]["value"],
"mon": properties["entries"]["value"]["mon"],
"tue": properties["entries"]["value"]["tue"],
"wed": properties["entries"]["value"]["wed"],
"thu": properties["entries"]["value"]["thu"],
"fri": properties["entries"]["value"]["fri"],
"sat": properties["entries"]["value"]["sat"],
"sun": properties["entries"]["value"]["sun"]
}
except KeyError:
return "error"
def getDomesticHotWaterSchedule(self):
try:
properties = self.service.getProperty(
"heating.dhw.schedule")["properties"]
return {
"active": properties["active"]["value"],
"mon": properties["entries"]["value"]["mon"],
"tue": properties["entries"]["value"]["tue"],
"wed": properties["entries"]["value"]["wed"],
"thu": properties["entries"]["value"]["thu"],
"fri": properties["entries"]["value"]["fri"],
"sat": properties["entries"]["value"]["sat"],
"sun": properties["entries"]["value"]["sun"]
}
except KeyError:
return "error"
class PyViCareCachedServiceTest(unittest.TestCase):
CACHE_DURATION = 60
def setUp(self):
self.oauth_mock = Mock()
self.oauth_mock.get.return_value = {'data': [{"feature": "someprop"}]}
accessor = ViCareDeviceAccessor("[id]", "[serial]", "[device]")
self.service = ViCareCachedService(self.oauth_mock, accessor, [],
self.CACHE_DURATION)
def test_getProperty_existing(self):
self.service.getProperty("someprop")
self.oauth_mock.get.assert_called_once_with(
'/equipment/installations/[id]/gateways/[serial]/devices/[device]/features/'
)
def test_getProperty_nonexisting_raises_exception(self):
def func():
return self.service.getProperty("some-non-prop")
self.assertRaises(PyViCareNotSupportedFeatureError, func)
def test_setProperty_works(self):
self.service.setProperty("someotherprop", "doaction", {'name': 'abc'})
self.oauth_mock.post.assert_called_once_with(
'/equipment/installations/[id]/gateways/[serial]/devices/[device]/features/someotherprop/doaction',
'{"name": "abc"}')
def test_getProperty_existing_cached(self):
# time+0 seconds
with now_is('2000-01-01 00:00:00'):
self.service.getProperty("someprop")
self.service.getProperty("someprop")
# time+30 seconds
with now_is('2000-01-01 00:00:30'):
self.service.getProperty("someprop")
self.assertEqual(self.oauth_mock.get.call_count, 1)
self.oauth_mock.get.assert_called_once_with(
'/equipment/installations/[id]/gateways/[serial]/devices/[device]/features/'
)
# time+70 seconds (must be more than CACHE_DURATION)
with now_is('2000-01-01 00:01:10'):
self.service.getProperty("someprop")
self.assertEqual(self.oauth_mock.get.call_count, 2)
def test_setProperty_invalidateCache(self):
# freeze time
with now_is('2000-01-01 00:00:00'):
self.assertEqual(self.service.is_cache_invalid(), True)
self.service.getProperty("someprop")
self.assertEqual(self.service.is_cache_invalid(), False)
self.service.setProperty("someotherprop", "doaction",
{'name': 'abc'})
self.assertEqual(self.service.is_cache_invalid(), True)
self.service.getProperty("someprop")
self.assertEqual(self.oauth_mock.get.call_count, 2)
def __buildService(self, accessor):
if self.cacheDuration > 0:
return ViCareCachedService(self.oauth_manager, accessor,
self.cacheDuration)
else:
return ViCareService(self.oauth_manager, accessor)
def setUp(self):
self.oauth_mock = Mock()
self.oauth_mock.get.return_value = {'data': [{"feature": "someprop"}]}
accessor = ViCareDeviceAccessor("[id]", "[serial]", "[device]")
self.service = ViCareCachedService(self.oauth_mock, accessor, [],
self.CACHE_DURATION)