Package peak.can.basic
Enum TPCANParameter
- All Implemented Interfaces:
Serializable
,Comparable<TPCANParameter>
,java.lang.constant.Constable
Parameter definition.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionPCAN-PC Card 5-Volt power parameterFilter over code and mask patterns for 11-Bit messagesFilter over code and mask patterns for 29-Bit messagesEcho messages reception status within a PCAN-ChannelError messages reception status within a PCAN-ChannelRTR messages reception status within a PCAN-ChannelStatus messages reception status within a PCAN-ChannelPCAN-Basic API version parameterGet information about PCAN channels attached to a systemGet the amount of PCAN channels attached to a systemUsing of an existing bit rate (PCAN-View connected to a channel)Configured Bit rate as Btr0Btr1 valueConfigured Bit rate as TPCANBitrateFD stringPCAN Reset-On-Busoff parameterConfigured CAN data speed as Bits per secondsConfigured nominal CAN Bus speed as Bits per secondsAvailability status of a PCAN-ChannelCapabilities of a PCAN device (FEATURE_***)Physical identification of a USB based PCAN-Channel by blinking its associated LEDPCAN device channel version parameterCAN-Controller number of a PCAN-ChannelGet the global unique device identifier (GUID) associated to a devicePCAN-USB device number parameterDeprecated.Deprecated parameter.Get the part number associated to a deviceGet the version of the firmware used by the device associated with a PCAN-ChannelActivation status of hard reset processing via CAN_Reset callsPCAN hardware name parameterDelay, in microseconds, between sending framesGet value of a single analog input pinClear multiple digital I/O pins to 0Output mode of 32 digital I/O pin of a PCAN-USB Chip. 1: Output-Active 0 : Output InactiveValue assigned to a 32 digital I/O pins of a PCAN-USB Chip - Multiple digital I/O pins to 1 = HighValue assigned to a 32 digital I/O pins of a PCAN-USB ChipRemote address of a LAN channel as string in IPv4 formatCommunication direction of a PCAN-Channel representing a PCAN-LAN interfaceStatus of the Virtual PCAN-Gateway ServicePCAN Listen-Only parameterConfiguration of the debugged information (LOG_FUNCTION_***)Directory path for trace filesDebug-Trace activation statusCustom insertion of text into the log filePCAN message filter parameterPCAN receive event handler parameterMessage reception status of a PCAN-ChannelConfiguration of the trace file storing mode (TRACE_FILE_***)Directory path for PCAN trace filesConfiguration of the maximum file size of a CAN traceCAN tracing activation status -
Method Summary
Modifier and TypeMethodDescriptionstatic TPCANParameter[]
Returns the list of PCAN Parameters which are customizable as arraystatic String
Returns a description for the given TPCANParameterint
getValue()
The identifier of the CAN parameterstatic TPCANParameter
Returns the enum constant of this type with the specified name.static TPCANParameter[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
PCAN_DEVICE_NUMBER
Deprecated.Deprecated parameter. Use PCAN_DEVICE_ID insteadPCAN-USB device number parameter -
PCAN_DEVICE_ID
PCAN-USB device number parameter -
PCAN_5VOLTS_POWER
PCAN-PC Card 5-Volt power parameter -
PCAN_RECEIVE_EVENT
PCAN receive event handler parameter -
PCAN_MESSAGE_FILTER
PCAN message filter parameter -
PCAN_API_VERSION
PCAN-Basic API version parameter -
PCAN_CHANNEL_VERSION
PCAN device channel version parameter -
PCAN_BUSOFF_AUTORESET
PCAN Reset-On-Busoff parameter -
PCAN_LISTEN_ONLY
PCAN Listen-Only parameter -
PCAN_LOG_LOCATION
Directory path for trace files -
PCAN_LOG_STATUS
Debug-Trace activation status -
PCAN_LOG_CONFIGURE
Configuration of the debugged information (LOG_FUNCTION_***) -
PCAN_LOG_TEXT
Custom insertion of text into the log file -
PCAN_CHANNEL_CONDITION
Availability status of a PCAN-Channel -
PCAN_HARDWARE_NAME
PCAN hardware name parameter -
PCAN_RECEIVE_STATUS
Message reception status of a PCAN-Channel -
PCAN_CONTROLLER_NUMBER
CAN-Controller number of a PCAN-Channel -
PCAN_TRACE_LOCATION
Directory path for PCAN trace files -
PCAN_TRACE_STATUS
CAN tracing activation status -
PCAN_TRACE_SIZE
Configuration of the maximum file size of a CAN trace -
PCAN_TRACE_CONFIGURE
Configuration of the trace file storing mode (TRACE_FILE_***) -
PCAN_CHANNEL_IDENTIFYING
Physical identification of a USB based PCAN-Channel by blinking its associated LED -
PCAN_CHANNEL_FEATURES
Capabilities of a PCAN device (FEATURE_***) -
PCAN_BITRATE_ADAPTING
Using of an existing bit rate (PCAN-View connected to a channel) -
PCAN_BITRATE_INFO
Configured Bit rate as Btr0Btr1 value -
PCAN_BITRATE_INFO_FD
Configured Bit rate as TPCANBitrateFD string -
PCAN_BUSSPEED_NOMINAL
Configured nominal CAN Bus speed as Bits per seconds -
PCAN_BUSSPEED_DATA
Configured CAN data speed as Bits per seconds -
PCAN_IP_ADDRESS
Remote address of a LAN channel as string in IPv4 format -
PCAN_LAN_SERVICE_STATUS
Status of the Virtual PCAN-Gateway Service -
PCAN_ALLOW_STATUS_FRAMES
Status messages reception status within a PCAN-Channel -
PCAN_ALLOW_RTR_FRAMES
RTR messages reception status within a PCAN-Channel -
PCAN_ALLOW_ERROR_FRAMES
Error messages reception status within a PCAN-Channel -
PCAN_INTERFRAME_DELAY
Delay, in microseconds, between sending frames -
PCAN_ACCEPTANCE_FILTER_11BIT
Filter over code and mask patterns for 11-Bit messages -
PCAN_ACCEPTANCE_FILTER_29BIT
Filter over code and mask patterns for 29-Bit messages -
PCAN_IO_DIGITAL_CONFIGURATION
Output mode of 32 digital I/O pin of a PCAN-USB Chip. 1: Output-Active 0 : Output Inactive -
PCAN_IO_DIGITAL_VALUE
Value assigned to a 32 digital I/O pins of a PCAN-USB Chip -
PCAN_IO_DIGITAL_SET
Value assigned to a 32 digital I/O pins of a PCAN-USB Chip - Multiple digital I/O pins to 1 = High -
PCAN_IO_DIGITAL_CLEAR
Clear multiple digital I/O pins to 0 -
PCAN_IO_ANALOG_VALUE
Get value of a single analog input pin -
PCAN_FIRMWARE_VERSION
Get the version of the firmware used by the device associated with a PCAN-Channel -
PCAN_ATTACHED_CHANNELS_COUNT
Get the amount of PCAN channels attached to a system -
PCAN_ATTACHED_CHANNELS
Get information about PCAN channels attached to a system -
PCAN_ALLOW_ECHO_FRAMES
Echo messages reception status within a PCAN-Channel -
PCAN_DEVICE_PART_NUMBER
Get the part number associated to a device -
PCAN_HARD_RESET_STATUS
Activation status of hard reset processing via CAN_Reset calls -
PCAN_LAN_CHANNEL_DIRECTION
Communication direction of a PCAN-Channel representing a PCAN-LAN interface -
PCAN_DEVICE_GUID
Get the global unique device identifier (GUID) associated to a device
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getValue
public int getValue()The identifier of the CAN parameter- Returns:
- Identifier of the CAN parameter
-
customizableParameters
Returns the list of PCAN Parameters which are customizable as array- Returns:
- the list of PCAN Parameters which are customizable as array
-
getParameterDescription
Returns a description for the given TPCANParameter- Parameters:
param
- TPCANParameter for which we need description- Returns:
- a string description for the given TPCANParameter
-