File: owperl.man

package info (click to toggle)
owfs 3.2p3+dfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 8,688 kB
  • sloc: ansic: 65,085; pascal: 5,957; tcl: 2,688; makefile: 1,357; python: 1,114; sh: 891; cs: 623; php: 600; perl: 587; java: 404; ruby: 289; cpp: 105; asm: 102; xml: 53
file content (93 lines) | stat: -rw-r--r-- 1,960 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
'\"
'\" 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.
'\"
.TH OWPERL 3 2004 "OWFS Manpage" "One-Wire File System"
.SH NAME
.B owperl
\- perl interface for the 1-wire filesystem
.SH SYNOPSIS
.B OW.pm
.br
.B use OW ;
.br
.B OW::init(
.I interface
.B );
.br
.B OW::init(
.I initialization string
.B );
.PP
The full set of initialization options is extensive. They correspond roughly to the command line options of
,B owfs (1)
.B owhttpd (1)
and
.B owftpd (1)
.br
.B OW::get(
.I path
.B );
.br
.B OW::put(
.I path
.B ,
.I value
.B );
.br
.B OW::finish();
.SH "DESCRIPTION"
.so man3/description.3so
.SS owperl
.B owperl (3)
is a perl module that provides an interface to OWFS. The path to each 1-wire device is the same as
.B owfs (1)
\&. Only the top layer has been modified to return native perl strings.
.PP
.B owperl (3)
is created by
.B swig (1)
(http://www.swig.org) which can be easily modified to support other programming languages.
.SH FUNCTIONS
.SS OW::init( interface )
.I interface
.br
Location of the 1-wire bus:
.TP
"u"
Direct connection to the 1-wire interface on the USB port --
.I DS9490
.TP
/dev/ttySx
Direct connection to a 1-wire interface on the serial port --
.I DS9097U
or
.I DS9097
.TP
port | :port | IPaddress:port
Location of an
.I owserver
daemon that connects to the 1-wire bus. Multiple
.I owperl
as well as
.I owfs
and
.I owhttpd
programs can access the
.I owserver
process simultaneously. In fact, this will probably be the preferred mode of access to OWFS for
.I owperl
except in trivial applications.
.SH EXAMPLE
perl \-MOW \-e "OW::init('/dev/ttyS1'); printf OW::get('\');"
.SH SEE ALSO
.so man3/seealso.3so
.SH AVAILABILITY
http://www.owfs.org
.SH AUTHOR
Paul Alfille (paul.alfille@gmail.com)