1DS2401(3)                    One-Wire File System                    DS2401(3)
2
3
4

NAME

6       DS2401 - Silicon Serial Number
7
8       DS1990A
9              - Serial Number iButton
10
11       01  [.]XXXXXXXXXXXX[XX][/[  address | crc8 | id | locator | r_address |
12       r_id | r_locator | type ]]
13

SYNOPSIS

15       Unique serial number only.
16

FAMILY CODE

18       01
19

SPECIAL PROPERTIES

21       None.
22

STANDARD PROPERTIES

24   address
25   r_address
26       read-only, ascii
27       The entire 64-bit unique ID. Given as  upper  case  hexidecimal  digits
28       (0-9A-F).
29       address starts with the family code
30       r address is the address in reverse order, which is often used in other
31       applications and labeling.
32
33   crc8
34       read-only, ascii
35       The 8-bit error correction portion. Uses cyclic redundancy check.  Com‐
36       puted  from  the  preceding  56  bits of the unique ID number. Given as
37       upper case hexadecimal digits (0-9A-F).
38
39   family
40       read-only, ascii
41       The 8-bit family code. Unique to each type of device.  Given  as  upper
42       case hexadecimal digits (0-9A-F).
43
44   id
45   r_id
46       read-only, ascii
47       The 48-bit middle portion of the unique ID number. Does not include the
48       family code or CRC. Given as upper case hexadecimal digits (0-9A-F).
49       r id is the id in reverse order, which is often used in other  applica‐
50       tions and labeling.
51
52   locator
53   r_locator
54       read-only, ascii
55       Uses  an  extension  of the 1-wire design from iButtonLink company that
56       associated 1-wire physical connections with a unique  1-wire  code.  If
57       the  connection is behind a Link Locator the locator will show a unique
58       8-byte number (16 character hexadecimal) starting with family code FE.
59       If no Link Locator is between the device and the  master,  the  locator
60       field will be all FF.
61       r locator is the locator in reverse order.
62
63   present (DEPRECATED)
64       read-only, yes-no
65       Is the device currently present on the 1-wire bus?
66
67   type
68       read-only, ascii
69       Part  name  assigned by Dallas Semi. E.g.  DS2401 Alternative packaging
70       (iButton vs chip) will not be distiguished.
71

ALARMS

73       None.
74

DESCRIPTION

76   1-Wire
77       1-wire is a wiring protocol and series of devices designed and manufac‐
78       tured  by  Dallas  Semiconductor, Inc. The bus is a low-power low-speed
79       low-connector scheme where the data line can also provide power.
80
81       Each device is uniquely and unalterably  numbered  during  manufacture.
82       There  are a wide variety of devices, including memory, sensors (humid‐
83       ity, temperature, voltage, contact, current), switches, timers and data
84       loggers.  More complex devices (like thermocouple sensors) can be built
85       with these basic devices. There  are  also  1-wire  devices  that  have
86       encryption included.
87
88       The  1-wire  scheme uses a single bus master and multiple slaves on the
89       same wire. The bus master initiates all communication. The  slaves  can
90       be individually discovered and addressed using their unique ID.
91
92       Bus  masters come in a variety of configurations including serial, par‐
93       allel, i2c, network or USB adapters.
94
95   OWFS design
96       OWFS is a suite of programs that designed to make the  1-wire  bus  and
97       its  devices easily accessible. The underlying principle is to create a
98       virtual filesystem, with the unique ID being  the  directory,  and  the
99       individual  properties  of  the  device are represented as simple files
100       that can be read and written.
101
102       Details of the individual slave or master design are  hidden  behind  a
103       consistent interface. The goal is to provide an easy set of tools for a
104       software designer to create monitoring or control  applications.  There
105       are some performance enhancements in the implementation, including data
106       caching, parallel access to bus masters, and aggregation of device com‐
107       munication.  Still the fundamental goal has been ease of use, flexibil‐
108       ity and correctness rather than speed.
109
110   DS2401 DS1990A
111       The DS2401 (3) and DS1990A (3) are the most basic  of  1-wire  devices.
112       Their  sole  property is it's unique address. It can be used for unique
113       identification. Nonetheless, many keylocks, night watchman systems, and
114       tracking systems use this device.
115

ADDRESSING

117       All  1-wire  devices are factory assigned a unique 64-bit address. This
118       address is of the form:
119
120       Family Code
121              8 bits
122
123       Address
124              48 bits
125
126       CRC    8 bits
127
128       Addressing under OWFS is in hexadecimal, of form:
129
130              01.123456789ABC
131
132       where 01 is an example 8-bit family code, and 12345678ABC is an example
133       48 bit address.
134
135       The  dot  is  optional,  and the CRC code can included. If included, it
136       must be correct.
137

DATASHEET

139       http://pdfserv.maxim-ic.com/en/ds/DS2401.pdf
140       http://pdfserv.maxim-ic.com/en/ds/DS1990A-F3-DS1990A-F5.pdf
141

SEE ALSO

143   Programs
144       owfs (1) owhttpd (1) owftpd (1)  owserver  (1)  owdir  (1)  owread  (1)
145       owwrite (1) owpresent (1) owtap (1)
146
147   Configuration and testing
148       owfs (5) owtap (1) owmon (1)
149
150   Language bindings
151       owtcl (3) owperl (3) owcapi (3)
152
153   Clocks
154       DS1427  (3)  DS1904  (3)  DS1994  (3) DS2404 (3) DS2404S (3) DS2415 (3)
155       DS2417 (3)
156
157   ID
158       DS2401 (3) DS2411 (3) DS1990A (3)
159
160   Memory
161       DS1982 (3) DS1985 (3) DS1986 (3)  DS1991  (3)  DS1992  (3)  DS1993  (3)
162       DS1995  (3)  DS1996  (3)  DS2430A  (3) DS2431 (3) DS2433 (3) DS2502 (3)
163       DS2506 (3) DS28E04 (3) DS28EC20 (3)
164
165   Switches
166       DS2405 (3) DS2406 (3) DS2408 (3) DS2409 (3) DS2413 (3) DS28EA00 (3)
167
168   Temperature
169       DS1822 (3) DS1825 (3) DS1820 (3) DS18B20 (3)  DS18S20  (3)  DS1920  (3)
170       DS1921  (3) DS1821 (3) DS28EA00 (3) DS28E04 (3) EDS0064 (3) EDS0065 (3)
171       EDS0066 (3) EDS0067 (3) EDS0068 (3) EDS0071 (3)  EDS0072  (3)  MAX31826
172       (3)
173
174   Humidity
175       DS1922 (3) DS2438 (3) EDS0065 (3) EDS0068 (3)
176
177   Voltage
178       DS2450 (3)
179
180   Resistance
181       DS2890 (3)
182
183   Multifunction (current, voltage, temperature)
184       DS2436  (3)  DS2437  (3)  DS2438  (3)  DS2751 (3) DS2755 (3) DS2756 (3)
185       DS2760 (3) DS2770 (3) DS2780 (3) DS2781 (3) DS2788 (3) DS2784 (3)
186
187   Counter
188       DS2423 (3)
189
190   LCD Screen
191       LCD (3) DS2408 (3)
192
193   Crypto
194       DS1977 (3)
195
196   Pressure
197       DS2406 (3) TAI8570 (3) EDS0066 (3) EDS0068 (3)
198
199   Moisture
200       EEEF (3) DS2438 (3)
201

AVAILABILITY

203       http://www.owfs.org
204

AUTHOR

206       Paul Alfille (paul.alfille@gmail.com)
207
208
209
210OWFS Manpage                         2003                            DS2401(3)
Impressum