1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
|
""" Python Code for Communication with the Ecobee Thermostat """
import datetime
from typing import Optional
import requests
from requests.exceptions import HTTPError, RequestException, Timeout
try:
import simplejson as json
except ImportError:
import json
from .const import (
_LOGGER,
ECOBEE_ACCESS_TOKEN,
ECOBEE_API_KEY,
ECOBEE_API_VERSION,
ECOBEE_AUTH0_TOKEN,
ECOBEE_AUTH_BASE_URL,
ECOBEE_AUTHORIZATION_CODE,
ECOBEE_BASE_URL,
ECOBEE_CONFIG_FILENAME,
ECOBEE_DEFAULT_TIMEOUT,
ECOBEE_ENDPOINT_AUTH,
ECOBEE_ENDPOINT_THERMOSTAT,
ECOBEE_ENDPOINT_TOKEN,
ECOBEE_OPTIONS_NOTIFICATIONS,
ECOBEE_PASSWORD,
ECOBEE_REFRESH_TOKEN,
ECOBEE_USERNAME,
ECOBEE_WEB_CLIENT_ID,
)
from .errors import ExpiredTokenError, InvalidSensorError, InvalidTokenError
from .util import config_from_file, convert_to_bool
class Ecobee(object):
"""Class for communicating with the ecobee API."""
def __init__(self, config_filename: str = None, config: dict = None):
self.thermostats = None
self.config_filename = config_filename
self.config = config
self.api_key = None
self.pin = None
self.authorization_code = None
self.access_token = None
self.refresh_token = None
self.username = None
self.password = None
self.auth0_token = None
self.include_notifications = False
if self.config_filename is None and self.config is None:
_LOGGER.error("No ecobee credentials supplied, unable to continue")
return
if self.config:
self._file_based_config = False
self.api_key = self.config.get(ECOBEE_API_KEY)
if ECOBEE_ACCESS_TOKEN in self.config:
self.access_token = self.config[ECOBEE_ACCESS_TOKEN]
if ECOBEE_AUTHORIZATION_CODE in self.config:
self.authorization_code = self.config[ECOBEE_AUTHORIZATION_CODE]
if ECOBEE_REFRESH_TOKEN in self.config:
self.refresh_token = self.config[ECOBEE_REFRESH_TOKEN]
if ECOBEE_USERNAME in self.config:
self.username = self.config[ECOBEE_USERNAME]
if ECOBEE_PASSWORD in self.config:
self.password = self.config[ECOBEE_PASSWORD]
if ECOBEE_AUTH0_TOKEN in self.config:
self.auth0_token = self.config[ECOBEE_AUTH0_TOKEN]
if ECOBEE_OPTIONS_NOTIFICATIONS in self.config:
self.include_notifications = convert_to_bool(self.config[ECOBEE_OPTIONS_NOTIFICATIONS])
else:
self._file_based_config = True
def read_config_from_file(self) -> None:
"""Reads config info from passed-in config filename."""
if self._file_based_config:
self.config = config_from_file(self.config_filename)
self.api_key = self.config[ECOBEE_API_KEY]
if ECOBEE_ACCESS_TOKEN in self.config:
self.access_token = self.config[ECOBEE_ACCESS_TOKEN]
if ECOBEE_AUTHORIZATION_CODE in self.config:
self.authorization_code = self.config[ECOBEE_AUTHORIZATION_CODE]
if ECOBEE_REFRESH_TOKEN in self.config:
self.refresh_token = self.config[ECOBEE_REFRESH_TOKEN]
if ECOBEE_USERNAME in self.config:
self.username = self.config[ECOBEE_USERNAME]
if ECOBEE_PASSWORD in self.config:
self.password = self.config[ECOBEE_PASSWORD]
if ECOBEE_AUTH0_TOKEN in self.config:
self.auth0_token = self.config[ECOBEE_AUTH0_TOKEN]
if ECOBEE_OPTIONS_NOTIFICATIONS in self.config:
self.include_notifications = convert_to_bool(self.config[ECOBEE_OPTIONS_NOTIFICATIONS])
def _write_config(self) -> None:
"""Writes API tokens to a file or self.config if self.file_based_config is False."""
config = dict()
config[ECOBEE_API_KEY] = self.api_key
config[ECOBEE_ACCESS_TOKEN] = self.access_token
config[ECOBEE_REFRESH_TOKEN] = self.refresh_token
config[ECOBEE_USERNAME] = self.username
config[ECOBEE_PASSWORD] = self.password
config[ECOBEE_AUTH0_TOKEN] = self.auth0_token
config[ECOBEE_AUTHORIZATION_CODE] = self.authorization_code
config[ECOBEE_OPTIONS_NOTIFICATIONS] = str(self.include_notifications)
if self._file_based_config:
config_from_file(self.config_filename, config)
else:
self.config = config
def request_pin(self) -> bool:
"""Requests a PIN from ecobee for authorization on ecobee.com."""
params = {
"response_type": "ecobeePin",
"client_id": self.api_key,
"scope": "smartWrite",
}
log_msg_action = "request pin"
response = self._request(
"GET",
ECOBEE_ENDPOINT_AUTH,
log_msg_action,
params=params,
auth_request=True,
)
try:
self.authorization_code = response["code"]
self.pin = response["ecobeePin"]
_LOGGER.debug(
f"Authorize your ecobee developer app with PIN code {self.pin}. "
f"Goto https://www.ecobee/com/consumerportal/index.html, "
f"Click My Apps, Add Application, Enter Pin and click Authorize. "
f"After authorizing, call request_tokens method."
)
return True
except (KeyError, TypeError) as err:
_LOGGER.debug(f"Error obtaining PIN code from ecobee: {err}")
return False
def request_tokens(self) -> bool:
"""Requests API tokens from ecobee."""
if self.auth0_token is not None:
return self.request_tokens_web()
params = {
"grant_type": "ecobeePin",
"code": self.authorization_code,
"client_id": self.api_key,
}
log_msg_action = "request tokens"
response = self._request(
"POST",
ECOBEE_ENDPOINT_TOKEN,
log_msg_action,
params=params,
auth_request=True,
)
try:
self.access_token = response["access_token"]
self.refresh_token = response["refresh_token"]
self._write_config()
self.pin = None
_LOGGER.debug(f"Obtained tokens from ecobee: access {self.access_token}, "
f"refresh {self.refresh_token}")
return True
except (KeyError, TypeError) as err:
_LOGGER.debug(f"Error obtaining tokens from ecobee: {err}")
return False
def request_tokens_web(self) -> bool:
# Keep all cookies in a session
session = requests.Session()
# Get the auth0 token and redirect to the identifier step of the login flow
auth0_url = f"{ECOBEE_AUTH_BASE_URL}/{ECOBEE_ENDPOINT_AUTH}"
resp = session.get(
auth0_url,
params={
"response_type": "token",
"response_mode": "form_post",
"client_id": ECOBEE_WEB_CLIENT_ID,
"redirect_uri": "https://www.ecobee.com/home/authCallback",
"audience": "https://prod.ecobee.com/api/v1",
"scope": "openid smartWrite piiWrite piiRead smartRead deleteGrants",
},
)
if "auth0" not in session.cookies:
_LOGGER.error(
f"Failed to obtain auth0 token from {auth0_url}: {resp.status_code} {resp.text}"
)
return False
else:
self.auth0_token = session.cookies["auth0"]
# Submit the identifier/username and redirect to the password step
identifier_url = resp.url
resp = session.post(
identifier_url,
data={
"username": self.username,
},
)
if resp.status_code != 200:
_LOGGER.error(f"Failed to submit username: {resp.status_code} {resp.text}")
return False
# Submit the password and get the access_token
password_url = resp.url
resp = session.post(
password_url,
data={
"username": self.username,
"password": self.password,
},
)
if resp.status_code != 200:
_LOGGER.error(f"Failed to submit password: {resp.status_code} {resp.text}")
return False
if (
access_token := resp.text.split('name="access_token" value="')[1].split(
'"'
)[0]
) is None:
_LOGGER.error("Failed to refresh bearer token: no access token in response")
return False
self.access_token = access_token
if (
expires_in := resp.text.split('name="expires_in" value="')[1].split('"')[0]
) is None:
_LOGGER.error("Failed to refresh bearer token: no expiration in response")
return False
expires_at = datetime.datetime.now() + datetime.timedelta(
seconds=int(expires_in)
)
_LOGGER.debug(f"Access token expires at {expires_at}")
self._write_config()
return True
def refresh_tokens(self) -> bool:
if self.username and self.password:
return self.request_tokens_web()
"""Refreshes ecobee API tokens."""
params = {
"grant_type": "refresh_token",
"refresh_token": self.refresh_token,
"client_id": self.api_key,
}
log_msg_action = "refresh tokens"
response = self._request(
"POST",
ECOBEE_ENDPOINT_TOKEN,
log_msg_action,
params=params,
auth_request=True,
)
try:
self.access_token = response["access_token"]
self.refresh_token = response["refresh_token"]
self._write_config()
_LOGGER.debug(f"Refreshed tokens from ecobee: access {self.access_token}, "
f"refresh {self.refresh_token}")
return True
except (KeyError, TypeError) as err:
_LOGGER.debug(f"Error refreshing tokens from ecobee: {err}")
return False
def get_thermostats(self) -> bool:
"""Gets a json-list of thermostats from ecobee and caches in self.thermostats."""
param_string = {
"selection": {
"selectionType": "registered",
"includeRuntime": "true",
"includeSensors": "true",
"includeProgram": "true",
"includeEquipmentStatus": "true",
"includeEvents": "true",
"includeWeather": "true",
"includeSettings": "true",
"includeLocation": "true",
}
}
if self.include_notifications:
param_string["selection"]["includeNotificationSettings"] = self.include_notifications
params = {"json": json.dumps(param_string)}
log_msg_action = "get thermostats"
response = self._request_with_refresh(
"GET", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, params=params
)
try:
self.thermostats = response["thermostatList"]
return True
except (KeyError, TypeError):
return False
def get_thermostat(self, index: int) -> str:
"""Returns a single thermostat based on list index of self.thermostats."""
return self.thermostats[index]
def get_remote_sensors(self, index: int) -> str:
"""Returns remote sensors from a thermostat based on list index of self.thermostats."""
return self.thermostats[index]["remoteSensors"]
def get_equipment_notifications(self, index: int) -> str:
"""Returns equipment notifications from a thermostat based on list index of self.thermostats."""
return self.thermostats[index]["notificationSettings"]["equipment"]
def update(self) -> bool:
"""Gets new thermostat data from ecobee; wrapper for get_thermostats."""
return self.get_thermostats()
def set_hvac_mode(self, index: int, hvac_mode: str) -> None:
"""Sets the HVAC mode (auto, auxHeatOnly, cool, heat, off)."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"hvacMode": hvac_mode}},
}
log_msg_action = "set HVAC mode"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_fan_min_on_time(self, index: int, fan_min_on_time: int) -> None:
"""Sets the minimum time, in minutes, to run the fan each hour (1 to 60)."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"fanMinOnTime": fan_min_on_time}},
}
log_msg_action = "set fan minimum on time"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_fan_mode(
self,
index: int,
fan_mode: str,
hold_type: str,
**optional_arg,
) -> None:
"""
Sets the fan mode (auto, minontime, on).
valid optional_arg
holdHours - required if HoldType is holdHours
coolHoldTemp
heatHoldTemp
"""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [
{
"type": "setHold",
"params": {
"holdType": hold_type,
"fan": fan_mode,
},
}
],
}
# Set the optional args
if "holdHours" in optional_arg:
# Required if and only if hold_type == holdHours
if hold_type == "holdHours":
body["functions"][0]["params"]["holdHours"] = int(optional_arg["holdHours"])
if "coolHoldTemp" in optional_arg:
body["functions"][0]["params"]["coolHoldTemp"] = int(optional_arg["coolHoldTemp"]) * 10
if "heatHoldTemp" in optional_arg:
body["functions"][0]["params"]["heatHoldTemp"] = int(optional_arg["heatHoldTemp"]) * 10
log_msg_action = "set fan mode"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_hold_temp(
self,
index: int,
cool_temp: float,
heat_temp: float,
hold_type: str = "nextTransition",
hold_hours: str = "2",
) -> None:
"""Sets a hold temperature."""
if hold_type == "holdHours":
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [
{
"type": "setHold",
"params": {
"holdType": hold_type,
"coolHoldTemp": int(cool_temp * 10),
"heatHoldTemp": int(heat_temp * 10),
"holdHours": hold_hours,
},
}
],
}
else:
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [
{
"type": "setHold",
"params": {
"holdType": hold_type,
"coolHoldTemp": int(cool_temp * 10),
"heatHoldTemp": int(heat_temp * 10),
},
}
],
}
log_msg_action = "set hold temp"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_climate_hold(
self, index: int, climate: str, hold_type: str = "nextTransition", hold_hours: int = None
) -> None:
"""Sets a climate hold (away, home, sleep)."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [
{
"type": "setHold",
"params": {"holdType": hold_type, "holdClimateRef": climate, "holdHours": hold_hours},
}
],
}
if hold_type != "holdHours":
del body["functions"][0]["params"]["holdHours"]
log_msg_action = "set climate hold"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def create_vacation(
self,
index: int,
vacation_name: str,
cool_temp: float,
heat_temp: float,
start_date: str = None,
start_time: str = None,
end_date: str = None,
end_time: str = None,
fan_mode: str = "auto",
fan_min_on_time: str = "0",
) -> None:
"""Creates a vacation."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [
{
"type": "createVacation",
"params": {
"name": vacation_name,
"coolHoldTemp": int(cool_temp * 10),
"heatHoldTemp": int(heat_temp * 10),
"startDate": start_date,
"startTime": start_time,
"endDate": end_date,
"endTime": end_time,
"fan": fan_mode,
"fanMinOnTime": fan_min_on_time,
},
}
],
}
log_msg_action = "create a vacation"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def delete_vacation(self, index: int, vacation: str) -> None:
"""Deletes a vacation."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [{"type": "deleteVacation", "params": {"name": vacation}}],
}
log_msg_action = "delete a vacation"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def resume_program(self, index: int, resume_all: bool = False) -> None:
"""Resumes the currently scheduled program."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [
{"type": "resumeProgram", "params": {"resumeAll": resume_all}}
],
}
log_msg_action = "resume program"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def send_message(self, index: int, message: str = None) -> None:
"""Sends the first 500 characters of a message to the thermostat."""
if message is None:
message = "Hello from pyecobee!"
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"functions": [{"type": "sendMessage", "params": {"text": message[0:500]}}],
}
log_msg_action = "send message"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_dehumidifier_mode(self, index: int, dehumidifier_mode: str) -> None:
"""Sets the dehumidifier mode (on, off)."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"dehumidifierMode": dehumidifier_mode}},
}
log_msg_action = "set dehumidifier mode"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_dehumidifier_level(self, index: int, dehumidifier_level: int) -> None:
"""Sets the dehumidification set point in percentage."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"dehumidifierLevel": dehumidifier_level}}
}
log_msg_action = "set dehumidifier level"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_humidifier_mode(self, index: int, humidifier_mode: str) -> None:
"""Sets the humidifier mode (auto, off, manual)."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"humidifierMode": humidifier_mode}},
}
log_msg_action = "set humidifier mode"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_humidity(self, index: int, humidity: str) -> None:
"""Sets target humidity level."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"humidity": str(humidity)}},
}
log_msg_action = "set humidity level"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_mic_mode(self, index: int, mic_enabled: bool) -> None:
"""Enables/Disables Alexa microphone (only for ecobee4)."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"audio": {"microphoneEnabled": mic_enabled}},
}
log_msg_action = "set mic mode"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_occupancy_modes(
self, index: int, auto_away: bool = None, follow_me: bool = None
) -> None:
"""Enables/Disables Smart Home/Away and Follow Me modes."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {
"settings": {"autoAway": auto_away, "followMeComfort": follow_me}
},
}
log_msg_action = "set occupancy modes"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_dst_mode(self, index: int, enable_dst: bool) -> None:
"""Enables/Disables daylight savings time."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"location": {"isDaylightSaving": enable_dst}},
}
log_msg_action = "set dst mode"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_vent_mode(self, index: int, vent_mode: str) -> None:
"""Sets the ventilator mode. Values: auto, minontime, on, off."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"vent": vent_mode}},
}
log_msg_action = "set vent mode"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_ventilator_min_on_time(self, index: int, ventilator_min_on_time: int) -> None:
"""Sets the minimum time in minutes the ventilator is configured to run."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"ventilatorMinOnTime": ventilator_min_on_time}},
}
log_msg_action = "set ventilator minimum on time"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_ventilator_min_on_time_home(self, index: int, ventilator_min_on_time_home: int) -> None:
"""Sets the number of minutes to run ventilator per hour when home."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"ventilatorMinOnTimeHome": ventilator_min_on_time_home}},
}
log_msg_action = "set ventilator minimum on time when homw"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_ventilator_min_on_time_away(self, index: int, ventilator_min_on_time_away: int) -> None:
"""Sets the number of minutes to run ventilator per hour when away."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"ventilatorMinOnTimeAway": ventilator_min_on_time_away}},
}
log_msg_action = "set ventilator minimum on time when away"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_ventilator_timer(self, index: int, ventilator_on: bool) -> None:
"""Sets whether the ventilator timer is on or off."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"isVentilatorTimerOn": ventilator_on}},
}
log_msg_action = "set ventilator timer"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def set_aux_cutover_threshold(self, index: int, threshold: int) -> None:
"""Set the threshold for outdoor temp below which alt heat will be used."""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {"settings": {"compressorProtectionMinTemp": int(threshold * 10)}},
}
log_msg_action = "set outdoor temp threshold for aux"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def update_climate_sensors(self, index: int, climate_name: str, sensor_names: Optional[list]=None, sensor_ids: Optional[list]=None) -> None:
"""Get current climate program. Must provide either `sensor_names` or `ids`."""
# Ensure only either `sensor_names` or `ids` was provided.
if sensor_names is None and sensor_ids is None:
raise ValueError("Need to provide either `sensor_names` or `ids`.")
if sensor_names and sensor_ids:
raise ValueError("Either `sensor_names` or `ids` should be provided, not both.")
programs: dict = self.thermostats[index]["program"]
# Remove currentClimateRef key.
programs.pop("currentClimateRef", None)
for i, climate in enumerate(programs["climates"]):
if climate["name"] == climate_name:
climate_index = i
sensors = self.get_remote_sensors(index)
sensor_list = []
if sensor_ids:
"""Update climate sensors with sensor_ids list."""
for id in sensor_ids:
for sensor in sensors:
if sensor["id"] == id:
sensor_list.append(
{"id": "{}:1".format(id), "name": sensor["name"]})
if sensor_names:
"""Update climate sensors with sensor_names list."""
for name in sensor_names:
"""Find the sensor id from the name."""
for sensor in sensors:
if sensor["name"] == name:
sensor_list.append(
{"id": "{}:1".format(sensor["id"]), "name": name})
if len(sensor_list) == 0:
raise InvalidSensorError("no sensor matching provided ids or names on thermostat")
try:
programs["climates"][climate_index]["sensors"] = sensor_list
except UnboundLocalError:
"""This would occur if the climate_index was not assigned
because the climate name does not exist in the program climates."""
return
"""Updates Climate"""
body = {
"selection": {
"selectionType": "thermostats",
"selectionMatch": self.thermostats[index]["identifier"],
},
"thermostat": {
"program": programs
}
}
log_msg_action = "upate climate sensors"
try:
self._request_with_refresh(
"POST", ECOBEE_ENDPOINT_THERMOSTAT, log_msg_action, body=body
)
except (ExpiredTokenError, InvalidTokenError) as err:
raise err
def _request_with_refresh(
self,
method: str,
endpoint: str,
log_msg_action: str,
params: dict = None,
body: dict = None,
auth_request: bool = False,
) -> Optional[str]:
"""
Wrapper around _request, to refresh tokens if needed.
If an ExpiredTokenError is seen call refresh_tokens and
try one more time. Otherwise, send the results up
"""
response = None
refreshed = False
for _ in range(0, 2):
try:
response = self._request(
method, endpoint, log_msg_action, params, body, auth_request
)
except ExpiredTokenError:
if not refreshed:
# Refresh tokens and try again
self.refresh_tokens()
refreshed = True
continue
else:
# Send the exception up the stack otherwise
raise
except InvalidTokenError:
raise
# Success, fall out of the loop
break
return response
def _request(
self,
method: str,
endpoint: str,
log_msg_action: str,
params: dict = None,
body: dict = None,
auth_request: bool = False,
) -> Optional[str]:
"""Makes a request to the ecobee API."""
url = f"{ECOBEE_BASE_URL}/{endpoint}"
headers = dict()
if not auth_request:
url = f"{ECOBEE_BASE_URL}/{ECOBEE_API_VERSION}/{endpoint}"
headers = {
"Content-Type": "application/json;charset=UTF-8",
"Authorization": f"Bearer {self.access_token}",
}
_LOGGER.debug(
f"Making request to {endpoint} endpoint to {log_msg_action}: "
f"url: {url}, headers: {headers}, params: {params}, body: {body}"
)
try:
response = requests.request(
method, url, headers=headers, params=params, json=body, timeout=ECOBEE_DEFAULT_TIMEOUT
)
try:
log_msg = response.json()
except:
log_msg = response.text
_LOGGER.debug(
f"Request response: {response.status_code}: {log_msg}"
)
response.raise_for_status()
return response.json()
except HTTPError:
json_payload = {}
try:
json_payload = response.json()
except json.decoder.JSONDecodeError:
_LOGGER.debug("Invalid JSON payload received")
if auth_request:
if (
response.status_code == 400
and json_payload.get("error") == "invalid_grant"
):
raise InvalidTokenError(
"ecobee tokens invalid; re-authentication required"
)
else:
_LOGGER.error(
f"Error requesting authorization from ecobee: "
f"{response.status_code}: {json_payload}"
)
elif response.status_code == 500:
code = json_payload.get("status", {}).get("code")
if code in [1, 16]:
raise InvalidTokenError(
"ecobee tokens invalid; re-authentication required"
)
elif code == 14:
raise ExpiredTokenError(
"ecobee access token expired; token refresh required"
)
else:
_LOGGER.error(
f"Error from ecobee while attempting to {log_msg_action}: "
f"{code}: {json_payload.get('status', {}).get('message', 'Unknown error')}"
)
else:
_LOGGER.error(
f"Error from ecobee while attempting to {log_msg_action}: "
f"{response.status_code}: {json_payload}"
)
except Timeout:
_LOGGER.error(
f"Connection to ecobee timed out while attempting to {log_msg_action}. "
f"Possible connectivity outage."
)
except json.decoder.JSONDecodeError:
_LOGGER.error(
f"Error decoding response from ecobee while attempting to {log_msg_action}. "
)
except RequestException as err:
_LOGGER.error(
f"Error connecting to ecobee while attempting to {log_msg_action}. "
f"Possible connectivity outage.\n"
f"{err}"
)
return None
|