EEEF(3) - f39

1HobbyBoards_EE/EF(3)         One-Wire File System         HobbyBoards_EE/EF(3)
2
3
4

NAME

6       UVI, Moisture, Barometer, HUB
7              -  HobbyBoards  EE/EF  Microprocessor-based slaves: Ultra Violet
8              (UV) Index sensor, Soil and Leaf moisture measurements,  Barome‐
9              ter, 4-channel hub with switchable branches
10

SYNOPSIS

12   General EE device
13       EE [.]XXXXXXXXXXXX[XX][/[ temperature | version | type_number | temper‐
14       ature_offset | address | crc8 | id | locator | r_address | r_id | r_lo‐
15       cator | type ]]
16
17   UVI sensor
18       EE  [.]XXXXXXXXXXXX[XX][/[  UVI/UVI  |  UVI/UVI_offset  | UVI/in_case |
19       UVI/valid | temperature | version | type_number | temperature_offset ]]
20
21   General EF device
22       EF [.]XXXXXXXXXXXX[XX][/[ version | type_number | address | crc8 | id |
23       locator | r_address | r_id | r_locator | type ]]
24
25   Moisture Meter
26       moisture/sensor.[0-3|ALL]
27       moisture/is_moisture.[0-3|ALL|BYTE] | moisture/is_leaf.[0-3|ALL|BYTE]
28       moisture/calibrate/min   |   moisture/calibrate/max   |  moisture/cali‐
29       brate/raw.[0-4|ALL]
30
31   Hub
32       hub/branch.[0-3|ALL|BYTE] | hub/short.[0-3|ALL|BYTE]
33

FAMILY CODE

35       EE     Device with temperature
36
37       EE     UVI
38
39       EF     Device without temperature
40
41       EF     Moisture Meter
42
43       EF     Hub
44

TEMPERATURE PROPERTIES

46   temperature
47       read-only, floating point
48       Temperature read every 30 seconds. Resolution  .5C  (uses  an  on-board
49       DS18B20). Temperature is only present in the EE-series devices.
50
51   temperature_offset
52       read-write, floating point
53       Offset stored on device to apply to temperature readings.
54

UVI PROPERTIES

56   UVI/UVI
57       read-only floating point
58       UV Index (ultraviolet index) in the range 0.0 to 16.0 resolution .1
59
60       Only  the  UVI version of the EE device has a UVI sensor. Readings made
61       every .5 seconds.
62
63   UVI/UVI_offset
64       read-write, floating point
65       Signed offset to apply to the UVI measurement.  Stored  on-device  non-
66       volatile.
67
68   UVI/in_case
69       read-write, yes-no
70       Flag  to  apply  compensation for the protective case. Stored on-device
71       non-volatile.
72
73   UVI/valid
74       read-only, yes-no Flag the the EE device type  matches  the  known  UVI
75       type.
76

Moisture Meter

78   moisture/sensor.0 .. moisture/sensor.3 moisture/sensor.ALL
79       read-only integer
80       Up  to  4 sensors reading moisture can be attached.  OWFS addresses the
81       sensors as 0 through 3 while the datasheet uses 1-4.  Two types of  ex‐
82       ternal sensors are supported (and the data range):
83
84       Watermark Soil Moisture Sensor
85              0-199
86
87       Leaf Wetness Sensor
88              0-99
89
90   moisture/is_moisture.0 .. moisture/is_moisture.3 moisture/is_moisture.ALL
91   moisture/is_leaf.0 .. moisture/is_leaf.3 moisture/is_leaf.ALL
92       read-write yes_no
93       Set  or get the type of sensor attached to each channel. Note that OWFS
94       addresses the sensors as 0 through 3 while the datasheet uses 1-4.  Two
95       types of external sensors are supported:
96
97       Watermark Soil Moisture
98              Sensor
99
100       Leaf Wetness
101              Sensor
102
103       Note  that  is_leaf  and is_moisture are complementary and clearing one
104       sets the other.
105
106
107   moisture/calibrate/min
108   moisture/calibrate/max
109       read-write unsigned integer
110       Set or get the upper and lower range for the raw data for leaf  wetness
111       scaling. See the datasheet for details.
112
113
114   moisture/calibrate/raw.0    ..    moisture/calibrate/raw.3   moisture/cali‐
115       brate/raw.ALL
116       read-only unsigned integer
117       Read the raw leaf wetness values for setting scaling. See the datasheet
118       for details.  Note that OWFS addresses the sensors as 0 through 3 while
119       the datasheet uses 1-4.
120

Hub

122       4-channel hub. Individual branches can be switched on and off.
123
124   hub/branch.0 .. hub/branch.3 hub/branch.ALL hub/branch.BYTE
125       read-write, yes-no
126       The HobbyBoards hub has four 1-wire bus lines. Each branch is  electri‐
127       caly  isolated  from  reflections and shorts, and can be optionally ex‐
128       cluded from the 1-wire network.
129
130       You can turn each branch on or off by writing 0 (off) or 1 (on) to  the
131       corresponding  property.  Note  that  OWFS  indexes the branches 0 to 3
132       while the datasheet uses 1 to 4.
133
134       The easiest way to turn all the branches on is to write  15  (0x0F)  to
135       hub/branch.BYTE
136
137   hub/short.0 .. hub/short.3 hub/short.ALL hub/short.BYTE
138       read-only, yes-no
139       Is the corresponding branch in "short" condition? (Electrically shorted
140       out).
141

IDENTIFICATION PROPERTIES

143   version
144       read-only, ascii
145       Firmware version for the EE/EF device. Reported in nn.nn  format  where
146       nn is major/minor decimal value.
147
148       Note:  This  format was changed as of version owfs-2.9p6 at the request
149       of the HobbyBoards. Formerly reported in HH.HH format where HH is a hex
150       digit (0-9A-F).
151
152   type_number
153       read-only, integer
154       Index  of  the type of sensor built into this device. Current known as‐
155       signments:
156
157       1      UVI (Ultraviolet index)
158
159       2      Moisture meter
160
161       3      Moisture meter with datalogger
162
163       4      Sniffer
164
165       5      Hub
166

STANDARD PROPERTIES

168   address
169   r_address
170       read-only, ascii
171       The entire 64-bit unique ID. Given as  upper  case  hexadecimal  digits
172       (0-9A-F).
173       address starts with the family code
174       r address is the address in reverse order, which is often used in other
175       applications and labeling.
176
177   crc8
178       read-only, ascii
179       The 8-bit error correction portion. Uses cyclic redundancy check.  Com‐
180       puted  from the preceding 56 bits of the unique ID number. Given as up‐
181       per case hexadecimal digits (0-9A-F).
182
183   family
184       read-only, ascii
185       The 8-bit family code. Unique to each type of device.  Given  as  upper
186       case hexadecimal digits (0-9A-F).
187
188   id
189   r_id
190       read-only, ascii
191       The 48-bit middle portion of the unique ID number. Does not include the
192       family code or CRC. Given as upper case hexadecimal digits (0-9A-F).
193       r id is the id in reverse order, which is often used in other  applica‐
194       tions and labeling.
195
196   locator
197   r_locator
198       read-only, ascii
199       Uses  an  extension  of the 1-wire design from iButtonLink company that
200       associated 1-wire physical connections with a unique  1-wire  code.  If
201       the  connection is behind a Link Locator the locator will show a unique
202       8-byte number (16 character hexadecimal) starting with family code FE.
203       If no Link Locator is between the device and the  master,  the  locator
204       field will be all FF.
205       r locator is the locator in reverse order.
206
207   present (DEPRECATED)
208       read-only, yes-no
209       Is the device currently present on the 1-wire bus?
210
211   type
212       read-only, ascii
213       Part  name  assigned by Dallas Semi. E.g.  DS2401 Alternative packaging
214       (iButton vs chip) will not be distiguished.
215

ALARMS

217       None
218

DESCRIPTION

220   1-Wire
221       1-wire is a wiring protocol and series of devices designed and manufac‐
222       tured  by  Dallas  Semiconductor, Inc. The bus is a low-power low-speed
223       low-connector scheme where the data line can also provide power.
224
225       Each device is uniquely and unalterably  numbered  during  manufacture.
226       There  are a wide variety of devices, including memory, sensors (humid‐
227       ity, temperature, voltage, contact, current), switches, timers and data
228       loggers.  More complex devices (like thermocouple sensors) can be built
229       with these basic devices. There are also 1-wire devices that  have  en‐
230       cryption included.
231
232       The  1-wire  scheme uses a single bus master and multiple slaves on the
233       same wire. The bus master initiates all communication. The  slaves  can
234       be individually discovered and addressed using their unique ID.
235
236       Bus  masters come in a variety of configurations including serial, par‐
237       allel, i2c, network or USB adapters.
238
239   OWFS design
240       OWFS is a suite of programs that designed to make the  1-wire  bus  and
241       its  devices easily accessible. The underlying principle is to create a
242       virtual filesystem, with the unique ID being the directory, and the in‐
243       dividual  properties of the device are represented as simple files that
244       can be read and written.
245
246       Details of the individual slave or master design are  hidden  behind  a
247       consistent interface. The goal is to provide an easy set of tools for a
248       software designer to create monitoring or control  applications.  There
249       are some performance enhancements in the implementation, including data
250       caching, parallel access to bus masters, and aggregation of device com‐
251       munication.  Still the fundamental goal has been ease of use, flexibil‐
252       ity and correctness rather than speed.
253
254   EE / EF
255       The EEEF (3) are a reference platform of  microprocessor  based  1-wire
256       slaves.  In  general  they require external power, and have an on-board
257       index for the specific capabilities. They are designed by Eric  Vickery
258       at HobbyBoards.com
259
260       The EE class device uses family code EE and has an included temperature
261       sensor. The EF devices have no temperature sensor,
262
263   UVI
264       The UVI sensor is an implementation of the EE class device  with  Ultra
265       Violet  Index sensing. All it's specific properties are in the UVI/ di‐
266       rectory.
267

ADDRESSING

269       All 1-wire devices are factory assigned a unique 64-bit  address.  This
270       address is of the form:
271
272       Family Code
273              8 bits
274
275       Address
276              48 bits
277
278       CRC    8 bits
279
280       Addressing under OWFS is in hexadecimal, of form:
281
282              01.123456789ABC
283
284       where 01 is an example 8-bit family code, and 12345678ABC is an example
285       48 bit address.
286
287       The dot is optional, and the CRC code can  included.  If  included,  it
288       must be correct.
289

DATASHEET

291       UVI    http://www.hobby-boards.com/catalog/links/uvi2-r1/UVI%20Me‐
292              ter%20User%20Manual.pdf
293
294       Moisture and Leaf Sensor
295              http://www.hobby-boards.com/download/manuals/Moisture%20Me‐
296              ter.pdf
297
298       4 Channel Hub
299              http://www.hobby-boards.com/download/manuals/4%20Chan‐
300              nel%20Hub.pdf
301

AVAILABILITY

364       http://www.owfs.org
365

AUTHOR

367       Paul Alfille (paul.alfille@gmail.com)
368
369
370
371OWFS Manpage                         2009                 HobbyBoards_EE/EF(3)