~ubuntu-branches/debian/jessie/digitemp/jessie

« back to all changes in this revision

Viewing changes to digitemp.1

  • Committer: Bazaar Package Importer
  • Author(s): Jesus Roncero
  • Date: 2004-09-01 01:34:37 UTC
  • Revision ID: james.westby@ubuntu.com-20040901013437-eicsrrd40dr371u0
Tags: upstream-3.3.2
Import upstream version 3.3.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH DIGITEMP 1 "June 2003"
 
2
.\" Some roff macros, for reference:
 
3
.\" .nh        disable hyphenation
 
4
.\" .hy        enable hyphenation
 
5
.\" .ad l      left justify
 
6
.\" .ad b      justify to both left and right margins
 
7
.\" .nf        disable filling
 
8
.\" .fi        enable filling
 
9
.\" .br        insert line break
 
10
.\" .sp <n>    insert n+1 empty lines
 
11
.\" for manpage-specific macros, see man(7)
 
12
.SH NAME
 
13
digitemp \- program to read from temperature sensors. 
 
14
.SH SYNOPSIS
 
15
.B digitemp
 
16
.RI [ options ] 
 
17
.SH DESCRIPTION
 
18
DigiTemp uses the Dallas 1-wire bus to read temperatures from digital
 
19
sensors attached to a serial port adapter. It handles initializing the bus,
 
20
searching for attached devices, reading devices and custom log strings. It
 
21
suports the following temperature devices: DS1820, DS18S20, DS18B20, DS1822
 
22
.PP
 
23
It also handles the DS2406 1-wire hub switches, and DS2422 and DS2423
 
24
counters.
 
25
.PP
 
26
DigiTemp uses either the DS9097 passive serial port adapter, or the
 
27
DS2480B based DS9097U adapter (recommended).
 
28
.SH OPTIONS
 
29
At least 1 action must be given, along with some optional arguments. Actions
 
30
are one (and only on) of the 
 
31
.B \-w \-t \-a \-w 
 
32
options
 
33
.TP
 
34
.B \-h, \-?
 
35
Show summary of options.
 
36
.TP
 
37
.B \-v
 
38
Show verbose output.
 
39
.TP
 
40
.B \-i 
 
41
Initialize .digitemprc file, search the bus for all supported devices.
 
42
.TP
 
43
.B \-w
 
44
Walk the full device tree and display the serial number and type of all
 
45
devices detected on the bus.
 
46
.TP
 
47
.B \-s /dev/ttyS0
 
48
Set serial port to use. Make sure you have permission to access this port.
 
49
.TP
 
50
.B \-l /var/log/temperature
 
51
Send output to logfile, the output format is defined by the .B \-o
 
52
command
 
53
.TP
 
54
.B \-c digitemp.conf
 
55
Set digitemp configuration file. The default is .digitemprc in the current 
 
56
directory.
 
57
.TP
 
58
.B \-r 1000
 
59
Read delay in ms. This sets the amount of time to wait between sending the
 
60
temperature conversion command and reading the result. The DS18S20 takes
 
61
about 750mS to do the temperature conversion. Default is 1000mS (1 sec).
 
62
.TP
 
63
.B \-t #
 
64
Read sensor number #, the # depends on the order of the sensors in the
 
65
.digitemprc file.
 
66
.TP
 
67
.B \-q
 
68
Quiet output, no copyright banner.
 
69
.TP
 
70
.B \-a
 
71
Read all sensors.
 
72
.TP
 
73
.B \-d 5
 
74
Delay between samples (in seconds).
 
75
.TP
 
76
.B \-n 50
 
77
Number of times to repeat the command.
 
78
.TP
 
79
.B \-O"counter format string"
 
80
See Counter Format below.
 
81
.TP
 
82
.B \-o [1..3] ["output format string"]
 
83
See Temperature Format below.
 
84
.PP
 
85
.SH
 
86
Temperature Format
 
87
.PP
 
88
The temperature format can be either a numeric value, or a string. The
 
89
numeric values select pre-configured output formats:
 
90
.PP
 
91
    1 = One line per sensor, time, C, F (default) 
 
92
    2 = One line per sample, elapsed time, temperature in C
 
93
    3 = Same as #2, except temperature is in F
 
94
.PP
 
95
#2 and #3 have the data seperated by tabs, suitable for import into a 
 
96
spreadsheet or other graphing software.
 
97
.PP
 
98
The format string uses strftime tokens plus 5 special ones for
 
99
DigiTemp:
 
100
.TP
 
101
.B %s
 
102
for sensor #
 
103
.TP
 
104
.B %C
 
105
for centigrade
 
106
.TP
 
107
.B %F
 
108
for fahrenheit
 
109
.TP
 
110
.B %R
 
111
to output the hex serial number
 
112
.TP
 
113
.B %N
 
114
for seconds since Epoch.
 
115
.PP
 
116
The case of the token is important! The default format string is:
 
117
"%b %d %H:%M:%S Sensor %s C: %.2C F: %.2F" which gives you an
 
118
output of: May 24 21:25:43 Sensor 0 C: 23.66 F: 74.59
 
119
.PP
 
120
.SH
 
121
Counter Format String
 
122
.PP
 
123
The counter format string is similar, adding these tokens:
 
124
.TP
 
125
.B %n
 
126
is the counter #, which depends on its position in the .digitemprc file
 
127
.TP
 
128
.B %C
 
129
is the count in decimal.
 
130
.PP
 
131
.SH AUTHOR
 
132
This manual page was written by Jes�s Roncero <jesus@roncero.org>,
 
133
for the Debian project (but may be used by others). Modifications by Brian
 
134
C. Lane
 
135
.SH UPDATES
 
136
DigiTemp updates can be found on the http://www.digitemp.com website.
 
137