Skip to content

Commit

Permalink
add words and screenshots to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
attie-argentum committed Jun 15, 2024
1 parent 5dd000c commit 3c49200
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
# I<sup>2</sup>C Protocol Analyzer for Saleae Logic 2

This analyzer will decode I<sup>2</sup>C, with a handful of benefits over the bundled I<sup>2</sup>C analyzer.

## Settings

Decode in confidence, with the ability to configure a built-in glitch filter, and granular control over what data appears in the results table.

![settings screenshot](./images/settings.png)

## Edge-by-Edge Visibility

The analyzer operates in clear view, showing you the decision it made at each point of the signal - great for learning or identifying where something went wrong.

![edge-by-edge screenshot](./images/edge-by-edge.png)

## Tabular Data

Data is decoded into three categories - Control, Frame and Transaction... each can be independently enabled and disabled.

- "_Control_" includes the start, restart, stop and error conditions
- "_Frame_" is a per-frame decode, indicating the address or data value
- "_Transaction_" is a per-transaction decode, including the full binary payload

![table screenshot](./images/table-view.png)

## Filter by Address

For the more busy busses, filtering based on the target address will provide instant visibility on when the device is active.
The edge-by-edge details are still visible for everything, but bubbles and table data will only be produced according to the target address you specify.

![filtered screenshot](./images/filter-by-address.png)

## Glitch Filtering

Robust built-in glitch filtering helps to provide valid decodes, even when your data isn't perfect.
In this screenshot there are actually three 8ns glitches in the clock signal, but the decode is still correct.

![gliches screenshot](./images/glitch-filtering.png)


# Build and Install

See: [`i2c-analyzer`](https://github.com/saleae/i2c-analyzer)
Expand Down
Binary file added images/edge-by-edge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/filter-by-address.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/glitch-filtering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/table-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3c49200

Please sign in to comment.