def test_get_fault_list_in_several_pieces(self, hthp: HtHeatpump):
args = []
cmd = ""
fault_list_size = hthp.get_fault_list_size()
while len(cmd) < 255 * 2: # request has do be done in 3 parts
item = random.randint(0, fault_list_size - 1)
cmd += ",{}".format(item)
args.append(item)
fault_list = hthp.get_fault_list(*args)
# [ { "index": 29, # fault list index
# "error": 20, # error code
# "datetime": datetime.datetime(...), # date and time of the entry
# "message": "EQ_Spreizung", # error message
# },
# # ...
# ]
assert isinstance(fault_list,
list), "'fault_list' must be of type list"
assert len(fault_list) == len(args)
for entry in fault_list:
assert isinstance(entry, dict), "'entry' must be of type dict"
index = entry["index"]
assert isinstance(index, int), "'index' must be of type int"
assert 0 <= index < fault_list_size
error = entry["error"]
assert isinstance(error, int), "'error' must be of type int"
assert error >= 0
dt = entry["datetime"]
assert isinstance(
dt, datetime.datetime), "'dt' must be of type datetime"
msg = entry["message"]
assert isinstance(msg, str), "'msg' must be of type str"
def test_get_fault_list(self, hthp: HtHeatpump):
fault_list = hthp.get_fault_list()
# [ { "index": 29, # fault list index
# "error": 20, # error code
# "datetime": datetime.datetime(...), # date and time of the entry
# "message": "EQ_Spreizung", # error message
# },
# # ...
# ]
assert isinstance(fault_list,
list), "'fault_list' must be of type list"
assert len(fault_list) == hthp.get_fault_list_size()
for entry in fault_list:
assert isinstance(entry, dict), "'entry' must be of type dict"
index = entry["index"]
assert isinstance(index, int), "'index' must be of type int"
assert 0 <= index < hthp.get_fault_list_size()
error = entry["error"]
assert isinstance(error, int), "'error' must be of type int"
assert error >= 0
dt = entry["datetime"]
assert isinstance(
dt, datetime.datetime), "'dt' must be of type datetime"
msg = entry["message"]
assert isinstance(msg, str), "'msg' must be of type str"
def test_get_fault_list_with_indices(self, hthp: HtHeatpump):
size = hthp.get_fault_list_size()
for cnt in range(size + 1):
indices = random.sample(range(size), cnt)
fault_list = hthp.get_fault_list(*indices)
assert isinstance(fault_list,
list), "'fault_list' must be of type list"
assert len(fault_list) == (cnt if cnt > 0 else size)
for entry in fault_list:
assert isinstance(entry, dict), "'entry' must be of type dict"
index = entry["index"]
assert isinstance(index, int), "'index' must be of type int"
assert 0 <= index < hthp.get_fault_list_size()
error = entry["error"]
assert isinstance(error, int), "'error' must be of type int"
assert error >= 0
dt = entry["datetime"]
assert isinstance(
dt, datetime.datetime), "'dt' must be of type datetime"
msg = entry["message"]
assert isinstance(msg, str), "'msg' must be of type str"
def test_get_fault_list_with_index(self, hthp: HtHeatpump):
size = hthp.get_fault_list_size()
assert isinstance(size, int), "'size' must be of type int"
assert size >= 0
for i in range(size):
fault_list = hthp.get_fault_list(i)
assert isinstance(fault_list,
list), "'fault_list' must be of type list"
assert len(fault_list) == 1
entry = fault_list[0]
assert isinstance(entry, dict), "'entry' must be of type dict"
index = entry["index"]
assert isinstance(index, int), "'index' must be of type int"
assert 0 <= index < hthp.get_fault_list_size()
error = entry["error"]
assert isinstance(error, int), "'error' must be of type int"
assert error >= 0
dt = entry["datetime"]
assert isinstance(
dt, datetime.datetime), "'dt' must be of type datetime"
msg = entry["message"]
assert isinstance(msg, str), "'msg' must be of type str"
def test_get_fault_list_with_index_raises_IOError(self, hthp: HtHeatpump):
with pytest.raises(IOError):
hthp.get_fault_list(-1)
with pytest.raises(IOError):
hthp.get_fault_list(hthp.get_fault_list_size())
def main():
parser = argparse.ArgumentParser(
description=textwrap.dedent("""\
Command line tool to query for the fault list of the heat pump.
Example:
$ python3 htfaultlist.py --device /dev/ttyUSB1
#000 [2000-01-01T00:00:00]: 65534, Keine Stoerung
#001 [2000-01-01T00:00:00]: 65286, Info: Programmupdate 1
#002 [2000-01-01T00:00:00]: 65285, Info: Initialisiert
#003 [2000-01-01T00:00:16]: 00009, HD Schalter
#004 [2000-01-01T00:00:20]: 00021, EQ Motorschutz
"""),
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=textwrap.dedent("""\
DISCLAIMER
----------
Please note that any incorrect or careless usage of this program as well as
errors in the implementation can damage your heat pump!
Therefore, the author does not provide any guarantee or warranty concerning
to correctness, functionality or performance and does not accept any liability
for damage caused by this program or mentioned information.
Thus, use it on your own risk!
""") + "\r\n",
)
parser.add_argument(
"-d",
"--device",
default="/dev/ttyUSB0",
type=str,
help=
"the serial device on which the heat pump is connected, default: %(default)s",
)
parser.add_argument(
"-b",
"--baudrate",
default=115200,
type=int,
# the supported baudrates of the Heliotherm heat pump (HP08S10W-WEB):
choices=[9600, 19200, 38400, 57600, 115200],
help=
"baudrate of the serial connection (same as configured on the heat pump), default: %(default)s",
)
parser.add_argument("-t",
"--time",
action="store_true",
help="measure the execution time")
parser.add_argument(
"-v",
"--verbose",
action="store_true",
help="increase output verbosity by activating logging",
)
parser.add_argument(
"-l",
"--last",
action="store_true",
help="print only the last fault message of the heat pump",
)
parser.add_argument("-j",
"--json",
type=str,
help="write the fault list to the specified JSON file")
parser.add_argument("-c",
"--csv",
type=str,
help="write the fault list to the specified CSV file")
parser.add_argument("index",
type=int,
nargs="*",
help="fault list index/indices to query for")
args = parser.parse_args()
# activate logging with level DEBUG in verbose mode
log_format = "%(asctime)s %(levelname)s [%(name)s|%(funcName)s]: %(message)s"
if args.verbose:
logging.basicConfig(level=logging.DEBUG, format=log_format)
else:
logging.basicConfig(level=logging.WARNING, format=log_format)
hp = HtHeatpump(args.device, baudrate=args.baudrate)
try:
hp.open_connection()
hp.login()
rid = hp.get_serial_number()
if args.verbose:
_LOGGER.info(
"connected successfully to heat pump with serial number %d",
rid)
ver = hp.get_version()
if args.verbose:
_LOGGER.info("software version = %s (%d)", *ver)
if args.last:
# query for the last fault message of the heat pump
with Timer() as timer:
idx, err, dt, msg = hp.get_last_fault()
exec_time = timer.elapsed
fault_list = [{
"index": idx, # fault list index
"error": err, # error code
"datetime": dt.isoformat(), # date and time of the entry
"message": msg, # error message
}]
print("#{:03d} [{}]: {:05d}, {}".format(idx, dt.isoformat(), err,
msg))
else:
# query for the given fault list entries of the heat pump
with Timer() as timer:
fault_list = hp.get_fault_list(*args.index)
exec_time = timer.elapsed
for entry in fault_list:
entry["datetime"] = entry["datetime"].isoformat(
) # convert "datetime" dict entry to str
print("#{:03d} [{}]: {:05d}, {}".format(
entry["index"],
entry["datetime"],
entry["error"],
entry["message"],
))
if args.json: # write fault list entries to JSON file
with open(args.json, "w") as jsonfile:
json.dump(fault_list, jsonfile, indent=4, sort_keys=True)
if args.csv: # write fault list entries to CSV file
with open(args.csv, "w") as csvfile:
fieldnames = ["index", "datetime", "error", "message"]
writer = csv.DictWriter(csvfile,
delimiter=",",
fieldnames=fieldnames)
writer.writeheader()
for entry in fault_list:
writer.writerow({n: entry[n] for n in fieldnames})
# print execution time only if desired
if args.time:
print("execution time: {:.2f} sec".format(exec_time))
except Exception as ex:
_LOGGER.exception(ex)
sys.exit(1)
finally:
hp.logout() # try to logout for an ordinary cancellation (if possible)
hp.close_connection()
sys.exit(0)