########################################################################### # # Copyright (c) 2019-2020 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 ro_pump.py # # @author (last) Peter Lucia # @date (last) 26-Aug-2020 # @author (original) Sean # @date (original) 14-Apr-2020 # ############################################################################ import struct from ..utils.conversions import integer_to_bytearray, float_to_bytearray from ..common.msg_defs import MsgIds, MsgFldPositions from .constants import RESET, NO_RESET from ..protocols.CAN import (DenaliMessage, DenaliChannels) from ..utils.base import _AbstractSubSystem, _publish from logging import Logger class DGROPump(_AbstractSubSystem): """ DGROPump Dialysate Generator (DG) Dialin API sub-class for RO pump related commands. """ #Enums RAMP_UP_STATE = 0 def __init__(self, can_interface, logger: Logger): """ DGROPump constructor """ super().__init__() self.can_interface = can_interface self.logger = logger if self.can_interface is not None: channel_id = DenaliChannels.dg_sync_broadcast_ch_id msg_id = MsgIds.MSG_ID_RO_PUMP_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_ro_pump_sync) self.target_pressure_psi = 0 self.measured_flow_rate_lpm = 0.0 self.pwm_duty_cycle_pct = 0.0 self.ro_pump_state = 0.0 def get_target_pressure(self): """ Gets the target pressure @return: the target pressure (PSI) """ return self.target_pressure_psi def get_measured_flow_rate(self): """ Gets the measured flow rate (lpm) @return: The measured flow rate (float) """ return self.measured_flow_rate_lpm def get_pwm_duty_cycle_pct(self): """ Gets the PWM duty cycle pct @return: The PWM duty cycle pct (float) """ return self.pwm_duty_cycle_pct @_publish([ "target_pressure_psi", "measured_flow_rate_lpm", "pwm_duty_cycle_pct", "ro_pump_state" ]) def _handler_ro_pump_sync(self, message): """ Handles published ro pump data messages. RO pump data are captured for reference. @param message: published RO pump data message @return: None """ tgt = struct.unpack('f', bytearray( message['message'][MsgFldPositions.START_POS_FIELD_1:MsgFldPositions.END_POS_FIELD_1])) flow = struct.unpack('f', bytearray( message['message'][MsgFldPositions.START_POS_FIELD_2:MsgFldPositions.END_POS_FIELD_2])) pwm = struct.unpack('f', bytearray( message['message'][MsgFldPositions.START_POS_FIELD_3:MsgFldPositions.END_POS_FIELD_3])) ro_state = struct.unpack('i', bytearray( message['message'][MsgFldPositions.START_POS_FIELD_4:MsgFldPositions.END_POS_FIELD_4])) self.target_pressure_psi = tgt[0] self.measured_flow_rate_lpm = flow[0] self.pwm_duty_cycle_pct = pwm[0] raw_ro_pump_state = ro_state[0] #self.ro_pump_state = self.ro_pump_states.get("RO_PUMP_OFF_STATE", -1) if raw_ro_pump_state == 0: self.ro_pump_state = "RO_PUMP_OFF_STATE" elif raw_ro_pump_state == 1: self.ro_pump_state = "RO_PUMP_RAMP_UP_STATE" elif raw_ro_pump_state == 2: self.ro_pump_state = "RO_PUMP_VERIFY_FLOW_STATE" elif raw_ro_pump_state == 3: self.ro_pump_state = "RO_PUMP_CONTROL_TO_TARGET_STATE" elif raw_ro_pump_state == 4: self.ro_pump_state = "RO_PUMP_OPEN_LOOP_STATE" def cmd_ro_pump_set_point_override(self, pressure, reset=NO_RESET): """ Constructs and sends the RO pump set point override command. Constraints: Must be logged into DG. @param pressure: integer - pressure set point (in PSI) to override with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) prs = integer_to_bytearray(pressure) payload = rst + prs message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dg_ch_id, message_id=MsgIds.MSG_ID_RO_PUMP_SET_PT_OVERRIDE.value, payload=payload) self.logger.debug("override RO pump pressure set point") # 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(pressure) self.logger.debug( "RO pump pressure set point overridden to " + str_res + " PSI: " + 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_ro_flow_rate_override(self, flow, reset=NO_RESET): """ Constructs and sends the RO rate override command. Constraints: Must be logged into DG. @param flow: float - flow rate (in L/min) to override with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) flo = float_to_bytearray(flow) payload = rst + flo message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dg_ch_id, message_id=MsgIds.MSG_ID_RO_PUMP_SET_PT_OVERRIDE.value, payload=payload) self.logger.debug("override RO pump pressure set point") # 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(flo) self.logger.debug( "RO flow rate overridden to " + str_res + " L/min: " + 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_ro_pump_data_broadcast_interval_override(self, ms, reset=NO_RESET): """ Constructs and sends the RO pump set point override command Constraints: Must be logged into DG. Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). @param ms: integer - time interval (in ms) to broadcast RO pump data @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) mis = integer_to_bytearray(ms) payload = rst + mis message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dg_ch_id, message_id=MsgIds.MSG_ID_RO_PUMP_SEND_INTERVAL_OVERRIDE.value, payload=payload) self.logger.debug("override RO pump data 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(mis) self.logger.debug( "RO pump data broadcast interval overridden to " + str_res + " ms: " + 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