coqos_man(1)

✨ coqos_man(1) ✨

okay bestie, welcome to coqos_man, straight out of the Qualcomm Atheros Open Powerline Toolkit πŸ’– this little icon does exactly what it says on the tin: it watches your bandwidth and sets a cap on it. let's get into it 🫢


🌸 NAME 🌸

coqos_man β€” set and monitor bandwidth πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

coqos_man [options] limit [device] [...]

πŸ¦‹ DESCRIPTION πŸ¦‹

ngl, this page is under construction 🚧 so don't come for me if it's a little sparse.

what it does do: it monitors the bandwidth being used and sets a bandwidth limit. and the way that it's so smart?? if the bandwidth limit gets exceeded, it will suspend the lower priority streams in priority order until the bandwidth being used drops back below the limit. queen behavior, honestly πŸ‘‘

this program is part of the Qualcomm Atheros Powerline Toolkit. see the plc man page for an overview and installation instructions β€” iykyk πŸ“–


πŸ’… OPTIONS πŸ’…

  • -e β€” redirects stderr messages to stdout. by convention, progress messages and error messages get printed on stderr while the primary program output goes to stdout. this option prints all output on stdout in cases where that's what you want. no cap ✨
  • -i interface β€” picks the host Ethernet interface. all requests are sent via this host interface, and only responses received via this host interface are recognized. the default interface is eth1 because most people use eth0 as their principle network connection; however, if the environment string "PLC" is defined then it takes precedence over the default interface. and this option then takes precedence over either default. so it's like a little hierarchy, slay πŸŽ€
  • -q β€” suppresses status messages on stderr. quiet era πŸ“
  • -r β€” display relative memory offsets on output. this option is the default. so like, you already have it πŸ’–
  • -v β€” prints additional information on stdout. in particular, this option dumps outgoing Ethernet packets on stdout. very verbose, very main character πŸ’€
  • -?, --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 option when sending screen dumps to Atheros technical staff πŸ™ˆ

🌈 ARGUMENTS 🌈

  • limit β€” the bandwidth limit, in kbps, expressed as a decimal integer. this argument is required. the range is 10 through 90000. no going outside the lines bestie πŸ’€
  • device β€” the MAC 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". see DEVICES for more information πŸ¦‹

🧚 DEVICES 🧚

Ethernet MAC addresses are expressed as six hexadecimal octets, optionally separated by colon. for example, the Qualcomm Atheros Local Management Address (LMA) of "00b052000001" may also be entered as "00:b0:52:00:00:01" or "00b052:000001". addresses are case insensitive and quotes are optional. in addition, some special addresses may be entered by name rather than number β€” where names are case sensitive. yes, the rules are different for names, keep up bestie πŸ’…

  • all β€” a synonym for the "broadcast" address, described next.
  • broadcast β€” a synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. all devices, whether local, remote or foreign, will respond to this address. it's giving group chat energy πŸ“£
  • 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. ok so local is the exclusive club πŸ’–

⭐ REFERENCES ⭐

see the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more 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 without any obligation to notify or compensate users of this program. so like... yeah, they can change things whenever and you just have to deal 😭 periodt.


πŸ”₯ EXAMPLES πŸ”₯

the following example suspends streams if the bandwidth used exceeds 20mbps.

# coqos_man 20000 00:B0:52:BA:BE:01

ate, no crumbs πŸŽ€


🌸 SEE ALSO 🌸

coqos_add(1), coqos_info(1), coqos_mod(1), coqos_rel(1)

go read the whole fam, they're all iconic 🫢


πŸ‘‘ CREDITS πŸ‘‘

  • Bill Wike
  • Nathaniel Houghton
  • Charles Maier

the actual legends who built this πŸ’œ


and that's the whole vibe check bestie ✨ this page ships with open-plc-utils-0.0.3, dated November 2013 β€” yes it's vintage, and vintage is lowkey always in πŸŒˆπŸ’– bye!! πŸ¦‹