Index: leahi_dialin/td/modules/air_trap.py =================================================================== diff -u -r7f2603fa456a499fd7b835a6cf1714422d2e85e7 -r38e8dd31728056dbb7f9304c98ab16d7147b75a2 --- leahi_dialin/td/modules/air_trap.py (.../air_trap.py) (revision 7f2603fa456a499fd7b835a6cf1714422d2e85e7) +++ leahi_dialin/td/modules/air_trap.py (.../air_trap.py) (revision 38e8dd31728056dbb7f9304c98ab16d7147b75a2) @@ -7,22 +7,22 @@ # # @file air_trap.py # -# @author (last) Michael Garthwaite -# @date (last) 26-Jun-2024 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Sean Nash # @date (original) 21-Sep-2020 # ############################################################################ + import struct from logging import Logger -from enum import unique -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.common.td_defs import TDAirTrapValves, TDAirTrapLevelSensors, TDAirTrapLevelSensorsAttributes, TDAirTrapState -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish, DialinEnum -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms +from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override +from leahi_dialin.common.td_defs import td_enum_repository +from leahi_dialin.protocols.CAN import DenaliChannels +from leahi_dialin.utils.base import AbstractSubSystem, publish from leahi_dialin.utils.conversions import integer_to_bytearray @@ -39,7 +39,6 @@ def __init__(self, can_interface, logger: Logger): """ - @param can_interface: Denali Can Messenger object """ super().__init__() @@ -53,27 +52,28 @@ self._handler_air_trap_sync) self.air_trap_level_sensors = { - TDAirTrapLevelSensors.H17_LEVEL.name: { - TDAirTrapLevelSensorsAttributes.LEVEL.name: self.AIR_DETECTED_AT_LEVEL, - TDAirTrapLevelSensorsAttributes.RAW.name: self.AIR_DETECTED_AT_LEVEL + td_enum_repository.TDAirTrapLevelSensorNames.H17_LEVEL.name: { + td_enum_repository.TDAirTrapLevelSensorAttributes.LEVEL.name: self.AIR_DETECTED_AT_LEVEL, + td_enum_repository.TDAirTrapLevelSensorAttributes.RAW.name: self.AIR_DETECTED_AT_LEVEL }, - TDAirTrapLevelSensors.H16_LEVEL.name: { - TDAirTrapLevelSensorsAttributes.LEVEL.name: self.AIR_DETECTED_AT_LEVEL, - TDAirTrapLevelSensorsAttributes.RAW.name: self.AIR_DETECTED_AT_LEVEL + td_enum_repository.TDAirTrapLevelSensorNames.H16_LEVEL.name: { + td_enum_repository.TDAirTrapLevelSensorAttributes.LEVEL.name: self.AIR_DETECTED_AT_LEVEL, + td_enum_repository.TDAirTrapLevelSensorAttributes.RAW.name: self.AIR_DETECTED_AT_LEVEL } } self.air_trap_valve_states = { - TDAirTrapValves.H13_VALV.name: 0, - TDAirTrapValves.H20_VALV.name: 0 + td_enum_repository.TDAirTrapValveNames.H13_VALV.name: 0, + td_enum_repository.TDAirTrapValveNames.H20_VALV.name: 0 } self.air_control = 0 self.td_air_trap_timestamp = 0.0 + @publish(["msg_id_td_air_trap_data", - "td_air_trap_timestamp", "air_trap_level_sensors", "air_trap_valve_states", - "air_control"]) + "air_control", + "td_air_trap_timestamp"]) def _handler_air_trap_sync(self, message, timestamp=0.0): """ Handles published air trap data messages. Air trap data are captured @@ -82,7 +82,6 @@ @param message: published air trap data message @return: None """ - lower = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) upper = struct.unpack('i', bytearray( @@ -98,15 +97,37 @@ controlling = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7])) - self.air_trap_level_sensors[TDAirTrapLevelSensors.H17_LEVEL.name][TDAirTrapLevelSensorsAttributes.LEVEL.name] = lower[0] - self.air_trap_level_sensors[TDAirTrapLevelSensors.H16_LEVEL.name][TDAirTrapLevelSensorsAttributes.LEVEL.name] = upper[0] - self.air_trap_level_sensors[TDAirTrapLevelSensors.H17_LEVEL.name][TDAirTrapLevelSensorsAttributes.RAW.name] = raw_lower[0] - self.air_trap_level_sensors[TDAirTrapLevelSensors.H16_LEVEL.name][TDAirTrapLevelSensorsAttributes.RAW.name] = raw_upper[0] - self.air_trap_valve_states[TDAirTrapValves.H13_VALV.name] = h13_vlv_st[0] - self.air_trap_valve_states[TDAirTrapValves.H20_VALV.name] = h20_vlv_st[0] + self.air_trap_level_sensors[td_enum_repository.TDAirTrapLevelSensorNames.H17_LEVEL.name][td_enum_repository.TDAirTrapLevelSensorAttributes.LEVEL.name] = lower[0] + self.air_trap_level_sensors[td_enum_repository.TDAirTrapLevelSensorNames.H16_LEVEL.name][td_enum_repository.TDAirTrapLevelSensorAttributes.LEVEL.name] = upper[0] + self.air_trap_level_sensors[td_enum_repository.TDAirTrapLevelSensorNames.H17_LEVEL.name][td_enum_repository.TDAirTrapLevelSensorAttributes.RAW.name] = raw_lower[0] + self.air_trap_level_sensors[td_enum_repository.TDAirTrapLevelSensorNames.H16_LEVEL.name][td_enum_repository.TDAirTrapLevelSensorAttributes.RAW.name] = raw_upper[0] + self.air_trap_valve_states[td_enum_repository.TDAirTrapValveNames.H13_VALV.name] = h13_vlv_st[0] + self.air_trap_valve_states[td_enum_repository.TDAirTrapValveNames.H20_VALV.name] = h20_vlv_st[0] self.air_control = controlling[0] self.td_air_trap_timestamp = timestamp + + def cmd_air_trap_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the air trap data broadcast interval override command + Constraints: + Must be logged into TD. + Given interval must be non-zero and a multiple of the TD general task interval (50 ms). + + @param ms: integer - interval (in ms) to override with + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + """ + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_TRAP_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Air Trap', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_air_trap_level_sensor_override(self, sensor: int, detected: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air trap level sensor override command @@ -117,31 +138,24 @@ @param detected: unsigned int - detected to override sensor with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise - """ - rst = integer_to_bytearray(reset) det = integer_to_bytearray(detected) idx = integer_to_bytearray(sensor) payload = rst + det + idx - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = td_enum_repository.TDAirTrapLevelSensorNames(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_OVERRIDE_REQUEST, + entity_name = f'TD {sensor_name} Air Trap level sensor', + override_text = f'{str(detected)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override air trap level sensor detection value for sensor " + str(sensor) + " ,Level: " + str(detected)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_raw_air_trap_level_sensor_override(self, sensor: int, detected: int, reset: int = NO_RESET) -> int: """ Constructs and sends the raw air trap level sensor override command @@ -152,101 +166,48 @@ @param detected: unsigned int - detected (0=air, 1=fluid) to override sensor with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise - """ - rst = integer_to_bytearray(reset) det = integer_to_bytearray(detected) idx = integer_to_bytearray(sensor) payload = rst + det + idx - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_RAW_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = td_enum_repository.TDAirTrapLevelSensorNames(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_RAW_OVERRIDE_REQUEST, + entity_name = f'TD {sensor_name} Air Trap level sensor raw', + override_text = f'{str(detected)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override raw air trap level sensor detection value for sensor " + str(sensor) + " ,Level: " + str(detected)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - def cmd_air_trap_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + def cmd_set_td_air_trap_valve(self, valve: int = td_enum_repository.TDAirTrapValveNames.H13_VALV.value, + valve_state: int = td_enum_repository.TDAirTrapState.STATE_CLOSED.value) -> int: """ - Constructs and sends the air trap data broadcast interval override command - Constraints: - Must be logged into TD. - Given interval must be non-zero and a multiple of the TD general task interval (50 ms). - - @param ms: integer - interval (in ms) to override with - @param reset: integer - 1 to reset a previous override, 0 to override - @return: 1 if successful, zero otherwise - """ - - if not check_broadcast_interval_override_ms(ms): - return False - - rst = integer_to_bytearray(reset) - mis = integer_to_bytearray(ms) - payload = rst + mis - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_TRAP_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override TD air trap data broadcast interval") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(ms) + " ms: " - self.logger.debug("Air trap data broadcast interval overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - def cmd_set_td_air_trap_valve(self, valve: int = TDAirTrapValves.H13_VALV.value, - valve_state: int = TDAirTrapState.STATE_CLOSED.value) -> int: - """ Constructs and sends an open/close command to the TD air trap valves. @param valve: air trap valve ID @param valve_state: air trap valve state (open or close) @returns 1 if successful, zero otherwise """ - vlv = integer_to_bytearray(valve) sts = integer_to_bytearray(valve_state) payload = vlv + sts - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_2_WAY_VALVE_SET_STATE_REQUEST.value, - payload=payload) - # Send message - received_message = self.can_interface.send(message) + valve_name = td_enum_repository.TDAirTrapValveNames(valve).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_2_WAY_VALVE_SET_STATE_REQUEST, + entity_name = f'TD Air Trap {valve_name} Valve state', + override_text = f'{str(valve_state)}', + logger = self.logger, + can_interface = self.can_interface) - # If there is content... - if received_message is not None: - # response payload is OK or not OK - self.logger.debug("Air trap valve " + str(valve) + " set to " + str(valve_state)) - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("timeout!!") - return False def cmd_set_td_air_trap_control(self, control: int = 0) -> int: """ @@ -255,24 +216,19 @@ @param control: start/stop for air trap control (0=stop, 1=start) @returns 1 if successful, zero otherwise """ - ctl = integer_to_bytearray(control) payload = ctl - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_SET_AIR_TRAP_CONTROL.value, - payload=payload) - # Send message - received_message = self.can_interface.send(message) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_SET_AIR_TRAP_CONTROL, + entity_name = f'TD Air Trap control', + override_text = f'{str(control)}', + logger = self.logger, + can_interface = self.can_interface) - # If there is content... - if received_message is not None: - # response payload is OK or not OK - self.logger.debug("Air trap control set to " + str(control)) - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("timeout!!") - return False def cmd_air_trap_air_pump_power_raise_override(self, power: int, reset: int = NO_RESET) -> int: """ @@ -289,28 +245,17 @@ pwr = integer_to_bytearray(power) payload = rst + pwr - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_PUMP_POWER_RAISE_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_PUMP_POWER_RAISE_OVERRIDE_REQUEST, + entity_name = f'TD Air Pump Raise power', + override_text = f'{str(power)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("Override TD air trap air pump raise power level") - # Send message - received_message = self.can_interface.send(message) - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(power) - self.logger.debug("Air trap air pump power raise overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_air_trap_air_pump_power_lower_override(self, power: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air trap air pump power lower override command @@ -326,24 +271,12 @@ pwr = integer_to_bytearray(power) payload = rst + pwr - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_PUMP_POWER_LOWER_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Override TD air trap air pump lower power level") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(power) - self.logger.debug("Air trap air pump power lower overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_PUMP_POWER_LOWER_OVERRIDE_REQUEST, + entity_name = f'TD Air Pump Lower power', + override_text = f'{str(power)}', + logger = self.logger, + can_interface = self.can_interface)