Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Owtcl(TCL)							    Owtcl(TCL)

______________________________________________________________________________

NAME
       Owtcl - OWFS library access commands for	Tcl

SYNOPSIS
       package require ow

       ow option ?arg ...?

       ::OW::init interface ?interface ...? ?arg ...?
       ::OW::finish
       ::OW::isconnect
       ::OW::get ?path?	?arg ...?
       ::OW::put path ?value?
       ::OW::isdirectory path
       ::OW::isdir path
       ::OW::exists path

DESCRIPTION
   1-Wire
       1-wire is a wiring protocol and series of devices designed and manufac-
       tured 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  (humid-
       ity, 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 en-
       cryption	included.

       The 1-wire scheme uses a	single bus master 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,  par-
       allel, i2c, network or USB adapters.

   OWFS	design
       OWFS  is	 a  suite of programs that designed to make the	1-wire bus and
       its devices easily accessible. The underlying priciple is to  create  a
       virtual filesystem, with	the unique ID being the	directory, and the in-
       dividual	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 com-
       munication. Still the fundemental goal has been ease of use,  flexibil-
       ity and correctness rather than speed.

   owtcl
       owtcl  (3)  is  a Tcl extension that provides an	interface to OWFS. The
       underlying interface to	the  1-wire  bus  is  identical	 to  owfs  (1)
       (filesystem  view)  and	owhttpd	(1) web	server interface. Only the top
       layer has been modified to return native	Tcl data.

COMMANDS
       Performs	one of several operations, depending on	option.	 The legal op-
       tions (which may	be abbreviated)	are:

       ow open arg ...
	      Connect  to 1-wire adapter or owserver. arg ... defines a	way of
	      connection to the	1-wire bus.
	      The full set of initialization args is  extensive.  They	corre-
	      spond  roughly  to the command line args of owfs (1) owhttpd (1)
	      and owftpd (1)

       ow close
	      Close connection to 1-wire bus or	owserver.

       ow version ?-list?
	      Return version of	the owtcl and owlib/

       ow opened
	      Return 1 if connected to 1-wire adapter or  owserver,  otherwise
	      0.

       ow error	level value
	      Set debug	options. See owfs (5)

       ow error	print value
	      Set debug	options. See owfs (5)

       ow get path ?-list?
	      Returns  contents	of OWFS	directory as the list if path contains
	      name OWFS	directory.  If path is name of OWFS file,  returns  of
	      contents of this file. For files *.ALL returns a values list.

       ow put path value
	      Puts value in OWFS file indicated	in path. For files *.ALL use a
	      value list.

       ow isdirectory path
	      If path is the directory return 1. Otherwise return 0.

       ow isdir	path
	      Synonym of ow isdirectory

       ow set path
	      Creates a	new ow-like command with root in the path.  A new com-
	      mand allows options get, put, isdirectory, isdir and set.

LOW-LEVEL COMMANDS
       The following low-level commands	are possible:

       ::OW::init interface ?interface ...? ?arg ...?
	      Connect to 1-wire	adapter	or owserver. interface and arg ... de-
	      fines a way of connection	to the 1-wire bus.
	      The full set of initialization options is	extensive. They	corre-
	      spond roughly to the command line	options	of ,B owfs (1) owhttpd
	      (1) and owftpd (1)

       ::OW::finish
	      Close connection to 1-wire bus or	owserver.

       ::OW::isconnect
	      Return 1 if connected to 1-wire adapter or  owserver,  otherwise
	      0.

       ::OW::get ?path?	?-list?
	      Returns  contents	of OWFS	directory as the list if path contains
	      name OWFS	directory.  If path is name of OWFS file,  returns  of
	      contents of this file. For files *.ALL returns a values list. If
	      path is not defined, contents of root OWFS directory come	back.

       ::OW::put path ?value?
	      Puts value in OWFS file indicated	in path. For files *.ALL use a
	      value list. If /fIvalue is not defined, puts a empty string.

       ::OW::isdirectory path
	      If path is the directory - return	1. Otherwise return 0.

       ::OW::isdir path
	      Synonym of ::OW::isdirectory

       ::OW::exists path
	      If path is exists	- return 1. Otherwise return 0.

EXAMPLE
	      package require ow

	      ow open -d /dev/ttyS0 -t 60

	      set save_templow [ow get /28.86BF80000000/templow]
	      ow put /28.86BF80000000/templow 10

	      set room_sensor [ow set /28.86BF80000000]
	      $room_sensor put temphigh	50

	      set room_temp [$room_sensor set temperature]
	      set current_temp [$room_temp get]

SEE ALSO
   Programs
       owfs  (1)  owhttpd  (1)	owftpd	(1)  owserver (1) owdir	(1) owread (1)
       owwrite (1) owpresent (1) owtap (1)

   Configuration and testing
       owfs (5)	owtap (1) owmon	(1)

   Language bindings
       owtcl (3) owperl	(3) owcapi (3)

   Clocks
       DS1427 (3) DS1904(3) DS1994 (3)	DS2404	(3)  DS2404S  (3)  DS2415  (3)
       DS2417 (3)

   ID
       DS2401 (3) DS2411 (3) DS1990A (3)

   Memory
       DS1982  (3)  DS1985  (3)	 DS1986	 (3)  DS1991 (3) DS1992	(3) DS1993 (3)
       DS1995 (3) DS1996 (3) DS2430A (3) DS2431	 (3)  DS2433  (3)  DS2502  (3)
       DS2506 (3) DS28E04 (3) DS28EC20 (3)

   Switches
       DS2405 (3) DS2406 (3) DS2408 (3)	DS2409 (3) DS2413 (3) DS28EA00 (3)

   Temperature
       DS1822  (3)  DS1825  (3)	 DS1820	(3) DS18B20 (3)	DS18S20	(3) DS1920 (3)
       DS1921 (3) DS1821 (3) DS28EA00 (3) DS28E04 (3)

   Humidity
       DS1922 (3)

   Voltage
       DS2450 (3)

   Resistance
       DS2890 (3)

   Multifunction (current, voltage, temperature)
       DS2436 (3) DS2437 (3) DS2438 (3)	 DS2751	 (3)  DS2755  (3)  DS2756  (3)
       DS2760 (3) DS2770 (3) DS2780 (3)	DS2781 (3) DS2788 (3) DS2784 (3)

   Counter
       DS2423 (3)

   LCD Screen
       LCD (3) DS2408 (3)

   Crypto
       DS1977 (3)

   Pressure
       DS2406 (3) -- TAI8570

AVAILABILITY
       http://www.owfs.org

AUTHOR
       Serg Oskin (serg@oskin.ru)

Tcl				20/January/2005			    Owtcl(TCL)

NAME | SYNOPSIS | DESCRIPTION | COMMANDS | LOW-LEVEL COMMANDS | EXAMPLE | SEE ALSO | AVAILABILITY | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=owtcl&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help