'\" t
.\"     Title: w1retap
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 01/06/2017
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "W1RETAP" "1" "01/06/2017" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
w1retap \- Data logger for 1\-Wire weather sensors
.SH "SYNOPSIS"
.sp
\fBw1retap\fR [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.sp
The w1retap package reads weather sensors on a 1\-Wire bus and data logs the retrieved data to the configured databases or files\&. It supports a number of different 1\-Wire host bus adapters and 1\-Wire sensors designed by Dallas Semiconductor Corp (now Maxim Integrated) and compatible sensors including those from AAG Electrónica and other hobby sensors\&.
.SH "OPTIONS"
.PP
\fB\-h, \-\-help\fR
.RS 4
Show help options
.RE
.PP
\fB\-w, \-\-wait\fR
.RS 4
At startup, wait until next interval
.RE
.PP
\fB\-1, \-\-once\-only\fR
.RS 4
Read once and exit
.RE
.PP
\fB\-R, \-\-release\-interface\fR
.RS 4
Release the 1Wire interface between reads
.RE
.PP
\fB\-d, \-\-daemonise\fR
.RS 4
Daemonise (background) application
.RE
.PP
\fB\-T, \-\-no\-tmp\-log\fR
.RS 4
Disables /var/lib/w1retap/\&.w1retap\&.dat logging
.RE
.PP
\fB\-l, \-\-tmp\-log\-name\fR=\fIFILE\fR
.RS 4
Names logging file (/var/lib/w1retap/\&.w1retap\&.dat)
.RE
.PP
\fB\-i, \-\-interface\fR=\fIDEVICE\fR
.RS 4
Interface device, the DEVICE can be serial DS2480 adaptor or a USB DS2490\-1 adaptor\&. Use the serial device node (eg /dev/ttyS0 or /dev/ttyUSB0) for serial or use DS2490\-1 to use libusb for a USB adaptor\&.
.RE
.PP
\fB\-t, \-\-cycle\-time\fR=\fISECS\fR
.RS 4
Time (secs) between device readings
.RE
.PP
\fB\-N, \-\-dont\-read\fR
.RS 4
Don\(cqt read sensors (for debugging)
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Verbose messages
.RE
.PP
\fB\-o, \-\-vane\-offset\fR=\fIVAL\fR
.RS 4
Value for N for weather vane (0\-15)
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version number (and exit)
.RE
.PP
\fB\-s, \-\-simulate\fR
.RS 4
Simulate readings (for testing, not yet implemented)
.RE
.PP
\fB\-u, \-\-use\-utc\fR
.RS 4
Store dates as UTC (vice localtime)
.RE
.PP
\fB\-r, \-\-report\-log\fR=\fIFILE\fR
.RS 4
Report log file
.RE
.SH "EXAMPLE"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
$ w1retap \-l \-i /dev/ttyUSBS0 \-v
.RE
.SH "SIGNALS"
.sp
The w1retap daemon accepts three signals\&. SIGUSR1 causes it to read all the sensors immediately\&. SIGUSR2 causes it to print the current configuration\&. SIGHUP causes it to re\-read the configuration\&.
.SH "EXIT STATUS"
.PP
\fB0\fR
.RS 4
Returns 0 on success or failure
.RE
.SH "SEE ALSO"
.sp
w1find(1), w1sensors(1)
.SH "RESOURCES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
/usr/share/doc/w1retap\-doc/w1retap\&.odt
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
http://www\&.zen35309\&.zen\&.co\&.uk/wx/tech\&.html
.RE
.SH "AUTHOR"
.sp
This manual page was written by Thomas Stewart <thomas@stewarts\&.org\&.uk> for the Debian GNU/Linux system (but may be used by others)\&. Permission is granted to modify and distribute this manpage under the terms of GNU General Public Licence version 2 or (at your oppinion) any later version\&.