/
digitemp.1
180 lines (180 loc) · 4.86 KB
/
digitemp.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
.TH DIGITEMP 1 "August 2008"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
digitemp \- program to read from 1-wire temperature sensors.
.SH SYNOPSIS
.B digitemp
.RI [ options ]
.SH DESCRIPTION
DigiTemp uses the Dallas 1-wire bus to read temperatures from digital
sensors attached to a serial port adapter. It handles initializing the bus,
searching for attached devices, reading devices and custom log strings. It
supports the following temperature devices: DS1820, DS18S20, DS18B20, DS1822
.PP
It also handles the DS2406 1-wire hub switches, and DS2422 and DS2423
counters.
.PP
DigiTemp uses either the DS9097 passive serial port adapter, or the
DS2480B based DS9097U adapter. 1-wire adapters from ibuttonlink.com,
such as the Link45 are also supported.
.SH OPTIONS
At least 1 action must be given, along with some optional arguments. Actions
are one (and only on) of the
.B \-w \-t \-a \-w
options
.TP
.B \-h, \-?
Show summary of options.
.TP
.B \-v
Show verbose output.
.TP
.B \-i
Initialize .digitemprc file, search the bus for all supported devices.
.TP
.B \-I
Initialize .digitemprc file, search the bus for all supported devices, store devices
in sorted serial # order.
.TP
.B \-w
Walk the full device tree and display the serial number and type of all
devices detected on the bus.
.TP
.B \-s /dev/ttyS0
Set serial port to use. Make sure you have permission to access this port. For USB
operation pass USB instead of /dev/ttySX
.TP
.B \-l /var/log/temperature
Send output to logfile, the output format is defined by the .B \-o
command
.TP
.B \-c digitemp.conf
Set digitemp configuration file. The default is .digitemprc in the current
directory.
.TP
.B \-r 1000
Read delay in ms. This sets the amount of time to wait between sending the
temperature conversion command and reading the result. The DS18S20 takes
about 750mS to do the temperature conversion. Default is 1000mS (1 sec).
.TP
.B \-t #
Read sensor number #, the # depends on the order of the sensors in the
\&.digitemprc file.
.TP
.B \-q
Quiet output, no copyright banner.
.TP
.B \-a
Read all sensors.
.TP
.B \-A
Treat DS2438 as A/D converter, output raw voltages and currents.
.TP
.B \-d 5
Delay between samples (in seconds).
.TP
.B \-n 50
Number of times to repeat the command.
.TP
.B \-O"counter format string"
See Counter Format below.
.TP
.B \-o [1..3] ["output format string"]
See Temperature Format below.
.TP
.B \-H"Humidity format string"
See Humidity Format below.
.TP
.B \-V"ADC format"
See voltage ADC format below.
.PP
.SH
Temperature Format
.PP
The temperature format can be either a numeric value, or a string. The
numeric values select pre-configured output formats:
.PP
1 = One line per sensor, time, C, F (default)
2 = One line per sample, elapsed time, temperature in C
3 = Same as #2, except temperature is in F
.PP
#2 and #3 have the data separated by tabs, suitable for import into a
spreadsheet or other graphing software.
.PP
The format string uses strftime tokens plus 5 special ones for
DigiTemp:
.TP
.B %s
for sensor #
.TP
.B %C
for centigrade
.TP
.B %F
for fahrenheit
.TP
.B %R
to output the hex serial number
.TP
.B %N
for seconds since Epoch.
.PP
The case of the token is important! The default format string is:
"%b %d %H:%M:%S Sensor %s C: %.2C F: %.2F" which gives you an
output of: May 24 21:25:43 Sensor 0 C: 23.66 F: 74.59
.PP
The DS2438 sensor can be used for a variety of things. It includes a
temperature sensor and A/D converter. DigiTemp defaults to using it as a
humidity sensor. The raw voltages and currents can be displayed by passing
the \-A argument
.PP
When the \-o2 or \-o3 log options are used the attached DS2438's temperatures
will be output without the humidity.
.PP
.SH
Counter Format String
.PP
The counter format string is similar, adding these tokens:
.TP
.B %n
is the counter #, which depends on its position in the .digitemprc file
.TP
.B %C
is the count in decimal.
.PP
.SH
Humidity Format String
.PP
The Humidity format string is the same as the temperature format string
with the addition of this format specifier:
.TP
.B %h
is the humidity in 0-100%
.PP
.SH
Voltage Format String
.PP
The A/D converter (ADC) format is the same as the temperature format
string with the addition of two format specifiers:
.TP
.B %Q
for Vdd measurement (unit V "Volt"),
.B %q
for the analog input voltage Vad (unit V "Volt"), and
.B %J for Vsense (unit mV).
.PP
.SH AUTHOR
This manual page was written by Jes\['u]s Roncero <jesus@roncero.org>,
for the Debian project (but may be used by others). Modifications by Brian
C. Lane <bcl@brianlane.com>
.SH UPDATES
DigiTemp updates can be found on the http://www.digitemp.com website.