Ruby - CAN Bricklet 2.0¶

Loopback¶

Download (example_loopback.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_can_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your CAN Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
can = BrickletCANV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Configure transceiver for loopback mode
can.set_transceiver_configuration 1000000, 625, BrickletCANV2::TRANSCEIVER_MODE_LOOPBACK

# Register frame read callback
can.register_callback(BrickletCANV2::CALLBACK_FRAME_READ) do |frame_type, identifier,
                                                              data|
  if frame_type == BrickletCANV2::FRAME_TYPE_STANDARD_DATA
    puts "Frame Type: Standard Data"
  elsif frame_type == BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE
    puts "Frame Type: Standard Remote"
  elsif frame_type == BrickletCANV2::FRAME_TYPE_EXTENDED_DATA
    puts "Frame Type: Extended Data"
  elsif frame_type == BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE
    puts "Frame Type: Extended Remote"
  end

  puts "Identifier: #{identifier}"
  puts "Data (Length: #{data.length}): #{data[0, [data.length, 8].min].join(' ')}"
  puts ''
end

# Enable frame read callback
can.set_frame_read_callback_configuration true

# Write standard data frame with identifier 1742 and 3 bytes of data
can.write_frame BrickletCANV2::FRAME_TYPE_STANDARD_DATA, 1742, [42, 23, 17]

puts 'Press key to exit'
$stdin.gets

can.set_frame_read_callback_configuration false

ipcon.disconnect

Basic Functions¶

BrickletCANV2::new(uid, ipcon) → can_v2¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	can_v2 – Type: BrickletCANV2

Creates an object with the unique device ID uid:

can_v2 = BrickletCANV2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletCANV2#write_frame(frame_type, identifier, data) → bool¶

Parameters:	frame_type – Type: int, Range: See constants identifier – Type: int, Range: [0 to 230 - 1] data – Type: [int, ...], Length: variable, Range: [0 to 255]
Returns:	success – Type: bool

Writes a data or remote frame to the write queue to be transmitted over the CAN transceiver.

The Bricklet supports the standard 11-bit (CAN 2.0A) and the additional extended 29-bit (CAN 2.0B) identifiers. For standard frames the Bricklet uses bit 0 to 10 from the identifier parameter as standard 11-bit identifier. For extended frames the Bricklet uses bit 0 to 28 from the identifier parameter as extended 29-bit identifier.

The data parameter can be up to 15 bytes long. For data frames up to 8 bytes will be used as the actual data. The length (DLC) field in the data or remote frame will be set to the actual length of the data parameter. This allows to transmit data and remote frames with excess length. For remote frames only the length of the data parameter is used. The actual data bytes are ignored.

Returns true if the frame was successfully added to the write queue. Returns false if the frame could not be added because write queue is already full or because the write buffer or the write backlog are configured with a size of zero (see #set_queue_configuration).

The write queue can overflow if frames are written to it at a higher rate than the Bricklet can transmitted them over the CAN transceiver. This may happen if the CAN transceiver is configured as read-only or is using a low baud rate (see #set_transceiver_configuration). It can also happen if the CAN bus is congested and the frame cannot be transmitted because it constantly loses arbitration or because the CAN transceiver is currently disabled due to a high write error level (see #get_error_log).

The following constants are available for this function:

For frame_type:

• BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
• BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
• BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
• BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3

BrickletCANV2#read_frame → [bool, int, int, [int, ...]]¶

Return Array:	0: success – Type: bool 1: frame_type – Type: int, Range: See constants 2: identifier – Type: int, Range: [0 to 230 - 1] 3: data – Type: [int, ...], Length: variable, Range: [0 to 255]

Tries to read the next data or remote frame from the read queue and returns it. If a frame was successfully read, then the success return value is set to true and the other return values contain the frame. If the read queue is empty and no frame could be read, then the success return value is set to false and the other return values contain invalid data.

The identifier return value follows the identifier format described for #write_frame.

The data return value can be up to 15 bytes long. For data frames up to the first 8 bytes are the actual received data. All bytes after the 8th byte are always zero and only there to indicate the length of a data or remote frame with excess length. For remote frames the length of the data return value represents the requested length. The actual data bytes are always zero.

A configurable read filter can be used to define which frames should be received by the CAN transceiver and put into the read queue (see #set_read_filter_configuration).

Instead of polling with this function, you can also use callbacks. See the #set_frame_read_callback_configuration function and the ::CALLBACK_FRAME_READ callback.

The following constants are available for this function:

For frame_type:

• BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
• BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
• BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
• BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3

BrickletCANV2#set_transceiver_configuration(baud_rate, sample_point, transceiver_mode) → nil¶

Parameters:	baud_rate – Type: int, Unit: 1 bit/s, Range: [10000 to 1000000], Default: 125000 sample_point – Type: int, Unit: 1/10 %, Range: [500 to 900], Default: 625 transceiver_mode – Type: int, Range: See constants, Default: 0

Sets the transceiver configuration for the CAN bus communication.

The CAN transceiver has three different modes:

• Normal: Reads from and writes to the CAN bus and performs active bus error detection and acknowledgement.
• Loopback: All reads and writes are performed internally. The transceiver is disconnected from the actual CAN bus.
• Read-Only: Only reads from the CAN bus, but does neither active bus error detection nor acknowledgement. Only the receiving part of the transceiver is connected to the CAN bus.

The following constants are available for this function:

For transceiver_mode:

• BrickletCANV2::TRANSCEIVER_MODE_NORMAL = 0
• BrickletCANV2::TRANSCEIVER_MODE_LOOPBACK = 1
• BrickletCANV2::TRANSCEIVER_MODE_READ_ONLY = 2

BrickletCANV2#get_transceiver_configuration → [int, int, int]¶

Return Array:	0: baud_rate – Type: int, Unit: 1 bit/s, Range: [10000 to 1000000], Default: 125000 1: sample_point – Type: int, Unit: 1/10 %, Range: [500 to 900], Default: 625 2: transceiver_mode – Type: int, Range: See constants, Default: 0

Returns the configuration as set by #set_transceiver_configuration.

The following constants are available for this function:

For transceiver_mode:

• BrickletCANV2::TRANSCEIVER_MODE_NORMAL = 0
• BrickletCANV2::TRANSCEIVER_MODE_LOOPBACK = 1
• BrickletCANV2::TRANSCEIVER_MODE_READ_ONLY = 2

Advanced Functions¶

BrickletCANV2#set_queue_configuration(write_buffer_size, write_buffer_timeout, write_backlog_size, read_buffer_sizes, read_backlog_size) → nil¶

Parameters:	write_buffer_size – Type: int, Range: [0 to 32], Default: 8 write_buffer_timeout – Type: int, Range: [-1 to 231 - 1], Default: 0 write_backlog_size – Type: int, Range: [0 to 768], Default: 383 read_buffer_sizes – Type: [int, ...], Length: variable, Range: [-32 to -1, 1 to 32], Default: [16, -8] read_backlog_size – Type: int, Range: [0 to 768], Default: 383

Sets the write and read queue configuration.

The CAN transceiver has 32 buffers in total in hardware for transmitting and receiving frames. Additionally, the Bricklet has a backlog for 768 frames in total in software. The buffers and the backlog can be freely assigned to the write and read queues.

#write_frame writes a frame into the write backlog. The Bricklet moves the frame from the backlog into a free write buffer. The CAN transceiver then transmits the frame from the write buffer to the CAN bus. If there are no write buffers (write_buffer_size is zero) or there is no write backlog (write_backlog_size is zero) then no frames can be transmitted and #write_frame returns always false.

The CAN transceiver receives a frame from the CAN bus and stores it into a free read buffer. The Bricklet moves the frame from the read buffer into the read backlog. #read_frame reads the frame from the read backlog and returns it. If there are no read buffers (read_buffer_sizes is empty) or there is no read backlog (read_backlog_size is zero) then no frames can be received and #read_frame returns always false.

There can be multiple read buffers, because the CAN transceiver cannot receive data and remote frames into the same read buffer. A positive read buffer size represents a data frame read buffer and a negative read buffer size represents a remote frame read buffer. A read buffer size of zero is not allowed. By default the first read buffer is configured for data frames and the second read buffer is configured for remote frame. There can be up to 32 different read buffers, assuming that no write buffer is used. Each read buffer has its own filter configuration (see #set_read_filter_configuration).

A valid queue configuration fulfills these conditions:

write_buffer_size + abs(read_buffer_size_0) + abs(read_buffer_size_1) + ... + abs(read_buffer_size_31) <= 32
write_backlog_size + read_backlog_size <= 768

The write buffer timeout has three different modes that define how a failed frame transmission should be handled:

• Single-Shot (< 0): Only one transmission attempt will be made. If the transmission fails then the frame is discarded.
• Infinite (= 0): Infinite transmission attempts will be made. The frame will never be discarded.
• Milliseconds (> 0): A limited number of transmission attempts will be made. If the frame could not be transmitted successfully after the configured number of milliseconds then the frame is discarded.

The current content of the queues is lost when this function is called.

BrickletCANV2#get_queue_configuration → [int, int, int, [int, ...], int]¶

Return Array:	0: write_buffer_size – Type: int, Range: [0 to 32], Default: 8 1: write_buffer_timeout – Type: int, Range: [-1 to 231 - 1], Default: 0 2: write_backlog_size – Type: int, Range: [0 to 768], Default: 383 3: read_buffer_sizes – Type: [int, ...], Length: variable, Range: [-32 to -1, 1 to 32], Default: [16, -8] 4: read_backlog_size – Type: int, Range: [0 to 768], Default: 383

Returns the queue configuration as set by #set_queue_configuration.

BrickletCANV2#set_read_filter_configuration(buffer_index, filter_mode, filter_mask, filter_identifier) → nil¶

Parameters:	buffer_index – Type: int, Range: [0 to 31] filter_mode – Type: int, Range: See constants, Default: 0 filter_mask – Type: int, Range: [0 to 230 - 1] filter_identifier – Type: int, Range: [0 to 230 - 1]

Set the read filter configuration for the given read buffer index. This can be used to define which frames should be received by the CAN transceiver and put into the read buffer.

The read filter has four different modes that define if and how the filter mask and the filter identifier are applied:

• Accept-All: All frames are received.
• Match-Standard-Only: Only standard frames with a matching identifier are received.
• Match-Extended-Only: Only extended frames with a matching identifier are received.
• Match-Standard-And-Extended: Standard and extended frames with a matching identifier are received.

The filter mask and filter identifier are used as bit masks. Their usage depends on the mode:

• Accept-All: Mask and identifier are ignored.
• Match-Standard-Only: Bit 0 to 10 (11 bits) of filter mask and filter identifier are used to match the 11-bit identifier of standard frames.
• Match-Extended-Only: Bit 0 to 28 (29 bits) of filter mask and filter identifier are used to match the 29-bit identifier of extended frames.
• Match-Standard-And-Extended: Bit 18 to 28 (11 bits) of filter mask and filter identifier are used to match the 11-bit identifier of standard frames, bit 0 to 17 (18 bits) are ignored in this case. Bit 0 to 28 (29 bits) of filter mask and filter identifier are used to match the 29-bit identifier of extended frames.

The filter mask and filter identifier are applied in this way: The filter mask is used to select the frame identifier bits that should be compared to the corresponding filter identifier bits. All unselected bits are automatically accepted. All selected bits have to match the filter identifier to be accepted. If all bits for the selected mode are accepted then the frame is accepted and is added to the read buffer.

Filter Mask Bit	Filter Identifier Bit	Frame Identifier Bit	Result
0	X	X	Accept
1	0	0	Accept
1	0	1	Reject
1	1	0	Reject
1	1	1	Accept

For example, to receive standard frames with identifier 0x123 only, the mode can be set to Match-Standard-Only with 0x7FF as mask and 0x123 as identifier. The mask of 0x7FF selects all 11 identifier bits for matching so that the identifier has to be exactly 0x123 to be accepted.

To accept identifier 0x123 and identifier 0x456 at the same time, just set filter 2 to 0x456 and keep mask and filter 1 unchanged.

There can be up to 32 different read filters configured at the same time, because there can be up to 32 read buffer (see #set_queue_configuration).

The default mode is accept-all for all read buffers.

The following constants are available for this function:

For filter_mode:

• BrickletCANV2::FILTER_MODE_ACCEPT_ALL = 0
• BrickletCANV2::FILTER_MODE_MATCH_STANDARD_ONLY = 1
• BrickletCANV2::FILTER_MODE_MATCH_EXTENDED_ONLY = 2
• BrickletCANV2::FILTER_MODE_MATCH_STANDARD_AND_EXTENDED = 3

BrickletCANV2#get_read_filter_configuration(buffer_index) → [int, int, int]¶

Parameters:	buffer_index – Type: int, Range: [0 to 31]
Return Array:	0: filter_mode – Type: int, Range: See constants, Default: 0 1: filter_mask – Type: int, Range: [0 to 230 - 1] 2: filter_identifier – Type: int, Range: [0 to 230 - 1]

Returns the read filter configuration as set by #set_read_filter_configuration.

The following constants are available for this function:

For filter_mode:

• BrickletCANV2::FILTER_MODE_ACCEPT_ALL = 0
• BrickletCANV2::FILTER_MODE_MATCH_STANDARD_ONLY = 1
• BrickletCANV2::FILTER_MODE_MATCH_EXTENDED_ONLY = 2
• BrickletCANV2::FILTER_MODE_MATCH_STANDARD_AND_EXTENDED = 3

BrickletCANV2#get_error_log → [int, int, int, int, int, int, int, int, int, int, int, [bool, ...], int]¶

Return Array:

0: transceiver_state – Type: int, Range: See constants 1: transceiver_write_error_level – Type: int, Range: [0 to 255] 2: transceiver_read_error_level – Type: int, Range: [0 to 255] 3: transceiver_stuffing_error_count – Type: int, Range: [0 to 232 - 1] 4: transceiver_format_error_count – Type: int, Range: [0 to 232 - 1] 5: transceiver_ack_error_count – Type: int, Range: [0 to 232 - 1] 6: transceiver_bit1_error_count – Type: int, Range: [0 to 232 - 1] 7: transceiver_bit0_error_count – Type: int, Range: [0 to 232 - 1] 8: transceiver_crc_error_count – Type: int, Range: [0 to 232 - 1] 9: write_buffer_timeout_error_count – Type: int, Range: [0 to 232 - 1] 10: read_buffer_overflow_error_count – Type: int, Range: [0 to 232 - 1] 11: read_buffer_overflow_error_occurred – Type: [bool, ...], Length: variable 12: read_backlog_overflow_error_count – Type: int, Range: [0 to 232 - 1]

Returns information about different kinds of errors.

The write and read error levels indicate the current level of stuffing, form, acknowledgement, bit and checksum errors during CAN bus write and read operations. For each of this error kinds there is also an individual counter.

When the write error level extends 255 then the CAN transceiver gets disabled and no frames can be transmitted or received anymore. The CAN transceiver will automatically be activated again after the CAN bus is idle for a while.

The write buffer timeout, read buffer and backlog overflow counts represents the number of these errors:

• A write buffer timeout occurs if a frame could not be transmitted before the configured write buffer timeout expired (see #set_queue_configuration).
• A read buffer overflow occurs if a read buffer of the CAN transceiver still contains the last received frame when the next frame arrives. In this case the last received frame is lost. This happens if the CAN transceiver receives more frames than the Bricklet can handle. Using the read filter (see #set_read_filter_configuration) can help to reduce the amount of received frames. This count is not exact, but a lower bound, because the Bricklet might not able detect all overflows if they occur in rapid succession.
• A read backlog overflow occurs if the read backlog of the Bricklet is already full when the next frame should be read from a read buffer of the CAN transceiver. In this case the frame in the read buffer is lost. This happens if the CAN transceiver receives more frames to be added to the read backlog than are removed from the read backlog using the #read_frame function. Using the ::CALLBACK_FRAME_READ callback ensures that the read backlog can not overflow.

The read buffer overflow counter counts the overflows of all configured read buffers. Which read buffer exactly suffered from an overflow can be figured out from the read buffer overflow occurrence list (read_buffer_overflow_error_occurred). Reading the error log clears the occurence list.

The following constants are available for this function:

For transceiver_state:

• BrickletCANV2::TRANSCEIVER_STATE_ACTIVE = 0
• BrickletCANV2::TRANSCEIVER_STATE_PASSIVE = 1
• BrickletCANV2::TRANSCEIVER_STATE_DISABLED = 2

BrickletCANV2#set_communication_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the communication LED configuration. By default the LED shows CAN-Bus traffic, it flickers once for every 40 transmitted or received frames.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For config:

• BrickletCANV2::COMMUNICATION_LED_CONFIG_OFF = 0
• BrickletCANV2::COMMUNICATION_LED_CONFIG_ON = 1
• BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

BrickletCANV2#get_communication_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_communication_led_config

The following constants are available for this function:

For config:

• BrickletCANV2::COMMUNICATION_LED_CONFIG_OFF = 0
• BrickletCANV2::COMMUNICATION_LED_CONFIG_ON = 1
• BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

BrickletCANV2#set_error_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the error LED configuration.

By default (show-transceiver-state) the error LED turns on if the CAN transceiver is passive or disabled state (see #get_error_log). If the CAN transceiver is in active state the LED turns off.

If the LED is configured as show-error then the error LED turns on if any error occurs. If you call this function with the show-error option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For config:

• BrickletCANV2::ERROR_LED_CONFIG_OFF = 0
• BrickletCANV2::ERROR_LED_CONFIG_ON = 1
• BrickletCANV2::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCANV2::ERROR_LED_CONFIG_SHOW_TRANSCEIVER_STATE = 3
• BrickletCANV2::ERROR_LED_CONFIG_SHOW_ERROR = 4

BrickletCANV2#get_error_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_error_led_config.

The following constants are available for this function:

For config:

• BrickletCANV2::ERROR_LED_CONFIG_OFF = 0
• BrickletCANV2::ERROR_LED_CONFIG_ON = 1
• BrickletCANV2::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCANV2::ERROR_LED_CONFIG_SHOW_TRANSCEIVER_STATE = 3
• BrickletCANV2::ERROR_LED_CONFIG_SHOW_ERROR = 4

BrickletCANV2#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 232 - 1] 2: error_count_frame – Type: int, Range: [0 to 232 - 1] 3: error_count_overflow – Type: int, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletCANV2#set_status_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

• BrickletCANV2::STATUS_LED_CONFIG_OFF = 0
• BrickletCANV2::STATUS_LED_CONFIG_ON = 1
• BrickletCANV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCANV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletCANV2#get_status_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

• BrickletCANV2::STATUS_LED_CONFIG_OFF = 0
• BrickletCANV2::STATUS_LED_CONFIG_ON = 1
• BrickletCANV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCANV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletCANV2#get_chip_temperature → int¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletCANV2#reset → nil¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletCANV2#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

BrickletCANV2#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletCANV2#set_frame_read_callback_configuration(enabled) → nil¶

Parameters:	enabled – Type: bool, Default: false

Enables and disables the ::CALLBACK_FRAME_READ callback.

By default the callback is disabled. Enabling this callback will disable the ::CALLBACK_FRAME_READABLE callback.

BrickletCANV2#get_frame_read_callback_configuration → bool¶

Returns:	enabled – Type: bool, Default: false

Returns true if the ::CALLBACK_FRAME_READ callback is enabled, false otherwise.

BrickletCANV2#set_frame_readable_callback_configuration(enabled) → nil¶

Parameters:	enabled – Type: bool, Default: false

Enables and disables the ::CALLBACK_FRAME_READABLE callback.

By default the callback is disabled. Enabling this callback will disable the ::CALLBACK_FRAME_READ callback.

New in version 2.0.3 (Plugin).

BrickletCANV2#get_frame_readable_callback_configuration → bool¶

Returns:	enabled – Type: bool, Default: false

Returns true if the ::CALLBACK_FRAME_READABLE callback is enabled, false otherwise.

New in version 2.0.3 (Plugin).

BrickletCANV2#set_error_occurred_callback_configuration(enabled) → nil¶

Parameters:	enabled – Type: bool, Default: false

Enables and disables the ::CALLBACK_ERROR_OCCURRED callback.

By default the callback is disabled.

New in version 2.0.3 (Plugin).

BrickletCANV2#get_error_occurred_callback_configuration → bool¶

Returns:	enabled – Type: bool, Default: false

Returns true if the ::CALLBACK_ERROR_OCCURRED callback is enabled, false otherwise.

New in version 2.0.3 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

can_v2.register_callback BrickletCANV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

BrickletCANV2::CALLBACK_FRAME_READ¶

Callback Parameters:	frame_type – Type: int, Range: See constants identifier – Type: int, Range: [0 to 230 - 1] data – Type: [int, ...], Length: variable, Range: [0 to 255]

This callback is triggered if a data or remote frame was received by the CAN transceiver.

The identifier return value follows the identifier format described for #write_frame.

For details on the data return value see #read_frame.

A configurable read filter can be used to define which frames should be received by the CAN transceiver and put into the read queue (see #set_read_filter_configuration).

To enable this callback, use #set_frame_read_callback_configuration.

Note

If reconstructing the value fails, the callback is triggered with nil for data.

The following constants are available for this function:

For frame_type:

• BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
• BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
• BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
• BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3

BrickletCANV2::CALLBACK_FRAME_READABLE¶

Callback Parameters:	no parameters

This callback is triggered if a data or remote frame was received by the CAN transceiver. The received frame can be read with #read_frame. If additional frames are received, but #read_frame was not called yet, the callback will not trigger again.

A configurable read filter can be used to define which frames should be received by the CAN transceiver and put into the read queue (see #set_read_filter_configuration).

To enable this callback, use #set_frame_readable_callback_configuration.

New in version 2.0.3 (Plugin).

BrickletCANV2::CALLBACK_ERROR_OCCURRED¶

Callback Parameters:	no parameters

This callback is triggered if any error occurred while writing, reading or transmitting CAN frames.

The callback is only triggered once until #get_error_log is called. That function will return details abount the error(s) occurred.

To enable this callback, use #set_error_occurred_callback_configuration.

New in version 2.0.3 (Plugin).

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletCANV2#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletCANV2#get_response_expected(function_id) → bool¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by #set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickletCANV2::FUNCTION_SET_FRAME_READ_CALLBACK_CONFIGURATION = 3
• BrickletCANV2::FUNCTION_SET_TRANSCEIVER_CONFIGURATION = 5
• BrickletCANV2::FUNCTION_SET_QUEUE_CONFIGURATION = 7
• BrickletCANV2::FUNCTION_SET_READ_FILTER_CONFIGURATION = 9
• BrickletCANV2::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
• BrickletCANV2::FUNCTION_SET_ERROR_LED_CONFIG = 14
• BrickletCANV2::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 17
• BrickletCANV2::FUNCTION_SET_ERROR_OCCURRED_CALLBACK_CONFIGURATION = 20
• BrickletCANV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletCANV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletCANV2::FUNCTION_RESET = 243
• BrickletCANV2::FUNCTION_WRITE_UID = 248

BrickletCANV2#set_response_expected(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickletCANV2::FUNCTION_SET_FRAME_READ_CALLBACK_CONFIGURATION = 3
• BrickletCANV2::FUNCTION_SET_TRANSCEIVER_CONFIGURATION = 5
• BrickletCANV2::FUNCTION_SET_QUEUE_CONFIGURATION = 7
• BrickletCANV2::FUNCTION_SET_READ_FILTER_CONFIGURATION = 9
• BrickletCANV2::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
• BrickletCANV2::FUNCTION_SET_ERROR_LED_CONFIG = 14
• BrickletCANV2::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 17
• BrickletCANV2::FUNCTION_SET_ERROR_OCCURRED_CALLBACK_CONFIGURATION = 20
• BrickletCANV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletCANV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletCANV2::FUNCTION_RESET = 243
• BrickletCANV2::FUNCTION_WRITE_UID = 248

BrickletCANV2#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletCANV2#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

• BrickletCANV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletCANV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletCANV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletCANV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletCANV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletCANV2::BOOTLOADER_STATUS_OK = 0
• BrickletCANV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletCANV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletCANV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletCANV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletCANV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletCANV2#get_bootloader_mode → int¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

• BrickletCANV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletCANV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletCANV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletCANV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletCANV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletCANV2#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for #write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletCANV2#write_firmware(data) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by #set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletCANV2#write_uid(uid) → nil¶

Parameters:	uid – Type: int, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletCANV2#read_uid → int¶

Returns:	uid – Type: int, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

BrickletCANV2::DEVICE_IDENTIFIER¶

This constant is used to identify a CAN Bricklet 2.0.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletCANV2::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a CAN Bricklet 2.0.