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

NAME

6       owperl - perl interface for the 1-wire filesystem
7

SYNOPSIS

9       OW.pm
10       use OW ;
11       OW::init( interface );
12       OW::init( initialization string );
13
14       The  full  set  of initialization options is extensive. They correspond
15       roughly to the command line options of ,B  owfs  (1)  owhttpd  (1)  and
16       owftpd (1)
17       OW::get( path );
18       OW::put( path , value );
19       OW::finish();
20

DESCRIPTION

22   1-Wire
23       1-wire is a wiring protocol and series of devices designed and manufac‐
24       tured by Dallas Semiconductor, Inc. The bus is  a  low-power  low-speed
25       low-connector scheme where the data line can also provide power.
26
27       Each  device  is  uniquely and unalterably numbered during manufacture.
28       There are a wide variety of devices, including memory, sensors  (humid‐
29       ity, temperature, voltage, contact, current), switches, timers and data
30       loggers. More complex devices (like thermocouple sensors) can be  built
31       with  these  basic devices. There are also 1-wire devices that have en‐
32       cryption included.
33
34       The 1-wire scheme uses a single bus master and multiple slaves  on  the
35       same  wire.  The bus master initiates all communication. The slaves can
36       be individually discovered and addressed using their unique ID.
37
38       Bus masters come in a variety of configurations including serial,  par‐
39       allel, i2c, network or USB adapters.
40
41   OWFS design
42       OWFS  is  a  suite of programs that designed to make the 1-wire bus and
43       its devices easily accessible. The underlying principle is to create  a
44       virtual filesystem, with the unique ID being the directory, and the in‐
45       dividual properties of the device are represented as simple files  that
46       can be read and written.
47
48       Details  of  the  individual slave or master design are hidden behind a
49       consistent interface. The goal is to provide an easy set of tools for a
50       software  designer  to create monitoring or control applications. There
51       are some performance enhancements in the implementation, including data
52       caching, parallel access to bus masters, and aggregation of device com‐
53       munication. Still the fundamental goal has been ease of use,  flexibil‐
54       ity and correctness rather than speed.
55
56   owperl
57       owperl  (3)  is  a  perl module that provides an interface to OWFS. The
58       path to each 1-wire device is the same as owfs (1) . Only the top layer
59       has been modified to return native perl strings.
60
61       owperl  (3)  is  created by swig (1) (http://www.swig.org) which can be
62       easily modified to support other programming languages.
63

FUNCTIONS

65   OW::init( interface )
66       interface
67       Location of the 1-wire bus:
68
69       "u"    Direct connection to the 1-wire interface on  the  USB  port  --
70              DS9490
71
72       /dev/ttySx
73              Direct  connection  to  a 1-wire interface on the serial port --
74              DS9097U or DS9097
75
76       port | :port | IPaddress:port
77              Location of an owserver daemon that connects to the 1-wire  bus.
78              Multiple  owperl as well as owfs and owhttpd programs can access
79              the owserver process simultaneously. In fact, this will probably
80              be  the  preferred  mode  of access to OWFS for owperl except in
81              trivial applications.
82

EXAMPLE

84       perl -MOW -e "OW::init('/dev/ttyS1'); printf OW::get('´);"
85

SEE ALSO

87   Programs
88       owfs (1) owhttpd (1) owftpd (1)  owserver  (1)  owdir  (1)  owread  (1)
89       owwrite (1) owpresent (1) owtap (1)
90
91   Configuration and testing
92       owfs (5) owtap (1) owmon (1)
93
94   Language bindings
95       owtcl (3) owperl (3) owcapi (3)
96
97   Clocks
98       DS1427  (3)  DS1904  (3)  DS1994  (3) DS2404 (3) DS2404S (3) DS2415 (3)
99       DS2417 (3)
100
101   ID
102       DS2401 (3) DS2411 (3) DS1990A (3)
103
104   Memory
105       DS1982 (3) DS1985 (3) DS1986 (3)  DS1991  (3)  DS1992  (3)  DS1993  (3)
106       DS1995  (3)  DS1996  (3)  DS2430A  (3) DS2431 (3) DS2433 (3) DS2502 (3)
107       DS2506 (3) DS28E04 (3) DS28EC20 (3)
108
109   Switches
110       DS2405 (3) DS2406 (3) DS2408 (3) DS2409 (3) DS2413 (3) DS28EA00 (3) In‐
111       fernoEmbedded (3)
112
113   Temperature
114       DS1822  (3)  DS1825  (3)  DS1820 (3) DS18B20 (3) DS18S20 (3) DS1920 (3)
115       DS1921 (3) DS1821 (3) DS28EA00 (3) DS28E04 (3) EDS0064 (3) EDS0065  (3)
116       EDS0066  (3)  EDS0067  (3) EDS0068 (3) EDS0071 (3) EDS0072 (3) MAX31826
117       (3)
118
119   Humidity
120       DS1922 (3) DS2438 (3) EDS0065 (3) EDS0068 (3)
121
122   Voltage
123       DS2450 (3)
124
125   Resistance
126       DS2890 (3)
127
128   Multifunction (current, voltage, temperature)
129       DS2436 (3) DS2437 (3) DS2438 (3)  DS2751  (3)  DS2755  (3)  DS2756  (3)
130       DS2760 (3) DS2770 (3) DS2780 (3) DS2781 (3) DS2788 (3) DS2784 (3)
131
132   Counter
133       DS2423 (3)
134
135   LCD Screen
136       LCD (3) DS2408 (3)
137
138   Crypto
139       DS1977 (3)
140
141   Pressure
142       DS2406 (3) TAI8570 (3) EDS0066 (3) EDS0068 (3)
143
144   Moisture
145       EEEF (3) DS2438 (3)
146

AVAILABILITY

148       http://www.owfs.org
149

AUTHOR

151       Paul Alfille (paul.alfille@gmail.com)
152
153
154
155OWFS Manpage                         2004                            OWPERL(3)
Impressum