owfs-libs/owfs(5)

1OWFS(5)                      One-Wire File System                      OWFS(5)
2
3
4

NAME

6       owfs.conf - owfs programs configuration file
7

SYNOPSIS

9       An OWFS configuration file is specified on the command line:
10
11       owfs -c config_file [other options]
12              The  file  name  is arbitrary, there is no default configuration
13              file used.
14

USAGE

16       A configuration file can be invoked for any of the OWFS programs ( owfs
17       [1m(1)  owhttpd (1) owserver (1) owftpd (1) ) or any of the language bind‐
18       ings ( owperl (1) owcapi (1) owtcl (1) owphp owpython ) to set  command
19       line parameters.
20

SYNTAX

22       Similar to Unix shell script or perl syntax
23
24       Comments
25              # Any # marks the start of a comment
26              # blank lines are ignored
27
28
29       Options
30              option # some options (like 'foreground') take no values
31              option = value # other options need a value
32              option value # '=' can be omitted if whitespace separates
33              Option # Case is ignored (for options, not values)
34              opt # non-ambiguous abbreviation allowed
35              -opt --opt # hyphens ignored
36
37       owserver
38              server: opt = value # only owserver effected by this line
39              ! server: opt = value # owserver NOT effected by this line
40
41       owhttpd
42              http: opt = value # only owhttpd effected by this line
43              ! http: opt = value # owhttpd NOT effected by this line
44
45       owftpd ftp: opt = value # only owftpd effected by this line
46              ! ftp: opt = value # owftpd NOT effected by this line
47
48       owfs   owfs: opt = value # only owfs effected by this line
49              ! owfs: opt = value # owfs NOT effected by this line
50
51       Limits # maximum line length of 250 characters
52              # no limit on number of lines
53

DESCRIPTION

55   1-Wire
56       1-wire is a wiring protocol and series of devices designed and manufac‐
57       tured by Dallas Semiconductor, Inc. The bus is  a  low-power  low-speed
58       low-connector scheme where the data line can also provide power.
59
60       Each  device  is  uniquely and unalterably numbered during manufacture.
61       There are a wide variety of devices, including memory, sensors  (humid‐
62       ity, temperature, voltage, contact, current), switches, timers and data
63       loggers. More complex devices (like thermocouple sensors) can be  built
64       with  these  basic devices. There are also 1-wire devices that have en‐
65       cryption included.
66
67       The 1-wire scheme uses a single bus master and multiple slaves  on  the
68       same  wire.  The bus master initiates all communication. The slaves can
69       be individually discovered and addressed using their unique ID.
70
71       Bus masters come in a variety of configurations including serial,  par‐
72       allel, i2c, network or USB adapters.
73
74   OWFS design
75       OWFS  is  a  suite of programs that designed to make the 1-wire bus and
76       its devices easily accessible. The underlying principle is to create  a
77       virtual filesystem, with the unique ID being the directory, and the in‐
78       dividual properties of the device are represented as simple files  that
79       can be read and written.
80
81       Details  of  the  individual slave or master design are hidden behind a
82       consistent interface. The goal is to provide an easy set of tools for a
83       software  designer  to create monitoring or control applications. There
84       are some performance enhancements in the implementation, including data
85       caching, parallel access to bus masters, and aggregation of device com‐
86       munication. Still the fundamental goal has been ease of use,  flexibil‐
87       ity and correctness rather than speed.
88
89   Configuration
90       owfs.conf  (5)  allows  a  uniform set of command line parameters to be
91       set.
92
93       Not all OWFS programs use the same command line options, but  the  non-
94       relevant ones will be ignored.
95
96       Command  line and configuration options can mixed. They will be invoked
97       in the order presented. Left to right for the command line. Top to bot‐
98       tom for the configuration file.
99
100       Configuration files can call other configuration files. There is an ar‐
101       bitrary depth of 5 levels to prevent infinite loops. More than one con‐
102       figuration file can be specified.
103

SAMPLE

105       Here  is  a  sample configuration file with all the possible parameters
106       included.
107              # Sources
108              device = /dev/ttyS0 # serial port: DS9097U DS9097 ECLO or LINK
109              device = /dev/i2c-0 # i2c port: DS2482-100 or DS2482-800
110              usb #       USB device: DS9490 PuceBaboon
111              usb = 2 #   Second DS9490
112              usb = all # All DS9490s
113              altUSB # Willy Robison's tweaks
114              LINK = /dev/ttyS0 #     serial LINK in ascii mode
115              LINK = [address:]port # LINK-HUB-E (tcp access)
116              HA7 # HA7Net autodiscovery mode
117              HA7 = address[:port] # HA7Net at tcp address (port 80)
118              etherweather = address[:port] # Etherweather device
119              server = [address:]port # owserver tcp address
120              FAKE = 10,1B # Random simulated device with family codes (hex)
121              TESTER = 28,3E # Predictable simulated device with family codes
122              #
123              # Sinks
124              # # owfs specific
125              mountpoint = filelocation # FUSE mount point
126              allow_other # Short hand for FUSE mount option "
127              # # owhttpd owserver owftpd specific
128              port = [address:]port # tcp out port
129              #
130              # Temperature scales
131              Celsius # default
132              Fahrenheit
133              Kelvin
134              Rankine
135              #
136              # Timeouts (all in seconds)
137              #                    cache for values that change on their own
138              timeout_volatile = value # seconds "volatile" values  remain  in
139              cache
140              #                    cache for values that change on command
141              timeout_stable = value # seconds "stable" values remain in cache
142              #                    cache for directory lists (non-alarm)
143              timeout_directory = value # seconds "directory" values remain in
144              cache
145              #                    cache for 1-wire device location
146              timeout_presence = value # seconds "device presence" (which bus)
147              timeout_serial = value # seconds to wait for serial response
148              timeout_usb = value # seconds to wait for USB response
149              timeout_network = value # seconds to wait for tcp/ip response
150              timeout_ftp = value # seconds inactivity before closing ftp ses‐
151              sion
152              #
153              # Process control
154              configuration = filename # file (like this) of program options
155              pid_file = filename # file to store PID number
156              foreground
157              background # default
158              readonly # prevent changing 1-wire device contents
159              write # default
160              error_print = 0-3 # 0-mixed 1-syslog 2-stderr 3-suppressed
161              error_level = 0-9 # increasing noise
162              #
163              # zeroconf / Bonjour
164              zero #   turn on zeroconf announcement (default)
165              nozero #   turn off zeroconf announcement
166              announce = name  # name of announced service (optional)
167              autoserver #   Add owservers descovered by zeroconf/Bonjour
168              noautoserver #   Don't use zeroconf/Bonjour owservers (default)
169              #
170              # tcp persistence
171              timeout_persistent_low  = 600 # minimum time a persistent socket
172              will stay open
173              timeout_persistent_high = 3600 # max time an idle client  socket
174              will stay around
175              #
176              # Display
177              format = f[.]i[[.]c] # 1-wire address f amily i d code c rc
178              #
179              # Cache
180              cache_size = 1000000 # maximum cache size (in bytes) or 0 for no
181              limit (default 0) #
182              # Information
183              # (silly in a configuration file)
184              version
185              help
186              morehelp
187

AVAILABILITY

244       http://www.owfs.org
245

AUTHOR

247       Paul Alfille (paul.alfille@gmail.com)
248
249
250
251OWFS Configuration File Manpage      2006                              OWFS(5)