owfs-libs/IBLSS(3)

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

NAME

6       IBLSS - iButtonLink SmartSlave
7

SYNOPSIS

9   Wall-TH Humidity and Temperature Sensor.
10       FE [.]XXXXXXXX2X00[XX][/[ TH/humidity | TH/latesthumidity | TH/tempera‐
11       ture | TH/latesttemp | TH/led | firmware | subtype | address |  crc8  |
12       id | locator | r_address | r_id | r_locator | type ]]
13

FAMILY CODE

15       FE
16

SPECIAL PROPERTIES

18   TH/humidity
19       read-only, floating point
20       Humidity read by the chip at high resolution (~13 bits). Unit is % rel‐
21       ative humidity. Negative values indicate a condensing condition.   Con‐
22       version takes about one second.
23
24   TH/latesthumidity
25       read-only, floating point
26       Latest  measured  humidity. Reading this node will never trigger a com‐
27       bined humidity/temperature conversion. Intended for use after a  previ‐
28       ous  read of the TH/temperature node or in conjunction with /simultane‐
29       ous/iblss.
30
31   TH/temperature
32       read-only, floating point
33       Temperature read by the chip at high resolution (~13 bits).  Units  are
34       selected  from the invoking command line. See owfs(1) or owhttpd(1) for
35       choices. Default is Celsius.  Conversion takes about one second.
36
37   TH/latesttemp
38       read-only, floating point
39       Latest measured temperature. Reading this node  will  never  trigger  a
40       combined humidity/temperature conversion. Intended for use after a pre‐
41       vious read of the TH/humidity node or in conjunction  with  /simultane‐
42       ous/iblss.
43
44   TH/led
45       write-only, yes-no
46       Switches the indicator LED on/off.
47
48   firmware
49       read-only, ascii
50       Firmware  version  of  the Smart Slave displayed as major.major number.
51       Firmware versions of the SS-WALL-TH before 1.4 had  known  issues  with
52       humidity reporting.
53
54   subtype
55       read-only, ascii
56       Subtype  of the Smart Slave. Currently only possible value is "TH" sig‐
57       nifying an SS-WALL-TH drywall temperature/humidity sensor.
58

STANDARD PROPERTIES

60   address
61   r_address
62       read-only, ascii
63       The entire 64-bit unique ID. Given as  upper  case  hexidecimal  digits
64       (0-9A-F).
65       address starts with the family code
66       r address is the address in reverse order, which is often used in other
67       applications and labeling.
68
69   crc8
70       read-only, ascii
71       The 8-bit error correction portion. Uses cyclic redundancy check.  Com‐
72       puted  from  the  preceding  56  bits of the unique ID number. Given as
73       upper case hexadecimal digits (0-9A-F).
74
75   family
76       read-only, ascii
77       The 8-bit family code. Unique to each type of device.  Given  as  upper
78       case hexadecimal digits (0-9A-F).
79
80   id
81   r_id
82       read-only, ascii
83       The 48-bit middle portion of the unique ID number. Does not include the
84       family code or CRC. Given as upper case hexadecimal digits (0-9A-F).
85       r id is the id in reverse order, which is often used in other  applica‐
86       tions and labeling.
87
88   locator
89   r_locator
90       read-only, ascii
91       Uses  an  extension  of the 1-wire design from iButtonLink company that
92       associated 1-wire physical connections with a unique  1-wire  code.  If
93       the  connection is behind a Link Locator the locator will show a unique
94       8-byte number (16 character hexadecimal) starting with family code FE.
95       If no Link Locator is between the device and the  master,  the  locator
96       field will be all FF.
97       r locator is the locator in reverse order.
98
99   present (DEPRECATED)
100       read-only, yes-no
101       Is the device currently present on the 1-wire bus?
102
103   type
104       read-only, ascii
105       Part  name  assigned by Dallas Semi. E.g.  DS2401 Alternative packaging
106       (iButton vs chip) will not be distiguished.
107

ALARMS

109       None.
110

DESCRIPTION

112   1-Wire
113       1-wire is a wiring protocol and series of devices designed and manufac‐
114       tured  by  Dallas  Semiconductor, Inc. The bus is a low-power low-speed
115       low-connector scheme where the data line can also provide power.
116
117       Each device is uniquely and unalterably  numbered  during  manufacture.
118       There  are a wide variety of devices, including memory, sensors (humid‐
119       ity, temperature, voltage, contact, current), switches, timers and data
120       loggers.  More complex devices (like thermocouple sensors) can be built
121       with these basic devices. There  are  also  1-wire  devices  that  have
122       encryption included.
123
124       The  1-wire  scheme uses a single bus master and multiple slaves on the
125       same wire. The bus master initiates all communication. The  slaves  can
126       be individually discovered and addressed using their unique ID.
127
128       Bus  masters come in a variety of configurations including serial, par‐
129       allel, i2c, network or USB adapters.
130
131   OWFS design
132       OWFS is a suite of programs that designed to make the  1-wire  bus  and
133       its  devices easily accessible. The underlying principle is to create a
134       virtual filesystem, with the unique ID being  the  directory,  and  the
135       individual  properties  of  the  device are represented as simple files
136       that can be read and written.
137
138       Details of the individual slave or master design are  hidden  behind  a
139       consistent interface. The goal is to provide an easy set of tools for a
140       software designer to create monitoring or control  applications.  There
141       are some performance enhancements in the implementation, including data
142       caching, parallel access to bus masters, and aggregation of device com‐
143       munication.  Still the fundamental goal has been ease of use, flexibil‐
144       ity and correctness rather than speed.
145

ADDRESSING

147       All 1-wire devices are factory assigned a unique 64-bit  address.  This
148       address is of the form:
149
150       Family Code
151              8 bits
152
153       Address
154              48 bits
155
156       CRC    8 bits
157
158       Addressing under OWFS is in hexadecimal, of form:
159
160              01.123456789ABC
161
162       where 01 is an example 8-bit family code, and 12345678ABC is an example
163       48 bit address.
164
165       The dot is optional, and the CRC code can  included.  If  included,  it
166       must be correct.
167

DATASHEET

169       https://www.ibuttonlink.com/products/ss-wall-th
170

AVAILABILITY

232       http://www.owfs.org
233

AUTHOR

235       Paul Alfille <paul.alfille@gmail.com> Jan Kandziora <jjj@gmx.de>
236
237
238
239OWFS Manpage                         2003                             IBLSS(3)