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 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
|
import datetime
from enum import IntEnum
import requests
from random import randint
import warnings
import hashlib
name = "growattServer"
BATT_MODE_LOAD_FIRST = 0
BATT_MODE_BATTERY_FIRST = 1
BATT_MODE_GRID_FIRST = 2
def hash_password(password):
"""
Normal MD5, except add c if a byte of the digest is less than 10.
"""
password_md5 = hashlib.md5(password.encode('utf-8')).hexdigest()
for i in range(0, len(password_md5), 2):
if password_md5[i] == '0':
password_md5 = password_md5[0:i] + 'c' + password_md5[i + 1:]
return password_md5
class Timespan(IntEnum):
hour = 0
day = 1
month = 2
class GrowattApi:
server_url = 'https://openapi.growatt.com/'
agent_identifier = "Dalvik/2.1.0 (Linux; U; Android 12; https://github.com/indykoning/PyPi_GrowattServer)"
def __init__(self, add_random_user_id=False, agent_identifier=None):
if (agent_identifier != None):
self.agent_identifier = agent_identifier
# If a random user id is required, generate a 5 digit number and add it to the user agent
if (add_random_user_id):
random_number = ''.join(["{}".format(randint(0, 9))
for num in range(0, 5)])
self.agent_identifier += " - " + random_number
self.session = requests.Session()
self.session.hooks = {
'response': lambda response, *args, **kwargs: response.raise_for_status()
}
headers = {'User-Agent': self.agent_identifier}
self.session.headers.update(headers)
def __get_date_string(self, timespan=None, date=None):
if timespan is not None:
assert timespan in Timespan
if date is None:
date = datetime.datetime.now()
date_str = ""
if timespan == Timespan.month:
date_str = date.strftime('%Y-%m')
else:
date_str = date.strftime('%Y-%m-%d')
return date_str
def get_url(self, page):
"""
Simple helper function to get the page URL.
"""
return self.server_url + page
def login(self, username, password, is_password_hashed=False):
"""
Log the user in.
Returns
'data' -- A List containing Objects containing the folowing
'plantName' -- Friendly name of the plant
'plantId' -- The ID of the plant
'service'
'quality'
'isOpenSmartFamily'
'totalData' -- An Object
'success' -- True or False
'msg'
'app_code'
'user' -- An Object containing a lot of user information
'uid'
'userLanguage'
'inverterGroup' -- A List
'timeZone' -- A Number
'lat'
'lng'
'dataAcqList' -- A List
'type'
'accountName' -- The username
'password' -- The password hash of the user
'isValiPhone'
'kind'
'mailNotice' -- True or False
'id'
'lasLoginIp'
'lastLoginTime'
'userDeviceType'
'phoneNum'
'approved' -- True or False
'area' -- Continent of the user
'smsNotice' -- True or False
'isAgent'
'token'
'nickName'
'parentUserId'
'customerCode'
'country'
'isPhoneNumReg'
'createDate'
'rightlevel'
'appType'
'serverUrl'
'roleId'
'enabled' -- True or False
'agentCode'
'inverterList' -- A list
'email'
'company'
'activeName'
'codeIndex'
'appAlias'
'isBigCustomer'
'noticeType'
"""
if not is_password_hashed:
password = hash_password(password)
response = self.session.post(self.get_url('newTwoLoginAPI.do'), data={
'userName': username,
'password': password
})
data = response.json()['back']
if data['success']:
data.update({
'userId': data['user']['id'],
'userLevel': data['user']['rightlevel']
})
return data
def plant_list(self, user_id):
"""
Get a list of plants connected to this account.
Args:
user_id (str): The ID of the user.
Returns:
list: A list of plants connected to the account.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.get(
self.get_url('PlantListAPI.do'),
params={'userId': user_id},
allow_redirects=False
)
return response.json().get('back', [])
def plant_detail(self, plant_id, timespan, date=None):
"""
Get plant details for specified timespan.
Args:
plant_id (str): The ID of the plant.
timespan (Timespan): The ENUM value conforming to the time window you want e.g. hours from today, days, or months.
date (datetime, optional): The date you are interested in. Defaults to datetime.datetime.now().
Returns:
dict: A dictionary containing the plant details.
Raises:
Exception: If the request to the server fails.
"""
date_str = self.__get_date_string(timespan, date)
response = self.session.get(self.get_url('PlantDetailAPI.do'), params={
'plantId': plant_id,
'type': timespan.value,
'date': date_str
})
return response.json().get('back', {})
def plant_list_two(self):
"""
Get a list of all plants with detailed information.
Returns:
list: A list of plants with detailed information.
"""
response = self.session.post(
self.get_url('newTwoPlantAPI.do'),
params={'op': 'getAllPlantListTwo'},
data={
'language': '1',
'nominalPower': '',
'order': '1',
'pageSize': '15',
'plantName': '',
'plantStatus': '',
'toPageNum': '1'
}
)
return response.json().get('PlantList', [])
def inverter_data(self, inverter_id, date=None):
"""
Get inverter data for specified date or today.
Args:
inverter_id (str): The ID of the inverter.
date (datetime, optional): The date you are interested in. Defaults to datetime.datetime.now().
Returns:
dict: A dictionary containing the inverter data.
Raises:
Exception: If the request to the server fails.
"""
date_str = self.__get_date_string(date=date)
response = self.session.get(self.get_url('newInverterAPI.do'), params={
'op': 'getInverterData',
'id': inverter_id,
'type': 1,
'date': date_str
})
return response.json()
def inverter_detail(self, inverter_id):
"""
Get detailed data from PV inverter.
Args:
inverter_id (str): The ID of the inverter.
Returns:
dict: A dictionary containing the inverter details.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.get(self.get_url('newInverterAPI.do'), params={
'op': 'getInverterDetailData',
'inverterId': inverter_id
})
return response.json()
def inverter_detail_two(self, inverter_id):
"""
Get detailed data from PV inverter (alternative endpoint).
Args:
inverter_id (str): The ID of the inverter.
Returns:
dict: A dictionary containing the inverter details.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.get(self.get_url('newInverterAPI.do'), params={
'op': 'getInverterDetailData_two',
'inverterId': inverter_id
})
return response.json()
def tlx_system_status(self, plant_id, tlx_id):
"""
Get status of the system
Args:
plant_id (str): The ID of the plant.
tlx_id (str): The ID of the TLX inverter.
Returns:
dict: A dictionary containing system status.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.post(
self.get_url("newTlxApi.do"),
params={"op": "getSystemStatus_KW"},
data={"plantId": plant_id,
"id": tlx_id}
)
return response.json().get('obj', {})
def tlx_energy_overview(self, plant_id, tlx_id):
"""
Get energy overview
Args:
plant_id (str): The ID of the plant.
tlx_id (str): The ID of the TLX inverter.
Returns:
dict: A dictionary containing energy data.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.post(
self.get_url("newTlxApi.do"),
params={"op": "getEnergyOverview"},
data={"plantId": plant_id,
"id": tlx_id}
)
return response.json().get('obj', {})
def tlx_energy_prod_cons(self, plant_id, tlx_id, timespan=Timespan.hour, date=None):
"""
Get energy production and consumption (KW)
Args:
tlx_id (str): The ID of the TLX inverter.
timespan (Timespan): The ENUM value conforming to the time window you want e.g. hours from today, days, or months.
date (datetime): The date you are interested in.
Returns:
dict: A dictionary containing energy data.
Raises:
Exception: If the request to the server fails.
"""
date_str = self.__get_date_string(timespan, date)
response = self.session.post(
self.get_url("newTlxApi.do"),
params={"op": "getEnergyProdAndCons_KW"},
data={'date': date_str,
"plantId": plant_id,
"language": "1",
"id": tlx_id,
"type": timespan.value}
)
return response.json().get('obj', {})
def tlx_data(self, tlx_id, date=None):
"""
Get TLX inverter data for specified date or today.
Args:
tlx_id (str): The ID of the TLX inverter.
date (datetime, optional): The date you are interested in. Defaults to datetime.datetime.now().
Returns:
dict: A dictionary containing the TLX inverter data.
Raises:
Exception: If the request to the server fails.
"""
date_str = self.__get_date_string(date=date)
response = self.session.get(self.get_url('newTlxApi.do'), params={
'op': 'getTlxData',
'id': tlx_id,
'type': 1,
'date': date_str
})
return response.json()
def tlx_detail(self, tlx_id):
"""
Get detailed data from TLX inverter.
Args:
tlx_id (str): The ID of the TLX inverter.
Returns:
dict: A dictionary containing the detailed TLX inverter data.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.get(self.get_url('newTlxApi.do'), params={
'op': 'getTlxDetailData',
'id': tlx_id
})
return response.json()
def tlx_params(self, tlx_id):
"""
Get parameters for TLX inverter.
Args:
tlx_id (str): The ID of the TLX inverter.
Returns:
dict: A dictionary containing the TLX inverter parameters.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.get(self.get_url('newTlxApi.do'), params={
'op': 'getTlxParams',
'id': tlx_id
})
return response.json()
def tlx_all_settings(self, tlx_id):
"""
Get all possible settings from TLX inverter.
Args:
tlx_id (str): The ID of the TLX inverter.
Returns:
dict: A dictionary containing all possible settings for the TLX inverter.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.post(self.get_url('newTlxApi.do'), params={
'op': 'getTlxSetData'
}, data={
'serialNum': tlx_id
})
return response.json().get('obj', {}).get('tlxSetBean')
def tlx_enabled_settings(self, tlx_id):
"""
Get "Enabled settings" from TLX inverter.
Args:
tlx_id (str): The ID of the TLX inverter.
Returns:
dict: A dictionary containing the enabled settings.
Raises:
Exception: If the request to the server fails.
"""
string_time = datetime.datetime.now().strftime('%Y-%m-%d')
response = self.session.post(
self.get_url('newLoginAPI.do'),
params={'op': 'getSetPass'},
data={'deviceSn': tlx_id, 'stringTime': string_time, 'type': '5'}
)
return response.json().get('obj', {})
def tlx_battery_info(self, serial_num):
"""
Get battery information.
Args:
serial_num (str): The serial number of the battery.
Returns:
dict: A dictionary containing the battery information.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.post(
self.get_url('newTlxApi.do'),
params={'op': 'getBatInfo'},
data={'lan': 1, 'serialNum': serial_num}
)
return response.json().get('obj', {})
def tlx_battery_info_detailed(self, plant_id, serial_num):
"""
Get detailed battery information.
Args:
plant_id (str): The ID of the plant.
serial_num (str): The serial number of the battery.
Returns:
dict: A dictionary containing the detailed battery information.
Raises:
Exception: If the request to the server fails.
"""
response = self.session.post(
self.get_url('newTlxApi.do'),
params={'op': 'getBatDetailData'},
data={'lan': 1, 'plantId': plant_id, 'id': serial_num}
)
return response.json()
def mix_info(self, mix_id, plant_id=None):
"""
Returns high level values from Mix device
Keyword arguments:
mix_id -- The serial number (device_sn) of the inverter
plant_id -- The ID of the plant (the mobile app uses this but it does not appear to be necessary) (default None)
Returns:
'acChargeEnergyToday' -- ??? 2.7
'acChargeEnergyTotal' -- ??? 25.3
'acChargePower' -- ??? 0
'capacity': '45' -- The current remaining capacity of the batteries (same as soc but without the % sign)
'eBatChargeToday' -- Battery charged today in kWh
'eBatChargeTotal' -- Battery charged total (all time) in kWh
'eBatDisChargeToday' -- Battery discharged today in kWh
'eBatDisChargeTotal' -- Battery discharged total (all time) in kWh
'epvToday' -- Energy generated from PVs today in kWh
'epvTotal' -- Energy generated from PVs total (all time) in kWh
'isCharge'-- ??? 0 - Possible a 0/1 based on whether or not the battery is charging
'pCharge1' -- ??? 0
'pDischarge1' -- Battery discharging rate in W
'soc' -- Statement of charge including % symbol
'upsPac1' -- ??? 0
'upsPac2' -- ??? 0
'upsPac3' -- ??? 0
'vbat' -- Battery Voltage
'vbatdsp' -- ??? 51.8
'vpv1' -- Voltage PV1
'vpv2' -- Voltage PV2
"""
request_params = {
'op': 'getMixInfo',
'mixId': mix_id
}
if (plant_id):
request_params['plantId'] = plant_id
response = self.session.get(self.get_url(
'newMixApi.do'), params=request_params)
return response.json().get('obj', {})
def mix_totals(self, mix_id, plant_id):
"""
Returns "Totals" values from Mix device
Keyword arguments:
mix_id -- The serial number (device_sn) of the inverter
plant_id -- The ID of the plant
Returns:
'echargetoday' -- Battery charged today in kWh (same as eBatChargeToday from mix_info)
'echargetotal' -- Battery charged total (all time) in kWh (same as eBatChargeTotal from mix_info)
'edischarge1Today' -- Battery discharged today in kWh (same as eBatDisChargeToday from mix_info)
'edischarge1Total' -- Battery discharged total (all time) in kWh (same as eBatDisChargeTotal from mix_info)
'elocalLoadToday' -- Load consumption today in kWh
'elocalLoadTotal' -- Load consumption total (all time) in kWh
'epvToday' -- Energy generated from PVs today in kWh (same as epvToday from mix_info)
'epvTotal' -- Energy generated from PVs total (all time) in kWh (same as epvTotal from mix_info)
'etoGridToday' -- Energy exported to the grid today in kWh
'etogridTotal' -- Energy exported to the grid total (all time) in kWh
'photovoltaicRevenueToday' -- Revenue earned from PV today in 'unit' currency
'photovoltaicRevenueTotal' -- Revenue earned from PV total (all time) in 'unit' currency
'unit' -- Unit of currency for 'Revenue'
"""
response = self.session.post(self.get_url('newMixApi.do'), params={
'op': 'getEnergyOverview',
'mixId': mix_id,
'plantId': plant_id
})
return response.json().get('obj', {})
def mix_system_status(self, mix_id, plant_id):
"""
Returns current "Status" from Mix device
Keyword arguments:
mix_id -- The serial number (device_sn) of the inverter
plant_id -- The ID of the plant
Returns:
'SOC' -- Statement of charge (remaining battery %)
'chargePower' -- Battery charging rate in kw
'fAc' -- Frequency (Hz)
'lost' -- System status e.g. 'mix.status.normal'
'pLocalLoad' -- Load conumption in kW
'pPv1' -- PV1 Wattage in W
'pPv2' -- PV2 Wattage in W
'pactogrid' -- Export to grid rate in kW
'pactouser' -- Import from grid rate in kW
'pdisCharge1' -- Discharging batteries rate in kW
'pmax' -- ??? 6 ??? PV Maximum kW ??
'ppv' -- PV combined Wattage in kW
'priorityChoose' -- Priority setting - 0=Local load
'status' -- System statue - ENUM - Unknown values
'unit' -- Unit of measurement e.g. 'kW'
'upsFac' -- ??? 0
'upsVac1' -- ??? 0
'uwSysWorkMode' -- ??? 6
'vAc1' -- Grid voltage in V
'vBat' -- Battery voltage in V
'vPv1' -- PV1 voltage in V
'vPv2' -- PV2 voltage in V
'vac1' -- Grid voltage in V (same as vAc1)
'wBatteryType' -- ??? 1
"""
response = self.session.post(self.get_url('newMixApi.do'), params={
'op': 'getSystemStatus_KW',
'mixId': mix_id,
'plantId': plant_id
})
return response.json().get('obj', {})
def mix_detail(self, mix_id, plant_id, timespan=Timespan.hour, date=None):
"""
Get Mix details for specified timespan
Keyword arguments:
mix_id -- The serial number (device_sn) of the inverter
plant_id -- The ID of the plant
timespan -- The ENUM value conforming to the time window you want e.g. hours from today, days, or months (Default Timespan.hour)
date -- The date you are interested in (Default datetime.datetime.now())
Returns:
A chartData object where each entry is for a specific 5 minute window e.g. 00:05 and 00:10 respectively (below)
'chartData': { '00:05': { 'pacToGrid' -- Export rate to grid in kW
'pacToUser' -- Import rate from grid in kW
'pdischarge' -- Battery discharge in kW
'ppv' -- Solar generation in kW
'sysOut' -- Load consumption in kW
},
'00:10': { 'pacToGrid': '0',
'pacToUser': '0.93',
'pdischarge': '0',
'ppv': '0',
'sysOut': '0.93'},
......
}
'eAcCharge' -- Exported to grid in kWh
'eCharge' -- System production in kWh = Self-consumption + Exported to Grid
'eChargeToday' -- Load consumption from solar in kWh
'eChargeToday1' -- Self-consumption in kWh
'eChargeToday2' -- Self-consumption in kWh (eChargeToday + echarge1)
'echarge1' -- Load consumption from battery in kWh
'echargeToat' -- Total battery discharged (all time) in kWh
'elocalLoad' -- Load consumption in kW (battery + solar + imported)
'etouser' -- Load consumption imported from grid in kWh
'photovoltaic' -- Load consumption from solar in kWh (same as eChargeToday)
'ratio1' -- % of system production that is self-consumed
'ratio2' -- % of system production that is exported
'ratio3' -- % of Load consumption that is "self consumption"
'ratio4' -- % of Load consumption that is "imported from grid"
'ratio5' -- % of Self consumption that is directly from Solar
'ratio6' -- % of Self consumption that is from batteries
'unit' -- Unit of measurement e.g kWh
'unit2' -- Unit of measurement e.g kW
NOTE - It is possible to calculate the PV generation that went into charging the batteries by performing the following calculation:
Solar to Battery = Solar Generation - Export to Grid - Load consumption from solar
epvToday (from mix_info) - eAcCharge - eChargeToday
"""
date_str = self.__get_date_string(timespan, date)
response = self.session.post(self.get_url('newMixApi.do'), params={
'op': 'getEnergyProdAndCons_KW',
'plantId': plant_id,
'mixId': mix_id,
'type': timespan.value,
'date': date_str
})
return response.json().get('obj', {})
def get_mix_inverter_settings(self, serial_number):
"""
Gets the inverter settings related to battery modes
Keyword arguments:
serial_number -- The serial number (device_sn) of the inverter
Returns:
A dictionary of settings
"""
default_params = {
'op': 'getMixSetParams',
'serialNum': serial_number,
'kind': 0
}
response = self.session.get(self.get_url('newMixApi.do'), params=default_params)
data = json.loads(response.content.decode('utf-8'))
return data
def dashboard_data(self, plant_id, timespan=Timespan.hour, date=None):
"""
Get 'dashboard' data for specified timespan
NOTE - All numerical values returned by this api call include units e.g. kWh or %
- Many of the 'total' values that are returned for a Mix system are inaccurate on the system this was tested against.
However, the statistics that are correct are not available on any other interface, plus these values may be accurate for
non-mix types of system. Where the values have been proven to be inaccurate they are commented below.
Keyword arguments:
plant_id -- The ID of the plant
timespan -- The ENUM value conforming to the time window you want e.g. hours from today, days, or months (Default Timespan.hour)
date -- The date you are interested in (Default datetime.datetime.now())
Returns:
A chartData object where each entry is for a specific 5 minute window e.g. 00:05 and 00:10 respectively (below)
NOTE: The keys are interpreted differently, the examples below describe what they are used for in a 'Mix' system
'chartData': { '00:05': { 'pacToUser' -- Power from battery in kW
'ppv' -- Solar generation in kW
'sysOut' -- Load consumption in kW
'userLoad' -- Export in kW
},
'00:10': { 'pacToUser': '0',
'ppv': '0',
'sysOut': '0.7',
'userLoad': '0'},
......
}
'chartDataUnit' -- Unit of measurement e.g. 'kW',
'eAcCharge' -- Energy exported to the grid in kWh e.g. '20.5kWh' (not accurate for Mix systems)
'eCharge' -- System production in kWh = Self-consumption + Exported to Grid e.g '23.1kWh' (not accurate for Mix systems - actually showing the total 'load consumption'
'eChargeToday1' -- Self-consumption of PPV (possibly including excess diverted to batteries) in kWh e.g. '2.6kWh' (not accurate for Mix systems)
'eChargeToday2' -- Total self-consumption (PPV consumption(eChargeToday2Echarge1) + Battery Consumption(echarge1)) e.g. '10.1kWh' (not accurate for Mix systems)
'eChargeToday2Echarge1' -- Self-consumption of PPV only e.g. '0.8kWh' (not accurate for Mix systems)
'echarge1' -- Self-consumption from Battery only e.g. '9.3kWh'
'echargeToat' -- Not used on Dashboard view, likely to be total battery discharged e.g. '152.1kWh'
'elocalLoad' -- Total load consumption (etouser + eChargeToday2) e.g. '20.3kWh', (not accurate for Mix systems)
'etouser'-- Energy imported from grid today (includes both directly used by load and AC battery charging e.g. '10.2kWh'
'keyNames' -- Keys to be used for the graph data e.g. ['Solar', 'Load Consumption', 'Export To Grid', 'From Battery']
'photovoltaic' -- Same as eChargeToday2Echarge1 e.g. '0.8kWh'
'ratio1' -- % of 'Solar production' that is self-consumed e.g. '11.3%' (not accurate for Mix systems)
'ratio2' -- % of 'Solar production' that is exported e.g. '88.7%' (not accurate for Mix systems)
'ratio3' -- % of 'Load consumption' that is self consumption e.g. '49.8%' (not accurate for Mix systems)
'ratio4' -- % of 'Load consumption' that is imported from the grid e.g '50.2%' (not accurate for Mix systems)
'ratio5' -- % of Self consumption that is from batteries e.g. '92.1%' (not accurate for Mix systems)
'ratio6' -- % of Self consumption that is directly from Solar e.g. '7.9%' (not accurate for Mix systems)
NOTE: Does not return any data for a tlx system. Use plant_energy_data() instead.
"""
date_str = self.__get_date_string(timespan, date)
response = self.session.post(self.get_url('newPlantAPI.do'), params={
'action': "getEnergyStorageData",
'date': date_str,
'type': timespan.value,
'plantId': plant_id
})
return response.json()
def plant_settings(self, plant_id):
"""
Returns a dictionary containing the settings for the specified plant
Keyword arguments:
plant_id -- The id of the plant you want the settings of
Returns:
A python dictionary containing the settings for the specified plant
"""
response = self.session.get(self.get_url('newPlantAPI.do'), params={
'op': 'getPlant',
'plantId': plant_id
})
return response.json()
def storage_detail(self, storage_id):
"""
Get "All parameters" from battery storage.
"""
response = self.session.get(self.get_url('newStorageAPI.do'), params={
'op': 'getStorageInfo_sacolar',
'storageId': storage_id
})
return response.json()
def storage_params(self, storage_id):
"""
Get much more detail from battery storage.
"""
response = self.session.get(self.get_url('newStorageAPI.do'), params={
'op': 'getStorageParams_sacolar',
'storageId': storage_id
})
return response.json()
def storage_energy_overview(self, plant_id, storage_id):
"""
Get some energy/generation overview data.
"""
response = self.session.post(self.get_url('newStorageAPI.do?op=getEnergyOverviewData_sacolar'), params={
'plantId': plant_id,
'storageSn': storage_id
})
return response.json().get('obj', {})
def inverter_list(self, plant_id):
"""
Use device_list, it's more descriptive since the list contains more than inverters.
"""
warnings.warn(
"This function may be deprecated in the future because naming is not correct, use device_list instead", DeprecationWarning)
return self.device_list(plant_id)
def __get_all_devices(self, plant_id):
"""
Get basic plant information with device list.
"""
response = self.session.get(self.get_url('newTwoPlantAPI.do'),
params={'op': 'getAllDeviceList',
'plantId': plant_id,
'language': 1})
return response.json().get('deviceList', {})
def device_list(self, plant_id):
"""
Get a list of all devices connected to plant.
"""
device_list = self.plant_info(plant_id).get('deviceList', [])
if not device_list:
# for tlx systems, the device_list in plant is empty, so use __get_all_devices() instead
device_list = self.__get_all_devices(plant_id)
return device_list
def plant_info(self, plant_id):
"""
Get basic plant information with device list.
"""
response = self.session.get(self.get_url('newTwoPlantAPI.do'), params={
'op': 'getAllDeviceListTwo',
'plantId': plant_id,
'pageNum': 1,
'pageSize': 1
})
return response.json()
def plant_energy_data(self, plant_id):
"""
Get the energy data used in the 'Plant' tab in the phone
"""
response = self.session.post(self.get_url('newTwoPlantAPI.do'),
params={
'op': 'getUserCenterEnertyDataByPlantid'},
data={'language': 1,
'plantId': plant_id})
return response.json()
def is_plant_noah_system(self, plant_id):
"""
Returns a dictionary containing if noah devices are configured for the specified plant
Keyword arguments:
plant_id -- The id of the plant you want the noah devices of (str)
Returns
'msg'
'result' -- True or False
'obj' -- An Object containing if noah devices are configured
'isPlantNoahSystem' -- Is the specified plant a noah system (True or False)
'plantId' -- The ID of the plant
'isPlantHaveNoah' -- Are noah devices configured in the specified plant (True or False)
'deviceSn' -- Serial number of the configured noah device
'plantName' -- Friendly name of the plant
"""
response = self.session.post(self.get_url('noahDeviceApi/noah/isPlantNoahSystem'), data={
'plantId': plant_id
})
return response.json()
def noah_system_status(self, serial_number):
"""
Returns a dictionary containing the status for the specified Noah Device
Keyword arguments:
serial_number -- The Serial number of the noah device you want the status of (str)
Returns
'msg'
'result' -- True or False
'obj' -- An Object containing the noah device status
'chargePower' -- Battery charging rate in watt e.g. '200Watt'
'workMode' -- Workingmode of the battery (0 = Load First, 1 = Battery First)
'soc' -- Statement of charge (remaining battery %)
'associatedInvSn' -- ???
'batteryNum' -- Numbers of batterys
'profitToday' -- Today generated profit through noah device
'plantId' -- The ID of the plant
'disChargePower' -- Battery discharging rate in watt e.g. '200Watt'
'eacTotal' -- Total energy exported to the grid in kWh e.g. '20.5kWh'
'eacToday' -- Today energy exported to the grid in kWh e.g. '20.5kWh'
'pac' -- Export to grid rate in watt e.g. '200Watt'
'ppv' -- Solar generation in watt e.g. '200Watt'
'alias' -- Friendly name of the noah device
'profitTotal' -- Total generated profit through noah device
'moneyUnit' -- Unit of currency e.g. '€'
'status' -- Is the noah device online (True or False)
"""
response = self.session.post(self.get_url('noahDeviceApi/noah/getSystemStatus'), data={
'deviceSn': serial_number
})
return response.json()
def noah_info(self, serial_number):
"""
Returns a dictionary containing the informations for the specified Noah Device
Keyword arguments:
serial_number -- The Serial number of the noah device you want the informations of (str)
Returns
'msg'
'result' -- True or False
'obj' -- An Object containing the noah device informations
'neoList' -- A List containing Objects
'unitList' -- A Object containing currency units e.g. "Euro": "euro", "DOLLAR": "dollar"
'noah' -- A Object containing the folowing
'time_segment' -- A List containing Objects with configured "Operation Mode"
NOTE: The keys are generated numerical, the values are generated with folowing syntax "[workingmode (0 = Load First, 1 = Battery First)]_[starttime]_[endtime]_[output power]"
'time_segment': {
'time_segment1': "0_0:0_8:0_150", ([Load First]_[00:00]_[08:00]_[150 watt])
'time_segment2': "1_8:0_18:0_0", ([Battery First]_[08:00]_[18:00]_[0 watt])
....
}
'batSns' -- A List containing all battery Serial Numbers
'associatedInvSn' -- ???
'plantId' -- The ID of the plant
'chargingSocHighLimit' -- Configured "Battery Management" charging upper limit
'chargingSocLowLimit' -- Configured "Battery Management" charging lower limit
'defaultPower' -- Configured "System Default Output Power"
'version' -- The Firmware Version of the noah device
'deviceSn' -- The Serial number of the noah device
'formulaMoney' -- Configured "Select Currency" energy cost per kWh e.g. '0.22'
'alias' -- Friendly name of the noah device
'model' -- Model Name of the noah device
'plantName' -- Friendly name of the plant
'tempType' -- ???
'moneyUnitText' -- Configured "Select Currency" (Value from the unitList) e.G. "euro"
'plantList' -- A List containing Objects containing the folowing
'plantId' -- The ID of the plant
'plantImgName' -- Friendly name of the plant Image
'plantName' -- Friendly name of the plant
"""
response = self.session.post(self.get_url('noahDeviceApi/noah/getNoahInfoBySn'), data={
'deviceSn': serial_number
})
return response.json()
def update_plant_settings(self, plant_id, changed_settings, current_settings=None):
"""
Applies settings to the plant e.g. ID, Location, Timezone
See README for all possible settings options
Keyword arguments:
plant_id -- The id of the plant you wish to update the settings for
changed_settings -- A python dictionary containing the settings to be changed and their value
current_settings -- A python dictionary containing the current settings of the plant (use the response from plant_settings), if None - fetched for you
Returns:
A response from the server stating whether the configuration was successful or not
"""
# If no existing settings have been provided then get them from the growatt server
if current_settings == None:
current_settings = self.plant_settings(plant_id)
# These are the parameters that the form requires, without these an error is thrown. Pre-populate their values with the current values
form_settings = {
'plantCoal': (None, str(current_settings['formulaCoal'])),
'plantSo2': (None, str(current_settings['formulaSo2'])),
'accountName': (None, str(current_settings['userAccount'])),
'plantID': (None, str(current_settings['id'])),
# Hardcoded to 0 as I can't work out what value it should have
'plantFirm': (None, '0'),
'plantCountry': (None, str(current_settings['country'])),
'plantType': (None, str(current_settings['plantType'])),
'plantIncome': (None, str(current_settings['formulaMoneyStr'])),
'plantAddress': (None, str(current_settings['plantAddress'])),
'plantTimezone': (None, str(current_settings['timezone'])),
'plantLng': (None, str(current_settings['plant_lng'])),
'plantCity': (None, str(current_settings['city'])),
'plantCo2': (None, str(current_settings['formulaCo2'])),
'plantMoney': (None, str(current_settings['formulaMoneyUnitId'])),
'plantPower': (None, str(current_settings['nominalPower'])),
'plantLat': (None, str(current_settings['plant_lat'])),
'plantDate': (None, str(current_settings['createDateText'])),
'plantName': (None, str(current_settings['plantName'])),
}
# Overwrite the current value of the setting with the new value
for setting, value in changed_settings.items():
form_settings[setting] = (None, str(value))
response = self.session.post(self.get_url(
'newTwoPlantAPI.do?op=updatePlant'), files=form_settings)
return response.json()
def update_inverter_setting(self, serial_number, setting_type,
default_parameters, parameters):
"""
Applies settings for specified system based on serial number
See README for known working settings
Arguments:
serial_number -- Serial number (device_sn) of the inverter (str)
setting_type -- Setting to be configured (str)
default_params -- Default set of parameters for the setting call (dict)
parameters -- Parameters to be sent to the system (dict or list of str)
(array which will be converted to a dictionary)
Returns:
JSON response from the server whether the configuration was successful
"""
settings_parameters = parameters
# If we've been passed an array then convert it into a dictionary
if isinstance(parameters, list):
settings_parameters = {}
for index, param in enumerate(parameters, start=1):
settings_parameters['param' + str(index)] = param
settings_parameters = {**default_parameters, **settings_parameters}
response = self.session.post(self.get_url('newTcpsetAPI.do'),
params=settings_parameters)
return response.json()
def update_mix_inverter_setting(self, serial_number, setting_type, parameters):
"""
Alias for setting inverter parameters on a mix inverter
See README for known working settings
Arguments:
serial_number -- Serial number (device_sn) of the inverter (str)
setting_type -- Setting to be configured (str)
parameters -- Parameters to be sent to the system (dict or list of str)
(array which will be converted to a dictionary)
Returns:
JSON response from the server whether the configuration was successful
"""
default_parameters = {
'op': 'mixSetApiNew',
'serialNum': serial_number,
'type': setting_type
}
return self.update_inverter_setting(serial_number, setting_type,
default_parameters, parameters)
def update_ac_inverter_setting(self, serial_number, setting_type, parameters):
"""
Alias for setting inverter parameters on an AC-coupled inverter
See README for known working settings
Arguments:
serial_number -- Serial number (device_sn) of the inverter (str)
setting_type -- Setting to be configured (str)
parameters -- Parameters to be sent to the system (dict or list of str)
(array which will be converted to a dictionary)
Returns:
JSON response from the server whether the configuration was successful
"""
default_parameters = {
'op': 'spaSetApi',
'serialNum': serial_number,
'type': setting_type
}
return self.update_inverter_setting(serial_number, setting_type,
default_parameters, parameters)
def update_tlx_inverter_time_segment(self, serial_number, segment_id, batt_mode, start_time, end_time, enabled):
"""
Updates the time segment settings for a TLX hybrid inverter.
Arguments:
serial_number -- Serial number (device_sn) of the inverter (str)
segment_id -- ID of the time segment to be updated (int)
batt_mode -- Battery mode (int)
start_time -- Start time of the segment (datetime.time)
end_time -- End time of the segment (datetime.time)
enabled -- Whether the segment is enabled (bool)
Returns:
JSON response from the server whether the configuration was successful
"""
params = {
'op': 'tlxSet'
}
data = {
'serialNum': serial_number,
'type': f'time_segment{segment_id}',
'param1': batt_mode,
'param2': start_time.strftime('%H'),
'param3': start_time.strftime('%M'),
'param4': end_time.strftime('%H'),
'param5': end_time.strftime('%M'),
'param6': '1' if enabled else '0'
}
response = self.session.post(self.get_url(
'newTcpsetAPI.do'), params=params, data=data)
result = response.json()
if not result.get('success', False):
raise Exception(
f"Failed to update TLX inverter time segment: {result.get('msg', 'Unknown error')}")
return result
def update_tlx_inverter_setting(self, serial_number, setting_type, parameter):
"""
Alias for setting parameters on a tlx hybrid inverter
See README for known working settings
Arguments:
serial_number -- Serial number (device_sn) of the inverter (str)
setting_type -- Setting to be configured (str)
parameter -- Parameter(s) to be sent to the system (str, dict, list of str)
(array which will be converted to a dictionary)
Returns:
JSON response from the server whether the configuration was successful
"""
default_parameters = {
'op': 'tlxSet',
'serialNum': serial_number,
'type': setting_type
}
# If parameter is a single value, convert it to a dictionary
if not isinstance(parameter, (dict, list)):
parameter = {'param1': parameter}
elif isinstance(parameter, list):
parameter = {f'param{index+1}': param for index,
param in enumerate(parameter)}
return self.update_inverter_setting(serial_number, setting_type,
default_parameters, parameter)
def update_noah_settings(self, serial_number, setting_type, parameters):
"""
Applies settings for specified noah device based on serial number
See README for known working settings
Arguments:
serial_number -- Serial number (device_sn) of the noah (str)
setting_type -- Setting to be configured (str)
parameters -- Parameters to be sent to the system (dict or list of str)
(array which will be converted to a dictionary)
Returns:
JSON response from the server whether the configuration was successful
"""
default_parameters = {
'serialNum': serial_number,
'type': setting_type
}
settings_parameters = parameters
# If we've been passed an array then convert it into a dictionary
if isinstance(parameters, list):
settings_parameters = {}
for index, param in enumerate(parameters, start=1):
settings_parameters['param' + str(index)] = param
settings_parameters = {**default_parameters, **settings_parameters}
response = self.session.post(self.get_url('noahDeviceApi/noah/set'),
data=settings_parameters)
return response.json()
def update_classic_inverter_setting(self, default_parameters, parameters):
"""
Applies settings for specified system based on serial number
See README for known working settings
Arguments:
default_params -- Default set of parameters for the setting call (dict)
parameters -- Parameters to be sent to the system (dict or list of str)
(array which will be converted to a dictionary)
Returns:
JSON response from the server whether the configuration was successful
"""
settings_parameters = parameters
# If we've been passed an array then convert it into a dictionary
if isinstance(parameters, list):
settings_parameters = {}
for index, param in enumerate(parameters, start=1):
settings_parameters['param' + str(index)] = param
settings_parameters = {**default_parameters, **settings_parameters}
response = self.session.post(self.get_url('tcpSet.do'),
params=settings_parameters)
return response.json()
|