Index: leahi_dialin/fp/modules/levels.py =================================================================== diff -u -r68422d08c4141999a13496343264483a32314d37 -r1f2bf6d939eb4033dbedb7d7005494cc12fccbc6 --- leahi_dialin/fp/modules/levels.py (.../levels.py) (revision 68422d08c4141999a13496343264483a32314d37) +++ leahi_dialin/fp/modules/levels.py (.../levels.py) (revision 1f2bf6d939eb4033dbedb7d7005494cc12fccbc6) @@ -7,71 +7,75 @@ # # @file levels.py # -# @author (last) Michael Garthwaite -# @date (last) 28-Oct-2024 +# @author (last) Zoltan Miskolci +# @date (last) 05-May-2026 # @author (original) Dara Navaei # @date (original) 29-May-2020 # ############################################################################ -import struct -from enum import unique +# Module imports from logging import Logger -from .constants import NO_RESET -from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -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.utils.conversions import integer_to_bytearray, float_to_bytearray +# Project imports +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common import fp_enum_repository +from leahi_dialin.common.fp_defs import BETA_IOFP_LEVEL_OFFSET +from leahi_dialin.common.generic_defs import DataTypes +from leahi_dialin.common.msg_defs import MsgIds +from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, 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 -@unique -class FPFloaterLevels(DialinEnum): - LEVEL_STATE_LOW = 0 - LEVEL_STATE_MEDIUM = 1 - LEVEL_STATE_HIGH = 2 - LEVEL_STATE_ILLEGAL = 3 - class FPLevels(AbstractSubSystem): """ - Dialin API sub-class for levels related commands. """ - def __init__(self, can_interface, logger: Logger): + def __init__(self, can_interface: CanMessenger, logger: Logger): """ - - @param can_interface: Denali CAN Messenger object + @param can_interface: Can Messenger object """ - super().__init__() self.can_interface = can_interface self.logger = logger if self.can_interface is not None: - channel_id = DenaliChannels.fp_sync_broadcast_ch_id - msg_id = MsgIds.MSG_ID_FP_LEVEL_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_levels_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.fp_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_FP_LEVEL_DATA.value, + function = self._handler_levels_sync) - self.p25_level = 0 - self.fp_levels_timestamp = 0 + self.fp_levels_timestamp = 0 #: The timestamp of the last message - @publish(["fp_levels_timestamp", - "p25_level",]) + #: The Level Sensors data in dictionary format + self.fp_levels = { + fp_enum_repository.FPFloaterLevelSensorNames.P25_LEVEL.name: 0 + } + + + @publish(["msg_id_fp_level_data", + "fp_levels", + "fp_levels_timestamp"]) def _handler_levels_sync(self, message, timestamp=0.0): """ Handles published levels message @param message: published levels data message @returns none """ - self.p25_level = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] + sensor_list =[] + sensor_list.append((fp_enum_repository.FPFloaterLevelSensorNames.P25_LEVEL.name, DataTypes.U32)) + self.process_into_dict(dict_to_update = self.fp_levels, + decoder_list = sensor_list, + message = message) self.fp_levels_timestamp = timestamp + def cmd_levels_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends an FP levels data broadcast interval override command message. @@ -83,52 +87,38 @@ @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ - if not check_broadcast_interval_override_ms(ms): - return False + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_LEVEL_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'FP Levels', + logger = self.logger, + can_interface = self.can_interface) - reset_value = integer_to_bytearray(reset) - interval_value = integer_to_bytearray(ms) - payload = reset_value + interval_value - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_LEVEL_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Sending {} ms publish interval to the FP Levels module".format(ms)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content in message - if received_message is not None: - # Response payload is OK or not - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - def cmd_level_status_override(self, status: int, reset: int = NO_RESET) -> int: + def cmd_floater_level_status_override(self, level_sensor: int, status: int, reset: int = NO_RESET) -> int: """ Constructs and sends level status override command. Must be logged into FP. + @param level_sensor: integer - level sensor id to override @param status: integer - the status value to override @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ reset_value = integer_to_bytearray(reset) + lvl_sen = integer_to_bytearray(level_sensor + BETA_IOFP_LEVEL_OFFSET ) sts = integer_to_bytearray(status) - payload = reset_value + sts - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_LEVEL_OVERRIDE_REQUEST.value, - payload=payload) + lvl_sen = integer_to_bytearray(level_sensor) + payload = reset_value + sts + lvl_sen - # Send message - received_message = self.can_interface.send(message) - - # If there is content in message - if received_message is not None: - # Response payload is OK or not - 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 = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_FLOATER_LEVEL_OVERRIDE_REQUEST, + entity_name = f'FP Levels status', + override_text = f'{str(status)}', + logger = self.logger, + can_interface = self.can_interface)