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

NAME

6       DS1963S - 256 byte Monetary iButton with SHA-1
7

SYNOPSIS

9       Non-volatile R/W memory with counters, SHA-1 (under NDA)
10
11       18    [.]XXXXXXXXXXXX[XX][/[    pages/count.[0-15|ALL]   |   memory   |
12       pages/page.[0-15|ALL] | address | crc8 | id |  locator  |  r_address  |
13       r_id | r_locator | type ]]
14

FAMILY CODE

16       18
17

SPECIAL PROPERTIES

19   page/count.[0-15|ALL]
20       read-only, unsigned
21       Each  write  to  the memory page increments the counter. An application
22       can tell if the memory has been changed by another process.
23
24       Only 4 pages are actually connected to counters:
25
26       Counter1
27              page/counter.12
28
29       Counter2
30              page/counter.13
31
32       Counter3
33              page/counter.14
34
35       Counter4
36              page/counter.15
37

STANDARD PROPERTIES

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

ALARMS

88       None.
89

DESCRIPTION

91   1-Wire
92       1-wire is a wiring protocol and series of devices designed and manufac‐
93       tured  by  Dallas  Semiconductor, Inc. The bus is a low-power low-speed
94       low-connector scheme where the data line can also provide power.
95
96       Each device is uniquely and unalterably  numbered  during  manufacture.
97       There  are a wide variety of devices, including memory, sensors (humid‐
98       ity, temperature, voltage, contact, current), switches, timers and data
99       loggers.  More complex devices (like thermocouple sensors) can be built
100       with these basic devices. There  are  also  1-wire  devices  that  have
101       encryption included.
102
103       The  1-wire  scheme uses a single bus master and multiple slaves on the
104       same wire. The bus master initiates all communication. The  slaves  can
105       be individually discovered and addressed using their unique ID.
106
107       Bus  masters come in a variety of configurations including serial, par‐
108       allel, i2c, network or USB adapters.
109
110   OWFS design
111       OWFS is a suite of programs that designed to make the  1-wire  bus  and
112       its  devices easily accessible. The underlying principle is to create a
113       virtual filesystem, with the unique ID being  the  directory,  and  the
114       individual  properties  of  the  device are represented as simple files
115       that can be read and written.
116
117       Details of the individual slave or master design are  hidden  behind  a
118       consistent interface. The goal is to provide an easy set of tools for a
119       software designer to create monitoring or control  applications.  There
120       are some performance enhancements in the implementation, including data
121       caching, parallel access to bus masters, and aggregation of device com‐
122       munication.  Still the fundemental goal has been ease of use, flexibil‐
123       ity and correctness rather than speed.
124
125   DS1963S
126       The DS1963S (3) is used for read/write storage. It has SHA-1  authenti‐
127       cation.  Most of the information is under NDA and was not available for
128       either the implementation of this man page.
129
130       This man page corresponds to the non-secret  DS1963L  (3)  OWFS  system
131       handles this automatically.
132

ADDRESSING

134       All  1-wire  devices are factory assigned a unique 64-bit address. This
135       address is of the form:
136
137       Family Code
138              8 bits
139
140       Address
141              48 bits
142
143       CRC    8 bits
144
145       Addressing under OWFS is in hexidecimal, of form:
146
147              01.123456789ABC
148
149       where 01 is an example 8-bit family code, and 12345678ABC is an example
150       48 bit address.
151
152       The  dot  is  optional,  and the CRC code can included. If included, it
153       must be correct.
154

DATASHEET

156       http://www.maxim-ic.com/quick_view2.cfm/qv_pk/2822
157

SEE ALSO

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

AVAILABILITY

219       http://www.owfs.org
220

AUTHOR

222       Paul Alfille (paul.alfille@gmail.com)
223
224
225
226OWFS Manpage                         2003                           DS1963S(3)
Impressum