pev.1 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. .TH pev 1 "Mar 2014" "plc-utils-2.1.6" "Qualcomm Atheros Powerline Toolkit"
  2. .SH NAME
  3. pev - Qualcomm Atheros Plug-in Electric Vehicle Emulator
  4. .SH SYNOPSIS
  5. .BR pev
  6. .RI [ options ]
  7. .SH DESCRIPTION
  8. Emulate the PEV part of the HomePlug AV Signal Level Attentuation Characterization (SLAC) protocol where a \fBPEV\fR is a "\fBPlug-in Electric Vehicle\fR" and an \fBEVSE\fR is an "\fBElectric Vehicle Supply Equipment\fR" or charging station.
  9. This program will remain active until it detects and connects to an available EVSE-HLE on the powerline network.
  10. Once connected, it charges a virtual vehicle for about 10 seconds then disconnects and terminates.
  11. See the \fIHomePlug Green PHY Specification Release Version 1.1\fR for more information on this protocol.
  12. .PP
  13. Signal Level Attenuation Characterization (SLAC) enables a station to measure the signal level of its transmission at other stations in the network.
  14. It is designed for automotive applications where there are multiple plug-in vehicle (PEVs) and electric vehicle supply equipment (EVSE) on the network.
  15. The PEV signal level is measured at multiple EVSEs to determine which EVSE the PEV is actually plugged into.
  16. The process leading to this determination is called "\fBGreen PHY PEV-EVSE Association\fB" (GreenPPEA).
  17. .PP
  18. This program is part of the Qualcomm Atheros Powerline Toolkit.
  19. See the \fBplc\fR man page for an overview and installation instructions.
  20. .SH OPTIONS
  21. .TP
  22. .RB - c
  23. Print the PEV-HLE configuration profile on stdout.
  24. The configuration profile specifies program defaults in a format that you, as a user, can edit and save.
  25. Use options \fB-p\fR and \fB-s\fR to read named profiles and sections.
  26. .TP
  27. .RB - d
  28. Print the contents of the PEV-HLE session variable on stdout.
  29. The session variable is an program data structure that stores information passed between the PEV-HLE and EVSE-HLE during SLAC association.
  30. This option is used to inspect and veriify information relevant to the process.
  31. If the program was compiled with variable SLAC_DEBUG defined then this option also prints MME message fields before messages are sent or after they are received.
  32. Interested parties can follow along in the source code.
  33. .TP
  34. .RB - i
  35. Select the host Ethernet interface.
  36. All requests are sent via this host interface and only reponses received via this host interface are recognized.
  37. The default interface is \fBeth1\fR because most people use \fBeth0\fR as their principle network connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
  38. This option then takes precedence over either default.
  39. .TP
  40. -\fBp \fIprofile\fR
  41. The PEV-HLE configuration profile name.
  42. The program will supply default values for missing profile elements.
  43. See the example profile shown below.
  44. The default profile name is "\fBpev.ini\fR".
  45. .TP
  46. .RB - q
  47. Enter quiet mode.
  48. Progress messages are suppressed.
  49. .TP
  50. -\fBs \fIsection\fR
  51. The configuration profile section name.
  52. The program will supply default values for missing configuration profile elements.
  53. See the example profile shown below.
  54. The default section name is "\fBdefault\fR".
  55. .TP
  56. .RB - v
  57. Enter verbose mode.
  58. All Etherenet frames sent or received by the program are displayed on stdout.
  59. .TP
  60. -\fBw \fImilliseconds\fR
  61. Wakeup frequency in milliseconds.
  62. Values range from 0 through UINT_MAX.
  63. The default is \fB5000\fR milliseconds (or 5 seconds).
  64. .TP
  65. -\fB?\fR, --\fBhelp\fR
  66. Print program help summary on stdout.
  67. This option takes precedence over other options on the command line.
  68. .TP
  69. -\fB!\fR, --\fBversion\fR
  70. Print program version information on stdout.
  71. This option takes precedence over other options on the command line.
  72. 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.
  73. .SH PROFILES
  74. The default configuration profile for this program is "\fBpev.ini\fR".
  75. The default profile section is "\fBdefault\fR".
  76. Users may create addition profiles and reference them with option \fB-p\fr or add additional sections to an existing profiles and reference them with option \fB-s\fR.
  77. .TP
  78. .B Attenuation Theshold
  79. The average attenuation above which the PEV will not connect to an EVSE.
  80. The default value is \fB10\fRdb.
  81. .TP
  82. .B MSound Pause
  83. The time in milliseconds between each MSound sent by the PEV-HLE to the EVSE-HLE.
  84. Sending MSounds too frequently overloads the EVSE-PLC.
  85. Sending them too infrequently wastes time.
  86. This value is derived and does not appear in the HPGP specification.
  87. The default pause is \fB10\fR milliseconds.
  88. .TP
  89. .B Vehicle Identifier
  90. Vehicle identification.
  91. The 17-byte Vehicle Identification Number to be placed in CM_MNBC_SOUND.IND.SenderID.
  92. This value is not used but is can be changed here so that the field is easy to spot within network message traces.
  93. .TP
  94. .B Network Membership Key
  95. The 16-byte Network Memberhip Key (NMK) for the PEV-PLC device.
  96. This program uses CM_SET_KEY to sets the PEV-PLC NMK to this value after disconnecting.
  97. The default value is the key for Network Password "\fBHomePlugAV\fR".
  98. .TP
  99. .B Network Identifier
  100. The 7-byte Network Identifier (NID) for the PEV-PLC device.
  101. This program uses CM_SET_KEY to sets the PEV-PLC NID to this value after disconnecting.
  102. The default value is the same as that for Network Password "\fBHomePlugAV\fR".
  103. .SH REFERENCES
  104. See the \fIQualcomm Atheros AR7420, QCA6410 IEEE 1901, HomePlug AV and QCA7000 HomePlug Green PHY PLC Chipset Programmer''s Guide\fR or the \fIHomePlug Green PHY Specification Release Version 1.1\fR for more information on this protocol.
  105. .SH EXAMPLES
  106. The following example starts a PEV session on interface \fBeth0\fR and wait up to 2000 milliseconds (or 2 seconds) for the EVSE to respond during any given exchange.
  107. .PP
  108. # pev -ieth0 -w2000
  109. .PP
  110. The default PEV-HLE configuration profile, "\fBpev.ini\fR", looks something like this but it can be changed using a normal text editor.
  111. Use option \fB-P\fR to produce a template profile, if one is needed.
  112. .PP
  113. # file: pev.ini
  114. # ====================================================================
  115. # PEV-HLE initialization;
  116. # --------------------------------------------------------------------
  117. [default]
  118. attenuation threshold = 10
  119. msound pause = 10
  120. vehicle identifier = AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
  121. network membership key = 50D3E4933F855B7040784DF815AA8DB7
  122. network identifier = B0F2E695666B03
  123. .SH SEE ALSO
  124. .BR plc ( 1 ),
  125. .BR evse ( 1 )
  126. .SH CREDITS
  127. Charles Maier <cmaier@qca.qualcomm.com>