plcget(1)

💖 plcget — Qualcomm Atheros PLC Get Propery 💖

okay bestie, we're doing plcget, part of the Qualcomm Atheros Open Powerline Toolkit. pull up a chair, grab a strawberry 🍓, this one's cute actually.

✨ SYNOPSIS ✨

plcget [options] [device] [device] [...]

like, give it some options, then a device or five, and it goes brrr. 🦋

🌸 DESCRIPTION 🌸

So basically: this reads one specific property value off a Qualcomm Atheros powerline device, using the VS_GET_PROPERTY message. You pick the property by its numeric property identifier — names are NOT supported, so don't even try it, bestie, it's not that kind of party. 🙈

Property values get printed on stdout in hexadecimal by default. But you also have alternate formats: ASCII, binary and decimal. options, we love options. 💅

Only selected properties can be read using this message type, okay? So go see the Qualcomm Atheros Firmware Technical Reference Manual for the supported properties and versions. iykyk.

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

💅 OPTIONS 💅

• -a — Display output in string format where each byte shows up as an ASCII character. Non-ASCII characters get displayed as a period / full-stop. This one is perfect for showing off HFID property values. ✨
• -b — Display output in binary format where each byte appears as 8 bits / binary digits. chef's kiss for interpreting bit-mapped property values. 🔥
• -d — Display output in decimal format where each byte appears as three decimal digits. Great for properties with small integer values.
• -e — Redirects stderr messages to stdout. By convention, status and error messages go to stderr while primary program output goes to stdout. This option prints everything on stdout for when that's the vibe you want.
• -h — Display output in hexadecimal format where each byte appears as a hexadecimal octet consisting of two hexadecimal digits. Hexadecimal is the default output format, so this is lowkey the home base. 🏠
• -n number — The property identifier or property version. Property identifiers and versions are entered as 32-bit decimal integers. Property names are not supported (again, no names, periodt). The default is 0. This option may appear <b>more than once</b> on the command line: the first occurrence specifies the property identifier, and the second occurrence specifies the property version. Check the Firmware Technical Reference Manual for a list of valid property identifiers and versions. 👑
• -i interface — Select the host Ethernet interface. All requests are sent via this interface, and only responses received via this interface are recognized. The default interface is eth1 because most people use eth0 as their principle network connection. BUT — if the environment string PLC is defined, then it takes precedence over the default interface. And this option takes precedence over either default. hierarchy, we love her. 💜
• -q — Suppresses status messages on stderr. shhh. 🤫
• -v — Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout. not me being nosy 👀
• -?, --help — Displays program help information on stderr. This option takes precedence over all other options on the command line except version information.
• -!, --version — Displays program version information on stderr. This option takes precedence over all other options on the command line except help information. Use this one when sending screen dumps to Atheros technical staff. 📸

🎀 ARGUMENTS 🎀

• device — The MAC address of some powerline device. More than one address may be specified. If more than one address is specified, then operations are performed on each device in turn. The default address is local. See DEVICES for info about symbolic device addresses.

🦋 DEVICES 🦋

Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexadecimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are all valid and equivalent. cute, right? ✨

The following MAC addresses are special and may be entered by name instead of number:

• all — Same as "broadcast".
• broadcast — A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices — whether local, remote or foreign — recognize messages sent to this address. A remote device is any device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
• local — A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local Atheros devices recognize this address, but remote and foreign devices do not. A remote device is any device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.

🌈 REFERENCES 🌈

See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information. 📚

⚠️ DISCLAIMER ⚠️

Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message structure and content in future firmware releases <b>without any obligation to notify or compensate users of this program</b>. 💀

like... they can just change stuff and not tell us. no cap. be aware.

💀 EXAMPLES 💀

None. 😭 that's it. that's the section. sorry bestie.

👑 SEE ALSO 👑

plc(1), getpib(1), modpib(1), plcset(1), setpib(1)

💖 CREDITS 💖

Charles Maier — thank you for your service, king. 🫶

and that's the whole page, bestie! this one shipped in open-plc-utils-0.0.3, dated November 2013 — vintage, but she still slays. go read your properties responsibly. 🎀✨💅