Support multiple protocol decoder stacks
[sigrok-cli.git] / NEWS
1 0.6.0 (2016-01-29)
2 ------------------
3
4  * Update sigrok-cli to the new APIs from both libsigrok 0.4.0 and also
5    libsigrokdecode 0.4.0.
6  * Updated build requirements:
7    - libglib >= 2.32.0
8    - libsigrok >= 0.4.0
9    - libsigrokdecode >= 0.4.0
10  * Fix various compiler errors/warnings.
11  * Check srd_decoder_get_by_id() output to prevent a segfault (bug #370).
12  * manpage: Document the -M and -B options.
13  * Improve option parsing code and make it more robust.
14  * Drop references to obsolete sigrok-commits mailing list.
15  * Properly handle saving logic data packets of any size.
16  * Add 'analog' output module to default output.
17  * Fix various memory leaks.
18  * Show PD annotation row members by name, not number (bug #388).
19  * Handle floating point options for output modules.
20  * If only one non-demo device is present, select it.
21  * Allow input from stdin by specifying "-i -".
22  * Support uint64 input/output module options.
23  * Command line option changes:
24    - Add the --get option.
25    - Add the -T|--transform-module option.
26  * Always save all channels to a session file (bug #410).
27  * Support boolean command line options (bug #450).
28  * NSIS:
29    - Drop libusb0.dll, we always use libusb-1.0 now.
30    - Add start menu entries for Zadig (bug #543).
31    - Install data files into a 'share' subdirectory.
32    - Various additional NSIS file improvements.
33  * Fix a runtime warning with --show (bug #520).
34  * Add "-git-<hash>" suffix to development version numbers.
35  * Fix a libzip-related issue resulting in errors writing .sr files (bug #570).
36  * Fix a unitsize related issue (bug #352).
37  * Add support for SR_T_MQLIST and SR_T_MQ.
38  * Modernize the whole autotools setup.
39
40 0.5.0 (2014-05-06)
41 ------------------
42
43  * Update sigrok-cli to the new APIs from both libsigrok 0.3.0 and also
44    libsigrokdecode 0.3.0.
45  * Add support for the new channel groups feature in libsigrok.
46  * Report channel groups (drivers) and annotation rows (PDs) in --show.
47  * The protocol decoder output verbosity now depends on the --loglevel used.
48  * Only show the longest annotation per default if multiple are provided by
49    the PD. Higher numbers for the -l option will show them all.
50  * Allow both hex and decimal numbers as values for command-line options.
51  * Add support for an explicit "sigrok" file format option that can be
52    used with --input-format or --output-format (bug #131).
53  * If no PD annotation class is specified, default to showing all (bug #149).
54  * Fix an issue when running decoders with optional channels (bug #138).
55  * Report possible PD option values in --show output (bug #330).
56  * Allow saving of output in continuous mode (bug #122).
57  * Add support for libsigrok's SR_T_DOUBLE_RANGE config key (bug #335).
58  * Add support for config keys of type G_VARIANT_TYPE_INT32.
59  * Fix a bug which involved trying to save a file containing no data.
60  * Fix an internal probe ordering issue (bug #268).
61  * Fix various memory leak issues (bug #134, others).
62  * Fix a bug causing samplerates in session files being zero (bug #340).
63  * Fix segfault during analog acquisition without '-O analog' (bugs #90, #105).
64  * Fix a compile issue when building without libsigrokdecode (bug #351).
65  * Command line option changes:
66    - Add the -g|--channel-group option.
67    - Add the -M option (for PD meta output type support).
68    - Add the -B option (for PD binary output type support).
69    - Rename the -p|--probes option to -C|--channels.
70  * Various improvements to the NSIS file for better Windows installer support.
71    - Ship (redistributable) firmware files in the Windows installer.
72    - Ship libusb0.dll in the Windows installer (bug #243).
73    - Ship zadig.exe and zadig_xp.exe in the Windows installer.
74    - Ship all sample files from sigrok-dumps in the Windows installer.
75    - Don't ship/run the full Python MSI installer, only the required files.
76    - Fix a working directory issue in the installer.
77  * Build system:
78    - Use a non-recursive automake setup (fewer files, less clutter).
79    - configure output: Show which libs are required and which are optional.
80  * manpage: Various documentation updates.
81
82 0.4.0 (2013-05-04)
83 ------------------
84
85  * Update sigrok-cli to the new APIs from both libsigrok 0.2.0 and also
86    libsigrokdecode 0.2.0.
87  * Add support for handling analog data sources (DMMs, scopes, dataloggers).
88  * Bugfix in the handling of -A options with arguments.
89  * Updated build dependencies list.
90    - glib (required): Now must be >= 2.28.0.
91    - libsigrok (required): Now must be >= 0.2.0.
92    - libsigrokdecode (required): Now must be >= 0.2.0.
93  * Add support for specifying input format options.
94  * Probe numbers now generally start at 0 (not 1).
95  * Command line option changes:
96    - The -D|--list-devices option was renamed to --scan.
97    - The -d|--device option was renamed to -c|--config.
98    - The -a|--protocol-decoders option was renamed to -P|--protocol-decoders.
99    - The -s|--protocol-decoder-stack option was renamed to
100      -S|--protocol-decoder-stack.
101    - Added a --driver option to specify which libsigrok driver is to be used.
102    - Added a --show option. This can show details about drivers or PDs.
103    - Added a --frames option which limits the number of frames to get from
104      a supported oscilloscope (or other frame-based device).
105  * Various documentation updates (README, manpage, and so on).
106  * configure: Don't overwrite CFLAGS, but rather amend it.
107
108 0.3.1 (2012-05-30)
109 ------------------
110
111  * Add a ChangeLog file to the tarball.
112  * -V option: If "-l 3" or higher is used, the PD description is shown, too.
113  * -a option: Print optional/required PD probes. Example: sigrok-cli -a uart.
114  * Fix compiling with "Homebrew" (Mac OS X).
115  * Stacking order doesn't have to be specified if it's the same as the
116    PD list. Example: sigrok-cli -i <file.sr> -a i2c,edid -s i2c,edid.
117    The -s option is no longer required in this special case.
118  * Only output module or PD output goes to stdout, everything else to stderr.
119  * Improved error handling: Stop sigrok-cli upon various PD related errors.
120  * New -A | --protocol-decoder-annotations option which allows the user to
121    select which annotation types (and from which PD in the stack) to show.
122  * Update the manpage.
123  * Fix a Makefile.am bug which caused the generated ChangeLog files being
124    accidentally deleted upon 'make distclean'.
125
126 0.3.0 (2012-04-17)
127 ------------------
128
129  * New major version, now depends on libsigrok and libsigrokdecode.
130  * Initial support for protocol decoders (written in Python >= 3).
131    Supports streaming processing, and stacking of protocol decoders.
132    Currently supported: dcf77, mx25lxx05d, i2s, spi, edid, pan1321, mlx90614,
133    rtc8564, transitioncounter, usb, i2cdemux, i2c, i2cfilter, uart.
134  * Add support for the ChronoVu LA8 logic analyzer.
135  * Add support for the ChronoVu LA8 input- and output-formats.
136  * Add support for the CSV output format.
137  * New CLI options: --loglevel, --input-format, --protocol-decoders, and
138    --protocol-decoder-stack.
139  * Changed CLI options: Rename -f|--format to -O|--output-format.
140  * Demo driver: Add all-low and all-high pattern support.
141  * Saleae Logic driver: Initial support for multiple attached devices.
142  * OLS driver: Run-Length Encoding (RLE) support.
143  * Various portability fixes for Mac OS X and MinGW/Windows.
144  * Many bugfixes, improvements, and documentation updates.
145
146 0.2.0 (2011-04-03)
147 ------------------
148
149 This is mostly a bugfix release.
150
151  * Fix session saving & input file loading, implement session loading support.
152  * Initial work on an NSIS-based Windows installer for sigrok.
153  * CLI: Change syntax for -d and -f to <thing>:key=value:key2=value2.
154  * Various bugfixes, internal code improvements, and documentation updates.
155  * Improve MinGW/Windows support in sigrok, fix various Windows issues.
156  * Improve Openbench Logic Sniffer output format support and add metadata
157    support (requires jawi's OLS client >= 0.9.4-rc1).
158  * Add FreeBSD support for sigrok.
159  * Add initial doxygen support (sigrok API documentation).
160  * ASIX SIGMA: Fix a firmware loading bug.
161
162 0.1.0 (2011-01-20)
163 ------------------
164
165  * Initial release.
166