Saleae Controller Area Network (CAN) Analyzer
Saleae Controller Area Network (CAN) Analyzer
Getting Started
The following documentation describes getting this analyzer building locally. For more detailed information about the Analyzer SDK, debugging, CI build, and more, checkout the readme from the Sample Analyzer repository:
https://github.com/saleae/SampleAnalyzer
MacOS
Dependencies:
- XCode with command line tools
- CMake 3.13+
- git
Installing command line tools after XCode is installed:
xcode-select --install
Then open XCode, open Preferences from the main menu, go to locations, and select the only option under 'Command line tools'.
Installing CMake on MacOS:
- Download the binary distribution for MacOS,
cmake-*-Darwin-x86_64.dmg - Install the usual way by dragging into applications.
- Open a terminal and run the following:
/Applications/CMake.app/Contents/bin/cmake-gui --install
Note: Errors may occur if older versions of CMake are installed.
Building the analyzer:
mkdir build
cd build
cmake ..
cmake --build .
Ubuntu 18.04+
Dependencies:
- CMake 3.13+
- gcc 4.8+
- git
Misc dependencies:
sudo apt-get install build-essential
Building the analyzer:
mkdir build
cd build
cmake ..
cmake --build .
Windows
Dependencies:
- Visual Studio 2019
- CMake 3.13+
- git
Visual Studio 2019
Note - newer and older versions of Visual Studio are likely to work.
Setup options:
- Workloads > Desktop & Mobile > "Desktop development with C++"
Note - if CMake has any problems with the MSVC compiler, it's likely a component is missing.
CMake
Download and install the latest CMake release here. https://cmake.org/download/
git
Download and install git here. https://git-scm.com/
Building the analyzer:
mkdir build
cd build
cmake .. -A x64
Then, open the newly created solution file located here: build\can_analyzer.sln
The built analyzer DLLs will be located here:
build\Analyzers\Debug
build\Analyzers\Release
For debug and release builds, respectively.
Output Frame Format
Frame Type: "identifier_field"
| Property | Type | Description |
|---|---|---|
identifier |
int | Identifier, either 11 bit or 29 bit |
extended |
bool | (optional) Indicates that this identifier is a 29 bit extended identifier. This key is not present on regular 11 bit identifiers |
remote_frame |
bool | (optional) Present and true for remote frames |
Frame Type: "control_field"
| Property | Type | Description |
|---|---|---|
num_data_bytes |
int | Number of data bytes in the transaction |
Frame Type: "data_field"
| Property | Type | Description |
|---|---|---|
data |
int | The byte |
Frame Type: "crc_field"
| Property | Type | Description |
|---|---|---|
crc |
int | 16 bit CRC value |
Frame Type: "ack_field"
| Property | Type | Description |
|---|---|---|
ack |
bool | True when an ACK was present |
Frame Type: "can_error"
| Property | Type | Description |
|---|
Invalid CAN data was encountered