ST G3-PLC User Manual

ST G3-PLC User Manual

Graphical user interface (gui)
Table of Contents

Advertisement

Quick Links

UM1811
User manual
G3-PLC graphical user interface (GUI)
Introduction
The G3 power line communication (G3-PLC) graphical user interface (GUI) is a tool
implemented by STMicroelectronics™ that allows interfacing one or more ST platforms
equipped with the G3-PLC protocol, hereafter called G3-PLC platforms. This tool is running
®
®
®
on a Microsoft
Windows
PC that is connected to a supported G3-PLC
platform (see
Section 2 on page
6) through to a serial link, converted to a USB connection. On the PC
side, the communication with the G3-PLC platform is managed thanks to a node interface
plugin written in C# accessible through a graphical front-end. On the G3-PLC platform, the
communication is managed thanks to a host interface application that receives/sends the
messages from/to the PC. Messages are translated into commands for the ST G3-PLC
library. This document does not describe in details the plugin, the host interface application,
nor the ST G3-PLC library. It describes the PC tool features, it details the options that it
offers, it gives clear guidance on how to connect a G3-PLC platform to the tool and it
provides examples in order to transmit data between two different G3-PLC platforms. To
better understand some menu of the GUI, it is useful to understand how the ST G3-PLC
protocol stack is implemented:

Figure 1. Communication between GUI and G3-PLC platform

On the G3-PLC platform, a Host Interface application forwards commands from the serial
link to the right layer of the protocol stack (6LoWPAN, MAC, PHY) and it forwards responses
from one layer of the protocol stack to the serial link. On the PC side, the node interface
plugin forwards commands from the graphical front-end to the serial link and it forwards the
responses from the serial link to the graphical front-end. The host interface application and
node interface plugin communicate thanks to a serial link.
October 2014
DocID026814 Rev 1
1/52
www.st.com
52

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the G3-PLC and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for ST G3-PLC

  • Page 1: Figure 1. Communication Between Gui And G3-Plc Platform

    This document does not describe in details the plugin, the host interface application, nor the ST G3-PLC library. It describes the PC tool features, it details the options that it offers, it gives clear guidance on how to connect a G3-PLC platform to the tool and it provides examples in order to transmit data between two different G3-PLC platforms.
  • Page 2: Table Of Contents

    G3-PLC GUI release ........
  • Page 3 Environment setup ......... . 43 10.2 Connect Node 1 and 2 on the G3-PLC GUI ..... . . 43 10.3 PHY layer data exchange .
  • Page 4 Figure 1. Communication between GUI and G3-PLC platform ......1 Figure 2.
  • Page 5: Documentation Conventions

    Abbreviation Description 6LoWPAN IPv6 over low power wireless personal area networks Adaptation layer Bit error rate Graphical user interface G3-PLC powerline protocol Medium access control layer Personal computer Physical layer Power line communication UART Universal asynchronous receiver transmitter Universal serial bus...
  • Page 6: Gui Installation

    Once the archive is successfully uncompressed, the user needs to run the StPowerLineGui.exe file. G3-PLC GUI main window overview Once the StPowerLineGui.exe executable has been launched, the main window of the G3- PLC GUI appears on the screen after few seconds.
  • Page 7: Figure 2. Main G3-Plc Gui Window

    Node tree navigation panel: it is used to select a specific node and to choose the command type Command panel: it is used to execute a specific command Trace window: it traces the traffic from/to the G3-PLC GUI application and one node. DocID026814 Rev 1 7/52...
  • Page 8: Getting Started

    UM1811 Getting started Node connection More than one G3-PLC platforms can be connected to the same instance of the G3-PLC GUI. Click on the small cross on the command panel to connect one G3-PLC platform (Figure 3). Alternatively, right-click on the ST PowerLine Host icon and click on “Add Node”.
  • Page 9: Node Tree Panel

    G3-PLC standard plus some additional features such as a bootstrap application or the G3 library configuration. Once a G3-PLC platform is connected, it can be explored thanks to the object tree panel. Each root menu can be collapsed or not to see its detailed content. The detailed content gives access to each specific SAP: PHY, MAC, ADP, BOOT and G3LIB.
  • Page 10: Figure 5. Node Tree Panel

    All the services provided by one layer may be accessed from the main menu or from one of its sub menus. Below here there is a brief description of each main menu:  PHY: the PHY menu offers an interface to use the PHY primitives of the G3-PLC protocol. ...
  • Page 11: Gui And Plugin Settings

    TEST: the TEST menu offers an interface for test purposes. Each menu provides one specific SAP layer of the G3-PLC stack. In order to access a given SAP layer, the G3-PLC implementation needs to be configured to work in a specific operational mode.
  • Page 12: Automatic Confirm And Indication Events Parsing

    Automatic confirm and indication events parsing The G3-PLC GUI has an automatic management of the “Confirm” and “Indication” events communicated by the G3-PLC platform. As a consequence the user does not need to periodically poll the status of the G3-PLC platform.
  • Page 13: G3Lib Menu

    G3LIB menu G3LIB menu G3LIB root menu The G3LIB root menu allows to configure the G3-PLC library implementation and to get access to features not specified by the G3 protocol. Figure 7. G3LIB root panel The G3LIB main menu contains two areas. The first one (1) comprises the commands useful to configure the host interface application: ...
  • Page 14: G3Lib Ib Ex Menu

    Below this SET command, a list of options or a text box allows providing the value with which the selected attribute is set.  G3LIB-SWRESET.Request: this command performs a software reset of the G3-PLC protocol stack (RTE and non-RTE part.). ...
  • Page 15: G3Lib Information Base Attributes Description

    G3LIB information base attributes description From the G3LIB menu, a set of attributes may be read and written. These attributes are not specified by the G3-PLC protocol. Here is a brief description of all those attributes: Table 2. G3LIB real-time engine information base attributes...
  • Page 16 G3LIB menu UM1811 Table 4. PHY layer information base attributes (continued) PHYSICAL layer attributes Status returned by the Reed-Solomon decoder on the last received packet (0 PHYLASTRCVPKTRSSTATUS - no errors, 1 - corrected errors, 2 or 3 - errors detected but not corrected) PHYLASTRCVPKTDT DT value of the last RX PHY packet PHYLASTRCVPKTPDC...
  • Page 17: Phy Menu

    UM1811 PHY menu PHY menu To be able to execute PHY layer commands, the G3-PLC platform working mode needs to be configured to the PHY mode. To do this, simply go to the G3LIB panel as shown in Figure 9. Choose the PHY_MODE from the available modes (1) and press the HI-MODE-SET.Request button (2).
  • Page 18: Phy Root Menu

    PHY menu UM1811 PHY root menu The root menu offers the possibility to enter a payload and send the frame in physical layer mode, as represented Figure Figure 10. PHY root panel On this panel, three main actions can be done: ...
  • Page 19: Plme Control Menu

    UM1811 PHY menu PLME control menu The physical sublayer management entity control menu offers 2 options: set the RX and TX chain status and get the status of the line (carrier sense). Figure 11. PLME control menu Concerning the PLME_SET_TRX_STATE.Request command, two options may be selected: ...
  • Page 20: Plme Menu

    PHY menu UM1811 PLME menu The physical sublayer management entity menu allows setting the transmission parameters, as shown in Figure Figure 12. PLME menu description From this panel, the following commands are available:  PLME_SET.Request: to set PHY layer transmission parameters ...
  • Page 21 This checkbox acts on the ToneMask field.  PreEmphasis: specifies transmission gain for each sub-band represented by the tone map (optional feature currently not supported in ST G3-PLC implementation).  Coherent Mode: enables or disables the coherent modulations.
  • Page 22: Mac Menu

    MAC menu UM1811 MAC menu To be able to execute MAC commands, the G3-PLC platform working mode needs to be configured to the MAC mode. To do this, simply go to the G3LIB panel as shown in Figure 13. Choose the MAC_MODE from the available modes (1) and press the HI-MODE-SET.Request button (2).
  • Page 23: Mac Root Menu

    UM1811 MAC menu MAC root menu The root menu offers the possibility to enter a payload and send it at the MAC layer. Figure 14. MAC root panel On this panel, the following command may be executed:  MCPS-DATA.Request: command used to send data across the MAC layer ...
  • Page 24: Mlme Control Menu

    MLME control menu The MAC sublayer management entity control menu offers the management layer commands of the G3-PLC MAC layer, as shown in Figure Figure 15. MLME control menu On the MLME_control panel, the following commands are available: ...
  • Page 25: Mlme Ib Menu

    UM1811 MAC menu  MLME-START.Request: starts a new powerline area network in case of the G3-PLC platform acts as coordinator. The PANId needs to be specified in the corresponding text box area.  MLME-START.Confirm: forces generation of a confirm message (if automatic event is disabled).
  • Page 26: Mlme Ib Ex Menu

    MAC menu UM1811 MLME IB EX menu Figure 17 shows the explorer menu of the information base for the MAC entity. Figure 17. MAC information base explorer This menu offers the same set of commands as the MLME IB ones. The main difference is the white board where the user may drag and drop any of the elements from the list.
  • Page 27: Mac Information Base Attributes Description

    UM1811 MAC menu MAC information base attributes description Here is a brief description for all the attributes of the MAC information base. Table 5. MAC IEEE 802.15.4 information base attributes Standard IEEE 802.15.4 attributes macAckWaitDuration Duration of acknowledgment in microseconds Maximum value of the backoff exponent.
  • Page 28 This read only attribute indicates the capability of the node macFCCLegacyMode This read only attribute indicates the capability of the device Table 7. MAC ST implementation defined information base attributes ST implementation defined attributes aExtendedAddress EUI-64 address to be used...
  • Page 29 UM1811 MAC menu Table 7. MAC ST implementation defined information base attributes (continued) ST implementation defined attributes macInvalidDataCmd The counter of discarded frames due to an invalid command detected The counter of discarded frames due to an invalid state of MAC when macInternalStateNotCorrect receiving a PD-DATA.indication...
  • Page 30: Adp Menu

    ADP menu UM1811 ADP menu To be able to execute ADP commands, the G3-PLC platform working mode needs to be configured to the ADP mode. To do this, simply go to the G3LIB panel as shown in Figure 18. Choose the ADP_MODE from the available modes (1) and press the HI-MODE-SET.Request button (2).
  • Page 31: Adp Root Menu

    UM1811 ADP menu ADP root menu The root menu offers the possibility to enter a payload and send it at the ADP layer, as shown in Figure Figure 19. ADP root panel The ADP root panel is composed of one single command: ...
  • Page 32: Adpm Control Menu

    UM1811 ADPM control menu The ADP layer management entity control menu offers the management layer commands of the G3-PLC ADP layer, as shown in Figure Figure 20. ADPM control menu This menu allows the user to execute the following commands: ...
  • Page 33: Adpm Lbp Menu

    UM1811 ADP menu ADPM LBP menu The root menu offers the possibility to enter a payload and send it using the LoWPAN bootstrap protocol (LBP), as shown in Figure These primitives are accessible only to PAN coordinator devices. Figure 21. LoWPAN bootstrap protocol menu From this panel, the following command may be executed: ...
  • Page 34: Adpm Ib Menu

    UM1811 ADPM IB menu The ADP layer management entity menu offers the possibility to get and set the information base parameters of the G3-PLC ADP layer. Figure 22. ADPM_IB menu Using this panel, the following commands can be executed: ...
  • Page 35: Adp Information Base Attributes Description

    UM1811 ADP menu Figure 23. Effect of show routing table command ADP information base attributes description Here is a brief description for all the attributes of the ADP information base. Table 8. ADP G.9903 information base attributes52 Standard G.9903 ADP information base attributes The minimum security level to be used for incoming and outgoing adaptation adpSecurityLevel frames...
  • Page 36 ADP menu UM1811 Table 8. ADP G.9903 information base attributes52 (continued) Standard G.9903 ADP information base attributes adpBroadcastLogTable Contains the broadcast log table adpRoutingTable Contains the routing table If TRUE, the RREQ shall be generated with its ''unicast RREQ'' flag set to '1' adpUnicastRREQGenEnable If FALSE, the RREQ shall be generated with its ''unicast RREQ'' flag set to '0' adpGroupTable...
  • Page 37 UM1811 ADP menu Table 9. ADP ST implementation defined information base attributes ST implementation defined attributes It defines the DatagramTag for the fragmentation dispatch. Increased by one for adpDatagramTag each fragmented transmission. It defines the SequenceNumber for the broadcast dispatch. Increased by one for adpBroadcastSeqNumber each broadcast transmission.
  • Page 38: Ber Test Panel

    BER performance. Test description To be able to perform the BER Test, two G3-PLC platforms need be connected to the G3- PLC GUI. Both boards need to be configured in the PHY operational mode as described in Section 5 on page 17.
  • Page 39: Figure 25. Enable Ber Test Panel

    UM1811 BER Test panel Figure 25. Enable BER Test panel Once the Test panel is enabled, the RX and TX Nodes need to be slided into their area, as show in Figure 26. To do that, click on the TX Node in the object tree panel and slide it in the right area (1).
  • Page 40: Figure 27. Deactivate Reed-Solomon

    BER Test panel UM1811 Figure 27. Deactivate Reed-Solomon In the BER Test panel, the following parameters may be configured:  Pkts: the number of packets to be sent (if 0, the test will end when the STOP button is pressed) ...
  • Page 41: Sniffer Panel

    (1), then the GMK can be inserted within the pop-up window (2). The GMK is typically a secret in a G3-PLC network, so it is not always possible to use the on-the-fly deciphering feature in a real scenario. Moreover ST cannot be responsible for key stealing when the user decides to reveal this secret in order to use this tool.
  • Page 42: Data Logs

    Sniffer panel UM1811 Figure 29. Sniffer tool activation Data logs Each captured PHY packet is displayed in a single row, whereas the columns show the various header fields (LSF, CAP, CC, etc.). The PHY packets (data, acknowledgments) are displayed in white color. If the PHY payload is encapsulating a MAC frame the row is displayed in light blue color.
  • Page 43: Basic G3 Operations

    Connect Node 1 and 2 on the G3-PLC GUI The first action to perform with the G3-PLC GUI is to add two nodes. Click on the small cross on the top of the empty panel twice to open two tabs, as described in Section 3.1 on...
  • Page 44: Figure 32. Configure Node 1 In Tx

    Basic G3 operations UM1811 Figure 32. Configure Node 1 in TX For the Node 2, as shown in Figure 32, go into the PHY menu / PLME_Control panel (1) to configure the state of the node. Check the TXOFF_RXON (2) parameter and click on the PLME_SET_TRX_STATE.Request button (3).
  • Page 45: Mac Layer Data Exchange

    UM1811 Basic G3 operations Any message in the trace window may be hovered over to see more details. The message content may also be expanded in the trace window by clicking on the small cross on the left side of the message (4). Figure 34.
  • Page 46: Figure 35. Configure Node 1 Panid

    Basic G3 operations UM1811 To configure the PANId, as shown in Figure 34, go into the MAC / MLME_IB (1) menu of the Node 1, select first the macPANId in the list on the right side of the MLME-SET.Request command (2). One text box area will appear just below. Enter the PANId of the node (3) and click on the MLME-SET.Request button (4).
  • Page 47: Figure 37. Configure Node 2 Panid

    UM1811 Basic G3 operations Figure 37. Configure Node 2 PANId Then, the short address needs to be configured: it must be different from the one of the Node 1, as represented in Figure Figure 38. Configure Node 2 short address Now that the Node 1 and Node 2 are properly configured, data can be exchanged from one node to the other one.
  • Page 48: Figure 39. Send Mac Data From Tx To Rx

    Basic G3 operations UM1811 Figure 39. Send MAC data from TX to RX To check that the transmission was successful, look for the MCPS-DATA.Indication message in the trace window with the SUCCESS status. When hovering over this message its detailed content appears in a new window, as represented in Figure Figure 40.
  • Page 49: Adp Layer Data Exchange

    UM1811 Basic G3 operations 10.5 ADP layer data exchange To be able to execute an ADP command, the Node 1 and 2 working modes need to be set to the ADP mode, as explained in Figure 18 on page To be able to send data at the ADP level, the macPANId and macShortAddress attributes need to be configured for both nodes as in the MAC layer scenario (Section 10.4 on page 45).
  • Page 50: Figure 42. Send Adp Data From Tx To Rx

    Basic G3 operations UM1811  Node 2 – Short address: 010C – PANId: 781D – MAC Key entry : AF4D6DCCF14DE7C1C4235E6FEF6C151F  NSDU – 6000000000171104FE80000000000000781D00FFFE00002AFE8000000000000078 1D00FFFE00010CF0B1F0B20017EE2C112233445566778899AABBCCDDEEFF Once the Nsdu is correctly set (1) and the ADPD-DATA.Request command has been executed (2), the ADPD-DATA-Indication message will be displayed in the trace window with the SUCCESS status (3).
  • Page 51: Revision History

    UM1811 Revision history Revision history Table 10. Document revision history Date Revision Changes 07-Oct-2014 Initial release. DocID026814 Rev 1 51/52...
  • Page 52 ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order acknowledgement.

Table of Contents