saleae/one-wire-analyzer

Saleae 1-Wire Analyzer

Saleae 1-Wire Analyzer

Saleae 1-Wire 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:

1. Download the binary distribution for MacOS, cmake-*-Darwin-x86_64.dmg
2. Install the usual way by dragging into applications.
3. 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\one_wire_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: "reset"

Property	Type	Description

Reset pulse

Frame Type: "presence"

Property	Type	Description

Presence Pulse

Frame Type: "rom_command"

Property	Type	Description
description	str	read, skip, search, or match
rom_command	bytes	The command byte

ROM command. This is the first command issued by the master after a presence pulse

Frame Type: "crc"

Property	Type	Description
crc	bytes	The CRC byte

8 bit CRC, last part of the 64 bit identifier

Frame Type: "family_code"

Property	Type	Description
family	bytes	The family code, which is the first part of the 64 bit identifier

The family code of the device ID

Frame Type: "id"

Property	Type	Description
id	int	48 bit integer, taken from the center of the 64 bit identifier

The 48 bit device identifier

Frame Type: "data"

Property	Type	Description
data	bytes	A single data byte

Data byte after the ROM command and identifier

Frame Type: "invalid_rom_command"

Property	Type	Description
rom_command	bytes	The ROM command byte

Unknown ROM command

Frame Type: "alarm"

Property	Type	Description
rom_command	bytes	The command byte

Alarm search command