########################################################################### # # 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 valves.py # # @author (last) Micahel Garthwaite # @date (last) 17-Aug-2023 # @author (original) Peman Montazemi # @date (original) 19-May-2020 # ############################################################################ import struct from enum import unique from logging import Logger from collections import OrderedDict from .constants import NO_RESET from leahi_dialin.common.msg_defs import MsgIds 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 # Valve states ENERGIZED = True DEENERGIZED = False @unique class DDValveStates(DialinEnum): VALVE_STATE_CLOSED = 0 VALVE_STATE_OPEN = 1 @unique class DDValveNames(DialinEnum): D14_VALV = 0 # Valve Hydraulics Outlet (D14) D52_VALV = 1 # Valve Thermal Disinfect (D52) D8_VALV = 2 # Valve Hydraulics Bypass (D8) D54_VALV = 3 # Valve Rinse Port (D54) D53_VALV = 4 # Valve Drain (D53) D34_VALV = 5 # Valve DryBcarb Inlet (D65) D64_VALV = 6 # Valve Purge 1 (D64) D31_VALV = 7 # Valve Pressure Test (D31) D65_VALV = 8 # Valve Dialyzer Bypass (D34) D35_VALV = 9 # Valve Dialyzer Inlet (D35) D40_VALV = 10 # Valve Dialyzer Outlet (D40) D47_VALV = 11 # Valve Dialysate Out Purge 2 (D47) D3_VALV = 12 # Valve Hydraulics Inlet (D3) M4_VALV = 13 # Valve Water Inlet (M4) RSRVD_SPACE1 = 14 # This space has been reserved RSRVD_SPACE2 = 15 # This space has been reserved D23_VALV = 16 # Balancing chamber Valve 1 (D23) D19_VALV = 17 # Balancing chamber Valve 2 (D19) D25_VALV = 18 # Balancing chamber Valve 3 (D25) D26_VALV = 19 # Balancing chamber Valve 7 (D26) D24_VALV = 20 # Balancing chamber Valve 5 (D24) D20_VALV = 21 # Balancing chamber Valve 6 (D20) D21_VALV = 22 # Balancing chamber Valve 4 (D21) D22_VALV = 23 # Balancing chamber Valve 8 (D22) D69_VALV = 24 # Ultrafiltration Valve 1 Inlet (D69) D71_VALV = 25 # Ultrafiltration Valve 2 Inlet (D71) D70_VALV = 26 # Ultrafiltration Valve 1 Outlet (D70) D72_VALV = 27 # Ultrafiltration Valve 2 Outlet (D72) class DDValves(AbstractSubSystem): """ Dialysate Delivery (DD) interface for valve related commands. """ # Valves states publish message field positions START_POS_VALVES_STATES = DenaliMessage.PAYLOAD_START_INDEX END_POS_VALVES_STATES = START_POS_VALVES_STATES + 2 # Valves States come in as a U16 value (2 bytes) START_POS_BCV_VALVES_STATES = END_POS_VALVES_STATES END_POS_BCV_VALVES_STATES = START_POS_BCV_VALVES_STATES + 1 START_POS_UFI_VALVES_STATES = END_POS_BCV_VALVES_STATES END_POS_UFI_VALVES_STATES = START_POS_UFI_VALVES_STATES + 1 END_POS_ALL_VALVES = START_POS_VALVES_STATES + 4 def __init__(self, can_interface, logger: Logger): """ @param can_interface: Denali CAN Messenger object """ super().__init__() self.can_interface = can_interface self.logger = logger self.valves_sensed_states = OrderedDict() self.dd_valves_states_timestamp = 0.0 if self.can_interface is not None: channel_id = DenaliChannels.dd_sync_broadcast_ch_id msg_id = MsgIds.MSG_ID_DD_VALVES_STATES_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_valves_sync) self.valve_states_all = 0x00000000 self.d14_valv = {"id": DDValveNames.D14_VALV.value, "state": DEENERGIZED} self.d52_valv = {"id": DDValveNames.D52_VALV.value, "state": DEENERGIZED} self.d8_valv = {"id": DDValveNames.D8_VALV.value, "state": DEENERGIZED} self.d54_valv = {"id": DDValveNames.D54_VALV.value, "state": DEENERGIZED} self.d53_valv = {"id": DDValveNames.D53_VALV.value, "state": DEENERGIZED} self.d65_valv = {"id": DDValveNames.D65_VALV.value, "state": DEENERGIZED} self.d64_valv = {"id": DDValveNames.D64_VALV.value, "state": DEENERGIZED} self.d31_valv = {"id": DDValveNames.D31_VALV.value, "state": DEENERGIZED} self.d34_valv = {"id": DDValveNames.D34_VALV.value, "state": DEENERGIZED} self.d35_valv = {"id": DDValveNames.D35_VALV.value, "state": DEENERGIZED} self.d40_valv = {"id": DDValveNames.D40_VALV.value, "state": DEENERGIZED} self.d47_valv = {"id": DDValveNames.D47_VALV.value, "state": DEENERGIZED} self.d3_valv = {"id": DDValveNames.D3_VALV.value, "state": DEENERGIZED} self.m4_valv = {"id": DDValveNames.M4_VALV.value, "state": DEENERGIZED} self.rsvrd1 = {"id": DDValveNames.RSRVD_SPACE1.value, "state": DEENERGIZED} self.rsvrd2 = {"id": DDValveNames.RSRVD_SPACE2.value, "state": DEENERGIZED} self.d23_valv = {"id": DDValveNames.D23_VALV.value, "state": DEENERGIZED} self.d19_valv = {"id": DDValveNames.D19_VALV.value, "state": DEENERGIZED} self.d25_valv = {"id": DDValveNames.D25_VALV.value, "state": DEENERGIZED} self.d26_valv = {"id": DDValveNames.D26_VALV.value, "state": DEENERGIZED} self.d24_valv = {"id": DDValveNames.D24_VALV.value, "state": DEENERGIZED} self.d20_valv = {"id": DDValveNames.D20_VALV.value, "state": DEENERGIZED} self.d21_valv = {"id": DDValveNames.D21_VALV.value, "state": DEENERGIZED} self.d22_valv = {"id": DDValveNames.D22_VALV.value, "state": DEENERGIZED} self.d69_valv = {"id": DDValveNames.D69_VALV.value, "state": DEENERGIZED} self.d71_valv = {"id": DDValveNames.D71_VALV.value, "state": DEENERGIZED} self.d70_valv = {"id": DDValveNames.D70_VALV.value, "state": DEENERGIZED} self.d72_valv = {"id": DDValveNames.D72_VALV.value, "state": DEENERGIZED} # NOTE: The len function counts the enums with the same number only once. This is not the case in the DD valves # class because each valve must have a unique ID. self.valve_states_enum = [0 for _ in range(len(DDValveNames))] for valve in DDValveNames.__members__: self.valves_sensed_states[valve] = '' def get_valve_states(self): """ Gets the valve states @return: All valve states """ return [ self.d14_valv.get("state", None), self.d52_valv.get("state", None), self.d8_valv.get("state", None), self.d54_valv.get("state", None), self.d53_valv.get("state", None), self.d65_valv.get("state", None), self.d64_valv.get("state", None), self.d31_valv.get("state", None), self.d34_valv.get("state", None), self.d35_valv.get("state", None), self.d40_valv.get("state", None), self.d47_valv.get("state", None), self.d3_valv.get("state", None), self.m4_valv.get("state", None), self.rsvrd1.get("state", None), self.rsvrd2.get("state", None), self.d23_valv.get("state", None), self.d19_valv.get("state", None), self.d25_valv.get("state", None), self.d26_valv.get("state", None), self.d24_valv.get("state", None), self.d20_valv.get("state", None), self.d21_valv.get("state", None), self.d22_valv.get("state", None), self.d69_valv.get("state", None), self.d71_valv.get("state", None), self.d70_valv.get("state", None), self.d72_valv.get("state", None) ] @staticmethod def sort_by_id(observation): """ Converts a published dictionary of valve state information to an ordered list of tuples. @param observation: dictionary of the observed valve states @return: a list of tuples of the valve states """ result = [] for key, value in observation.items(): if isinstance(value, dict): result.append((key, value.get("id", None), value.get("state", None))) result = sorted(result, key=lambda each: each[1]) return result @staticmethod def _binary_to_valve_state(binary) -> bool: """ @param binary: binary value @return: 1 = energized, otherwise de-energized """ if binary != 0: return ENERGIZED else: return DEENERGIZED @publish([ "dd_valves_states_timestamp", "valve_states_all", "d14_valv", "d52_valv", "d8_valv", "d54_valv", "d53_valv", "d65_valv", "d64_valv", "d31_valv", "d34_valv", "d35_valv", "d40_valv", "d47_valv", "d3_valv", "m4_valv", "rsvrd1", "rsvrd2", "d23_valv", "d19_valv", "d25_valv", "d26_valv", "d24_valv", "d20_valv", "d21_valv", "d22_valv", "d69_valv", "d71_valv", "d70_valv", "d72_valv", "valve_states_enum" ]) def _handler_valves_sync(self, message, timestamp=0.0): """ Handles published DD valves states message. @param message: published DD valves states message @return: none """ vsa = struct.unpack('I', bytearray(message['message'][self.START_POS_VALVES_STATES:self.END_POS_ALL_VALVES])) self.valve_states_all = vsa[0] vst = struct.unpack('H', bytearray(message['message'][self.START_POS_VALVES_STATES:self.END_POS_VALVES_STATES])) # Extract each valve state from U16 valves states using bit-masking self.d14_valv["state"] = self._binary_to_valve_state(vst[0] & 1) self.d52_valv["state"] = self._binary_to_valve_state(vst[0] & 2) self.d8_valv["state"] = self._binary_to_valve_state(vst[0] & 4) self.d54_valv["state"] = self._binary_to_valve_state(vst[0] & 8) self.d53_valv["state"] = self._binary_to_valve_state(vst[0] & 16) self.d34_valv["state"] = self._binary_to_valve_state(vst[0] & 32) self.d64_valv["state"] = self._binary_to_valve_state(vst[0] & 64) self.d31_valv["state"] = self._binary_to_valve_state(vst[0] & 128) self.d65_valv["state"] = self._binary_to_valve_state(vst[0] & 256) self.d35_valv["state"] = self._binary_to_valve_state(vst[0] & 512) self.d40_valv["state"] = self._binary_to_valve_state(vst[0] & 1024) self.d47_valv["state"] = self._binary_to_valve_state(vst[0] & 2048) self.d3_valv["state"] = self._binary_to_valve_state(vst[0] & 4096) self.m4_valv["state"] = self._binary_to_valve_state(vst[0] & 8192) self.rsvrd1["state"] = self._binary_to_valve_state(vst[0] & 16384) self.rsvrd2["state"] = self._binary_to_valve_state(vst[0] & 32768) bcv = struct.unpack('B', bytearray(message['message'][self.START_POS_BCV_VALVES_STATES:self.END_POS_BCV_VALVES_STATES])) self.d23_valv["state"] = self._binary_to_valve_state(bcv[0] & 1) self.d19_valv["state"] = self._binary_to_valve_state(bcv[0] & 2) self.d25_valv["state"] = self._binary_to_valve_state(bcv[0] & 4) self.d26_valv["state"] = self._binary_to_valve_state(bcv[0] & 8) self.d24_valv["state"] = self._binary_to_valve_state(bcv[0] & 16) self.d20_valv["state"] = self._binary_to_valve_state(bcv[0] & 32) self.d21_valv["state"] = self._binary_to_valve_state(bcv[0] & 64) self.d22_valv["state"] = self._binary_to_valve_state(bcv[0] & 128) ufi = struct.unpack('B', bytearray(message['message'][self.START_POS_UFI_VALVES_STATES:self.END_POS_UFI_VALVES_STATES])) self.d69_valv["state"] = self._binary_to_valve_state(ufi[0] & 1) self.d69_valv["state"] = self._binary_to_valve_state(ufi[0] & 2) self.d70_valv["state"] = self._binary_to_valve_state(ufi[0] & 4) self.d72_valv["state"] = self._binary_to_valve_state(ufi[0] & 8) start = self.END_POS_UFI_VALVES_STATES end = start + 1 for valve_id in self.valves_sensed_states: valve_state_number = struct.unpack('B', bytearray(message['message'][start:end]))[0] self.valves_sensed_states[valve_id] = DDValveNames(valve_state_number).name start = end end += 1 self.dd_valves_states_timestamp = timestamp def cmd_valve_sensed_state_override(self, valve: int, state: bool, reset: int = NO_RESET) -> int: """ Constructs and sends the valve sensed state override command. Constraints: Must be logged into DD. Given valve ID must be one of the valve IDs listed below. @param valve: unsigned int - valve ID @param state: bool - valve state @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) ste = integer_to_bytearray(int(state)) vlv = integer_to_bytearray(valve) payload = rst + ste + vlv message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_VALVE_SENSED_STATE_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("Override valve sensed state") # 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_valve_override(self, valve: int, state: bool, reset: int = NO_RESET) -> int: """ Constructs and sends the valve state override command. Constraints: Must be logged into DD. Given valve ID must be one of the valve IDs listed below. @param valve: unsigned int - valve ID @param state: bool - valve state @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) ste = integer_to_bytearray(int(state)) vlv = integer_to_bytearray(valve) payload = rst + ste + vlv message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_VALVE_STATE_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("Override valve state") # 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_bc_valves_override(self, bcv1: bool, bcv2: bool, bcv3: bool, bcv4: bool, bcv5: bool, bcv6: bool, bcv7: bool, bcv8: bool) -> int: """ Constructs and sends the balancing chamber valve states override command. Constraints: Must be logged into DD. Given valve ID must be one of the valve IDs listed below. @param bcv1: bool - valve state for D23_VALV (true=open, false=closed) @param bcv2: bool - valve state for D19_VALV (true=open, false=closed) @param bcv3: bool - valve state for D25_VALV (true=open, false=closed) @param bcv4: bool - valve state for D21_VALV (true=open, false=closed) @param bcv5: bool - valve state for D24_VALV (true=open, false=closed) @param bcv6: bool - valve state for D20_VALV (true=open, false=closed) @param bcv7: bool - valve state for D26_VALV (true=open, false=closed) @param bcv8: bool - valve state for D22_VALV (true=open, false=closed) @return: 1 if successful, zero otherwise """ valve = 0 if bcv1: valve = valve | 0x1 if bcv2: valve = valve | 0x2 if bcv3: valve = valve | 0x4 if bcv7: valve = valve | 0x8 if bcv5: valve = valve | 0x10 if bcv6: valve = valve | 0x20 if bcv4: valve = valve | 0x40 if bcv8: valve = valve | 0x80 payload = integer_to_bytearray(valve) message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_BC_VALVE_STATES_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("Override balancing chamber valve states") # 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_valve_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the valve state override command. Constraints: Must be logged into DD. Given interval must be non-zero and a multiple of the DD general task interval (50 ms). @param ms: unsigned int - broadcast interval (in ms) @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) ivl = integer_to_bytearray(ms) payload = rst + ivl message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_VALVE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("override valves states publish interval") # 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_valve_set_open_close(self, valve: int, state: int) -> int: """ Constructs and sends the valve open close command Constraints: Must be logged into DD. @param valve: unsigned int - valve ID @param state: int - value to command the valve @return: 1 if successful, zero otherwise """ vlv = integer_to_bytearray(valve) sts = integer_to_bytearray(state) payload = vlv + sts message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_VALVES_OPEN_CLOSE_STATE_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("setting " + str(state) + " - for valve: " + str(valve)) # 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.error("Timeout!!!!") return False