coqos_info(1)

coqos_info(1) πŸ’–

okay bestie, welcome to coqos_info, the CoQoS Stream Utility from the Qualcomm Atheros Open Powerline Toolkit. she's a little mysterious, she's a little under construction, but we're gonna get through this together 🫢


✨ NAME ✨

coqos_info β€” the CoQoS Stream Utility, aka your girl for poking at connection info πŸ’…


✨ SYNOPSIS ✨

coqos_info [options] type [cid] [limit] [device]

yes that's the whole vibe. type is doing the heavy lifting, everything else is optional bestie 🌸


✨ DESCRIPTION ✨

so here's the tea: this page is under construction. 🚧

None.

This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation instructions. (iykyk, go read that one too πŸ’–)


✨ OPTIONS ✨

  • -e β€” redirects stderr messages to stdout. okay so by convention, progress messages and error messages get printed on stderr while the primary program output goes to stdout. this option puts everything on stdout for when that's what you want. slay ✨
  • -i interface β€” picks the host Ethernet interface. all requests go out via this host interface, and only responses that come back via this host 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, periodt πŸ‘‘
  • -q β€” suppresses status messages on stderr. quiet queen behavior 🀫
  • -r β€” display relative memory offsets on output. this option is the default, so it's already giving what it needs to give πŸ’…
  • -v β€” prints additional information on stdout. in particular, this option dumps outgoing Ethernet packets on stdout. very nosy of her, we love that πŸ¦‹
  • -?, --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 ✨

  • type β€” the request type. valid types are "STA", "CID", "RSVD", "VIC", "BW", and "BW". (yes, BW is listed twice. that's just what the page says bestie, we don't question it πŸ™ˆ) individual request types are described below πŸ‘‡
  • 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 πŸ’–

✨ TYPES ✨

  • STA β€” Station. request information on all active connections for this station. main character energy fr fr ⭐
  • CID number β€” Connection identifier. if present, it must be followed by a valid connection identifier. connection identifiers are assigned when the connection is added using program coqos_add. the connection identifier is two bytes where byte 0 is the LLID-F and byte 1 is the OrigTEI. very specific, very demure πŸŽ€
  • RSVD β€” Reserved. sets REQ_TYPE = 2 in the mme. that's it, that's the whole thing πŸ’…
  • VIC β€” Vicinity. provide all active connections in the vicinity. she's just keeping an eye on the neighborhood 🌸
  • BW number β€” Bandwidth. set station to provide info when the limit is exceeded. BW must be followed by a number. this number is in units of 10kbps. BWC cancels all previous requests. 🚨 heads up on that last bit

✨ 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. πŸ‘€

  • 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. everyone's invited to the party πŸŽ‰
  • 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 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. 😭 yeah bestie, they can just do that

✨ EXAMPLES ✨

this command requests connection from the station 🫢

# coqos_info STA 00:B0:52:BA:BE:01

this command set the station to provide notification if the bandwidth used exceeds 20mbps πŸ”₯

# coqos_info BW 2000 00:B0:52:BA:BE:01

✨ SEE ALSO ✨

coqos_add(1), coqos_rel(1), coqos_man(1), coqos_mod(1) β€” the whole friend group πŸ’– go say hi


✨ CREDITS ✨

  • Bill Wike
  • Nathaniel Houghton
  • Charles Maier

icons, all of them πŸ‘‘βœ¨


and that's the page bestie!! this was coqos_info(1) from the open-plc-utils-0.0.3 era, dated November 2013. yes she's vintage, yes she still ate πŸ’…πŸŽ€πŸ¦‹πŸ’–