NEWS

   1 0.7.2 (2021-03-01)
   2 ------------------
   3
   4  * Command line option changes:
   5    - Add the -D|--dont-scan option.
   6    - Add the --list-serial option.
   7    - Add the --list-supported-wiki option (internal, developer-only).
   8    - Accept multiple --config requests for multiple channel groups.
   9    - Accept multiple --get requests for multiple channel groups.
  10  * Protocol decoding:
  11    - Add support for Google Trace Event output (JSON).
  12    - Add support for float option data type (bug #1247).
  13    - Perform stricter checks for integer decoder options.
  14    - Accept annotation rows for -A specs.
  15    - Fix memory leaks in annotation setup error paths.
  16    - Add sanity check when mapping channels (bug #1515).
  17  * Manpage:
  18    - Fix -A description wrt default annotations shown.
  19    - Clarify annotation classes in -A description.
  20    - Improve/clarify documentation of the -d option.
  21  * --show:
  22    - Mark currently selected samplerate item in samplerates lists.
  23    - Support arrays of floats, unbreaks LCR output frequency listing.
  24    - Do print floating point results even if value is zero.
  25    - List protocol decoder tags (if available).
  26    - Synchronize --get output for MQ with --show output.
  27    - Add support for -i <file> --show, provide details on input stream.
  28  * --scan: Show device serial number if available.
  29  * Warn about unknown input/output module option keys (bug #1549).
  30  * Extend options parser, support optional ID in key-value lists.
  31  * Terminate with error when -B was specified but -P is missing (bug #1180).
  32  * Fix listing of some configuration options (bug #1331).
  33  * Print error message when output file creation fails (bug #1372).
  34  * Windows:
  35    - Set stdout to binary mode on Windows as needed (bug #1427).
  36    - nsis: Ship Python stdlib *.pyd files needed by some PDs (bug #1409).
  37    - nsis: Install 64bit Windows programs into 'Program Files' (bug #1082).
  38
  39 0.7.1 (2018-10-26)
  40 ------------------
  41
  42  * Command line option changes:
  43    - Add the --protocol-decoder-samplenum option.
  44  * Scan: Fix auto-select of non-demo device, if there's only one (bug #848).
  45  * Protocol decoding: Always print colon after protocol decoder ID.
  46  * input:
  47    - Increase chunk size to 4MB (large performance improvements).
  48    - Make read from stdin work with the presence of -I specs.
  49  * Manpage:
  50    - Fix outdated references to -V (it's -L now).
  51    - Don't list specific output formats, only mention -L.
  52    - Improve decoder stacking documentation.
  53    - Mention currently unsupported channel name auto-matching.
  54    - Various example invocation improvements (bug #1181).
  55  * Fix invalid frame limit error reporting.
  56  * Bugfix in order to make sr_session_stop() actually work.
  57  * Add a .desktop file and an icon.
  58  * Don't unnecessarily run the 'analog' output module on data sources
  59    which don't have analog channels, thus improving performance.
  60  * HACKING: Prefer git pull requests over mailing list patches.
  61
  62 0.7.0 (2017-06-12)
  63 ------------------
  64
  65  * Update sigrok-cli to the new APIs from both libsigrok 0.5.0 and also
  66    libsigrokdecode 0.5.0.
  67  * -P <decoder> --show:
  68    - List the binary output classes of the decoder.
  69    - List the possible input and output IDs of the decoder.
  70  * --help:
  71    - Clarify that --show also lists input/output format options,
  72      as well as protocol decoder options (bug #851).
  73    - Show a few typical invocations of e.g. --samples/--time/--continuous.
  74  * Add an -L|--list-supported option; this used to be part of -V (bug #604).
  75  * Drop the superfluous -S|--protocol-decoder-stack option. Stacking can
  76    be done by simply using -P and providing the decoders in the correct order.
  77  * Allow multiple -P options to decode multiple stacks (bug #868).
  78  * Show decoder instance IDs so the user can tell instances apart (bug #868).
  79  * Show annotations based on decoder ID (not instance ID).
  80    - Behaviour preserved:
  81      Single PD, no -A flag => all annotations from PD
  82      Single PD, -A pdid => all annotations from PD
  83      Single PD, -A pdid=annX => annX from PD
  84    - Behaviour now added:
  85      Duplicate PDs, no -A flag => all annotations from all PDs
  86      Duplicate PDs, -A pdid => all annotations from all PDs of type pdid
  87      Duplicate PDs, -A pdid=annX => all annX from all PDs of type pdid
  88  * Fix various memory leaks.
  89  * ./configure summary: Show linker flags used.
  90  * NSIS:
  91    - Update to Python 3.4.x. We can't use any higher version for the time
  92      being, since 3.4.x is the last version to support Windows XP.
  93    - Place the example .sr files in a separate installer section.
  94    - Limit example .sr files to a small set to shrink the installer size.
  95    - Clarify Start menu links (e.g. "Uninstall") to avoid confusion.
  96  * HACKING: Update URL to Linux kernel coding style.
  97  * Fix some compiler warnings (clang).
  98
  99 0.6.0 (2016-01-29)
 100 ------------------
 101
 102  * Update sigrok-cli to the new APIs from both libsigrok 0.4.0 and also
 103    libsigrokdecode 0.4.0.
 104  * Updated build requirements:
 105    - libglib >= 2.32.0
 106    - libsigrok >= 0.4.0
 107    - libsigrokdecode >= 0.4.0
 108  * Fix various compiler errors/warnings.
 109  * Check srd_decoder_get_by_id() output to prevent a segfault (bug #370).
 110  * manpage: Document the -M and -B options.
 111  * Improve option parsing code and make it more robust.
 112  * Drop references to obsolete sigrok-commits mailing list.
 113  * Properly handle saving logic data packets of any size.
 114  * Add 'analog' output module to default output.
 115  * Fix various memory leaks.
 116  * Show PD annotation row members by name, not number (bug #388).
 117  * Handle floating point options for output modules.
 118  * If only one non-demo device is present, select it.
 119  * Allow input from stdin by specifying "-i -".
 120  * Support uint64 input/output module options.
 121  * Command line option changes:
 122    - Add the --get option.
 123    - Add the -T|--transform-module option.
 124  * Always save all channels to a session file (bug #410).
 125  * Support boolean command line options (bug #450).
 126  * NSIS:
 127    - Drop libusb0.dll, we always use libusb-1.0 now.
 128    - Add start menu entries for Zadig (bug #543).
 129    - Install data files into a 'share' subdirectory.
 130    - Various additional NSIS file improvements.
 131  * Fix a runtime warning with --show (bug #520).
 132  * Add "-git-<hash>" suffix to development version numbers.
 133  * Fix a libzip-related issue resulting in errors writing .sr files (bug #570).
 134  * Fix a unitsize related issue (bug #352).
 135  * Add support for SR_T_MQLIST and SR_T_MQ.
 136  * Modernize the whole autotools setup.
 137
 138 0.5.0 (2014-05-06)
 139 ------------------
 140
 141  * Update sigrok-cli to the new APIs from both libsigrok 0.3.0 and also
 142    libsigrokdecode 0.3.0.
 143  * Add support for the new channel groups feature in libsigrok.
 144  * Report channel groups (drivers) and annotation rows (PDs) in --show.
 145  * The protocol decoder output verbosity now depends on the --loglevel used.
 146  * Only show the longest annotation per default if multiple are provided by
 147    the PD. Higher numbers for the -l option will show them all.
 148  * Allow both hex and decimal numbers as values for command-line options.
 149  * Add support for an explicit "sigrok" file format option that can be
 150    used with --input-format or --output-format (bug #131).
 151  * If no PD annotation class is specified, default to showing all (bug #149).
 152  * Fix an issue when running decoders with optional channels (bug #138).
 153  * Report possible PD option values in --show output (bug #330).
 154  * Allow saving of output in continuous mode (bug #122).
 155  * Add support for libsigrok's SR_T_DOUBLE_RANGE config key (bug #335).
 156  * Add support for config keys of type G_VARIANT_TYPE_INT32.
 157  * Fix a bug which involved trying to save a file containing no data.
 158  * Fix an internal probe ordering issue (bug #268).
 159  * Fix various memory leak issues (bug #134, others).
 160  * Fix a bug causing samplerates in session files being zero (bug #340).
 161  * Fix segfault during analog acquisition without '-O analog' (bugs #90, #105).
 162  * Fix a compile issue when building without libsigrokdecode (bug #351).
 163  * Command line option changes:
 164    - Add the -g|--channel-group option.
 165    - Add the -M option (for PD meta output type support).
 166    - Add the -B option (for PD binary output type support).
 167    - Rename the -p|--probes option to -C|--channels.
 168  * Various improvements to the NSIS file for better Windows installer support.
 169    - Ship (redistributable) firmware files in the Windows installer.
 170    - Ship libusb0.dll in the Windows installer (bug #243).
 171    - Ship zadig.exe and zadig_xp.exe in the Windows installer.
 172    - Ship all sample files from sigrok-dumps in the Windows installer.
 173    - Don't ship/run the full Python MSI installer, only the required files.
 174    - Fix a working directory issue in the installer.
 175  * Build system:
 176    - Use a non-recursive automake setup (fewer files, less clutter).
 177    - configure output: Show which libs are required and which are optional.
 178  * manpage: Various documentation updates.
 179
 180 0.4.0 (2013-05-04)
 181 ------------------
 182
 183  * Update sigrok-cli to the new APIs from both libsigrok 0.2.0 and also
 184    libsigrokdecode 0.2.0.
 185  * Add support for handling analog data sources (DMMs, scopes, dataloggers).
 186  * Bugfix in the handling of -A options with arguments.
 187  * Updated build dependencies list.
 188    - glib (required): Now must be >= 2.28.0.
 189    - libsigrok (required): Now must be >= 0.2.0.
 190    - libsigrokdecode (required): Now must be >= 0.2.0.
 191  * Add support for specifying input format options.
 192  * Probe numbers now generally start at 0 (not 1).
 193  * Command line option changes:
 194    - The -D|--list-devices option was renamed to --scan.
 195    - The -d|--device option was renamed to -c|--config.
 196    - The -a|--protocol-decoders option was renamed to -P|--protocol-decoders.
 197    - The -s|--protocol-decoder-stack option was renamed to
 198      -S|--protocol-decoder-stack.
 199    - Added a --driver option to specify which libsigrok driver is to be used.
 200    - Added a --show option. This can show details about drivers or PDs.
 201    - Added a --frames option which limits the number of frames to get from
 202      a supported oscilloscope (or other frame-based device).
 203  * Various documentation updates (README, manpage, and so on).
 204  * configure: Don't overwrite CFLAGS, but rather amend it.
 205
 206 0.3.1 (2012-05-30)
 207 ------------------
 208
 209  * Add a ChangeLog file to the tarball.
 210  * -V option: If "-l 3" or higher is used, the PD description is shown, too.
 211  * -a option: Print optional/required PD probes. Example: sigrok-cli -a uart.
 212  * Fix compiling with "Homebrew" (Mac OS X).
 213  * Stacking order doesn't have to be specified if it's the same as the
 214    PD list. Example: sigrok-cli -i <file.sr> -a i2c,edid -s i2c,edid.
 215    The -s option is no longer required in this special case.
 216  * Only output module or PD output goes to stdout, everything else to stderr.
 217  * Improved error handling: Stop sigrok-cli upon various PD related errors.
 218  * New -A | --protocol-decoder-annotations option which allows the user to
 219    select which annotation types (and from which PD in the stack) to show.
 220  * Update the manpage.
 221  * Fix a Makefile.am bug which caused the generated ChangeLog files being
 222    accidentally deleted upon 'make distclean'.
 223
 224 0.3.0 (2012-04-17)
 225 ------------------
 226
 227  * New major version, now depends on libsigrok and libsigrokdecode.
 228  * Initial support for protocol decoders (written in Python >= 3).
 229    Supports streaming processing, and stacking of protocol decoders.
 230    Currently supported: dcf77, mx25lxx05d, i2s, spi, edid, pan1321, mlx90614,
 231    rtc8564, transitioncounter, usb, i2cdemux, i2c, i2cfilter, uart.
 232  * Add support for the ChronoVu LA8 logic analyzer.
 233  * Add support for the ChronoVu LA8 input- and output-formats.
 234  * Add support for the CSV output format.
 235  * New CLI options: --loglevel, --input-format, --protocol-decoders, and
 236    --protocol-decoder-stack.
 237  * Changed CLI options: Rename -f|--format to -O|--output-format.
 238  * Demo driver: Add all-low and all-high pattern support.
 239  * Saleae Logic driver: Initial support for multiple attached devices.
 240  * OLS driver: Run-Length Encoding (RLE) support.
 241  * Various portability fixes for Mac OS X and MinGW/Windows.
 242  * Many bugfixes, improvements, and documentation updates.
 243
 244 0.2.0 (2011-04-03)
 245 ------------------
 246
 247 This is mostly a bugfix release.
 248
 249  * Fix session saving & input file loading, implement session loading support.
 250  * Initial work on an NSIS-based Windows installer for sigrok.
 251  * CLI: Change syntax for -d and -f to <thing>:key=value:key2=value2.
 252  * Various bugfixes, internal code improvements, and documentation updates.
 253  * Improve MinGW/Windows support in sigrok, fix various Windows issues.
 254  * Improve Openbench Logic Sniffer output format support and add metadata
 255    support (requires jawi's OLS client >= 0.9.4-rc1).
 256  * Add FreeBSD support for sigrok.
 257  * Add initial doxygen support (sigrok API documentation).
 258  * ASIX SIGMA: Fix a firmware loading bug.
 259
 260 0.1.0 (2011-01-20)
 261 ------------------
 262
 263  * Initial release.
 264