def test_get_last_fault(self, hthp: HtHeatpump):
fault = hthp.get_last_fault()
# (29, 20, datetime.datetime(...), "EQ_Spreizung")
assert isinstance(fault, tuple), "'fault' must be of type tuple"
assert len(fault) == 4
index, error, dt, msg = fault
assert isinstance(index, int), "'index' must be of type int"
assert 0 <= index < hthp.get_fault_list_size()
assert isinstance(error, int), "'error' must be of type int"
assert error >= 0
assert isinstance(dt,
datetime.datetime), "'dt' must be of type datetime"
assert isinstance(msg, str), "'msg' must be of type str"
def main():
parser = argparse.ArgumentParser(
description=textwrap.dedent('''\
Command line tool to query for the fault list of the heat pump.
Example:
$ python3 %(prog)s --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")
args = parser.parse_args()
# activate logging with level INFO in verbose mode
if args.verbose:
logging.basicConfig(level=logging.INFO)
else:
logging.basicConfig(level=logging.ERROR)
hp = HtHeatpump(args.device, baudrate=args.baudrate)
start = timer()
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}".
format(rid))
ver = hp.get_version()
if args.verbose:
_logger.info("software version = {} ({:d})".format(ver[0], ver[1]))
if args.last:
# query for the last fault message of the heat pump
idx, err, dt, msg = hp.get_last_fault()
print("#{:d} [{}]: {:d}, {}".format(idx, dt.isoformat(), err, msg))
else:
# query for the whole fault list of the heat pump
lst = hp.get_fault_list()
for idx, e in lst.items():
print("#{:03d} [{}]: {:05d}, {}".format(
idx, e["datetime"].isoformat(), e["error"], e["message"]))
except Exception as ex:
_logger.error(ex)
sys.exit(1)
finally:
hp.logout() # try to logout for an ordinary cancellation (if possible)
hp.close_connection()
end = timer()
# print execution time only if desired
if args.time:
print("execution time: {:.2f} sec".format(end - start))
sys.exit(0)
def main():
parser = argparse.ArgumentParser(
description=textwrap.dedent('''\
Command line tool to query for the fault list of the heat pump.
Example:
$ python3 %(prog)s --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}".
format(rid))
ver = hp.get_version()
if args.verbose:
_logger.info("software version = {} ({:d})".format(ver[0], ver[1]))
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)
