mirror of
https://github.com/gillham/logic_analyzer.git
synced 2026-05-01 23:53:02 +03:00
Cleanup README
Cleanup older notes from the README. Move the part about disabling auto-reset to towards the end under ‘older notes’ and add a comment about how it shouldn’t be necessary. Almost move the part about the device profiles as they are builtin to ols-0.9.7 or newer.
This commit is contained in:
Andrew Gillham
63
README
63
README
@@ -1,19 +1,13 @@
|
||||
SUMP compatible logic analyzer for Arduino
|
||||
==========================================
|
||||
|
||||
NOTE: With v0.11 you can now sample at 4MHz & 2MHz rates in addition to the
|
||||
previous 1MHz and lower rates. This is done via unrolled loops which
|
||||
makes the source code huge and the binary takes much more of the flash.
|
||||
v0.11 is just slightly to big for an ATmega168's flash. You can comment
|
||||
out either captureInline2mhz() or captureInline4mhz() and it will fit.
|
||||
|
||||
NOTE: v0.09 switched the channels BACK to pins 8-13 for trigger reliability.
|
||||
Please report any issues. Uncomment USE_PORTD for pins 2-7.
|
||||
|
||||
This Arduino sketch implements a SUMP protocol compatible with the standard
|
||||
SUMP client as well as the alternative client from here:
|
||||
http://www.lxtreme.nl/ols/
|
||||
|
||||
The alternative client version is highly recommended. Download version "ols-0.9.7"
|
||||
or newer for built-in device profiles.
|
||||
|
||||
This SUMP protocol compatible logic analyzer for the Arduino board supports
|
||||
5 channels consisting of digital pins 8-12, which are the first 5 bits (0-4)
|
||||
of PORTB. Arduino pin 13 / bit 5 is the Arduino LED, bits 6 & 7 are the
|
||||
@@ -22,23 +16,7 @@ Uncomment CHAN5 below if you want to use the LED pin as an input and have
|
||||
6 channels.
|
||||
|
||||
On the Arduino Mega board 8 channels are supported and 7k of samples.
|
||||
Pins 22-29 (Port A) are used by default, you can change the 'CHANPIN' below
|
||||
if something else works better for you.
|
||||
|
||||
NOTE:
|
||||
If you are using the original SUMP client, or using the alternative client
|
||||
without the device profiles, then you will get a "device not found" error.
|
||||
You must DISABLE the Arduino auto reset feature to use this logic analyzer
|
||||
code. There are various methods to do this, some boards have a jumper,
|
||||
others require you to cut a trace. You may also install a *precisely*
|
||||
120 Ohm resistor between the reset & 5V piins. Make sure it is really
|
||||
120 Ohm or you may damage your board. It is much easier to use the
|
||||
alternative SUMP client referenced above.
|
||||
|
||||
The device profiles should be included with this code. Copy them to the
|
||||
'plugins' directory of the client. The location varies depending on the
|
||||
platform, but on the mac it is here by default:
|
||||
/Applications/LogicSniffer.app/Contents/Resources/Java/plugins
|
||||
Pins 22-29 (Port A) are used by default.
|
||||
|
||||
To use this with the original or alternative SUMP clients,
|
||||
use these settings:
|
||||
@@ -57,8 +35,37 @@ below 1MHz. 1MHz works for a basic busy wait trigger that doesn't store
|
||||
until after the trigger fires.
|
||||
Please try it out and report back.
|
||||
|
||||
This master branch now supports Arduino 1.0 only.
|
||||
Checkout branch logic_analyzer_v0_5 for Arduino 22 support.
|
||||
Older Notes
|
||||
===========================================================================
|
||||
NOTE: With v0.11 you can now sample at 4MHz & 2MHz rates in addition to the
|
||||
previous 1MHz and lower rates. This is done via unrolled loops which
|
||||
makes the source code huge and the binary takes much more of the flash.
|
||||
v0.11 is just slightly to big for an ATmega168's flash. You can comment
|
||||
out either captureInline2mhz() or captureInline4mhz() and it will fit.
|
||||
|
||||
NOTE: v0.09 switched the channels BACK to pins 8-13 for trigger reliability.
|
||||
Please report any issues. Uncomment USE_PORTD for pins 2-7.
|
||||
|
||||
NOTE: The device profiles should be included with this code. Copy them to the
|
||||
'plugins' directory of the client. The location varies depending on the
|
||||
platform, but on the mac it is here by default:
|
||||
/Applications/LogicSniffer.app/Contents/Resources/Java/plugins
|
||||
[ These are already included in ols-0.9.7 or newer so do not copy them. ]
|
||||
|
||||
NOTE: If you are using the original SUMP client, then you will get a
|
||||
"device not found" error.
|
||||
You must DISABLE the Arduino auto reset feature to use this logic analyzer
|
||||
code. There are various methods to do this, some boards have a jumper,
|
||||
others require you to cut a trace. You may also install a *precisely*
|
||||
120 Ohm resistor between the reset & 5V piins. Make sure it is really
|
||||
120 Ohm or you may damage your board. It is much easier to use the
|
||||
alternative SUMP client referenced above.
|
||||
[ This is no longer needed for the general case and is just here for reference. ]
|
||||
[ DO NOT use this resistor unless absolutely necessary due to very old clients. ]
|
||||
|
||||
NOTE: This master branch now supports Arduino 1.0 only.
|
||||
Checkout branch logic_analyzer_v0_5 for Arduino 22 support.
|
||||
|
||||
|
||||
Release: v0.12 September 6, 2013.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
*
|
||||
* SUMP Protocol Implementation for Arduino boards.
|
||||
*
|
||||
* Copyright (c) 2011,2012,2013 Andrew Gillham
|
||||
* Copyright (c) 2011,2012,2013,2014 Andrew Gillham
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
@@ -44,22 +44,6 @@
|
||||
* Pins 22-29 (Port A) are used by default, you can change the 'CHANPIN' below
|
||||
* if something else works better for you.
|
||||
*
|
||||
* NOTE:
|
||||
* If you are using the original SUMP client, or using the alternative client
|
||||
* without the device profiles, then you will get a "device not found" error.
|
||||
* You must DISABLE the Arduino auto reset feature to use this logic analyzer
|
||||
* code. There are various methods to do this, some boards have a jumper,
|
||||
* others require you to cut a trace. You may also install a *precisely*
|
||||
* 120 Ohm resistor between the reset & 5V piins. Make sure it is really
|
||||
* 120 Ohm or you may damage your board.
|
||||
* It is much easier to use the alternative SUMP client from here:
|
||||
* http://www.lxtreme.nl/ols/
|
||||
*
|
||||
* The device profiles should be included with this code. Copy them to the
|
||||
* 'plugins' directory of the client. The location varies depending on the
|
||||
* platform, but on the mac it is here by default:
|
||||
* /Applications/LogicSniffer.app/Contents/Resources/Java/plugins
|
||||
*
|
||||
* To use this with the original or alternative SUMP clients,
|
||||
* use these settings:
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user