USBtin

https://www.fischl.de/usbtin/
Admin
USBtin is a simple USB to CAN interface that can monitor CAN busses and transmit CAN messages,...
Tokens:5,624
Snippets:96
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Import USBtinLib and jSSC Libraries

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Import the necessary classes from USBtinLib and jSSC for serial port communication. This setup is required before instantiating the USBtin object.

```java
import de.fischl.usbtin.*;
import jssc.SerialPortList;
```

--------------------------------

### Control USBtin via ASCII Commands

Source: https://www.fischl.de/usbtin

Interact with USBtin using ASCII commands over a virtual serial port. This example demonstrates setting baud rate, opening the CAN channel, sending a CAN message, and closing the channel.

```text
Command:                Response:
S0[CR]                  [CR]
O[CR]                   [CR]
t001411223344[CR]       z[CR]
C[CR]                   [CR]
```

--------------------------------

### Start CANopen Node

Source: https://www.fischl.de/usbtin/canopen

Transmit the 'Start Remote Node' command to transition the CANopen device to the OPERATIONAL (RUN) mode. Ensure the CAN bus termination is correctly set.

```text
t00020100
```

--------------------------------

### Attach and Start CAN Interface

Source: https://www.fischl.de/usbtin/linux_can_socketcan

Attaches the USBtin device to a CAN network device (slcan0) and brings the interface up. The 's5' parameter sets a baudrate of 250k; use 'b' for custom baudrates.

```bash
sudo ./slcan_attach -f -s5 -o /dev/ttyACM0
sudo ./slcand ttyACM0 slcan0
sudo ifconfig slcan0 up
```

--------------------------------

### Send messages to USBtin via /dev/ttyACM0

Source: https://www.fischl.de/usbtin

This snippet demonstrates how to send messages to a USBtin device connected via a router. It requires the kmod-usb-acm module to be installed.

```bash
echo "O" > /dev/ttyACM0
```

--------------------------------

### Prepare and Play CAN Message Sequence

Source: https://www.fischl.de/usbtin/linux_can_socketcan

Creates a log file containing CAN messages with timestamps and then plays them back using canplayer. The '-l 20' option limits playback to 20 loops, '-I' specifies the input file, '-v' enables verbose output, and '-g500' sets a gap of 500ms between messages.

```bash
cat test.log 
(0.1) slcan0 5D1#0000
(0.2) slcan0 271#0100
(0.3) slcan0 289#72027000
(0.4) slcan0 401#081100000000
```

```bash
$ ./canplayer -l 20 -I test.log -v -g500
```

--------------------------------

### Clone and Compile CAN Utils

Source: https://www.fischl.de/usbtin/linux_can_socketcan

Downloads the can-utils repository from GitHub and compiles the utilities for use with Linux-CAN.

```bash
git clone https://github.com/linux-can/can-utils.git
cd can-utils
make
```

--------------------------------

### Initialize Serial Port ComboBox Model

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Sets the model for the serial port selection combobox using available USBtin serial port names.

```java
new javax.swing.DefaultComboBoxModel(SerialPortList.getPortNames())
```

--------------------------------

### Update USBtin Firmware

Source: https://www.fischl.de/usbtin

Use the MPHidFlash application to load new firmware onto the USBtin device. Ensure the bootloader jumper (JP1) is set before connecting the USBtin.

```bash
mphidflash -w USBtin_firmware_v1.x.hex
```

--------------------------------

### Load Kernel Modules for CAN

Source: https://www.fischl.de/usbtin/linux_can_socketcan

Loads the necessary kernel modules for CAN bus functionality on Ubuntu systems.

```bash
sudo modprobe can
sudo modprobe can-raw
sudo modprobe slcan
```

--------------------------------

### Connect, Listen, and Send CAN Messages with USBtinLib

Source: https://www.fischl.de/usbtin

This Java code demonstrates how to connect to a USBtin device, set up a listener for incoming CAN messages, send a CAN message, and then disconnect. Ensure Java JRE>=1.5 and the USBtinLib JAR are available.

```java
usbtin.connect("COM3");

usbtin.addMessageListener(new CANMessageListener() {
    @Override
    public void receiveCANMessage(CANMessage canmsg) {
        System.out.println(canmsg);
    }
});

usbtin.openCANChannel(10000, USBtin.OpenMode.ACTIVE);

System.in.read(); // wait for user input

usbtin.send(new CANMessage(0x100, new byte[]{0x11}));

usbtin.closeCANChannel();
usbtin.disconnect();
```

--------------------------------

### Add User to Dialout Group (Linux/Ubuntu)

Source: https://www.fischl.de/usbtin

Grant necessary permissions to access serial devices like /dev/ttyACMx by adding the current user to the 'dialout' group. A re-login or reboot is required for changes to take effect.

```bash
$sudo adduser $USER dialout
```

--------------------------------

### Ignore USBtin with Network Manager (Linux/Ubuntu/RaspberryPi)

Source: https://www.fischl.de/usbtin

Prevent the 'network-manager' from interfering with USBtin by adding a udev rule. This rule identifies USBtin by its vendor and product IDs and sets an environment variable to ignore it.

```bash
sudo gedit /etc/udev/rules.d/10-local.rules
ATTRS{idVendor}="04d8", ATTRS{idProduct}="000a", ENV{ID_MM_DEVICE_IGNORE}="1"
```

--------------------------------

### Instantiate USBtin Object

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Declare and initialize a protected USBtin object. This object will be used to interact with the USBtin device for CAN bus operations.

```java
protected USBtin usbtin = new USBtin();
```

--------------------------------

### Send CAN Message with Button

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Implement a button's action listener to send a predefined CAN message. Requires a USBtin instance and handles potential exceptions.

```java
private void sendButtonActionPerformed(java.awt.event.ActionEvent evt) {
    
    try {
        usbtin.send(new CANMessage(0x100, new byte[]{0x11, 0x22, 0x33}));
    } catch (USBtinException e) {
        System.err.println(e.getMessage());
    }
}
```

--------------------------------

### Simulate CAN Device Behavior

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Extend the CAN message listener to simulate a CAN device. It processes incoming messages with ID 0x001, calculates a sum of data bytes, and sends a response.

```java
@Override
    public void receiveCANMessage(CANMessage canmessage) {
        logTextArea.append(canmessage.toString() + "\n");
        
        if (canmessage.getId() == 0x001) {
            byte sum = 0;
            for (byte b : canmessage.getData()) sum += b;
            
            try {
               usbtin.send(new CANMessage(0x002, new byte[]{sum}));
            } catch (USBtinException e) {
                System.err.println(e.getMessage());
            }
        }
    }
```

--------------------------------

### Implement CAN Message Listener Interface

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Implement the CANMessageListener interface to receive incoming CAN messages. Register the listener with the USBtin instance.

```java
public class USBtinLibGUIDemo extends javax.swing.JFrame implements CANMessageListener {
```

```java
@Override
    public void receiveCANMessage(CANMessage canmessage) {
        logTextArea.append(canmessage.toString() + "\n");
    }
```

```java
usbtin.addMessageListener(this);
```

--------------------------------

### USBtin Connect/Disconnect Button Action

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Handles the connection and disconnection logic for a USBtin device when a button is clicked. It manages the USBtin connection, opens a CAN channel with specified baud rate, and updates the button text and serial port combobox state accordingly. Errors during connection or disconnection are caught and printed to standard error.

```java
private void connectionButtonActionPerformed(java.awt.event.ActionEvent evt) {
       
        if (connectionButton.getText().equals("Disconnect")) {
            try {
                usbtin.closeCANChannel();
                usbtin.disconnect();
                System.out.println("Disconnected");
            } catch (USBtinException e) {
                System.err.println(e.getMessage());
            }
            connectionButton.setText("Connect");
            serialPort.setEnabled(true);
        } else {
            try {
                usbtin.connect((String) serialPort.getSelectedItem());
                usbtin.openCANChannel(100000, USBtin.OpenMode.ACTIVE);
                connectionButton.setText("Disconnect");
                serialPort.setEnabled(false);
                System.out.println("Connected to USBtin (FW" + usbtin.getFirmwareVersion() +
                                   "/HW" + usbtin.getHardwareVersion() + ")");
            } catch (USBtinException e) {
                System.err.println(e.getMessage());
            }
        }
    }
```

--------------------------------

### Dump CAN Messages

Source: https://www.fischl.de/usbtin/linux_can_socketcan

Displays all CAN messages received on the specified CAN interface (slcan0) in real-time.

```bash
./candump slcan0
```

--------------------------------

### Identify USBtin Serial Device

Source: https://www.fischl.de/usbtin/linux_can_socketcan

Inspects kernel log files to determine the assigned CDC serial device name (e.g., ttyACM0) for the USBtin.

```bash
tail /var/log/kern.log
```

--------------------------------

### Set Digital Outputs Bit 0 and Bit 1

Source: https://www.fischl.de/usbtin/canopen

Set the state of digital outputs Bit 0 and Bit 1 simultaneously on the CANopen device. This command utilizes a specific CAN message identifier and a combined data payload.

```text
t201103
```

--------------------------------

### Check CANopen Node State

Source: https://www.fischl.de/usbtin/canopen

Send a request telegram to check the current operational state of the CANopen node. The response indicates the node's status, with bit 7 being a toggle bit and bits 6-0 representing the state.

```text
r7010
```

--------------------------------

### Set Digital Output Bit 0

Source: https://www.fischl.de/usbtin/canopen

Set the state of digital output Bit 0 on the CANopen device. This command uses a specific CAN message identifier and data payload format.

```text
t201101
```

--------------------------------

### Send CAN Message on Slider Change

Source: https://www.fischl.de/usbtin/usbtinlib_guidemo

Send a CAN message with data from a JSlider's value when the slider's state changes. Only sends when the user finishes adjusting the slider.

```java
private void testSliderStateChanged(javax.swing.event.ChangeEvent evt) {
    JSlider source = (JSlider)evt.getSource();
    if (!source.getValueIsAdjusting()) {
        try {
            usbtin.send(new CANMessage(0x101, new byte[]{(byte)source.getValue()}));
        } catch (USBtinException e) {
            System.err.println(e.getMessage());
        }
    }
}
```
Tokens:
Raw