def getPCMSolenoidBlackList(self):
"""
Reads complete solenoid blacklist for all 8 solenoids as a single byte.
If a solenoid is shorted, it is added to the blacklist and
disabled until power cycle, or until faults are cleared. See
:meth:`clearAllPCMStickyFaults`
:returns: The solenoid blacklist of all 8 solenoids on the module.
"""
return hal.getPCMSolenoidBlackList(self.ports[0])
def getPCMSolenoidBlackList(self):
"""
Reads complete solenoid blacklist for all 8 solenoids as a single byte.
If a solenoid is shorted, it is added to the blacklist and
disabled until power cycle, or until faults are cleared. See
:meth:`clearAllPCMStickyFaults`
:returns: The solenoid blacklist of all 8 solenoids on the module.
"""
return hal.getPCMSolenoidBlackList(self.moduleNumber)
def getPCMSolenoidBlackList(moduleNumber):
"""
Reads complete solenoid blacklist for all 8 solenoids as a single byte.
If a solenoid is shorted, it is added to the blacklist and
disabled until power cycle, or until faults are cleared. See
:meth:`clearAllPCMStickyFaults`
:param moduleNumber: in a static context, the module number to read. otherwise don't provide it.
:returns: The solenoid blacklist of all 8 solenoids on the module.
"""
if isinstance(moduleNumber, SolenoidBase):
moduleNumber = moduleNumber.moduleNumber
return hal.getPCMSolenoidBlackList(moduleNumber)
def getPCMSolenoidBlackList(moduleNumber: Union[int, "SolenoidBase"]) -> int:
"""
Reads complete solenoid blacklist for all 8 solenoids as a single byte.
If a solenoid is shorted, it is added to the blacklist and
disabled until power cycle, or until faults are cleared. See
:meth:`clearAllPCMStickyFaults`
:param moduleNumber: in a static context, the module number to read. otherwise don't provide it.
:returns: The solenoid blacklist of all 8 solenoids on the module.
"""
if isinstance(moduleNumber, SolenoidBase):
moduleNumber = moduleNumber.moduleNumber
return hal.getPCMSolenoidBlackList(moduleNumber)