org.lsst.ccs.subsystems.fcs.drivers

Class CanCBXAI814

java.lang.Object

org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

org.lsst.ccs.subsystems.fcs.drivers.CanCBXAI814

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, ADCInterface, AlertRaiser, PieceOfHardware, EmergencyMessageListener

Direct Known Subclasses:

SimuCanOpenADC

public class CanCBXAI814
extends CanOpenDevice
implements ADCInterface

This is the driver class for the ADC we use in the FCS test bench at APC and in SINGLE FILTER TEST CAN-CBX-AI814.

Author:

virieux

Field Summary

Fields

Modifier and Type	Field and Description
static double	adcVoltsPerBit One bit read on the input of the ADC represents 0.3125 mV
protected int	cobid1
protected int	cobid2
int[]	inputs
protected int	transmissionType The transmission types for CAN-CBX-AI814 are described in doc CAN-CBX-AI814_Manual.pdf § 8.6.2 - acyclic, synchronous: The transmission is initiated if a SYNC-message has been received (PDO- transmission type 0) and data has changed.
static double	waterFreezeTemp

Fields inherited from class org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

booted, dataProviderDictionaryService, errorHistory, errorRegister, inError, initialized, lastErrorCode, lastErrorName, name, nodeID, serialNB, subs, tcpProxy

Fields inherited from interface org.lsst.ccs.subsystems.fcs.common.AlertRaiser

alertSeparator

Constructor Summary

Constructors

Constructor and Description
CanCBXAI814(int nodeID, String serialNB, int transmissionType) Build a CanOpenADC with a CANopen node ID, a serial number and a transmission type.

Method Summary

Modifier and Type	Method and Description
void	doInitializePDOs() Do nothing if this device doesn't send PDOs except log for debug purpose.
long	getInput(int i) return input value read on ADC at channel 1
int[]	getInputs()
void	initializeAndCheckHardware() This methods has to be overridden if there is some initialization to do for the device.
void	postStart() lifecycle commands
String	printInputs()
int	readAnalogInput(int inputNB) Read the analog input whom number is given as a parameter
double	readVoltage(int inputNB) Read the voltage at the ADC input inputNB on the ADC and returns the value in Volt
String	toString()
void	updateFromPDO(org.lsst.ccs.drivers.canopenjni.PDOData pdo) process PDOData to extract the values this device has sent.

Methods inherited from class org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

build, configAsHeartbeatConsumer, configAsHeartbeatProducer, createStatusDataPublishedByCanOpenDevice, displayError, displayErrorHistory, displayErrorRegister, getAlertService, getErrorHistory, getErrorHistoryNB, getErrorRegister, getLastErrorCode, getLastErrorName, getName, getNodeID, getSerialNB, getSubsystem, getTcpProxy, isBooted, isInError, isInitialized, onEmergencyMessage, printSerialNumber, publishData, readErrorRegister, readNumberOfErrors, readSDO, resetError, saveParameters, setBooted, updateDeviceInfo, updateErrorHistory, writeSDO, writeTransmissionTypeToDevice

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.PieceOfHardware

checkBooted, checkId, checkInitialized, createStatusDataPublishedByHardware, getName, getNodeID, getSerialNB, initializePDOs, isBooted, isInitialized, printState, publishData, raiseAlarmIfMissing, raiseWarningIfMissing, setBooted, updateDeviceInfo

Methods inherited from interface org.lsst.ccs.subsystems.fcs.drivers.EmergencyMessageListener

onEmergencyMessage, onFault, onFaultReset

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.AlertRaiser

clearAlarm, getAlertSeparator, getAlertService, getSubsystem, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarmOnlyIfNew, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyIfNew, raiseWarning, raiseWarning, raiseWarningOnlyEveryTenMinutes, raiseWarningOnlyIfNew

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

init, postBuild, postInit, postShutdown, shutdown, start

Field Detail

adcVoltsPerBit

public static final double adcVoltsPerBit

One bit read on the input of the ADC represents 0.3125 mV

See Also:

Constant Field Values

waterFreezeTemp

public static final double waterFreezeTemp

See Also:

Constant Field Values

transmissionType

@ConfigurationParameter(description="UNDEFINED",
                        units="unitless")
protected volatile int transmissionType

The transmission types for CAN-CBX-AI814 are described in doc CAN-CBX-AI814_Manual.pdf § 8.6.2 - acyclic, synchronous: The transmission is initiated if a SYNC-message has been received (PDO- transmission type 0) and data has changed. - cyclic, synchronous: The transmission is initiated if a defined number of SYNC-messages have been received (PDO-transmission type 1...240). - synchronous, remote request: The state of the inputs is latched with each SYNC-message and is transmitted after the reception of a RTR-frame (PDO-transmission type 252). - asynchronous, remote request: After the reception of a RTR-frame the last latched state of the inputs is transmitted (PDO-transmission type 253). - event controlled, asynchronous: The transmission is initiated if the state of selected inputs has changed (PDO-transmission type 254, 255).

inputs

public int[] inputs

cobid1

protected int cobid1

cobid2

protected int cobid2

Constructor Detail

CanCBXAI814

public CanCBXAI814(int nodeID,
                   String serialNB,
                   int transmissionType)

Build a CanOpenADC with a CANopen node ID, a serial number and a transmission type.

Parameters:

nodeID -

serialNB -

transmissionType -

Method Detail

getInput

public long getInput(int i)

Description copied from interface: ADCInterface

return input value read on ADC at channel 1

Specified by:

getInput in interface ADCInterface

Returns:

getInputs

public int[] getInputs()

Returns:

doInitializePDOs

public void doInitializePDOs()
                      throws org.lsst.ccs.drivers.commons.DriverException

Description copied from class: CanOpenDevice

Do nothing if this device doesn't send PDOs except log for debug purpose. To be overriden if this device sends PDOS.

Specified by:

doInitializePDOs in interface PieceOfHardware

Overrides:

doInitializePDOs in class CanOpenDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

initializeAndCheckHardware

public void initializeAndCheckHardware()

Description copied from class: CanOpenDevice

This methods has to be overridden if there is some initialization to do for the device.

Specified by:

initializeAndCheckHardware in interface PieceOfHardware

Overrides:

initializeAndCheckHardware in class CanOpenDevice

readAnalogInput

public int readAnalogInput(int inputNB)

Read the analog input whom number is given as a parameter

Specified by:

readAnalogInput in interface ADCInterface

Parameters:

inputNB -

Returns:

the value read

Throws:

SDORequestException

HardwareNotDetectedException

readVoltage

public double readVoltage(int inputNB)

Read the voltage at the ADC input inputNB on the ADC and returns the value in Volt

Specified by:

readVoltage in interface ADCInterface

Parameters:

inputNB - : integer from 1 to 8

Returns:

the value read (on 16bits)

Throws:

SDORequestException

HardwareNotDetectedException

updateFromPDO

public void updateFromPDO(org.lsst.ccs.drivers.canopenjni.PDOData pdo)

process PDOData to extract the values this device has sent.

Specified by:

updateFromPDO in interface PieceOfHardware

Overrides:

updateFromPDO in class CanOpenDevice

Parameters:

pdo -

printInputs

@Command(type=QUERY,
         level=1,
         description="print input values. For test and debug.")
public String printInputs()

toString

@Command(type=QUERY,
         level=1,
         description="Return the string representation of CanCBXAI814.",
         alias="print_cobid")
public String toString()

Overrides:

toString in class CanOpenDevice

postStart

public void postStart()

lifecycle commands

Specified by:

postStart in interface org.lsst.ccs.framework.HasLifecycle