Miscellaneous

bitrateSetting

class canlib.canlib.bitrateSetting(freq=1000000, tseg1=4, tseg2=3, sjw=1, nosamp=1, syncMode=0)[source]

Class that holds bitrate setting.

Variables:
  • freq – Bitrate in bit/s.
  • tseg1 – Number of quanta from (but not including) the Sync Segment to the sampling point.
  • tseg2 – Number of quanta from the sampling point to the end of the bit.
  • sjw – The Synchronization Jump Width, can be 1,2,3, or 4.
  • nosamp – The number of sampling points, only 1 is supported.
  • syncMode – Unsupported and ignored.

dllversion()

canlib.canlib.dllversion()[source]

Get the CANlib DLL version number

Parameters:None

Returns a BetaVersionNumber if the CANlib DLL is marked as beta (preview), otherwise returns VersionNumber.

Changed in version 1.6.

getErrorText()

canlib.canlib.getErrorText(error_code)[source]

Return error text for supplied error_code

getNumberOfChannels()

canlib.canlib.getNumberOfChannels(driver=False)[source]

Get number of available CAN channels.

Returns the number of available CAN channels in the computer. The virtual channels are included in this number.

Parameters:None
Returns:chanCount (int) – Number of available CAN channels

getVersion()

canlib.canlib.getVersion()[source]

Get the CANlib DLL version number as a str

Deprecated since version 1.5: Use dllversion instead.

prodversion()

canlib.canlib.prodversion()[source]

Get the CANlib Product version number

Parameters:None

Returns a BetaVersionNumber if the CANlib driver/DLL is marked as beta (preview), otherwise returns VersionNumber.

New in version 1.6.

reinitializeLibrary()

canlib.canlib.reinitializeLibrary()[source]

Reinitializes the CANlib driver.

Convenience function that calls unloadLibrary and initializeLibrary in succession.

ScriptText

class canlib.canlib.ScriptText[source]

Text returned by Channel.scriptGetText

Subclass of built-in str, so it can be used just like a normal string.

It also has the following attributes:

Variables:
  • slot (int) – Which script-slot the text came from.
  • time (int) – Timestamp of when the text was printed.
  • ScriptText.flags (canlib.canlib.Stat) – Any flags associated with the text.

New in version 1.7.

translateBaud()

canlib.canlib.translateBaud(freq)[source]

Translate bitrate constant

This function translates the canBITRATE_xxx constants to their corresponding bus parameter values.

Parameters:freq – Any of the predefined constants canBITRATE_xxx
Returns:
A bitrateSetting object containing the actual values of
frequency, tseg1, tseg2 etc.

unloadLibrary()

canlib.canlib.unloadLibrary()[source]

Unload CANlib

Unload canlib and release all internal handles.

Warning

Calling unloadLibrary invalidates every canlib-object. Use at your own risk.