File: DS2404.man

package info (click to toggle)
owfs 3.2p3+dfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 8,688 kB
  • sloc: ansic: 65,085; pascal: 5,957; tcl: 2,688; makefile: 1,357; python: 1,114; sh: 891; cs: 623; php: 600; perl: 587; java: 404; ruby: 289; cpp: 105; asm: 102; xml: 53
file content (384 lines) | stat: -rw-r--r-- 6,045 bytes parent folder | download | duplicates (2)
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
'\"
'\" Copyright (c) 2003-2004 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Device manual page for the OWFS -- 1-wire filesystem package
'\" Based on Dallas Semiconductor, Inc's datasheets, and trial and error.
'\"
'\" Free for all use. No warranty. None. Use at your own risk.
'\"
.TH DS2404 3  2006 "OWFS Manpage" "One-Wire File System"
.SH NAME
.B DS2404
\- EconoRAM time chip
.TP
.B DS2404S
\- Dual port memory plus time
.TP
.B DS1994
\- 4k plus time iButton
.TP
.B DS1427
\- Time iButton
.SH SYNOPSIS
Real time clock, 4kbit memory. 3-wire interface, too.
.P
.B 04.XXXXXXXXXXXX 
/
.B alarm
|
.B auto
|
.B cycle
|
.B date
|
.B delay
|
.B interval
|
.B memory
|
.B pages/page.[0-15|ALL]
|
.B readonly/[memory|clock|cycle|interval]
|
.B memory
|
.B pages/page.[0-15|ALL]
|
.B readonly/[memory|clock|cycle|interval]
|
.B running
|
.B set_alarm
|
.B start
|
.B trigger/[cycle,date,interval,udate,uinterval]
|
.B udate
|
.B uinterval
|
.so man3/standard_mini.3so
.P
.B 84.XXXXXXXXXXXX
/
.B alarm
|
.B auto
|
.B cycle
|
.B date
|
.B delay
|
.B interval
|
.B memory
|
.B pages/page.[0-15|ALL]
|
.B readonly/[memory|clock|cycle|interval]
|
.B running
|
.B set_alarm
|
.B start
|
.B trigger/[cycle,date,interval,udate,uinterval]
|
.B udate
|
.B uinterval
|
.B address
|
.B crc8
|
.B id
|
.B present
|
.B type
.SH FAMILY CODE
.TP
.I 04
DS2404 DS1994
.TP
.I 84
DS1427 DS2404S
.SH SPECIAL PROPERTIES
.SS alarm
.I read-write, unsigned integer (0-111)
.br
.I Alarm
state of the
.I DS2404 (3)
triggered by time or counter events. Reading the alarm state clears the alarm.
.br
The 
.I alarm
value is of the form CIR, where:
.TP
C
.I cycle 
counter alarm
.br
.I 0
no
.br
.I 1
yes
.TP
I
.I interval
timer alarm
.br
.I 0
no
.br
.I 1
yes
.TP
R
real-time clock alarm
.br
.I 0
no
.br
.I 1
yes
.SS auto
.I read-write, yes-no
.br
Flag for mode of 
.I interval
counter operation. 0=manual 1=auto
.br
See the 
.I datasheet
for details.
.SS date
.I read-write, ascii
.br
26 character date representation of the
.I udate
value. Increments once per second while
.I running
.br
Actual internal representation has higher precision.
.br
Cannot be altered if
.I readonly/clock
is set.
.br
Setting
.I date
to a null string will put the current system time.
.br
Accepted date formats are:
.br
  Sat[urday] March 12 12:23:59 2001
.br
  Apr[il] 4 9:34:56 2002
.br
  3/23/04 23:34:57
.br
  current locale setting (your system's format)
.SS delay
.I read-write, yes-no
.br
Flag for adding a delay to
.I cycle
counter. 0=short 1-long
.br
See the 
.I datasheet
under "IDEL" for details.
.SS interval
.I read-write, date
.br
Interval timer value, represented as a 
.I date
string. More typically will be used as
.I uinterval
to read the actual elapsed seconds.
.SS memory
.I read-write, binary
.br
512 bytes of memory. The
.I readonly/memory
flag prevents further change.
.SS pages/page.0 ... pages/page.15 pages/page.ALL
.I read-write, yes-no
.br
Memory is split into 16 pages of 32 bytes each. The
.I readonly/memory
flag prevents further change.
.I ALL
is an aggregate of the pages. Each page is accessed sequentially.
.SS readonly/[memory|clock|interval|cycle]
.I read-write, yes-no
.br
Permanently protect part of the chip's function from alteration.
.TP
.I readonly/memory
.I page.X
and
. I memory
.TP
.I readonly/clock
.I date
and
.I udate
.TP
.I readonly/interval
.I interval
.TP
.I readonly/cycle
.I cycle
.SS running
.I read-write, yes-no
.br
State of the clock. 0=off 1=running.
.SS set_alarm
.I read-write, unsigned integer (0-111)
.br
Which of the
.I alarm
triggers are enabled in the
.I DS2404 (3)
.br
The 
.I set_alarm
value is of the form CIR, where:
.TP
C
.I cycle 
counter alarm
.br
.I 0
no
.br
.I 1
yes
.TP
I
.I interval
timer alarm
.br
.I 0
no
.br
.I 1
yes
.TP
R
real-time clock alarm
.br
.I 0
no
.br
.I 1
yes
.SS start
.I read-write, yes-no
.br
Flag for starting the 
.I interval
counter operation if not in 
.I auto
mode. 0=stop 1=start
.br
See the 
.I datasheet
for details.
.SS trigger/[cycle,date,interval,udate,uinterval]
.I read-write,varies
.br
Target value that will
.I trigger
the 
.I alarm
if the corresponding
.I set_alarm
field is set.
.br
The format is the same as the similarly named field (i.e.
.I date
for
.I trigger/date
)
.SS udate
.I read-write, unsigned integer
.br
Time represented as a number.
.I udate
increments once per second, while
.I running
is on.
.br
Usually set to unix time standard: number of seconds since Jan 1, 1970. The
.I date
field will be the unix representation of
.I udate
and setting either will change the other.
.SS uinterval
.I read-write, unsigned interval
.br
Similar to the 
.I udate
field, except corresponds to the
.I interval
value.
.SH STANDARD PROPERTIES
.so man3/standard.3so
.SH ALARMS
None implemented.
.SH DESCRIPTION
.so man3/description.3so
.SS DS1427 DS1994 DS2404 DS2404S
The
.B DS1427 (3), DS1994 (3), DS2404 (3),
and
.B DS2404S (3)
family of 1-wire devices includes clock functions, with timers, memory, counters and alarms. It is possible to write-protect regians of memory. Uses include software or hardware timing and control.
.P
.SS Chips
Both the
.B DS2404 (3)
and
.B DS2404S (3)
have 1-wire and 3-wire interfaces, which might be useful for transferring data between the 2 buses. They act as a passive slave to both buses. The
.B DS2404 (3)
and
.B DS2404S (3)
require an external source of power and an external crystal. They also offer a reset and 1HZ clock pin.
.P
.SS iButtons
Both the
.B DS1427
and
.B DS1994
offer the memory, alarms, and clock function in iButton format. Because the iButton is a complete sealed package, battery and crystal are internal. Everything is access via the 1-wire interface.
.SH ADDRESSING
.so man3/addressing.3so
.SH DATASHEET
.br
http://pdfserv.maxim-ic.com/en/ds/DS2404.pdf
.br
http://pdfserv.maxim-ic.com/en/ds/DS2404S-C01.pdf
.br
http://pdfserv.maxim-ic.com/en/ds/DS1994.pdf
.br
http://pdfserv.maxim-ic.com/en/ds/DS1427.pdf
.SH SEE ALSO
.so man3/seealso.3so
.SH AVAILABILITY
http://www.owfs.org
.SH AUTHOR
Paul Alfille (paul.alfille@gmail.com)