search

mac-can / SLCAN

Libray for Lawicel SLCAN Protocol (Serial-Line CAN)
https://www.mac-can.net/slcan.html
BSD 2-Clause "Simplified" License
8 stars 1 forks source link
can can-bus canusb cygwin linux macos serial slcan-protocol windows

readme

Library for Lawicel SLCAN Protocol (Serial-Line CAN)

Copyright © 2016,2020-2024 Uwe Vogt, UV Software, Berlin (info@uv-software.com)

macOS Build MSBuild x64

SLCAN

Implementation of Lawicel SLCAN protocol.

Lawicel SLCAN Protocol

Supported commands

Note: Channel configuration commands must be sent before opening the channel. The channel must be opened before transmitting frames.

CANable SLCAN Protocol (Option 1)

Supported commands

Note: Channel configuration commands must be sent before opening the channel. The channel must be opened before transmitting frames.

Note: The firmware currently does not provide any ACK/NACK feedback for serial commands.

Note: The implementation currently does not support CAN FD commands and frame format.

SLCAN API

slcan_port_t slcan_create(size_t queueSize);
int slcan_destroy(slcan_port_t port);
int slcan_connect(slcan_port_t port, const char *device, const sio_attr_t *attr);
int slcan_disconnect(slcan_port_t port);
int slcan_get_attr(slcan_port_t port, slcan_attr_t *attr);
int slcan_set_ack(slcan_port_t port, bool on);
int slcan_setup_bitrate(slcan_port_t port, uint8_t index);
int slcan_setup_btr(slcan_port_t port, uint16_t btr);
int slcan_open_channel(slcan_port_t port);
int slcan_close_channel(slcan_port_t port);
int slcan_write_message(slcan_port_t port, const slcan_message_t *message, uint16_t timeout);
int slcan_read_message(slcan_port_t port, slcan_message_t *message, uint16_t timeout);
int slcan_status_flags(slcan_port_t port, slcan_flags_t *flags);
int slcan_acceptance_code(slcan_port_t port, uint32_t code);
int slcan_acceptance_mask(slcan_port_t port, uint32_t mask);
int slcan_version_number(slcan_port_t port, uint8_t *hardware, uint8_t *software);
int slcan_serial_number(slcan_port_t port, uint32_t *number);
int slcan_signal(slcan_port_t port);
char *slcan_api_version(uint16_t *version_no, uint8_t *patch_no, uint32_t *build_no);

Build Targets

Important note: To build any of the following build targets run the build_no.sh script to generate a pseudo build number.

gonggomg@uv-pc015deb:~$ cd ~/Projects/CAN/SLCAN
gonggomg@uv-pc015deb:~/Projects/CAN/SLCAN$ ./build_no.sh

Repeat this step after each git commit, git pull, git clone, etc.

Then you can build the whole bleep by typing the usual commands:

gonggomg@uv-pc015deb:~$ cd ~/Projects/CAN/SLCAN
gonggomg@uv-pc015deb:~/Projects/CAN/SLCAN$ make clean
gonggomg@uv-pc015deb:~/Projects/CAN/SLCAN$ make all
gonggomg@uv-pc015deb:~/Projects/CAN/SLCAN$ sudo make install

(The version number of the libraries can be adapted by editing the Makefiles in the subfolders and changing the variable VERSION accordingly. Don´t forget to set the version number also in the source files.)

libSLCAN

libSLCAN is a dynamic library with a basic SLCAN application programming interface for use in C applications. See header file slcan.h for a description of all API functions.

Target Platforms

POSIX® compatible operating systems:

  1. macOS®
  2. Linux®
  3. Cygwin®

Windows® (x64 operating system):

  1. Windows 10 Pro
  2. Windows 11 Pro

Development Environments

macOS Sonoma

macOS Monterey

macOS High Sierra

Debian "bookworm" (12.5)

Cygwin (64-bit)

Windows 10 & 11

CAN Hardware

Known Bugs and Caveats

  1. Transmitting messages over the TTY is extremely slow; approx. 16ms per frame. I guess this is because the transmission is acknowledged by the CAN device.

  2. Time-stamps are currently not supported.

This and That

The documentation of the SLCAN protocol can be found on Lawicel CANUSB product page. For the CANable 2.0 adaptation, see the CANable Firmware documentation on GitHub.

Dual-License

Except where otherwise noted, this work is dual-licensed under the terms of the BSD 2-Clause "Simplified" License and under the terms of the GNU General Public License v3.0 (or any later version). You can choose between one of them if you use these portions of this work in whole or in part.

Trademarks

Mac and macOS are trademarks of Apple Inc., registered in the U.S. and other countries. \ Windows is a registered trademarks of Microsoft Corporation in the United States and/or other countries. \ POSIX is a registered of the Institute of Electrical and Electronic Engineers, Inc. \ Linux is a registered trademark of Linus Torvalds. \ Cygwin is a registered trademark of Red Hat, Inc. \ All other company, product and service names mentioned herein may be trademarks, registered trademarks, or service marks of their respective owners.

Hazard Note

If you connect your CAN device to a real CAN network when using this library, you might damage your application.

Contact

E-Mail: mailto://info@mac.can.com \ Internet: https://www.mac-can.net