########################################################################### # # Copyright (c) 2020-2024 Diality Inc. - All Rights Reserved. # # THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN # WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. # # @file filtration_purification.py # # @author (last) Dara Navaei # @date (last) 26-Feb-2024 # @author (original) Peter Lucia # @date (original) 02-Apr-2020 # ############################################################################ import struct from .modules.alarms import FPAlarms from .modules.boost_pump import FPBoostPump from .modules.conductivity_sensors import FPConductivitySensors from .modules.constants import NO_RESET, RESET from .modules.flow_sensors import FPFlowSensors from .modules.levels import FPLevels from .modules.permeate_tank import FPPermeateTank from .modules.pressure_sensors import FPPressureSensors from .modules.ro_pump import FPROPump from .modules.temperatures import FPTemperatureSensors from .modules.fp_test_configs import FPTestConfig from .modules.valves import FPValves from .modules.water_pumps import FPPumps from .proxies.dd_proxy import DDProxy from ..common.msg_defs import MsgIds, MsgFieldPositions, MsgFieldPositionsFWVersions from ..common.fp_defs import FPOpModes from ..protocols.CAN import DenaliMessage, DenaliCanMessenger, DenaliChannels from ..utils.base import AbstractSubSystem, publish, LogManager from ..utils.checks import check_broadcast_interval_override_ms from ..utils.conversions import integer_to_bytearray, unsigned_short_to_bytearray, bytearray_to_integer, \ bytearray_to_byte class FP(AbstractSubSystem): """ Reverse Osmosis ( FP aka IOFP ) Dialin object API. It provides the basic interface to communicate with the FP firmware. """ # FP debug event max count _FP_DEBUG_EVENT_LIST_COUNT = 10 _FP_DEBUG_EVENT_MSG_LEN_INDEX = 5 # FP login password FP_LOGIN_PASSWORD = '123' def __init__(self, can_interface="can0", log_level=None): """ FP object provides test/service commands for the FP sub-system. >> FP_object = FP('can0') >> FP_object = FP(can_interface='can0', log_level="DEBUG") Possible log levels: ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL", "CAN_ONLY", "PRINT_ONLY"] @param can_interface: (str) CANBus interface name, e.g. "can0" @param log_level: (str) Logging level, defaults to None """ super().__init__() self._log_manager = LogManager(log_level=log_level, log_filepath=self.__class__.__name__ + ".log") self.logger = self._log_manager.logger # Create listener self.can_interface = DenaliCanMessenger(can_interface=can_interface, logger=self.logger) self.can_interface.start() self.callback_id = None # register handler for FP operation mode broadcast messages if self.can_interface is not None: channel_id = DenaliChannels.fp_sync_broadcast_ch_id self.msg_id_fp_op_mode_data = MsgIds.MSG_ID_FP_OP_MODE_DATA.value self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_fp_op_mode_data, self._handler_fp_op_mode_sync) self.msg_id_fp_version_response = MsgIds.MSG_ID_FP_VERSION_RESPONSE.value self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_fp_version_response, self._handler_fp_version_response_sync) self.msg_id_fp_debug_event = MsgIds.MSG_ID_FP_DEBUG_EVENT.value self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_fp_debug_event, self._handler_fp_debug_event_sync) # create properties self.fp_op_mode_timestamp = 0.0 self.fp_debug_events_timestamp = 0.0 self.fp_version_response_timestamp = 0.0 self.fp_operation_mode = FPOpModes.MODE_INIT.value self.fp_operation_sub_mode = 0 self.fp_logged_in = False self.fp_set_logged_in_status(False) self.fp_version = None self.fp_fpga_version = None self.fp_debug_events = [''] * self._FP_DEBUG_EVENT_LIST_COUNT self.fp_debug_event_index = 0 self.fp_last_debug_event = '' # Create command groups self.alarms = FPAlarms(self.can_interface, self.logger) self.boost_pump = FPBoostPump(self.can_interface, self.logger) self.conductivity = FPConductivitySensors(self.can_interface, self.logger) self.flows = FPFlowSensors(self.can_interface, self.logger) self.fluid_pumps = FPPumps(self.can_interface, self.logger) self.levels = FPLevels(self.can_interface, self.logger) self.permeate_tank = FPPermeateTank(self.can_interface, self.logger) self.pressures = FPPressureSensors(self.can_interface, self.logger) self.ro_pump = FPROPump(self.can_interface, self.logger) self.temperatures = FPTemperatureSensors(self.can_interface, self.logger) self.test_configs = FPTestConfig(self.can_interface, self.logger) self.valves = FPValves(self.can_interface, self.logger) self.dd_proxy = DDProxy(self.can_interface, self.logger) @publish(["msg_id_fp_debug_event", "fp_debug_events_timestamp","fp_debug_events"]) def _handler_fp_debug_event_sync(self, message, timestamp = 0.0): """ Callback for fp debug event messages @param message: published FP debug event message @param timestamp: the timestamp in epoch time of the received message @return: none """ payload = message['message'] message_length = payload[self._FP_DEBUG_EVENT_MSG_LEN_INDEX] temp_message = '' index = MsgFieldPositions.START_POS_FIELD_1 for i in range(0, message_length): # Loop through the length and get the char, char_index = bytearray_to_byte(payload, index + i, False) temp_message += chr(char) self.fp_debug_events_timestamp = timestamp self.fp_debug_events.insert(self.fp_debug_event_index, temp_message) self.fp_last_debug_event = temp_message self.fp_debug_event_index += 1 if self.fp_debug_event_index == self._FP_DEBUG_EVENT_LIST_COUNT: self.fp_debug_event_index = 0 @publish(["fp_logged_in"]) def fp_set_logged_in_status(self, logged_in: bool = False): """ Callback for fp logged in status change. @param logged_in boolean logged in status for FP @return: none """ self.fp_logged_in = logged_in @publish(["msg_id_fp_version_response", "fp_version, fp_fpga_version"]) def _handler_fp_version_response_sync(self,message, timestamp = 0.0): """ Handler for response from FP regarding its version. @param message: version response message from FP.\n @return: None if not successful, the version string if unpacked successfully """ major = struct.unpack(' 0 for each in [major, minor, micro, build, compatibility]]): self.fp_version = f"v{major[0]}.{minor[0]}.{micro[0]}-{build[0]}.{compatibility[0]}" self.logger.debug(f"FP VERSION: {self.fp_version}") if all([len(each) > 0 for each in [fpga_id, fpga_major, fpga_minor, fpga_lab]]): self.fp_fpga_version = f"v{fpga_id[0]}.{fpga_major[0]}.{fpga_minor[0]}-{fpga_lab[0]}" self.logger.debug(f"FP FPGA VERSION: {self.fp_fpga_version}") self.fp_version_response_timestamp = timestamp @publish(["msg_id_fp_op_mode_data", "fp_op_mode_timestamp","fp_operation_mode", "fp_operation_sub_mode"]) def _handler_fp_op_mode_sync(self, message, timestamp = 0.0): """ Handles published FP operation mode messages. Current FP operation mode is captured for reference. @param message: published FP operation mode broadcast message @return: None """ mode = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) smode = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])) self.fp_operation_mode = mode[0] self.fp_operation_sub_mode = smode[0] self.fp_op_mode_timestamp = timestamp def cmd_log_in_to_fp(self, resend: bool = False) -> int: """ Constructs and sends a login command via CAN bus. Login required before \n other commands can be sent to the FP. @param resend: (bool) if False (default), try to login once. Otherwise, tries to login indefinitely @return: 1 if logged in, 0 if log in failed """ message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, message_id=MsgIds.MSG_ID_FP_TESTER_LOGIN_REQUEST.value, payload=list(map(int, map(ord, self.FP_LOGIN_PASSWORD)))) self.logger.debug("Logging in...") # Send message received_message = self.can_interface.send(message, resend=resend) if received_message is not None: if received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] == 1: self.logger.debug("Success: Logged In") self.fp_set_logged_in_status(True) #self._send_ro_checkin_message() # Timer starts interval first #self.can_interface.transmit_interval_dictionary[self.callback_id].start() else: self.logger.debug("Failure: Log In Failed.") return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] else: self.logger.debug("Login Timeout!!!!") return False def cmd_fp_set_operation_mode(self, new_mode: int = 0) -> int: """ Constructs and sends a set operation mode request command via CAN bus. Constraints: Must be logged into FP. Transition from current to requested op mode must be legal. NOTE: for POST the FP device shall be in Standby Mode @param new_mode: ID of operation mode to transition to @return: 1 if successful, zero otherwise """ payload = integer_to_bytearray(new_mode) message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, message_id=MsgIds.MSG_ID_FP_SET_OP_MODE_REQUEST.value, payload=payload) self.logger.debug("Requesting FP mode change to " + str(new_mode)) # Send message received_message = self.can_interface.send(message) if received_message is not None: if received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] == 1: self.logger.debug("Success: Mode change accepted") else: self.logger.debug("Failure: Mode change rejected.") return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] else: self.logger.debug("FP mode change request Timeout!!!!") return False def cmd_fp_software_reset_request(self) -> None: """ Constructs and sends an FP software reset request via CAN bus. Constraints: Must be logged into FP. @return: None """ message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, message_id=MsgIds.MSG_ID_FP_SOFTWARE_RESET_REQUEST.value) self.logger.debug("requesting FP software reset") # Send message self.can_interface.send(message, 0) self.logger.debug("Sent request to FP to reset...") self.fp_set_logged_in_status(False) def cmd_op_mode_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the measured op mode broadcast interval override command Constraints: Must be logged into FP. Given interval must be non-zero and a multiple of the FP 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_fp_ch_id, message_id=MsgIds.MSG_ID_FP_OPERATION_MODE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("override op mode broadcast interval") # Send message received_message = self.can_interface.send(message) # If there is content... if received_message is not None: # self.logger.debug(received_message) if reset == RESET: str_res = "reset back to normal: " else: str_res = str(ms) + " ms: " self.logger.debug("operation mode 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_fp_safety_shutdown_override(self, active: int, reset: int = NO_RESET) -> int: """ Constructs and sends an FP safety shutdown override command via CAN bus. Constraints: Must be logged into FP. @param active: int - True to activate safety shutdown, False to deactivate @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) saf = integer_to_bytearray(active) payload = rst + saf message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, message_id=MsgIds.MSG_ID_FP_SAFETY_SHUTDOWN_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("overriding FP safety shutdown") # Send message received_message = self.can_interface.send(message) if received_message is not None: if received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] == 1: self.logger.debug("Safety shutdown signal overridden") else: self.logger.debug("Safety shutdown signal override failed.") return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] else: self.logger.debug("Timeout!!!!") return False