File: owtap.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 (108 lines) | stat: -rw-r--r-- 2,780 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
'\"
'\" Copyright (c) 2007 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Device manual page for owtap -- 1-wire filesystem package
'\" Protocol sniffer for owserver tcp protocol
'\"
'\" Free for all use. No warranty. None. Use at your own risk.
'\"
.TH OWTAP 1 2007 "OWTAP Manpage" "One-Wire File System"
.SH NAME
.B owtap
\- Packet sniffer for the owserver protocol 
.SH SYNOPSIS
.B owtap
.I \-p
owtap-tcp-port
.I \-s
owserver-tcp-port
.br
.SH "DESCRIPTION"
.so man1/description.1so
.SS owserver
.B owserver (1)
is the backend component of the OWFS 1-wire bus control system.
.B owserver (1)
arbitrates access to the bus from multiple client processes. The physical bus is usually connected to a serial or USB port, and other processes connect to
.B owserver (1)
over network sockets (tcp port).
.PP
Frontend clients include a filesystem representation:
.B owfs (1)
, and a webserver:
.B owhttpd (1).
Direct language bindings are also available, e.g:
.B owperl (3).
.PP
There are also many light-weight clients that can only talk to 
.B owserver (1)
and not to the 1-Wire bus directly. They include shell and multiple language modules (perl, Visual Basic, python,...)
.SS owserver protocol
All the
.B owserver (1)
clients use the
.B owserver protocol
for communication. The
.B owserver protocol
is a well documented tcp/ip client/server protocol. Assigned the "well known port" default of 4304. 
.SS owtap
.B owtap (1)
is interposed between
.B owserver (1)
and clients, to display and help resolve communication problems. Network communication is forwarded in both directions, but a visual display is also created, with statistics and "drill-down" of individual packets.
.SH SPECIFIC OPTIONS
.SS \-p
TCP port or IPaddress:port for
.I owtap
.br
Other OWFS programs will access owtap via this address. (e.g. owdir \-s IP:port /)
.SS \-s
TCP port or IPaddress:port for
.I owserver
.br
The tcp port (IP:port) for the "upstream" owserver.
.SH EXAMPLE
If
.B owserver (1)
is started:
.br
.B owserver \-p 4304 \-d /dev/ttyS0
.br
owserver on tcp port 4304 and connects to a physical 1-wire bus on a serial port.
.PP
You can directly query 
.B owserver (1)
with
.br
.B owdir \-s 4304 /
.PP
To see the protocol in action:
.br
.B owtap \-s 4304 \-p 3000
.br
.B owdir \-p 3000 /
.PP
In this case 
.B owtap (1)
is connecting to
.B owserver (1)
on the original port (4304) and offering a new port (3000) for clients.
.SH PLATFOMS
.B owtap (1)
is a pure
.I Tcl/TK
program and will run wherever
.I Tcl/TK
is available (Windows, Macintosh, Linux, Unix)
.SH LINKS
.SS owserver protocol
http://www.owfs.org/index.php?page=owserver-protocol
.SS Tcl/TK
http://www.tcl.tk
.SH SEE ALSO
.so man1/seealso.1so
.SH AVAILABILITY
http://www.owfs.org
.SH AUTHOR
Paul Alfille (paul.alfille@gmail.com)