v0.14. Rearrange DEBUG functionality, disable by default.

v0.14. Add ‘DEBUG_MENU’ which can be uncommented to enable the basic
debug menu with the ability to run a capture / dump the data etc.
DEBUG and DEBUG_MENU are commented out by default to save RAM.

README

@@ -5,26 +5,29 @@ 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
 crystal oscillator pins.
+
 Uncomment CHAN5 below if you want to use the LED pin as an input and have
 6 channels.
 
-NOTE:
-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.
+On the Arduino Mega board 8 channels are supported and 7k of samples.
+Pins 22-29 (Port A) are used by default.
 
 To use this with the original or alternative SUMP clients,
 use these settings:
 
-Sampling rate: 1MHz (or lower)
+Sampling rate: 4MHz (or lower) (no 2MHz on ATmega168)
 Channel Groups: 0 (zero) only
-Recording Size: 1024 (or lower)
+Recording Size:
+   ATmega168:  532 (or lower)
+   ATmega328:  1024 (or lower)
+   ATmega2560: 7168 (or lower)
 Noise Filter: doesn't matter
 RLE: disabled (unchecked)
 
@@ -33,5 +36,49 @@ 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.
 
-Release: v0.03 March 7, 2011.
+Debugging
+=========
+
+You can uncomment the '#define DEBUG_MENU' line to add some diagnostic menu
+options for capturing or dumping the capture buffer.
+You can uncomment the '#define DEBUG' and '#define DEBUG_MENU' for a couple
+extra menu options and logging of the received commands.  The DEBUG option
+is generally only useful for development, while the DEBUG_MENU option is
+good for troubleshooting when the logic_analyzer sketch isn't working for you.
+Both are disabled by default to conserve RAM for improved stability.
+
+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.
+      [ The code automatically skips the 2MHz code now, this isn't needed. ]
+
+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 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 not needed with ols-0.9.7 or newer. ]
+      [ DO NOT use this resistor unless absolutely necessary on old clients. ]
+
+NOTE: This master branch now supports Arduino 1.0 only.
+      Checkout branch logic_analyzer_v0_5 for Arduino 22 support.
+
+
+Release: v0.14 December 16, 2015.
 

ols.profile-agla.cfg

@@ -0,0 +1,53 @@
+# Configuration for Arduino Generic Logic Analyzer profile
+
+# The short (single word) type of the device described in this profile
+device.type = AGLA
+# A longer description of the device
+device.description = Arduino Generic Logic Analyzer
+# The device interface, SERIAL only
+device.interface = SERIAL
+# The device's native clockspeed, in Hertz.
+device.clockspeed = 16000000
+# Whether or not double-data-rate is supported by the device (also known as the "demux"-mode).
+device.supports_ddr = false
+# Supported sample rates in Hertz, separated by comma's
+device.samplerates = 10, 20, 50, 100, 200, 500, 1000, 2000, 5000, 10000, 20000, 50000, 100000, 200000, 500000, 1000000, 2000000, 4000000
+# What capture clocks are supported
+device.captureclock = INTERNAL
+# The supported capture sizes, in bytes
+device.capturesizes = 64, 128, 256, 512, 1024
+# Whether or not the noise filter is supported
+device.feature.noisefilter = false
+# Whether or not Run-Length encoding is supported
+device.feature.rle = true
+# Whether or not a testing mode is supported
+device.feature.testmode = false
+# Whether or not triggers are supported
+device.feature.triggers = true
+# The number of trigger stages
+device.trigger.stages = 1
+# Whether or not "complex" triggers are supported
+device.trigger.complex = false
+
+# The total number of channels usable for capturing
+device.channel.count = 6
+# The number of channels groups, together with the channel count determines the channels per group
+device.channel.groups = 1
+# Whether the capture size is limited by the enabled channel groups
+device.capturesize.bound = false
+# Which numbering does the device support
+device.channel.numberingschemes = DEFAULT
+
+# Is a delay after opening the port and device detection needed? (0 = no delay, >0 = delay in milliseconds)
+device.open.portdelay = 2000
+# The receive timeout for the device (in milliseconds, 100 = default, <=0 = no timeout)
+device.receive.timeout = 100
+# Does the device need a high or low DTR-line to operate correctly? (high = true, low = false)
+device.open.portdtr = true
+# Which metadata keys correspond to this device profile? Value is a comma-separated list of (double quoted) names...
+device.metadata.keys = "AGLAv0"
+
+# In which order are samples sent back from the device? false = last sample first, true = first sample first
+device.samples.reverseOrder = true
+
+###EOF###

ols.profile-aglam.cfg

@@ -0,0 +1,53 @@
+# Configuration for Arduino Mega Logic Analyzer profile
+
+# The short (single word) type of the device described in this profile
+device.type = AGLAM
+# A longer description of the device
+device.description = Arduino Mega Logic Analyzer
+# The device interface, SERIAL only
+device.interface = SERIAL
+# The device's native clockspeed, in Hertz.
+device.clockspeed = 16000000
+# Whether or not double-data-rate is supported by the device (also known as the "demux"-mode).
+device.supports_ddr = false
+# Supported sample rates in Hertz, separated by comma's
+device.samplerates = 10, 20, 50, 100, 200, 500, 1000, 2000, 5000, 10000, 20000, 50000, 100000, 200000, 500000, 1000000, 2000000, 4000000
+# What capture clocks are supported
+device.captureclock = INTERNAL
+# The supported capture sizes, in bytes
+device.capturesizes = 64, 128, 256, 512, 1024, 2048, 4096, 7168
+# Whether or not the noise filter is supported
+device.feature.noisefilter = false
+# Whether or not Run-Length encoding is supported
+device.feature.rle = false
+# Whether or not a testing mode is supported
+device.feature.testmode = false
+# Whether or not triggers are supported
+device.feature.triggers = true
+# The number of trigger stages
+device.trigger.stages = 1
+# Whether or not "complex" triggers are supported
+device.trigger.complex = false
+
+# The total number of channels usable for capturing
+device.channel.count = 8
+# The number of channels groups, together with the channel count determines the channels per group
+device.channel.groups = 1
+# Whether the capture size is limited by the enabled channel groups
+device.capturesize.bound = false
+# Which numbering does the device support
+device.channel.numberingschemes = DEFAULT
+
+# Is a delay after opening the port and device detection needed? (0 = no delay, >0 = delay in milliseconds)
+device.open.portdelay = 2000
+# The receive timeout for the device (in milliseconds, 100 = default, <=0 = no timeout)
+device.receive.timeout = 100
+# Does the device need a high or low DTR-line to operate correctly? (high = true, low = false)
+device.open.portdtr = true
+# Which metadata keys correspond to this device profile? Value is a comma-separated list of (double quoted) names...
+device.metadata.keys = "AGLAMv0"
+
+# In which order are samples sent back from the device? false = last sample first, true = first sample first
+device.samples.reverseOrder = true
+
+###EOF###