Index: leahi_dialin/fp/__init__.py =================================================================== diff -u --- leahi_dialin/fp/__init__.py (revision 0) +++ leahi_dialin/fp/__init__.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,22 @@ +import os +import json + +# mandatory import +# none + +file_name = "config.json" +sw_key = "SW" +config = {} +ok: bool = False +module_name = os.path.basename(os.path.dirname(__file__)) + +try: + with open(file_name, 'r') as file: config = json.load(file); ok = config[sw_key] +except FileNotFoundError: print(f"Error ({module_name}): The file '{file_name}' was not found." ) +except KeyError : print(f"Error ({module_name}): The key '{sw_key}' was not found." ) +except Exception as e : print(f"Error ({module_name}): An unexpected error occurred: {e}" ) + +if ok: + print(f"{sw_key} is set to bypass the auto imports in '{module_name}' module.") +else: + from .reverse_osmosis import RO \ No newline at end of file Index: leahi_dialin/fp/modules/__init__.py =================================================================== diff -u --- leahi_dialin/fp/modules/__init__.py (revision 0) +++ leahi_dialin/fp/modules/__init__.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1 @@ \ No newline at end of file Index: leahi_dialin/fp/modules/boost_pump.py =================================================================== diff -u --- leahi_dialin/fp/modules/boost_pump.py (revision 0) +++ leahi_dialin/fp/modules/boost_pump.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,255 @@ +########################################################################### +# +# 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 boost_pump.py +# +# @author (last) Micahel Garthwaite +# @date (last) 17-Aug-2023 +# @author (original) Peter Lucia +# @date (original) 02-Apr-2020 +# +############################################################################ +import struct +from enum import unique +from logging import Logger + +from .constants import RESET, 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 + +@unique +class ROPumpNames(DialinEnum): + P12_PUMP_RO = 0 + P40_PUMP_BOOSTER = 1 + +class ROPumps(AbstractSubSystem): + """ + Dialin API sub-class for RO pump related commands. + """ + + def __init__(self, can_interface, logger: Logger): + """ + ROPumps constructor + """ + super().__init__() + self.can_interface = can_interface + self.logger = logger + + if self.can_interface is not None: + channel_id = DenaliChannels.ro_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_boost_pump_sync) + self.ro_pump_timestamp = 0.0 + self.p12_ro_pump_state = 0 + self.p12_ro_pump_duty_cycle = 0.0 + self.p12_ro_pump_fb_duty_cycle = 0.0 + self.p12_ro_pump_speed = 0.0 + self.p40_boost_pump_state = 0 + self.p40_boost_pump_duty_cycle = 0.0 + self.p40_boost_pump_fb_duty_cycle = 0.0 + self.p40_boost_pump_speed = 0.0 + + + @publish(["ro_pump_timestamp", "p12_ro_pump_state", "p12_ro_pump_duty_cycle", "p12_ro_pump_fb_duty_cycle", + "p12_ro_pump_speed", "p40_boost_pump_state", "p40_boost_pump_duty_cycle", + "p40_boost_pump_fb_duty_cycle", "p40_boost_pump_speed"]) + def _handler_boost_pump_sync(self, message, timestamp=0.0): + """ + Handles published RO pump data messages. RO pump data is captured + for reference. + + @param message: published RO pump data message + @return: none + """ + + rps = struct.unpack('i', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) + rpdc = struct.unpack('i', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])) + rpfbdc = struct.unpack('i', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3])) + rprpm = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4])) + bps = struct.unpack('i', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5])) + bpdc = struct.unpack('i', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6])) + bpfbdc = struct.unpack('i', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7])) + bprpm = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8])) + + self.ro_pump_timestamp = timestamp + self.p12_ro_pump_state = rps[0] + self.p12_ro_pump_duty_cycle = rpdc[0] + self.p12_ro_pump_fb_duty_cycle = rpfbdc[0] + self.p12_ro_pump_speed = rprpm[0] + self.p40_boost_pump_state = bps[0] + self.p40_boost_pump_duty_cycle = bpdc[0] + self.p40_boost_pump_fb_duty_cycle = bpfbdc[0] + self.p40_boost_pump_speed = bprpm[0] + + + + def cmd_boost_pump_set_speed_rate_override(self, pump: int, rpm: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the boost pump set point command + Constraints: + Must be logged into RO. + + @param rpm: integer - speed set point (in rpm) + @return: 1 if successful, zero otherwise + """ + rst = integer_to_bytearray(reset) + rpm = integer_to_bytearray(rpm) + pmp = integer_to_bytearray(pump) + payload = rst + rpm + pmp + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_BOOST_PUMP_SPEED_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override blood flow set point") + + # 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 = str(rpm) + + self.logger.debug("rpm overridden to " + str_res) + # response payload is OK or not OK + return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] + else: + self.logger.debug("Timeout!!!!") + return False + + def cmd_boost_pump_set_pwm_request(self, pump: int, pwm: int) -> int: + """ + Constructs and sends set pwm request for RO pumps \n + command. + Constraints: + Must be logged into RO. + + @param pwm: integer - counts to override the pwm ( 0 - 500 ) + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + """ + + spd = integer_to_bytearray(pwm) + pmp = integer_to_bytearray(pump) + payload = pmp + spd + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_BOOST_PUMP_SET_PWM_REQUEST.value, + payload=payload) + + self.logger.debug("setting pump {} to pwm count {}".format(pump,pwm)) + + # Send message + received_message = self.can_interface.send(message) + + # If there is content... + if received_message is not None: + + self.logger.debug("pwm set to " + str(pwm)) + # response payload is OK or not OK + return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] + else: + self.logger.debug("Timeout!!!!") + return False + + def cmd_boost_pump_read_pwm_override(self, pump: int, pwm: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends the read pwm override for the RO pumps \n + command. + Constraints: + Must be logged into RO. + + @param pwm: float - pwm in percentage 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) + rpwm = float_to_bytearray(pwm) + pmp = integer_to_bytearray(pump) + payload = rst + rpwm + pmp + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_BOOST_PUMP_READ_PWM_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override read pwm for pump".format(pump)) + + # 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 = str(rpwm) + + self.logger.debug("pwm overridden to " + str_res) + # response payload is OK or not OK + return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] + else: + self.logger.debug("Timeout!!!!") + return False + + def cmd_boost_pump_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO pump broadcast interval override command + Constraints: + Must be logged into RO. + Given interval must be non-zero and a multiple of the RO 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_BOOST_PUMPS_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override RO pump 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("broadcast overridden to " + str_res) + # response payload is OK or not OK + return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] + else: + self.logger.debug("Timeout!!!!") + return False \ No newline at end of file Index: leahi_dialin/fp/modules/conductivity_sensors.py =================================================================== diff -u --- leahi_dialin/fp/modules/conductivity_sensors.py (revision 0) +++ leahi_dialin/fp/modules/conductivity_sensors.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,230 @@ +########################################################################### +# +# 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 conductivity_sensors.py +# +# @author (last) Dara Navaei +# @date (last) 15-May-2023 +# @author (original) Quang Nguyen +# @date (original) 20-Jul-2020 +# +############################################################################ +import struct +from logging import Logger +from enum import unique + +from .constants import RESET, 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 + + +@unique +class ROConductivitySensorsEnum(DialinEnum): + P9_CPI = 0 # CPi (P9) conductivity sensor value + P18_CPO = 1 # CPo (P18) conductivity sensor value + +class ROConductivitySensors(AbstractSubSystem): + """ + Dialin API sub-class for conductivity sensors related commands. + """ + + def __init__(self, can_interface, logger: Logger): + """ + + @param can_interface: Denali Can Messenger object + """ + super().__init__() + + self.can_interface = can_interface + self.logger = logger + + if self.can_interface is not None: + channel_id = DenaliChannels.ro_sync_broadcast_ch_id + msg_id = MsgIds.MSG_ID_RO_CONDUCTIVITY_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, + self._handler_conductivity_sensors_sync) + + self.p9_cpi_conductivity = 0.0 + self.p18_cpo_conductivity = 0.0 + + self.ro_conductivity_timestamp = 0.0 + + @publish(["ro_conductivity_timestamp", + "p9_cpi_conductivity", "p18_cpo_conductivity"]) + def _handler_conductivity_sensors_sync(self, message, timestamp=0.0): + """ + Handles published RO conductivity sensor data messages. Conductivity sensor data are captured + for reference. + + @param message: published conductivity sensor data message + @return: None + """ + + self.p9_cpi_conductivity = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] + self.p18_cpo_conductivity = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] + + self.ro_conductivity_timestamp = timestamp + + def cmd_conductivity_sensor_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO conductivity sensor data broadcast interval override command + Constraints: + Must be logged into RO. + Given interval must be non-zero and a multiple of the RO 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 + + reset_byte_array = integer_to_bytearray(reset) + ms_byte_array = integer_to_bytearray(ms) + payload = reset_byte_array + ms_byte_array + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_CONDUCTIVITY_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override RO conductivity sensor broadcast interval") + + # 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 = str(ms) + " ms: " + self.logger.debug("RO Conductivity sensor data 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.error("Timeout!!!!") + return False + + def cmd_conductivity_sensor_readings_override(self, sensor: int, conductivity: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO conductivity value override command. + Constraints: + Must be logged into RO. + + @param sensor: unsigned int - sensor ID + @param conductivity: float - conductivity value to override sensor with + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + + """ + + reset_byte_array = integer_to_bytearray(reset) + cond_byte_array = float_to_bytearray(conductivity) + sensor_byte_array = integer_to_bytearray(sensor) + payload = reset_byte_array + cond_byte_array + sensor_byte_array + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_CONDUCTIVITY_OVERRIDE_REQUEST.value, + payload=payload) + + if reset == RESET: + str_res = "reset back to normal" + else: + str_res = str(conductivity) + " microsiemens/cm" + self.logger.debug("override RO conductivity sensor value for sensor " + str(sensor) + ": " + str_res) + + # 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 + + def cmd_conductivity_sensor_read_counter_override(self, sensor: int, counter: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO conductivity sensor read override command + + @param sensor: unsigned int - sensor ID + @param counter: counter - count value to override sensor with + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + + """ + + reset_byte_array = integer_to_bytearray(reset) + read_byte_array = integer_to_bytearray(counter) + sensor_byte_array = integer_to_bytearray(sensor) + payload = reset_byte_array + read_byte_array + sensor_byte_array + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_CONDUCTIVITY_READ_COUNT_OVERRIDE_REQUEST.value, + payload=payload) + + if reset == RESET: + str_res = "reset back to normal" + else: + str_res = str(counter) + self.logger.debug("override RO conductivity sensor value for sensor " + str(sensor) + ": " + str_res) + + # 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 + + def cmd_conductivity_sensor_error_counter_override(self, sensor: int, counter: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO conductivity error counter override command + + @param sensor: unsigned int - sensor ID + @param counter: counter - count value to override error counter + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + + """ + + reset_byte_array = integer_to_bytearray(reset) + error_byte_array = integer_to_bytearray(counter) + sensor_byte_array = integer_to_bytearray(sensor) + payload = reset_byte_array + error_byte_array + sensor_byte_array + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_CONDUCTIVITY_ERROR_COUNT_OVERRIDE_REQUEST.value, + payload=payload) + + if reset == RESET: + str_res = "reset back to normal" + else: + str_res = str(counter) + self.logger.debug("override RO conductivity sensor value for sensor " + str(sensor) + ": " + str_res) + + # 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 \ No newline at end of file Index: leahi_dialin/fp/modules/constants.py =================================================================== diff -u --- leahi_dialin/fp/modules/constants.py (revision 0) +++ leahi_dialin/fp/modules/constants.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,18 @@ +########################################################################### +# +# 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 constants.py +# +# @author (last) Michael +# @date (last) 14-Nov-2024 +# @author (original) Michael +# @date (original) 14-Nov-2024 +# +############################################################################ + +RESET = 1 +NO_RESET = 0 Index: leahi_dialin/fp/modules/flow_sensors.py =================================================================== diff -u --- leahi_dialin/fp/modules/flow_sensors.py (revision 0) +++ leahi_dialin/fp/modules/flow_sensors.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,175 @@ +########################################################################### +# +# 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 flow_sensors.py +# +# @author (last) Micahel Garthwaite +# @date (last) 17-Aug-2023 +# @author (original) Peter Lucia +# @date (original) 02-Apr-2020 +# +############################################################################ +import struct +from enum import unique +from logging import Logger + +from .constants import RESET, 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 + + +@unique +class ROFlowSensorNames(DialinEnum): + P7_FLOW_SENSOR_WATER_INLET = 0 # Water inlet flow sensor (FMS P7) + P16_FLOW_SENSOR_RO_OUTLET = 1 # RO outlet flow sensor (FMP P16) + + +class ROFlowSensors(AbstractSubSystem): + """ + + Dialin API sub-class for flow sensor related commands. + """ + + def __init__(self, can_interface, logger: Logger): + """ + + @param can_interface: Denali CAN Messenger object + """ + + super().__init__() + + self.can_interface = can_interface + self.logger = logger + + if self.can_interface is not None: + channel_id = DenaliChannels.ro_sync_broadcast_ch_id + msg_id = MsgIds.MSG_ID_RO_FLOW_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_flow_sensor_sync) + + + self.p7_flowFMS = 0.0 + self.p16_flowFMP = 0.0 + self.p7_tempFMS = 0.0 + self.p16_tempFMP = 0.0 + + self.ro_flow_timestamp = 0 + + @publish(["ro_levels_timestamp", + "p7_flowFMS", "p16_flowFMP", + "p7_tempFMS", "p16_tempFMP"]) + def _handler_flow_sensor_sync(self, message, timestamp=0.0): + """ + Handles published flow sensor message + + @param message: published flow sensor data message + @returns none + """ + self.p7_flowFMS = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] + self.p16_flowFMP = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] + self.p7_tempFMS = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] + self.p16_tempFMP = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] + + self.ro_flow_timestamp = timestamp + + def cmd_flow_sensor_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends an RO flow sensor broadcast interval override command message. + Constraints: + Must be logged into RO. + Given interval must be non-zero and a multiple of the RO general task interval (50 ms). + + @param ms: (int) Publish time interval in ms + @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 + + 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_FLOWS_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("Sending {} ms publish interval to the RO flow sensor 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_flow_rate_override(self, flow_sensor: int, rate: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends flow rate override command. + Must be logged into RO. + + @param flow_sensor: integer - the sensor to override its value. + @param rate: integer - the rate value to override. + @param reset: integer - 1 to reset a previous override, 0 to override + @returns 1 if successful, zero otherwise + """ + reset_value = integer_to_bytearray(reset) + lvl = integer_to_bytearray(flow_sensor) + sts = float_to_bytearray(rate) + payload = reset_value + sts + lvl + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_FLOW_RATE_OVERRIDE_REQUEST.value, + payload=payload) + + # 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_flow_temp_override(self, flow_sensor: int, temp: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends flow temp override command. + Must be logged into RO. + + @param flow_sensor: integer - the sensor to override its value + @param temp: float - the temperature value to override + @param reset: integer - 1 to reset a previous override, 0 to override + @returns 1 if successful, zero otherwise + """ + reset_value = integer_to_bytearray(reset) + lvl = integer_to_bytearray(flow_sensor) + sts = float_to_bytearray(temp) + payload = reset_value + sts + lvl + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_FLOW_TEMP_OVERRIDE_REQUEST.value, + payload=payload) + + # 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 \ No newline at end of file Index: leahi_dialin/fp/modules/levels.py =================================================================== diff -u --- leahi_dialin/fp/modules/levels.py (revision 0) +++ leahi_dialin/fp/modules/levels.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,128 @@ +########################################################################### +# +# 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 levels.py +# +# @author (last) Michael Garthwaite +# @date (last) 28-Oct-2024 +# @author (original) Dara Navaei +# @date (original) 29-May-2020 +# +############################################################################ + +import struct +from enum import unique +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 + +class ROLevels(AbstractSubSystem): + """ + + Dialin API sub-class for levels related commands. + """ + + 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.p25_level = 0 + self.ro_levels_timestamp = 0 + + if self.can_interface is not None: + channel_id = DenaliChannels.ro_sync_broadcast_ch_id + msg_id = MsgIds.MSG_ID_RO_LEVEL_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_levels_sync) + + @publish(["ro_levels_timestamp", + "p25_level",]) + 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] + + self.ro_levels_timestamp = timestamp + + def cmd_levels_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends an RO levels data broadcast interval override command message. + Constraints: + Must be logged into RO. + Given interval must be non-zero and a multiple of the RO general task interval (50 ms). + + @param ms: (int) Publish time interval in ms + @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 + + 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_LEVELS_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("Sending {} ms publish interval to the RO 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, level_sensor: int, status: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends level status override command. + Must be logged into RO. + + @param level_sensor: integer - the level sensor to override its value + @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 = integer_to_bytearray(level_sensor) + sts = integer_to_bytearray(status) + payload = reset_value + sts + lvl + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_LEVELS_STATUS_OVERRIDE_REQUEST.value, + payload=payload) + + # 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 Index: leahi_dialin/fp/modules/pressure_sensors.py =================================================================== diff -u --- leahi_dialin/fp/modules/pressure_sensors.py (revision 0) +++ leahi_dialin/fp/modules/pressure_sensors.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,220 @@ +########################################################################### +# +# 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 pressure_sensors.py +# +# @author (last) Vinayakam Mani +# @date (last) 02-May-2024 +# @author (original) Peter Lucia +# @date (original) 02-Apr-2020 +# +############################################################################ +import struct +from enum import unique +from logging import Logger + +from .constants import RESET, 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 + + +@unique +class ROPressureSensorNames(DialinEnum): + M1_PRESSURE_SENSOR_WATER_INLET_PRE_REG = 0 + M3_PRESSURE_SENSOR_WATER_INLET_POST_REG = 1 + P8_PRESSURE_SENSOR_WATER_INLET_PRE_COND = 2 + P13_PRESSURE_SENSOR_PRE_RO_FILTER = 3 + P17_PRESSURE_SENSOR_POST_RO_FILTER = 4 + X1_PRESSURE_SENSOR_PRE_RO_PUMP = 5 + + +class ROPressureSensors(AbstractSubSystem): + """ + Dialin API sub-class for RO pressure sensor related commands. + """ + + def __init__(self, can_interface, logger: Logger): + """ + ROPressureSensors constructor + + """ + super().__init__() + self.can_interface = can_interface + self.logger = logger + + if self.can_interface is not None: + channel_id = DenaliChannels.ro_sync_broadcast_ch_id + msg_id = MsgIds.MSG_ID_RO_PRESSURES_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, + self._handler_pressure_sync) + + self.ro_pressure_timestamp = 0.0 + self.m1_water_inlet_pre_reg_pressure = 0.0 + self.m3_water_inlet_post_reg_pressure = 0.0 + self.p8_water_inlet_pre_cond_pressure = 0.0 + self.p13_pre_ro_filter_pressure = 0.0 + self.p17_post_ro_filter_pressure = 0.0 + self.x1_pre_ro_pump_pressure = 0.0 + self.m1_water_inlet_pre_reg_temp = 0.0 + self.m3_water_inlet_post_reg_temp = 0.0 + self.p8_water_inlet_pre_cond_temp = 0.0 + self.p13_pre_ro_filter_temp = 0.0 + self.p17_post_ro_filter_temp = 0.0 + self.x1_pre_ro_pump_temp = 0.0 + + + @publish([ + "ro_pressure_timestamp", + "m1_water_inlet_pre_reg_pressure", + "m3_water_inlet_post_reg_pressure", + "p8_water_inlet_pre_cond_pressure", + "p13_pre_ro_filter_pressure", + "p17_post_ro_filter_pressure", + "x1_pre_ro_pump_pressure", + "m1_water_inlet_pre_reg_temp", + "m3_water_inlet_post_reg_temp", + "p8_water_inlet_pre_cond_temp", + "p13_pre_ro_filter_temp", + "p17_post_ro_filter_temp", + "x1_pre_ro_pump_temp" + ]) + def _handler_pressure_sync(self, message, timestamp=0.0): + """ + Handles published RO pressure sensor data messages. Pressure data are captured + for reference. + + @param message: published RO pressure sensor data message + @return: none + """ + + pre_reg_wi = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) + post_reg_wi = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])) + pre_cond_wi = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3])) + pre_ro = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4])) + post_ro = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5])) + pre_pump = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6])) + + pre_reg_wi_temp = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7])) + post_reg_wi_temp = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8])) + pre_cond_wi_temp = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9])) + pre_ro_temp = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_10:MsgFieldPositions.END_POS_FIELD_10])) + post_ro_temp = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_11:MsgFieldPositions.END_POS_FIELD_11])) + pre_pump_temp = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_12:MsgFieldPositions.END_POS_FIELD_12])) + + self.m1_water_inlet_pre_reg_pressure = pre_reg_wi[0] + self.m3_water_inlet_post_reg_pressure = post_reg_wi[0] + self.p8_water_inlet_pre_cond_pressure = pre_cond_wi[0] + self.p13_pre_ro_filter_pressure = pre_ro[0] + self.p17_post_ro_filter_pressure = post_ro[0] + self.x1_pre_ro_pump_pressure = pre_pump[0] + + self.m1_water_inlet_pre_reg_pressure = pre_reg_wi_temp[0] + self.m3_water_inlet_post_reg_pressure = post_reg_wi_temp[0] + self.p8_water_inlet_pre_cond_pressure = pre_cond_wi_temp[0] + self.p13_pre_ro_filter_pressure = pre_ro_temp[0] + self.p17_post_ro_filter_pressure = post_ro_temp[0] + self.x1_pre_ro_pump_temp = pre_pump_temp[0] + + self.ro_pressure_timestamp = timestamp + + def cmd_pressure_sensor_override(self, sensor: int, pressure: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends a measured RO pressure override command message. + Constraints: + Must be logged into RO. + + @param sensor: int - switch between filtered override and raw override + @param pressure: float - measured pressure (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) + sen = integer_to_bytearray(sensor) + prs = float_to_bytearray(pressure) + payload = rst + prs + sen + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_PRESSURE_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override RO pressure sensor") + + # 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 = str(pressure) + " PSI. " + self.logger.debug("RO pressure 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_pressure_sensors_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO pressure data broadcast interval override command. + Constraints: + Must be logged into RO. + Given interval must be non-zero and a multiple of the RO 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_PRESSURE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override RO pressure 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("RO pressure 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 \ No newline at end of file Index: leahi_dialin/fp/modules/valves.py =================================================================== diff -u --- leahi_dialin/fp/modules/valves.py (revision 0) +++ leahi_dialin/fp/modules/valves.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,294 @@ +########################################################################### +# +# 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 ROValveStates(DialinEnum): + VALVE_STATE_CLOSED = 0 + VALVE_STATE_OPEN = 1 + + +@unique +class ROValveNames(DialinEnum): + M4_VWI = 0 # Valve (M4 VWi) + P39_VROD = 1 # Valve (P39 VROd) + P6_VFF = 2 # Valve (P6 VFF) + P11_VPI = 3 # Valve (P11 VPi) + P33_VCR = 4 # Valve (P33 VCr) + P34_VCB = 5 # Valve (P34 VCb) + P37_VCD = 6 # Valve (P37 VCd) + M7_VFB = 7 # Valve (M7 VFB) + P20_SPP = 8 # Valve (P20 SPP) + +class ROValves(AbstractSubSystem): + """ + Dialin API sub-class for RO 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) + + 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.ro_valves_states_timestamp = 0.0 + + if self.can_interface is not None: + channel_id = DenaliChannels.ro_sync_broadcast_ch_id + msg_id = MsgIds.MSG_ID_RO_VALVES_STATES_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_valves_sync) + + self.valve_states_all = 0x0000 + self.m4_vwi_state= {"id": ROValveNames.M4_VWI.value, "state": DEENERGIZED} + self.p39_vrod_state = {"id": ROValveNames.P39_VROD.value, "state": DEENERGIZED} + self.p6_vff_state = {"id": ROValveNames.P6_VFF.value, "state": DEENERGIZED} + self.p11_vpi_state = {"id": ROValveNames.P11_VPI.value, "state": DEENERGIZED} + self.p33_vcr_state = {"id": ROValveNames.P33_VCR.value, "state": DEENERGIZED} + self.p34_vcb_state = {"id": ROValveNames.P34_VCB.value, "state": DEENERGIZED} + self.p37_vcd_state = {"id": ROValveNames.P37_VCD.value, "state": DEENERGIZED} + self.m7_vfb_state = {"id": ROValveNames.M7_VFB.value, "state": DEENERGIZED} + self.p20_spp_state = {"id": ROValveNames.P20_SPP.value, "state": DEENERGIZED} + + # NOTE: The len function counts the enums with the same number only once. This is not the case in the DG valves + # class because each valve must have a unique ID. + self.valve_states_enum = [0 for _ in range(len(ROValveNames))] + + for valve in ROValveNames.__members__: + self.valves_sensed_states[valve] = '' + + def get_valve_states(self): + """ + Gets the valve states + + @return: All valve states + """ + return [ + self.m4_vwi_state.get("state"), + self.p39_vrod_state.get("state"), + self.p6_vff_state.get("state"), + self.p11_vpi_state.get("state"), + self.p33_vcr_state.get("state"), + self.p34_vcb_state.get("state"), + self.p37_vcd_state.get("state"), + self.m7_vfb_state.get("state"), + self.p20_spp_state.get("state") + ] + + @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([ + "ro_valves_states_timestamp", + "valve_states_all", + "m4_vwi_state", + "p39_vrod_state", + "p6_vff_state", + "p11_vpi_state", + "p33_vcr_state", + "p34_vcb_state", + "p37_vcd_state", + "m7_vfb_state", + "p20_spp_state", + "valve_states_enum" + ]) + def _handler_valves_sync(self, message, timestamp=0.0): + """ + Handles published RO valves states message. + + @param message: published RO valves states message + @return: none + """ + + vst = struct.unpack('H', bytearray(message['message'][self.START_POS_VALVES_STATES:self.END_POS_VALVES_STATES])) + self.valve_states_all = vst[0] + # Extract each valve state from U16 valves states using bit-masking + self.m4_vwi_state["state"] = self._binary_to_valve_state(vst[0] & 1) + self.p39_vrod_state["state"] = self._binary_to_valve_state(vst[0] & 2) + self.p6_vff_state["state"] = self._binary_to_valve_state(vst[0] & 4) + self.p11_vpi_state["state"] = self._binary_to_valve_state(vst[0] & 8) + self.p33_vcr_state["state"] = self._binary_to_valve_state(vst[0] & 16) + self.p34_vcb_state["state"] = self._binary_to_valve_state(vst[0] & 32) + self.p37_vcd_state["state"] = self._binary_to_valve_state(vst[0] & 64) + self.m7_vfb_state["state"] = self._binary_to_valve_state(vst[0] & 128) + self.p20_spp_state["state"] = self._binary_to_valve_state(vst[0] & 256) + + start = self.END_POS_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] = ROValveStates(valve_state_number).name + start = end + end += 1 + + self.ro_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 RO. + 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_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: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO valve state override command. + Constraints: + Must be logged into RO. + Given valve ID must be one of the valve IDs listed below. + + @param valve: unsigned int - valve ID + @param state: int - 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_VALVE_CMD_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_valve_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the RO valve state override command. + Constraints: + Must be logged into RO. + Given interval must be non-zero and a multiple of the RO 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_VALVE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override RO 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 Index: leahi_dialin/fp/reverse_osmosis.py =================================================================== diff -u --- leahi_dialin/fp/reverse_osmosis.py (revision 0) +++ leahi_dialin/fp/reverse_osmosis.py (revision 35450f4b6cfc01b3bfdf48c9bda17523a053b38c) @@ -0,0 +1,248 @@ +########################################################################### +# +# 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.conductivity_sensors import ROConductivitySensors +from .modules.flow_sensors import ROFlowSensors +from .modules.boost_pump import ROPumps +from .modules.levels import ROLevels +from .modules.pressure_sensors import ROPressureSensors +from .modules.valves import ROValves + + +from ..common.msg_defs import MsgIds, MsgFieldPositions +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 RO(AbstractSubSystem): + """ + Reverse Osmosis ( RO aka IOFP ) Dialin object API. + It provides the basic interface to communicate with the RO firmware. + """ + # RO debug event max count + _RO_DEBUG_EVENT_LIST_COUNT = 10 + _RO_DEBUG_EVENT_MSG_LEN_INDEX = 5 + + # RO login password + RO_LOGIN_PASSWORD = '123' + + # UI version message field positions + START_POS_MAJOR = DenaliMessage.PAYLOAD_START_INDEX + END_POS_MAJOR = START_POS_MAJOR + 1 + START_POS_MINOR = END_POS_MAJOR + END_POS_MINOR = START_POS_MINOR + 1 + START_POS_MICRO = END_POS_MINOR + END_POS_MICRO = START_POS_MICRO + 1 + START_POS_BUILD = END_POS_MICRO + END_POS_BUILD = START_POS_BUILD + 2 + START_POS_COMPATIBILITY_REV = END_POS_BUILD + END_POS_COMPATIBILITY_REV = START_POS_COMPATIBILITY_REV + 4 + + def __init__(self, can_interface="can0", log_level=None): + """ + RO object provides test/service commands for the RO sub-system. + + >> RO_object = RO('can0') + >> RO_object = RO(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 RO operation mode broadcast messages + if self.can_interface is not None: + channel_id = DenaliChannels.ro_sync_broadcast_ch_id + msg_id = MsgIds.MSG_ID_RO_OP_MODE_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, + self._handler_ro_op_mode_sync) + + self.can_interface.register_receiving_publication_function(channel_id, + MsgIds.MSG_ID_RO_DEBUG_EVENT.value, + self._handler_ro_debug_event_sync) + + # create properties + self.ro_op_mode_timestamp = 0.0 + self.ro_debug_events_timestamp = 0.0 + self.ui_version_info_response_timestamp = 0.0 + + self.ro_operation_sub_mode = 0 + self.ro_logged_in = False + self.ro_set_logged_in_status(False) + self.ui_version = None + self.ro_debug_events = [''] * self._RO_DEBUG_EVENT_LIST_COUNT + self.ro_debug_event_index = 0 + self.ro_last_debug_event = '' + + # Create command groups + self.conductivity = ROConductivitySensors(self.can_interface, self.logger) + self.flows = ROFlowSensors(self.can_interface, self.logger) + self.pumps = ROPumps(self.can_interface, self.logger) + self.levels = ROLevels(self.can_interface, self.logger) + self.pressures = ROPressureSensors(self.can_interface, self.logger) + self.valves = ROValves(self.can_interface, self.logger) + + @publish(["ro_debug_events_timestamp","ro_debug_events"]) + def _handler_ro_debug_event_sync(self, message, timestamp = 0.0): + + payload = message['message'] + message_length = payload[self._RO_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.ro_debug_events_timestamp = timestamp + self.ro_debug_events.insert(self.ro_debug_event_index, temp_message) + self.ro_last_debug_event = temp_message + + self.ro_debug_event_index += 1 + if self.ro_debug_event_index == self._RO_DEBUG_EVENT_LIST_COUNT: + self.ro_debug_event_index = 0 + + @publish(["ro_logged_in"]) + def ro_set_logged_in_status(self, logged_in: bool = False): + """ + Callback for ro logged in status change. + @param logged_in boolean logged in status for RO + @return: none + """ + self.ro_logged_in = logged_in + + @publish(["ro_op_mode_timestamp","ro_operation_mode", "ro_operation_sub_mode"]) + def _handler_ro_op_mode_sync(self, message, timestamp = 0.0): + """ + Handles published RO operation mode messages. Current RO operation mode + is captured for reference. + + @param message: published RO 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.ro_operation_mode = mode[0] + self.ro_operation_sub_mode = smode[0] + self.ro_op_mode_timestamp = timestamp + + def cmd_log_in_to_ro(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 RO. + + @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_ro_ch_id, + message_id=MsgIds.MSG_ID_FIRST_RO_TESTER_MESSAGE.value, + payload=list(map(int, map(ord, self.RO_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.ro_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_ro_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 RO. + Transition from current to requested op mode must be legal. + NOTE: for POST the RO 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_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_SET_OP_MODE_REQUEST.value, + payload=payload) + + self.logger.debug("Requesting RO 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("RO mode change request Timeout!!!!") + return False + + + def cmd_ro_software_reset_request(self) -> None: + """ + Constructs and sends an RO software reset request via CAN bus. + Constraints: + Must be logged into RO. + + @return: None + """ + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_ro_ch_id, + message_id=MsgIds.MSG_ID_RO_SOFTWARE_RESET_REQUEST.value) + + self.logger.debug("requesting RO software reset") + + # Send message + self.can_interface.send(message, 0) + self.logger.debug("Sent request to RO to reset...") + self.ro_set_logged_in_status(False) + + Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/__init__.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/__init__.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/boost_pump.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/conductivity_sensors.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/constants.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/flow_sensors.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/levels.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/pressure_sensors.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/modules/valves.py'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 35450f4b6cfc01b3bfdf48c9bda17523a053b38c refers to a dead (removed) revision in file `leahi_dialin/ro/reverse_osmosis.py'. Fisheye: No comparison available. Pass `N' to diff?