plcget.1.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. <?xml version='1.0' encoding='iso-8859-1'?>
  2. <!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  3. <html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
  4. <head>
  5. <title>
  6. plcget.1
  7. </title>
  8. <meta http-equiv='content-type' content='text/html;iso-8859-1'/>
  9. <meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
  10. <meta name='author' content='cmaier@cmassoc.net'/>
  11. <meta name='robots' content='noindex,nofollow'/>
  12. <link href='toolkit.css' rel='stylesheet' type='text/css'/>
  13. </head>
  14. <body>
  15. <div class='headerlink'>
  16. [<a href='plcfwd.1.html' title=' plcfwd.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='plchost.1.html' title=' plchost.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. plcget(1) Qualcomm Atheros Open Powerline Toolkit plcget(1)
  22. NAME
  23. plcget - Qualcomm Atheros PLC Get Propery
  24. SYNOPSIS
  25. plcget [options] [device] [device] [...]
  26. DESCRIPTION
  27. Read a specific property value from a Qualcomm Atheros powerline device using the VS_GET_PROPERTY message. Properties
  28. are selected using their numeric property identifier. Property names are not supported. Property values are printed on
  29. stdout in hexadecimal format by default. Alternate formats are ASCII, binary and decimal.
  30. Only selected properties can be read using this message type. See the Qualcomm Atheros Firmware Technical Reference Man‐
  31. ual for supported properties and versions.
  32. This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
  33. instructions.
  34. OPTIONS
  35. -a Display output in string format where each byte appears as an ASCII character. Non-ASCII characters are displayed
  36. as a period or full-stop. This option is useful for displaying HFID property values.
  37. -b Display output in binary format where each byte appears as 8 bits or binary digits. This option is useful for
  38. interpreting bit-mapped property values.
  39. -d Display output in decimal format where each byte appears as three decimal digits. This option is useful for prop‐
  40. erties with small integer values.
  41. -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
  42. program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
  43. -h Display output in hexadecimal format where each byte appears as a hexadecimal octet consisting of two hexadecimal
  44. digits. Hexadecimal is the default output format.
  45. -n number
  46. The property identifier or property version. Property identifiers and versions are entered as 32-bit decimal
  47. integers. Property names are not supported. The default is 0. This option may appear more than once on the com‐
  48. mand line. The first occurance specifies the property identifier. The second occurances specifies the property
  49. version. See the Firmware Technical Reference Manual for an list of valid property identifiers and versions.
  50. -i interface
  51. Select the host Ethernet interface. All requests are sent via this interface and only reponses received via this
  52. interface are recognized. The default interface is eth1 because most people use eth0 as their principle network
  53. connection; however, if environment string &quot;PLC&quot; is defined then it takes precedence over the default interface.
  54. This option then takes precedence over either default.
  55. -q Suppresses status messages on stderr.
  56. -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
  57. -?,--help
  58. Displays program help information on stderr. This option takes precedence over all other options on the command
  59. line except version information.
  60. -!,--version
  61. Displays program version information on stderr. This option takes precedence over all other options on the com‐
  62. mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
  63. ARGUMENTS
  64. device The MAC address of some powerline device. More than one address may be specified. If more than one address is
  65. specified then operations are performed on each device in turn. The default address is local. See DEVICES for
  66. information about symbolic device addresses.
  67. DEVICES
  68. Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
  69. decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
  70. &quot;00b052000001&quot;, &quot;00:b0:52:00:00:01&quot; and &quot;00b052:000001&quot; are valid and equivalent.
  71. The following MAC addresses are special and may be entered by name instead of number.
  72. all Same as &quot;broadcast&quot;.
  73. broadcast
  74. A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
  75. recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
  76. A foreign device is any device not manufactured by Atheros.
  77. local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
  78. Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
  79. the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
  80. REFERENCES
  81. See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information.
  82. DISCLAIMER
  83. Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
  84. USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
  85. structure and content in future firmware releases without any obligation to notify or compensate users of this program.
  86. EXAMPLES
  87. None.
  88. SEE ALSO
  89. plc(1), getpib(1), modpib(1), plcset(1), setpib(1)
  90. CREDITS
  91. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  92. open-plc-utils-0.0.3 Mar 2014 plcget(1)
  93. </pre>
  94. <div class='footerlink'>
  95. [<a href='plcfwd.1.html' title=' plcfwd.1 '>PREV</a>]
  96. [<a href='toolkit.html' title=' Index '>HOME</a>]
  97. [<a href='plchost.1.html' title=' plchost.1 '>NEXT</a>]
  98. </div>
  99. </body>
  100. </html>