Skip to content
This repository was archived by the owner on Feb 25, 2024. It is now read-only.

Commit e93c93e

Browse files
author
René Ladan
committed
README.md : make things easier to understand after a private email discussion
1 parent 0184898 commit e93c93e

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ The software comes with three binaries and a library:
1616
* dcf77pi : Live decoding from the GPIO pins in interactive mode. Useable keys
1717
are shown at the bottom of the screen. The backspace key can be used to
1818
correct the last typed character of the input text (when changing the name of
19-
the log file).
19+
the log file). Depending on the permissions of your GPIO device node (the
20+
files in /dev), you might need to run this program as root or with sudo.
2021
* dcf77pi-analyze filename : Decode from filename instead of the GPIO pins.
2122
Output is generated in report mode.
2223
* readpin [-q] : Program to test reading from the GPIO pins and decode the
@@ -25,23 +26,25 @@ The software comes with three binaries and a library:
2526
* -q do not show the raw input, default is to show it.
2627
* libdcf77.so: The shared library containing common routines for reading bits
2728
(either from a log file or the GPIO pins) and to decode the date, time and
28-
third party buffer. Both dcf77pi and dcf77pi-analyze use this library. Header
29+
third party buffer. Both dcf77pi and dcf77pi-analyze use this library. Header
2930
files to use the library in your own software are supplied.
3031

3132
The meaning of the keywords in config.txt is:
3233

33-
* pin = GPIO pin number
34+
* pin = GPIO pin number (0-65535)
3435
* iodev = GPIO device number (FreeBSD only)
3536
* activehigh = pulses are active high (1) or passive high (0)
36-
* freq = sample frequency in Hz
37+
* freq = sample frequency in Hz (10-155000)
3738
* summermonth = month in which daylight saving time starts
3839
* wintermonth = month in which daylight saving time ends
3940
* leapsecmonths = months (in UTC) in which a leap second might be inserted
4041
* outlogfile = name of the output logfile which can be read back using
41-
dcf77pi-analyze (default empty)
42+
dcf77pi-analyze (default empty). The log file itself only stores the
43+
received bits, but not the decoded date and time.
4244

4345
Note that a value of 0 can be used for summermonth, wintermonth, or
4446
leapsecmonths to disallow daylight saving time changes or leap seconds.
47+
Otherwise use one or more values from 1 to 12.
4548

4649
The end of the minute is noted by the absence of high pulses. An absence of low
4750
pulses probably means that the transmitter is out of range. Any other situation
@@ -55,3 +58,13 @@ Currently supporrted platforms:
5558
* FreeBSD, Linux: full support
5659
* Cygwin, MacOS, NetBSD: supported without GPIO communication for live decoding
5760
* Windows: only via Cygwin
61+
62+
On Linux, you will have to install an (n)curses package development using your
63+
package manager to get the required header files and the .so library file.
64+
For example:
65+
% sudo apt-get install ncurses-devel
66+
67+
To build and install the program into /usr/bin , the library into /usr/lib and
68+
the configuration file into /usr/etc/dcf77pi :
69+
% make PREFIX=/usr
70+
% sudo make install PREFIX=/usr

0 commit comments

Comments
 (0)