owfs.conf - owfs programs configuration file

Paul Alfille (paul.alfille@gmail.com) OWFS Configuration File Manpage 2006 OWFS(5)

1-Wire1-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. 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. The 1-wire scheme uses a single busmaster and multiple slaves on the same wire. The bus master initiates all communication. The slaves can be individually discovered and addressed using their unique ID. Bus masters come in a variety of configurations including serial, parallel, i2c, network or USB adapters. OWFSdesignOWFS 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. 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. Configurationowfs.conf(5) allows a uniform set of command line parameters to be set. Not all OWFS programs use the same command line options, but the non-relevant ones will be ignored. Command line and configuration options can mixed. They will be invoked in the order presented. Left to right for the command line. Top to bottom for the configuration file. Configuration files can call other configuration files. There is an arbitrary depth of 5 levels to prevent infinite loops. More than one configuration file can be specified.

owfs.conf - owfs programs configuration file

Here is a sample configuration file with all the possible parameters included. # Sourcesdevice = /dev/ttyS0 # serial port: DS9097U DS9097 ECLO or LINK device = /dev/i2c-0 # i2c port: DS2482-100 or DS2482-800 usb # USB device: DS9490 PuceBaboon usb = 2 # Second DS9490 usb = all # All DS9490s altUSB # Willy Robison's tweaks LINK = /dev/ttyS0 # serial LINK in ascii mode LINK = [address:]port # LINK-HUB-E (tcp access) HA7 # HA7Net autodiscovery mode HA7 = address[:port] # HA7Net at tcp address (port 80) etherweather = address[:port] # Etherweather device server = [address:]port # owserver tcp address FAKE = 10,1B # Random simulated device with family codes (hex) TESTER = 28,3E # Predictable simulated device with family codes # # Sinks # # owfs specific mountpoint = filelocation # FUSE mount point allow_other# Short hand for FUSE mount option " # # owhttpdowserverowftpd specific port = [address:]port # tcp out port # # TemperaturescalesCelsius # default FahrenheitKelvinRankine # # Timeouts(allinseconds) # cache for values that change on their own timeout_volatile = value # seconds "volatile" values remain in cache # cache for values that change on command timeout_stable = value # seconds "stable" values remain in cache # cache for directory lists (non-alarm) timeout_directory = value # seconds "directory" values remain in cache # cache for 1-wire device location timeout_presence = value # seconds "device presence" (which bus) timeout_serial = value # seconds to wait for serial response timeout_usb = value # seconds to wait for USB response timeout_network = value # seconds to wait for tcp/ip response timeout_ftp = value # seconds inactivity before closing ftp session # # Processcontrolconfiguration = filename # file (like this) of program options pid_file = filename # file to store PID number foregroundbackground # default readonly # prevent changing 1-wire device contents write # default error_print = 0-3 # 0-mixed 1-syslog 2-stderr 3-suppressed error_level = 0-9 # increasing noise # # zeroconf/Bonjourzero # turn on zeroconf announcement (default) nozero # turn off zeroconf announcement announce = name # name of announced service (optional) autoserver # Add owservers descovered by zeroconf/Bonjour noautoserver # Don't use zeroconf/Bonjour owservers (default) # # tcppersistencetimeout_persistent_low = 600 # minimum time a persistent socket will stay open timeout_persistent_high = 3600 # max time an idle client socket will stay around # # Displayformat = f[.]i[[.]c] # 1-wire address f amily i d code c rc # # Cachecache_size = 1000000 # maximum cache size (in bytes) or 0 for no limit (default 0) # # Information # (silly in a configuration file) versionhelpmorehelp

An OWFS configuration file is specified on the command line: owfs-cconfig_file[otheroptions] The file name is arbitrary, there is no default configuration file used.

Similar to Unix shell script or perl syntax Comments # Any # marks the start of a comment # blank lines are ignored Options option # some options (like 'foreground') take no values option=value # other options need a value optionvalue # '=' can be omitted if whitespace separates Option # Case is ignored (for options, not values) opt # non-ambiguous abbreviation allowed -opt--opt # hyphens ignored owserverserver: opt = value # only owserver effected by this line !server: opt = value # owserver NOT effected by this line owhttpdhttp: opt = value # only owhttpd effected by this line !http: opt = value # owhttpd NOT effected by this line owftpdftp: opt = value # only owftpd effected by this line !ftp: opt = value # owftpd NOT effected by this line owfsowfs: opt = value # only owfs effected by this line !owfs: opt = value # owfs NOT effected by this line Limits # maximum line length of 250 characters # no limit on number of lines

A configuration file can be invoked for any of the OWFS programs ( owfs(1)owhttpd(1)owserver(1)owftpd(1) ) or any of the language bindings ( owperl(1)owcapi(1)owtcl(1)owphpowpython ) to set command line parameters.