plcotst(1)

💅 plcotst — PLC One-Time Self-Test Manager 💅

okay so real quick bestie: this is the plcotst page from the Qualcomm Atheros Open Powerline Toolkit, and it's literally the manager for the PLC One-Time Self-Test feature. buckle up, it's actually so good 🫶

✨ SYNOPSIS ✨

plcotst [options] [device] [device] [...]

🦋 DESCRIPTION 🦋

So here's the tea: this thing manages the PLC One-Time Self-Test feature on Atheros powerline devices. Normally the selftest runs once, on startup, at the factory — iconic, one-time-only behavior, very main character. But plot twist: you can also configure it and run it again with this utility. 💅

The selftest results get stored by the firmware, and yes, you can read them back with this utility too. Here's the vibe check on how it decides what to do:

• If you pass configuration options on the command line, the selftest gets configured.
• Otherwise, selftest results are read or cleared. periodt.

This program is part of the Qualcomm Atheros Powerline Toolkit. Peep the plc man page for an overview and the installation instructions — iykyk. 🌈

💖 OPTIONS 💖

• -c version — the configuration version number, bestie. Permitted values are 0 through 255. The default is 0. This option applies to both selftest configuration and selftest results, so it's doing double duty, no cap.
• -C — clear the stored selftest results. This option clears stored selftest results. It implies selftest results and supercedes options -d, -f, -m, -r and -R, if present on the command line. so if you put both, -C wins, sorry not sorry.
• -d seconds — delay the selftest after reboot. Permitted delay times are 0 through UINT_MAX seconds. The default is 0 seconds. This option implies selftest configuration and supercedes option -C, if present on the command line. ⏰
• -e — redirects stderr messages to stdout. By convention, status and error messages are printed on stderr while primary program output is printed on stdout. This option prints all output on stdout in cases where this is desired. merge the streams, slay. 🌊
• -f count — run the flash memory selftest count times. Valid values are 0 through UINT_MAX. The default is 0, which effectively suppresses the test. This option implies selftest configuration and supercedes option -C, if present on the command line.
• -m count — run the memory selftest count times. Valid values are 0 through UINT_MAX. The default is 0, which suppresses effectively the test. This option implies selftest configuration and supercedes option -C, if present on the command line.
• -q — suppresses status messages on stderr. shhh, quiet hours 🤫
• -r flag — run selftest after reboot. Permitted values are 0 through 255. Expected values are 0 for false and 1 for true. The default is 1. Heads up though: if the memory test count and the flash test count are both 0, no testing will occur when the time comes. This option implies selftest configuration and supercedes option -C, if present on the command line. 😭
• -R flag — reset the device after selftest. Permitted values are 0 through 255. Expected values are 0 for false and 1 for true. The default is 0. This option applies to selftest configuration only and supercedes option -C, if present on the command line. 🔄
• -t timeout — read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a response. The default is shown in brackets on the program menu. ⏳
• -v — print additional information on stdout. In particular, this option dumps incoming and outgoing packets, which can be saved as text files for reference. very demure, very forensic. 🔍
• -?,--help — print the program help summary on stdout. This option takes precedence over other options on the command line. it's giving "I'm the boss here". 👑
• -!,--version — print program version information on stdout. This option takes precedence over other options on the command line. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of the Linux Toolkit you are using. fr fr, they need the receipts. 📸

🎀 ARGUMENTS 🎀

• device — the Ethernet hardware address of some powerline device. More than one address may be specified on the command line. If more than one address is specified, then operations are performed on each device in turn. The default address is local. as explained in the DEVICES section.

🌸 EXAMPLES 🌸

This first one prints stored test results for the local device on stdout, because no options are specified on the command line. baby's first invocation 💖

# plcotst

The next example prints stored test results for remote device 00:B0:52:BA:BE:DE and clears them afterwards.

# plcotst -C

The next example configures the PLC selftest to wait 5 seconds before execution, because option -d is present. It also configures the selftest to reset the device after execution, because option -R is present. 🦋

# plcotst -d 5 -R

⭐ REFERENCES ⭐

See the Qualcomm Atheros Powerline Firmware Technical Reference Manual for more information about firmware selftest. 📚

💀 DISCLAIMER 💀

None.

(yeah, that's the whole thing. nothing. zero. nada. the disclaimer said "no thoughts, head empty" and honestly? respect. 🙈)

👑 SEE ALSO 👑

• plc(1)

🧚 CREDITS 🧚

• Charles Maier

and that's the whole page bestie, we ate and left no crumbs 🍓✨

open-plc-utils-0.0.3 — November 2013, that's the version and date this page came from, so when you cite it you know exactly which era of the toolkit you're living in 💜