OWTCL(3)

🎀 NAME 🎀

Owtcl — OWFS library access commands for Tcl. Yep, that's the whole vibe: it's OWTCL(3), from the Library Functions Manual, and it's here to let your Tcl scripts talk to 1-wire stuff 🦋

---

✨ 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 a whole series of devices, designed and manufactured by Dallas Semiconductor, Inc. It's giving low-power, low-speed, low-connector — the bus is literally so minimal that the data line can also hand out power. Main character energy for a cable 🔥

Every single device is uniquely and unalterably numbered during manufacture. No duplicates, no take-backs, no cap. And the family is huge: memory, sensors (humidity, temperature, voltage, contact, current), switches, timers and data loggers. You can build more complex devices (like thermocouple sensors) out of these basic ones. There are even 1-wire devices that have encryption built in 👑

The 1-wire scheme uses a single bus master and multiple slaves on the same wire. The bus master initiates all communication — it's the one holding the aux, periodt. 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 🌸

🧚 OWFS design 🧚

OWFS</purpose> is a suite of programs designed to make the 1-wire bus and its devices easily accessible. The underlying principle is to create a virtual filesystem, where the unique ID is the directory, and the individual properties of the device are represented as simple files you can read and write. It's giving "everything is a file" and honestly? Iconic 💅

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. But the fundamental goal has been ease of use, flexibility and correctness rather than speed. Not everything has to be a speedrun, bestie 🫶

🌸 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 options (which may be abbreviated) are:

• ow open arg ... — Connect to a 1-wire adapter or owserver. The arg ... defines the way of connecting to the 1-wire bus. The full set of initialization args is extensive — they correspond roughly to the command line args of owfs (1), owhttpd (1) and owftpd (1).
• ow close — Close the connection to the 1-wire bus or owserver. Bye bestie 👋
• ow version ?-list? — Return the version of the owtcl and owlib/.
• ow opened — Return 1 if connected to a 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 the contents of the OWFS directory as a list if path contains the name of an OWFS directory. If path is the name of an OWFS file, returns the contents of this file. For files *.ALL returns a values list.
• ow put path value — Puts value in the OWFS file indicated in path. For files *.ALL use a value list.
• ow isdirectory path — If path is a 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 command 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 a 1-wire adapter or owserver. interface and arg ... define the way of connecting to the 1-wire bus. The full set of initialization options is extensive — they correspond roughly to the command line options of ,B owfs (1), owhttpd (1) and owftpd (1). (Yes, the ,B is literally in the original. We don't ask questions 💀)
• ::OW::finish — Close the connection to the 1-wire bus or owserver.
• ::OW::isconnect — Return 1 if connected to a 1-wire adapter or owserver, otherwise 0.
• ::OW::get ?path? ?-list? — Returns the contents of the OWFS directory as a list if path contains the name of an OWFS directory. If path is the name of an OWFS file, returns the contents of this file. For files *.ALL returns a values list. If path is not defined, the contents of the root OWFS directory come back.
• ::OW::put path ?value? — Puts value in the OWFS file indicated in path. For files *.ALL use a value list. If value is not defined, puts an empty string.
• ::OW::isdirectory path — If path is a directory, return 1. Otherwise return 0.
• ::OW::isdir path — Synonym of ::OW::isdirectory.
• ::OW::exists path — If path 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]

Look at that. Nested command handles going full inception and it works. Ate 💖

---

🦋 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)

---

and that's a wrap, bestie ✨ this page came from the Tcl manual, dated 2005-01-20, and it's filed under OWTCL(3). go read some sensors, you got this 🫶🎀