W1RETAP(1)

📦
version 1.5.5 · 6 versions
, in ubuntu resolute, ubuntu stonking

💖 w1retap — bestie edition 💖

okay so you found w1retap in the man pages and you're like "what is this". bestie. it's literally the data logger for 1-Wire weather sensors and i'm about to make it make sense. this is from section 1 of the manual, so it's a user command, and we're gonna go through the whole thing together, no skipping, no skimming. 🎀

✨ NAME ✨

w1retap — a data logger for 1-Wire weather sensors. that's it, that's the whole vibe. 🌦️

✨ SYNOPSIS ✨

w1retap [OPTIONS]

that's the whole thing. options in, weather data out. 💅

✨ DESCRIPTION ✨

so the w1retap package reads weather sensors sitting on a 1-Wire bus, and then it data-logs whatever it retrieved into the databases or files you configured. like, it's the little guy that goes out, checks the weather, and writes it down. 📝

it supports a whole bunch of different 1-Wire host bus adapters, plus 1-Wire sensors designed by Dallas Semiconductor Corp (which is now Maxim Integrated, they rebranded, iconic of them) — and also compatible sensors, including ones from AAG Electrónica and other hobby sensors. so like, whatever weird little sensor you've got, there's a solid chance it's welcome here. 🫶

✨ OPTIONS ✨

here's the full menu, no cuts, all of it:

  • -h, --help — shows the help options. when in doubt, ask for help, that's the whole point. 🙈
  • -w, --wait — at startup, it waits until the next interval before doing anything. patient king energy. ⏳
  • -1, --once-only — read once and exit. one and done, no lingering. 👑
  • -R, --release-interface — releases the 1-Wire interface between reads. giving other processes a turn, so generous. 🎀
  • -d, --daemonise — daemonises (backgrounds) the application. it goes and lives in the background, main character who doesn't need attention. 🌙
  • -T, --no-tmp-log — disables the /var/lib/w1retap/.w1retap.dat logging. no temp log, no problem. 🚫
  • -l, --tmp-log-name=FILE — names the logging file (default is /var/lib/w1retap/.w1retap.dat). name your log, it deserves an identity. ✨
  • -i, --interface=DEVICE — sets the interface device. and here's the tea: DEVICE can be either a serial DS2480 adaptor or a USB DS2490-1 adaptor. for serial, use the serial device node (eg /dev/ttyS0 or /dev/ttyUSB0); for USB, use DS2490-1 to make it go through libusb. so like, pick your fighter. 🔌
  • -t, --cycle-time=SECS — time in seconds between device readings. how often it peeks at the sensors. ⏱️
  • -N, --dont-read — doesn't read sensors. and before you panic, the manpage says it's for debugging. so it's a feature, not a bug. 🐛
  • -v, --verbose — verbose messages. it will tell you everything, and honestly? we love a chatty icon. 🗣️
  • -o, --vane-offset=VAL — value for N for the weather vane, and the range is 0-15. weather vane calibration, very niche, very slay. 🧭
  • -V, --version — displays the version number, and then exits. quick little flex and then it's gone. 💅
  • -s, --simulate — simulates readings. it's for testing, and heads up: the manpage says it's not yet implemented, so don't come for it. 😭
  • -u, --use-utc — stores dates as UTC, instead of localtime. timezone girlies, this one's for you. 🌍
  • -r, --report-log=FILE — the report log file. 🌸

✨ EXAMPLE ✨

  • $ w1retap -l -i /dev/ttyUSBS0 -v

yes, that's the example exactly as written. copy it character for character if you're following along. 🔥

✨ SIGNALS ✨

the w1retap daemon accepts three signals, and they each do a different thing:

  • SIGUSR1 — causes it to read all the sensors immediately. right now. no waiting. ⚡
  • SIGUSR2 — causes it to print the current configuration. show me your settings bestie. 📋
  • SIGHUP — causes it to re-read the configuration. glow up time. 🦋

✨ EXIT STATUS ✨

  • 0 — returns 0 on success or failure.
okay so yes, that's genuinely what the manpage says. 0 on success or failure. that's the whole exit status section. no notes, that's just how it is. 💀

✨ SEE ALSO ✨

go read these too, they're the friends of this page:

✨ RESOURCES ✨

✨ AUTHOR ✨

this manual page was written by Thomas Stewart <thomas@stewarts.org.uk> for the Debian GNU/Linux system (but may be used by others). permission is granted to modify and distribute this manpage under the terms of GNU General Public Licence version 2 or (at your opinion) any later version. 💜

and that's the whole page, bestie, start to finish. this version is dated 11/05/2025 and it's from the W1RETAP(1) manual — so if you ever forget what you just read, that's where to find it again. go log some weather. 🌈✨

📦 where this page comes from