Peak.Can.Basic Namespace

The namespace Peak.Can.Basic contains different data types that grant access to the PCAN-Basic library to do CAN communication using plug and play devices from PEAK-System.

Classes

Api PCAN-Basic API class implementation.
BitrateFD Defines the different configuration parameters used to create a Flexible Data rate string for FD capable PCAN Channels initialization.
BitrateXL Defines the different configuration parameters used to create an Extended Data-Field Length bit rate string for XL capable PCAN Channels initialization.
Broadcast Represents a CAN message that is written periodically.
DataBytes Represents an object that manages the Data field for any CAN CC, CAN FD or CAN XL message.
MessageAvailableEventArgs Represents the arguments for a MessageAvailable event.
ParameterValue Represents the allowed values for PCAN-Basic parameters configuration.
ParameterValueActivation Represents values applicable to parameters, that can be activated or deactivated.
ParameterValueFilter Represents values applicable to filter parameters.
ParameterValueLog Represents values applicable to parameters related to data logging.
ParameterValueLookUp Represents values applicable to parameters related to the LookUpChannel method.
ParameterValueTrace Represents values applicable to parameters related to CAN data tracing.
PcanBasicException Represents an exception thrown when a call to a Api functions fails in an unexpected manner.
PcanChannelInformation Represents information about a PCAN Channel.
PcanMessage Represents a PCAN message from a CAN, CAN FD or CAN XL capable hardware.
SequentialBroadcast Represents a CAN message that is written periodically. Allows the incrementation of a sequence counter within the message data.

Remarks

The sequence counter is treated as a rolling counter. If the maximum sequence length is reached, the counter resets to 0.

Worker

PCAN Worker class implementation.

Worker makes use of the Api class to allows reading and writing from and to a PCAN Channel in an automatic way, using timers and events. It allows a more accurate filtering system that the native one, and the use of multiple receive queues with separate filter configuration.

If direct access to the PCAN-Basic interface is desired, use the Api class instead.

Structures

BitrateFDBitrateSegment Represents single bit rate parameters.
BitrateXLBitrateSegment Represents single bit rate parameters.
FilteringCriterion Represents a criterion for filtering CAN messages.

Enumerations

Bitrate Represents a PCAN bit rate register value.
BitrateFDBitrateType The bit rate representation.
BitrateFDClockFrequency Represents the supported bit rate clock frequencies.
BitrateXLBitrateType The bit rate representation.
BitrateXLClockFrequency Represents the supported bit rate clock frequencies.
ChannelCondition Represents the connectivity condition of a PCAN Channel.
FilterBehavior The operation that take place when a filtering criterion has a match.
FilterData The kind of information used for filtering messages.
FilteringState State of verification of a message filter.
FilterMode Represents a PCAN filter mode.
LanDirection Represents the direction of the communication being currently carried out by a PCAN-LAN device.
MessageType Represents the type of a CAN message.
MessageTypeXL Represents the type of a CAN XL message.
OutputLanguage Represents the available translation languages for error codes.
PcanChannel Represents the different PCAN buses (PCAN Channels) available to use within the API when a PCAN Handle is required.
PcanDevice Represents the type of interface and driver a device uses.
PcanDeviceFeatures Represents the features implemented by a PCAN device.
PcanParameter Represents a PCAN parameter or a PCAN Value that can be read or set.
PcanStatus Represents a PCAN status/error code.
Protocol Represents the transport protocol used for Data transmission.
ServiceStatus Represents the status of the Virtual PCAN-Gateway service.