BusSpeedNominal

This parameter is used to retrieve information about the currently used nominal CAN Bus speed, in bits per second. It can be used to display a friendly bit rate value in an application that can be easily and quickly understood by any user.

Availability

It is available since PCAN-Basic version 4.0.0.

Supported By

PCAN-USB: Channels Usb01 to Usb16.
PCAN-PCI: Channels Pci01 to Pci16
PCAN-LAN: Channels Lan01 to Lan16.

Access Mode

This parameter can only be read. It cannot be modified.

Possible Values

This value has a resolution of Double-Word (range [0... MaxValue]).

Default Value

Does not apply.

Initialization Status

Get: The PCAN Channel must be initialized before using this parameter.

Example

The following code shows how to retrieve the friendly nominal bit rate value from an USB Channel:

C#

uint bitrate;
PcanChannel channelUsed = PcanChannel.Usb01;

if (Api.Initialize(channelUsed, (BitrateFD)BitrateFD.BitrateSaeJ2284_4) == PcanStatus.OK)
{
    if (Api.GetValue(channelUsed, PcanParameter.BusSpeedNominal, out bitrate) == PcanStatus.OK)
        Console.WriteLine($"Nominal bit rate of channel {channelUsed} is {bitrate / 1000.0} kBit/s");
    else
        Console.WriteLine($"Error retrieving Bus Speed on channel {channelUsed}");
    Api.Uninitialize(channelUsed);
}

VB

Dim bitrate As UInteger
Dim channelUsed As PcanChannel = PcanChannel.Usb01

If Api.Initialize(channelUsed, CType(BitrateFD.BitrateSaeJ2284_4, BitrateFD)) = PcanStatus.OK Then
    If Api.GetValue(channelUsed, PcanParameter.BusSpeedNominal, bitrate) = PcanStatus.OK Then
        Console.WriteLine($"Nominal bit rate of channel {channelUsed} is {bitrate / 1000.0} kBit/s")
    Else
        Console.WriteLine($"Error retrieving Bus Speed on channel {channelUsed}")
    End If
    Api.Uninitialize(channelUsed)
End If

C++

UInt32 bitrate;
PcanChannel channelUsed = PcanChannel::Usb01;

if (Api::Initialize(channelUsed, (BitrateFD^)BitrateFD::BitrateSaeJ2284_4) == PcanStatus::OK)
{
    if (Api::GetValue(channelUsed, PcanParameter::BusSpeedNominal, bitrate) == PcanStatus::OK)
        Console::WriteLine("Nominal bit rate of channel {0} is {1} kBit/s", channelUsed, bitrate / 1000.0);
    else
        Console::WriteLine("Error retrieving Bus Speed on channel {0}", channelUsed);
    Api::Uninitialize(channelUsed);
}