1"""
  2Provides controls for the Chroma 16CH Cell Simulator.
  3
  4# (c) 2020-2024 TurnAround Factor, Inc.
  5#
  6# CUI DISTRIBUTION CONTROL
  7# Controlled by: DLA J68 R&D SBIP
  8# CUI Category: Small Business Research and Technology
  9# Distribution/Dissemination Controls: PROTECTED BY SBIR DATA RIGHTS
 10# POC: GOV SBIP Program Manager Denise Price, 571-767-0111
 11# Distribution authorized to U.S. Government Agencies only, to protect information not owned by the
 12# U.S. Government and protected by a contractor’s ‘limited rights’ statement, or received with the understanding that
 13# it is not routinely transmitted outside the U.S. Government (determination made September 14, 2024). Other requests
 14# for this document shall be referred to ACOR DLA Logistics Operations (J-68), 8725 John J. Kingman Rd., Suite 4317,
 15# Fort Belvoir, VA 22060-6221
 16#
 17# SBIR DATA RIGHTS
 18# Contract No.:SP4701-23-C-0083
 19# Contractor Name: TurnAround Factor, Inc.
 20# Contractor Address: 10365 Wood Park Ct. Suite 313 / Ashland, VA 23005
 21# Expiration of SBIR Data Rights Period: September 24, 2029
 22# The Government's rights to use, modify, reproduce, release, perform, display, or disclose technical data or computer
 23# software marked with this legend are restricted during the period shown as provided in paragraph (b)(4) of the Rights
 24# in Noncommercial Technical Data and Computer Software--Small Business Innovative Research (SBIR) Program clause
 25# contained in the above identified contract. No restrictions apply after the expiration date shown above. Any
 26# reproduction of technical data, computer software, or portions thereof marked with this legend must also reproduce
 27# the markings.
 28"""
 29
 30import time
 31from contextlib import suppress
 32from enum import IntEnum, IntFlag
 33
 34from hitl_tester.modules.bms.cell import Cell
 35from hitl_tester.modules.bms_types import UnderVoltageError, OverVoltageError, CellCompMode, SafeResource
 36from hitl_tester.modules.logger import logger
 37
 38CURRENT_LIMIT = 5.0
 39
 40
 41class CellTestingStatus(IntEnum):
 42    """Cell testing status."""
 43
 44    RUNNING = 0
 45    STOP_BY_IPC = 1
 46    STOP_BY_PROTECTION = 2
 47    STOP_BY_ERROR = 3
 48    STOP_BY_EMERGENCY_OFF = 4
 49
 50
 51class CellOutputStatus(IntEnum):
 52    """Cell output status."""
 53
 54    IDLE = 0
 55    TESTING = 1
 56    STOP = 2
 57
 58
 59class CellProtection(IntFlag):
 60    """Cell protection status."""
 61
 62    NO_ERROR = 0
 63    OCP = 2
 64    WIRELOSS = 8
 65    FAN_FAIL = 16
 66    POWER_FAIL = 32
 67    FAN_SPEED_WARNING = 256
 68    OLDP = 512
 69
 70
 71class ChromaCell(Cell):
 72    """Chroma 16CH Cell Simulator command wrapper."""
 73
 74    def __init__(self, cell_id: int, resource: SafeResource, cell_chemistry: str, cell_slot: int):
 75        self.slot = cell_slot
 76        super().__init__(cell_id, resource, cell_chemistry)
 77
 78    @property
 79    def measured_volts(self) -> float:
 80        """Measures actual cell voltage."""
 81        with self._lock:
 82            result = float(self._resource.query(f"SIM:MEAS:CELL:VOLT? 1,{self.slot},{self.slot}"))
 83            return result if result != 9.91e37 else 0.0  # Convert NaN to 0
 84
 85    @property
 86    def volts(self) -> float:
 87        """Gets the last target voltage."""
 88        with self._lock:
 89            return self._volts
 90
 91    @volts.setter
 92    def volts(self, new_voltage: float):
 93        """Sets the output voltage."""
 94        with self._lock:
 95            if not self.disengage_safety_protocols and new_voltage <= self.data.uv_protection:
 96                raise UnderVoltageError(
 97                    f"Undervoltage protection triggered at {time.strftime('%x %X')} on cell {self.id}, slot {self.slot}"
 98                    f" Voltage {new_voltage} is lower than {self.data.uv_protection}."
 99                )
100            if not self.disengage_safety_protocols and new_voltage >= self.data.ov_protection:
101                raise OverVoltageError(
102                    f"Overvoltage protection triggered at {time.strftime('%x %X')} on cell {self.id}, slot {self.slot}."
103                    f" Voltage {new_voltage} is higher than {self.data.ov_protection}."
104                )
105
106            self._resource.write(f"SIM:PROG:CELL 1,1,{self.slot},{self.slot},{new_voltage},{CURRENT_LIMIT}")
107            self._volts = new_voltage
108            self._resource.write("SIM:OUTP:IMM")
109            self.enable()  # FIXME(JA): explicitly enable cells
110
111    @property
112    def ohms(self) -> float:
113        """Measures internal resistance of the cell. Not supported."""
114        with self._lock:
115            return self._resistance
116
117    @ohms.setter
118    def ohms(self, new_ohms: float):
119        """Sets the internal resistance of the cell. Not supported."""
120        with self._lock:
121            self._resistance = new_ohms
122
123    @property
124    def amps(self) -> float:
125        """Measures cell current."""
126        with self._lock:
127            result = float(self._resource.query(f"SIM:MEAS:CELL:CURR? 1,{self.slot},{self.slot}"))
128            return result if result != 9.91e37 else 0.0  # Convert NaN to 0
129
130    @amps.setter
131    def amps(self, new_amps: float):
132        """Sets the current limit of the cell (current≥0:charge, current<0:discharge)."""
133        global CURRENT_LIMIT
134        with self._lock:
135            CURRENT_LIMIT = new_amps
136            self.volts = float(self._resource.query(f"SIM:PROG:CELL? 1,1,{self.slot},{self.slot}").split(",")[2])
137
138    @property
139    def compensation_mode(self) -> CellCompMode:
140        """Sets compensation mode"""
141        return CellCompMode.LLOCAL
142
143    @compensation_mode.setter
144    def compensation_mode(self, mode: CellCompMode):
145        """Sets compensation mode"""
146
147    def enable(self):
148        """Enables the cell."""
149        self._resource.write(f"SIM:OUTP:SPE ON,1,{self.slot},{self.slot}")
150        # with suppress(ValueError):  # Useful for debugging
151        #     protection = CellProtection(int(self._resource.query(f"SIM:MEAS:CELL:PROT? 1,{self.slot},{self.slot}")))
152        #     logger.write_debug_to_report(f"Protection is: {protection} ({protection!s})")
153        self._thread_pause_flag.set()
154
155    def disable(self):
156        """Disables the cell."""
157        self._thread_pause_flag.clear()
158        self._resource.write(f"SIM:OUTP:SPE OFF,1,{self.slot},{self.slot}")
159
160    def is_enabled(self) -> bool:
161        """Check output status."""
162        return bool(self._resource.query(f"SIM:MEAS:CELL:OPER? 1,{self.slot},{self.slot}"))
163
164    def reset(self):
165        """Resets the instrument"""
166        self._resource.write("*CLS")  # Clear the Error Queue and other status registers
167
168        logger.write_debug_to_report(f"Identification String: {self._resource.query('*IDN?')}")
169        logger.write_debug_to_report(f"Status: {self._resource.query('SYST:FRAME:STAT? 0')}")
170        logger.write_debug_to_report(f"Master Frame info: {self._resource.query('SYST:FRAME? 1')}")
171        logger.write_debug_to_report(f"Channels Status: {self._resource.query('SYST:FRAME:CHAN:STAT? 0')}")
172        logger.write_debug_to_report(f"Unit Channel: {self._resource.query('SYST:FRAME:CHAN:NUMB? 0')}")
173        logger.write_debug_to_report(f"Errors?: {self._resource.query('SYST:ERROR?')}")
174
175        self._resource.write("SYST:FRAME:PROT:CLE")  # Clears the protection status of all devices
176        self._resource.write("SIM:CONF:CLE")  # Clears UUT settings and resets them the default settings
177        self._resource.write("SIM:CONF:BMS:NUMB 1")  # 1 BMS
178        self._resource.write("SIM:CONF:SAMP:TIME 10")  # 10ms sample time
179        self._resource.write("SIM:CONF:CELL:NUMB 1,16")  # 16 cells
180        self._resource.write("SIM:CONF:CELL:PARA 1,1,8,2,4")  # current range (2 = 5A, 4 = 10A)
181
182        time.sleep(6)  # Needs delay after reset
183
184    def output_status(self) -> CellOutputStatus | None:
185        """Read cell output status."""
186        with suppress(ValueError):
187            return CellOutputStatus(int(self._resource.query(f"SIM:MEAS:CELL:OPER? 1,{self.slot},{self.slot}")))
188        return None
189
190    def testing_status(self) -> CellTestingStatus | None:
191        """Read cell testing status."""
192        with suppress(ValueError):
193            return CellTestingStatus(int(self._resource.query(f"SIM:MEAS:CELL:STAT? 1,{self.slot},{self.slot}")))
194        return None
195
196    def write(self, command: str):
197        """Issue an SCPI write command."""
198        self._resource.write(command)
199
200    def query(self, command: str) -> str:
201        """Issue an SCPI query command."""
202        return str(self._resource.query(command))