Index: leahi_dialin/td/modules/buttons.py =================================================================== diff -u -rafe332fec54d9d0432dfc0d54aef1debaa92b066 -re45b20cdc5d4c5dcff8cef530b173ca94cb2e422 --- leahi_dialin/td/modules/buttons.py (.../buttons.py) (revision afe332fec54d9d0432dfc0d54aef1debaa92b066) +++ leahi_dialin/td/modules/buttons.py (.../buttons.py) (revision e45b20cdc5d4c5dcff8cef530b173ca94cb2e422) @@ -7,19 +7,26 @@ # # @file buttons.py # -# @author (last) Micahel Garthwaite -# @date (last) 05-Nov-2024 +# @author (last) Zoltan Miskolci +# @date (last) 05-May-2026 # @author (original) Peter Lucia # @date (original) 14-Oct-2024 # ############################################################################ -import struct + +# Module imports from logging import Logger +import struct -from .constants import RESET, NO_RESET -from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliCanMessenger, DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish +# Project imports +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common.generic_defs import DataTypes +from leahi_dialin.common.msg_defs import MsgFieldPositions +from leahi_dialin.common.msg_ids import MsgIds +from leahi_dialin.common.override_templates import cmd_generic_override +from leahi_dialin.protocols.CAN import CanMessenger, CanChannels +from leahi_dialin.utils.abstract_classes import AbstractSubSystem +from leahi_dialin.utils.base import publish from leahi_dialin.utils.conversions import integer_to_bytearray @@ -28,34 +35,35 @@ Treatment Delivery (TD) Dialin API sub-class for button related commands. """ - def __init__(self, can_interface: DenaliCanMessenger, logger: Logger): + def __init__(self, can_interface: CanMessenger, logger: Logger): """ TD_Buttons constructor - @param can_interface: the Denali CAN interface object + @param can_interface: the CAN interface object """ - super().__init__() self.can_interface = can_interface self.logger = logger - self.poweroff_timeout_expired = False if self.can_interface is not None: - self.can_interface.register_receiving_publication_function(DenaliChannels.td_to_ui_ch_id, - MsgIds.MSG_ID_OFF_BUTTON_PRESS_REQUEST.value, - self._handler_poweroff_timeout_occurred) - self.td_power_off_timestamp = 0.0 + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_to_ui_ch_id, + message_id = MsgIds.MSG_ID_OFF_BUTTON_PRESS_REQUEST.value, + function = self._handler_poweroff_timeout_occurred) + self.td_power_off_timestamp = 0.0 #: The timestamp of the last message + self.poweroff_timeout_expired = False #: The Power Off timeout value + + def reset_poweroff_timeout_expired(self): """ Resets the dialin poweroff timeout flag to False @return: None """ - self.poweroff_timeout_expired = False - @publish(['td_power_off_timestamp', "poweroff_timeout_expired"]) + + @publish(['msg_id_off_button_press_request', 'poweroff_timeout_expired', 'td_power_off_timestamp']) def _handler_poweroff_timeout_occurred(self, message, timestamp=0.0): """ Poweroff timeout occurred handler @@ -67,13 +75,14 @@ self.logger.debug("Poweroff message id detected, but was the wrong length.") return - mode = struct.unpack('h', bytearray( + mode = struct.unpack(DataTypes.U16.unpack_attrib(), bytearray( message["message"][MsgFieldPositions.START_POS_FIELD_1: MsgFieldPositions.START_POS_FIELD_1 + 2])) if len(mode) > 0: self.poweroff_timeout_expired = bool(mode[0]) self.td_power_off_timestamp = timestamp + def cmd_off_button_override(self, state: int, reset: int = NO_RESET) -> int: """ Constructs and sends the Off button override command @@ -86,35 +95,22 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) sta = integer_to_bytearray(state) payload = rst + sta - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_OFF_BUTTON_OVERRIDE_REQUEST.value, - payload=payload) + state_name = 'Pressed' if state == 1 else 'Released' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_OFF_BUTTON_OVERRIDE_REQUEST, + entity_name = f'TD Off Button', + override_text = f'{state_name}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override off button") - # 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 = ("pressed" if state != 0 else "released") - - self.logger.debug("Off button 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_stop_button_override(self, state: int, reset: int = NO_RESET) -> int: """ Constructs and sends the Stop button override command @@ -127,31 +123,17 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) sta = integer_to_bytearray(state) payload = rst + sta - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_STOP_BUTTON_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override stop button") - - # 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 = ("pressed" if state != 0 else "released") - self.logger.debug("Stop button 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 + state_name = 'Pressed' if state == 1 else 'Released' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_STOP_BUTTON_OVERRIDE_REQUEST, + entity_name = f'TD Stop Button', + override_text = f'{state_name}', + logger = self.logger, + can_interface = self.can_interface)