Gerhard Sittig [Sun, 2 Oct 2022 12:14:11 +0000 (14:14 +0200)]
README: discuss installation of example captures
The sigrok-dumps repository differs from other components in that it's
neither autotoolized nor uses cmake. Which results in the necessity to
specify non-obvious commands to install the captures without actually
building them.
Introduce an "Installing" README section. Provide example commands for
'make install' invocations.
Gerhard Sittig [Sun, 2 Oct 2022 12:08:00 +0000 (14:08 +0200)]
Makefile: use PREFIX in "make install", use DESTDIR in traditional ways
Commit 4fafe8159940 as of 2012-05-14 introduced a simple "make install"
target. Unfortunately it used the DESTDIR variable to mean the location
where captures get installed to (relative to the target filesystem's
root). But traditionally DESTDIR is an optional "root directory" owned
by packagers or used for cross build installs. While the install location
within the filesystem should be relative to a --prefix spec which users
can control during build.
Use DESTDIR during installation in its traditional meaning, accept when
it's specified externally, but don't modify it locally. Use PREFIX to
mean the in-filesystem base directory which share/... gets appended to.
Provide a backwards compatible builtin, accept an external override.
$ make PREFIX=${HOME} install
$ make DESTDIR=$( pwd )/rootfs install
Add a developer comment. Ideally we would not have to roll DIY shell
commands, and use a higher level build tool instead. The reason that
this has not been done yet might be the portable construction of the
list of directories to install at compile time (a guess).
Gerhard Sittig [Sun, 2 Oct 2022 12:03:00 +0000 (14:03 +0200)]
Makefile: explicitly list which example capture subdirs to install
Commit 4fafe8159940 as of 2012-05-14 introduced a simple "make install"
target. The asterisk wildcard and the additional Makefile "negation" use
to work for clean checkouts, but are considered too greedy a pattern for
locally modified work areas during development.
Explicitly list which subdirs to install to the filesystem. Which
improves robustness, avoids clutter, and is considered acceptable
maintenance overhead since adding more top level directories should
be rare an event. The explicit list is also easy to trim down should
developers want that during local work.
Phrase the subdirectories list such that users can specify additional
items in the "make install" invocation.
Gerhard Sittig [Tue, 18 Aug 2020 18:19:42 +0000 (20:19 +0200)]
sle44xx: extend the README for the SLE4442 captures
Create a README in the sle44xx/ parent directory, discuss the chip
family's features, and reference the Siemens datasheet. Extend the
README for the SLE4442 captures, don't assume that all users are
familiar with the chips and their protocol. The example dumps also
serve for learning and exploration of the curious. Fixup the probe
names (according to --show their names are in the 0..7 range).
Gerhard Sittig [Sun, 26 Jul 2020 06:49:42 +0000 (08:49 +0200)]
ir_nec: add capture for extended NEC protocol
This is a modified version of a capture that was Submitted-By: Sebastian Rittau <redacted>
The file was provided as an attachment to bug #1583. I renamed the file,
renamed the probe for automatic assignment to the decoder, upsampled to
100kHz for compatibility with the IRMP decoder, and added a README.
Gerhard Sittig [Mon, 20 Jul 2020 20:03:21 +0000 (22:03 +0200)]
ir_sirc: add captures for Sony IR (SIRC)
Captures were provided by Tom Flanagan <redacted>. I renamed the
files and the probes, added a README, and trimmed several seconds of
idle input signal.
Gerhard Sittig [Sat, 18 Jul 2020 19:25:23 +0000 (21:25 +0200)]
caliper: rename dump files and probes
Rename captures to the "caliper*.sr" pattern. This avoids names which
start with dashes and could result in surprises. Users still can tell
whether to expect positive or negative values without too much effort.
Rename the probes. It's absolutely confusing to provide RXD and TXD
names for a protocol that has CLK and DATA signals. And users had to
manually assign the traces to decoder inputs after guessing which might
be which (it's not as obvious for calipers as I2C or SPI would be).
Gerhard Sittig [Mon, 22 Jun 2020 18:13:15 +0000 (20:13 +0200)]
pjon/pjdl: add capture of minimal PJON frames over PJDL link layer
The PJON protocol can use several link layers. These captures run on
PJDL, demonstrate a minimal PJON frame (with TX info) and a response.
And also contain a few exceptional conditions: Glitches in the signal,
outside and inside of frames. Lack of recipient's response, too.
The snippets were extracted from a capture that was Submitted-By: Julio Aguirre <redacted>
Gerhard Sittig [Thu, 2 Jan 2020 19:49:26 +0000 (20:49 +0100)]
misc/vcd: introduce VCD example files with not yet supported features
The VCD input module of the libsigrok library currently exclusively
supports single bit logic data. Provide some captures in the VCD format
which exercise currently unsupported features which a future version of
the input module might want to support (bit vectors, multi bit numbers,
analog signals).
projects / sigrok-dumps.git / log