'\"
'\" 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.
'\" $Id$
'\"
.TH HobbyBoards_EE/EF 3  2009 "OWFS Manpage" "One-Wire File System"
.SH NAME
.TP
.B UVI, Moisture, Barometer, HUB
\- HobbyBoards EE/EF Microprocessor-based slaves:
Ultra Violet (UV) Index sensor,
Soil and Leaf moisture measurements,
Barometer,
4-channel hub with switchable branches
.SH SYNOPSIS
.SS General EE device
.B EE
[.]XXXXXXXXXXXX[XX][/[
.B temperature
|
.B version
|
.B type_number
|
.B temperature_offset
|
'\"
'\" Copyright (c) 2003-2004 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Program 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.
'\" $Id$
'\"
.B address
|
.B crc8
|
.B id
|
.B locator
|
.B r_address
|
.B r_id
|
.B r_locator
|
.B type
]]
.SS UVI sensor
.B EE
[.]XXXXXXXXXXXX[XX][/[
.B UVI/UVI
|
.B UVI/UVI_offset
|
.B UVI/in_case
|
.B UVI/valid
|
.B temperature
|
.B version
|
.B type_number
|
.B temperature_offset
]]
.SS General EF device
.B EF
[.]XXXXXXXXXXXX[XX][/[
.B version
|
.B type_number
|
'\"
'\" Copyright (c) 2003-2004 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Program 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.
'\" $Id$
'\"
.B address
|
.B crc8
|
.B id
|
.B locator
|
.B r_address
|
.B r_id
|
.B r_locator
|
.B type
]]
.SS Moisture Meter
.B moisture/sensor.[0-3|ALL]
.br
.B moisture/is_moisture.[0-3|ALL|BYTE]
|
.B moisture/is_leaf.[0-3|ALL|BYTE]
.br
.B moisture/calibrate/min
|
.B moisture/calibrate/max
|
.B moisture/calibrate/raw.[0-4|ALL]
.SS Hub
. B hub/branch.[0-3|ALL|BYTE]
|
. B hub/short.[0-3|ALL|BYTE]
.SH FAMILY CODE
.TP
.I EE
Device with temperature
.TP
.I EE
UVI
.TP
.I EF
Device without temperature
.TP
.I EF
Moisture Meter
.TP
.I EF
Hub
.SH TEMPERATURE PROPERTIES
.SS temperature
.I read-only, floating point
.br
Temperature read every 30 seconds. Resolution .5C (uses an on-board DS18B20). Temperature is only present in the EE-series devices.
.SS temperature_offset
.I read-write, floating point
.br
Offset stored on device to apply to temperature readings.
.SH UVI PROPERTIES
.SS UVI/UVI
.I read-only floating point
.br
UV Index (ultraviolet index) in the range 0.0 to 16.0 resolution .1
.PP
Only the UVI version of the EE device has a UVI sensor. Readings made every .5 seconds.
.SS UVI/UVI_offset
.I read-write, floating point
.br
Signed offset to apply to the UVI measurement. Stored on-device non-volatile.
.SS UVI/in_case
.I read-write, yes-no
.br
Flag to apply compensation for the protective case. Stored on-device non-volatile.
.SS UVI/valid
.I read-only, yes-no
Flag the the EE device type matches the known UVI type.
.SH Moisture Meter
.SS moisture/sensor.0 .. moisture/sensor.3 moisture/sensor.ALL
.I read-only integer
.br
Up to 4 sensors reading moisture can be attached. 
.I OWFS
addresses the sensors as 0 through 3 while the datasheet uses 1-4.
Two types of external sensors are supported (and the data range):
.TP
Watermark Soil Moisture Sensor
0-199
.TP
Leaf Wetness Sensor
0-99
.SS moisture/is_moisture.0 .. moisture/is_moisture.3 moisture/is_moisture.ALL
.SS moisture/is_leaf.0 .. moisture/is_leaf.3 moisture/is_leaf.ALL
.I read-write yes_no
.br
Set or get the type of sensor attached to each channel. Note that 
.I OWFS
addresses the sensors as 0 through 3 while the datasheet uses 1-4.
Two types of external sensors are supported:
.TP
Watermark Soil Moisture
Sensor
.TP
Leaf Wetness
Sensor
.P
Note that
.I is_leaf
and 
.I is_moisture
are complementary and clearing one sets the other.

.SS moisture/calibrate/min
.SS moisture/calibrate/max
.I read-write unsigned integer
.br
Set or get the upper and lower range for the raw data for leaf wetness scaling. See the datasheet for details.

.SS moisture/calibrate/raw.0 .. moisture/calibrate/raw.3 moisture/calibrate/raw.ALL
.I read-only unsigned integer
.br
Read the raw leaf wetness values for setting scaling. See the datasheet for details.
Note that 
.I OWFS
addresses the sensors as 0 through 3 while the datasheet uses 1-4.
.SH Hub
4-channel hub. Individual branches can be switched on and off.
.SS hub/branch.0 .. hub/branch.3 hub/branch.ALL hub/branch.BYTE
.I read-write, yes-no
.br
The HobbyBoards hub has four 1-wire bus lines. Each branch is electricaly isolated from reflections and shorts, and can be optionally excluded from the 1-wire network.
.PP
You can turn each
.I branch
on or off by writing 0 (off) or 1 (on) to the corresponding property. Note that
.I OWFS
indexes the branches 0 to 3 while the datasheet uses 1 to 4.
.PP
The easiest way to turn all the branches on is to write 15 (0x0F) to
.I hub/branch.BYTE
.SS hub/short.0 .. hub/short.3 hub/short.ALL hub/short.BYTE
.I read-only, yes-no
.br
Is the corresponding branch in "short" condition? (Electrically shorted out).
.SH IDENTIFICATION PROPERTIES
.SS version
.I read-only, ascii
.br
Firmware version for the EE/EF device. Reported in nn.nn format where nn is major/minor decimal value.
.P
Note: This format was changed as of version owfs-2.9p6 at the request of the HobbyBoards. Formerly reported in HH.HH format where HH is a hex digit (0-9A-F).
.SS type_number
.I read-only, integer
.br
Index of the type of sensor built into this device. Current known assignments:
.TP
1
UVI (Ultraviolet index)
.TP
2
Moisture meter
.TP
3
Moisture meter with datalogger
.TP
4
Sniffer
.TP
5
Hub
.SH STANDARD PROPERTIES
'\"
'\" Copyright (c) 2003-2004 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Program 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.
'\" $Id$
'\"
.SS address
.SS r_address
.I read-only, ascii
.br
The entire 64-bit unique ID. Given as upper case hexadecimal digits (0-9A-F).
.br
.I address
starts with the
.I family
code
.br
.I r address
is the
.I address
in reverse order, which is often used in other applications and labeling.
.SS crc8
.I read-only, ascii
.br
The 8-bit error correction portion. Uses cyclic redundancy check. Computed from the preceding 56 bits of the unique ID number. Given as upper case hexadecimal digits (0-9A-F).
.SS family
.I read-only, ascii
.br
The 8-bit family code. Unique to each
.I type
of device. Given as upper case hexadecimal digits (0-9A-F).
.SS id
.SS r_id
.I read-only, ascii
.br
The 48-bit middle portion of the unique ID number. Does not include the family code or CRC. Given as upper case hexadecimal digits (0-9A-F).
.br
.I r id
is the
.I id
in reverse order, which is often used in other applications and labeling.
.SS locator
.SS r_locator
.I read-only, ascii
.br
Uses an extension of the 1-wire design from iButtonLink company that associated 1-wire physical connections with a unique 1-wire code. If the connection is behind a
.B Link Locator
the
.I locator will show a unique 8-byte number (16 character hexadecimal) starting with family code FE.
.br
If no
.B Link Locator
is between the device and the master, the
.I locator
field will be all FF.
.br
.I r locator
is the
.I locator
in reverse order.
.SS present (DEPRECATED)
.I read-only, yes-no
.br
Is the device currently
.I present
on the 1-wire bus?
.SS type
.I read-only, ascii
.br
Part name assigned by Dallas Semi. E.g.
.I DS2401
Alternative packaging (iButton vs chip) will not be distiguished.
.SH ALARMS
None
.SH DESCRIPTION
'\"
'\" Copyright (c) 2003-2004 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Program 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.
'\" $Id$
'\"
.SS 1-Wire
.I 1-wire 
is a wiring protocol and series of devices designed and manufactured
by Dallas Semiconductor, Inc. The bus is a low-power low-speed low-connector
scheme where the data line can also provide power.
.PP
Each device is uniquely and unalterably numbered during manufacture. There are a wide variety
of devices, including memory, sensors (humidity, temperature, voltage,
contact, current), switches, timers and data loggers. More complex devices (like
thermocouple sensors) can be built with these basic devices. There are also
1-wire devices that have encryption included.
.PP
The 1-wire scheme uses a single 
.I bus master
and multiple
.I slaves
on the same wire. The bus master initiates all communication. The slaves can be 
individually discovered and addressed using their unique ID.
.PP
Bus masters come in a variety of configurations including serial, parallel, i2c, network or USB
adapters.
.SS OWFS design
.I OWFS
is a suite of programs that designed to make the 1-wire bus and its
devices easily accessible. The underlying principle is to create a virtual
filesystem, with the unique ID being the directory, and the individual
properties of the device are represented as simple files that can be read and written.
.PP 
Details of the individual slave or master design are hidden behind a consistent interface. The goal is to 
provide an easy set of tools for a software designer to create monitoring or control applications. There 
are some performance enhancements in the implementation, including data caching, parallel access to bus 
masters, and aggregation of device communication. Still the fundamental goal has been ease of use, flexibility
and correctness rather than speed.
.SS EE / EF
The
.B EEEF (3)
are a reference platform of microprocessor based 1-wire slaves. In general they require external power, and have an on-board index for the specific capabilities. They are designed by Eric Vickery at HobbyBoards.com
.PP
The
.I EE
class device uses family code EE and has an included temperature sensor. The
.I EF
devices have no temperature sensor,
.SS UVI
The
.I UVI
sensor is an implementation of the
.I EE
class device with Ultra Violet Index sensing. All it's specific properties are in the
.I UVI/
directory.
.SH ADDRESSING
'\"
'\" Copyright (c) 2003-2004 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Program 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.
'\" $Id$
'\"
All 1-wire devices are factory assigned a unique 64-bit address. This address is of the form:
.TP
.B Family Code
8 bits
.TP
.B Address
48 bits
.TP
.B CRC
8 bits
.IP
.PP
Addressing under OWFS is in hexadecimal, of form:
.IP
.B 01.123456789ABC
.PP
where
.B 01
is an example 8-bit family code, and
.B 12345678ABC
is an example 48 bit address.
.PP
The dot is optional, and the CRC code can included. If included, it must be correct.
.SH DATASHEET
.TP
.B UVI
http://www.hobby-boards.com/catalog/links/uvi2-r1/UVI%20Meter%20User%20Manual.pdf
.TP
.B Moisture and Leaf Sensor
http://www.hobby-boards.com/download/manuals/Moisture%20Meter.pdf
.TP
.B 4 Channel Hub
http://www.hobby-boards.com/download/manuals/4%20Channel%20Hub.pdf
.SH SEE ALSO
.SS Programs
.B owfs (1) owhttpd (1) owftpd (1) owserver (1)
.B owdir (1) owread (1) owwrite (1) owpresent (1)
.B owtap (1)
.SS Configuration and testing
.B owfs (5) owtap (1) owmon (1)
.SS Language bindings
.B owtcl (3) owperl (3) owcapi (3)
.SS Clocks
.B DS1427 (3) DS1904 (3) DS1994 (3) DS2404 (3) DS2404S (3) DS2415 (3) DS2417 (3)
.SS ID
.B DS2401 (3) DS2411 (3) DS1990A (3)
.SS Memory
.B DS1982 (3) DS1985 (3) DS1986 (3) DS1991 (3) DS1992 (3) DS1993 (3) DS1995 (3) DS1996 (3) DS2430A (3) DS2431 (3) DS2433 (3) DS2502 (3) DS2506 (3) DS28E04 (3) DS28EC20 (3)
.SS Switches
.B DS2405 (3) DS2406 (3) DS2408 (3) DS2409 (3) DS2413 (3) DS28EA00 (3)
.SS Temperature
.B DS1822 (3) DS1825 (3) DS1820 (3) DS18B20 (3) DS18S20 (3) DS1920 (3) DS1921 (3) DS1821 (3) DS28EA00 (3) DS28E04 (3) EDS0064 (3) EDS0065 (3) EDS0066 (3) EDS0067 (3) EDS0068 (3) EDS0071 (3) EDS0072 (3) MAX31826 (3)
.SS Humidity
.B DS1922 (3) DS2438 (3) EDS0065 (3) EDS0068 (3)
.SS Voltage
.B DS2450 (3)
.SS Resistance
.B DS2890 (3)
.SS Multifunction (current, voltage, temperature)
.B DS2436 (3) DS2437 (3) DS2438 (3) DS2751 (3) DS2755 (3) DS2756 (3) DS2760 (3) DS2770 (3) DS2780 (3) DS2781 (3) DS2788 (3) DS2784 (3)
.SS Counter
.B DS2423 (3)
.SS LCD Screen
.B LCD (3) DS2408 (3)
.SS Crypto
.B DS1977 (3)
.SS Pressure
.B DS2406 (3) TAI8570 (3) EDS0066 (3) EDS0068 (3)
.SS Moisture
.B EEEF (3) DS2438 (3)
.SH AVAILABILITY
http://www.owfs.org
.SH AUTHOR
Paul Alfille (paul.alfille@gmail.com)