G3-PLC Communication between Meter and In Home...

G3-PLC Communication between Meter and In Home

Display

SummaryG3-PLC Communication between a Meter and an In Home Display (IHD) application note demonstrates how to takeadvantage of G3-PLC protocol to establish a communication between a Meter, that is part of a G3-PLC Network asG3-PLC Device, and an IHD at G3-PLC MAC layer level.

© 2020 Microchip Technology Inc. Application Note DS00003384A-page 1

Table of Contents

Summary........................................................................................................................................................1

1. Introduction............................................................................................................................................. 3

2. Protocol Description................................................................................................................................ 4

3. Hardware Description..............................................................................................................................6

4. Software Description............................................................................................................................... 7

4.1. G3-PLC Coordinator.....................................................................................................................74.2. G3-PLC Device............................................................................................................................ 74.3. G3-PLC MAC In Home Display....................................................................................................7

5. Start-up the Application.........................................................................................................................10

The Microchip Website.................................................................................................................................14

Product Change Notification Service............................................................................................................14

Customer Support........................................................................................................................................ 14

Microchip Devices Code Protection Feature................................................................................................ 14

Legal Notice................................................................................................................................................. 14

Trademarks.................................................................................................................................................. 15

Quality Management System....................................................................................................................... 15

Worldwide Sales and Service.......................................................................................................................16


1. IntroductionG3-PLC Communication between a Meter and an In Home Display (IHD) application note demonstrates how to takeadvantage of G3-PLC protocol to establish a communication between a Meter, that is part of a G3-PLC Network asG3-PLC Device, and an IHD at G3-PLC MAC layer level.

The Communication at MAC Layer uses extended addressing to avoid the need of assigning a short address to theIHD. Besides, the association between Meter and IHD is done automatically sending a broadcast message only fortesting purposes because the Meter EUI64 is unknown. In a real scenario could be better to define in advance whichIHD associates with each Meter configuring the corresponding Meter EUI64 on the IHD.

MAC traffic is sent in normal priority contention window to reduce the influence on medium access for the rest of theG3-PLC Network traffic.

The meter is part of a G3-PLC Network where an encryption key, the GMK, is configured during the bootstrappingprocess for data encryption at MAC Layer. The communication between the IHD and the Meter has not security(Security None) to avoid sharing the GMK with the IHD using an unprotected channel.

Introduction


2. Protocol DescriptionThe G3-PLC MAC Communication between meter and IHD is based on a simple protocol shown on Figure 2-1.Basically includes:

• Protocol ID (2 bytes): identifies the Protocol between the Meter and the IHD• Protocol CMD (1 byte): identifies the commands and actions to take into account

Figure 2-1. G3-PLC MAC Communication Protocol Fields

G3-PLCMAC

HEADER

PROTOCOL ID

2 Bytes

PROTOCOL CMD

1 Byte

PROTOCOLDATA

8 Bytes

0x0EFE 0x00: Get Meter ID0x01: Set Meter ID0x02: Get DATA0x03: Set DATA

The execution flow is shown on Figure 2-2. Basically:• The IHD request to the G3-PLC MAC Layer to scan for G3-PLC Networks to get the PANid of the network in use• The IHD tries to reach a Meter with IHD capabilities sending a broadcast GetMeterID message. The ID

requested is the EUI64 used by the meter on G3-PLC Communications• The Meter answers the broadcast request sending a unicast SetMeterID message (this is done this way to

simplify the association between IHD and Meter as both have random EUI64 extended address)• The IHD request to the Meter what data to show on the Display sending a unicast GetData message• The Meter answers the unicast request sending a unicast SetData message• The IHD waits for SetData messages from meter or polls periodically the meter with GetData messages to

keep connectivity• The Meter sends SetData messages to the meter periodically to update the message shown on the IHD

Protocol Description


Figure 2-2. G3-PLC Communication Protocol Flow

G3-PLCDevice

G3-PLC MACInHomeDisplay

G3-PLCCoordinator

G3-PLC Scan

G3-PLC Register

dispatch

Get PAN-idGet Short AddrGet GMK

G3-PLC Beacon

Get PAN-id

Get Meter EUI64Broadcast

Set Meter EUI64Unicast

Get MeterEUI64

Get Meter DataUnicast

Set Meter DataUnicast

Get FirstMeter Data

Set Meter Data

dispatch

Set Meter Data

Set NextMeter Data

Protocol Description


3. Hardware DescriptionThe application testbed needs at least these elements:

• Minimum G3-PLC Full Network:– G3-PLC Coordinator– G3-PLC Full Device - The Meter

• G3-PLC MAC Device – The In Home Display

PL360MB board is the hardware used to set-up all of them.

• https://www.microchip.com/DevelopmentTools/ProductDetails/PartNo/ATPL360-EK

As each ATPL360-EK includes 2 PL360MB boards, at least 2 kits are needed to set-up the application note testbed.However, other evaluation boards capable of running G3-PLC could be used as IHD, G3-PLC Coordinator or Device;although in the case of the IHD, if no LCD is available, the data will only be shown on the serial console. Theexample runs on CENELEC_A Band, so Coupling Board COUP007v2 must be mounted.

ATPL360-EK is already available from Microchipdirect.com and Distributors containing Software, HardwareSchematics, Bill of Materials and PCB Designs.

Hardware Description


https://www.microchip.com/DevelopmentTools/ProductDetails/PartNo/ATPL360-EK

4. Software DescriptionAll the software developped on this application note is based on G3-PLC Firmware package version G3_v1.4.0.

4.1 G3-PLC CoordinatorPL360MB board must be flashed with the example application dlms_app_coord located on thirdparty\g3\apps forplatform sam4cms16c_atpl360mb_cen_a_rt. This application runs a typical G3-PLC Coordinator that registersG3-PLC Devices on the Network and requests DLMS information periodically from them.

G3-PLC Coordinator also can act as G3-PLC Sniffer of the G3-PLC Network. To enable that, conf_usi.h must contain:

#ifndef CONF_USI_H_INCLUDED#define CONF_USI_H_INCLUDED#define ENABLE_SNIFFER#define USI_PORT_0 0/* Port Communications configuration */#define NUM_PORTS 1#define PORT_0 CONF_PORT(UART_TYPE, USI_PORT_0, 230400, TX_UART_BUF0_SIZE, RX_UART_BUF0_SIZE)/* Select PORT to serialize phy sniffer */#define PHY_SNIFFER_SERIAL_PORT USI_PORT_0#endif /* CONF_USI_H_INCLUDED */

4.2 G3-PLC DeviceG3-PLC Device Meter for PL360MB board is based on the example application dlms_app_dev located on thirdparty\g3\apps for platform sam4cms16c_atpl360mb_cen_a_rt.The project must be updated uncompressing the software package G3-PLC_v1.4.0.MeterPatch.7z inside theuncompressed folder g3.workspace.all_platforms of the G3-PLC Firmware package.

The patch shows how to work in case of MAC handling is needed without interfering deeply with the normal executionof the dlms_app_dev application.

All the changes have been included inside DLMS_APP_ENABLE_MAC_IHD definition to compare with standardversion of the application. Most of the changes are in mac_wrapper.c file. There are three points to take into account:

• MacWrapperMcpsDataIndication Callback: this function is modified to identify frames using the protocolbetween the Meter and the remote IHD. When one of these frames is received, a flag is set to be handled in thenext execution of the program loop.

• MacWrapperEventHandler: this function runs each execution of the program loop. It has been modified tocheck and handle if there is some flag related to communication with the IHD.

• MacWrapperMcpsDataRequest: this function is modified to avoid any interference between the handlers fromADP Layer and handlers used by this G3-PLC MAC application. The communication uses extended addressingin both sides, without security and normal priority for minumum interference on Meter communication with therest of the G3-PLC Network.

When a G3-PLC MAC IHD is detected and associated, the meter sends data periodically to be shown on the IHD.The data sent on the provided example is the uptime in seconds.

4.3 G3-PLC MAC In Home DisplayA new project compatible with the G3-PLC Firmware package G3-PLC_v1.4.0 has been developped for running asG3-PLC MAC In Home Display on the PL360MB board. The project is located in thirdparty/g3/apps/mac_app_ihdfolder on the uncompressed package g3_mac_app_ihd.7z.

The In Home Display project is compatible with the rest of G3-PLC applications in terms of:• Hardware Abstraction Layer (HAL)

Software Description


• Operating System Support (OSS)• Physical Abstraction Layer (PAL)

so, the process to initialize the board, to run tasks or get resources from the platform etc... are the same as in otherapplication examples.

The application is based on two tasks:• Application Task: it is the main application itself• Keyboard Task: handle the events from keyboard on the console to interact with the main application

The keyboard task waits for events from keyboard on console, these events are ignored if the main application is notin the state of waiting for Data Indications.

The application task shows how to interact with G3-PLC MAC Layer executing and processing the available requestsand callbacks:

• MacWrapperMlmeResetRequest: this request initializes completely the G3-PLC MAC Layer; needed after aScan Request was performed and the PANid was set

• MacWrapperMlmeScanRequest: this request initializes the process for G3-PLC Network discovering. Anydevice on a G3-PLC Network responds to this request sending a Beacon

• MacWrapperBeaconNotifyIndication callback: this indication is called when a beacon is received at G3-PLC MAC Layer. The IHD obtains the PANid of the G3-PLC Network from this

• MacWrapperMcpsDataRequest: the communication uses extended addresses in both sides, without securityand normal priority for minimum interference on Meter communication with the rest of the G3-PLC Network

• MacWrapperDataConfirm callback: this callback allows the application to know the result of the data requestexecution

• MacWrapperDataIndication callback: this callback is executed when a frame is received fetching thecommunication between the Meter and the IHD

The application task runs a finite state machine (FSM) where the state changes when some event happens (on waitstates) or by default to the next state. Figure 4-1 shows the different states and the events that produce the differenttransitions.



Figure 4-1. In Home Display Finite State Machine

The meter uptime is the data interchanged between Meter and IHD. The current status of the FSM and the data fromthe Meter is shown on the LCD display.



5. Start-up the ApplicationA simple G3-PLC network of three devices is used to evaluate the application:

• G3-PLC Coordinator: creates the G3-PLC Network and acts as a sniffer• G3-PLC Device Meter: becomes part of the G3-PLC Network and exchanges data with IHD• G3-PLC MAC IHD: associates and exchanges data with the G3-PLC Device Meter

Figure 5-1. G3-PLC MAC IHD Application Testbed

G3-PLCNET

G3-PLCDevice

Smart Meter

G3-PLCCoordinator

G3-PLCMAC IHD

G3-PLCSniffer

MAC IHDConsole

First, connect all the devices to the same powerstrip. The meter starts the registering process on the G3-PLCNetwork as shown on Figure 5-2. More information about this standard process can be found on Microchip50002728 G3-PLC Firmware Stack User Guide and 50002760 PLC Sniffer User Guide.Figure 5-2. G3-PLC Device Registering Process

Start-up the Application


For testing purposes, the G3-PLC MAC IHD is intentionally kept in reset until the end of the G3-PLC Deviceregistering process. The IHD association with the meter is shown on Figure 5-3. It corresponds with the flow shownon Figure 2-2.

• Frames 22-23-24 correspond with Get PAN-id phase• Frames 26-27-28 correspond with Get Meter EUI64 phase• Frames 29-30-31-32 correspond with Get First Meter Data phase

Figure 5-3. G3-PLC MAC IHD Association

The protocol can be analyzed through the Sniffer PC application, and focusing on the values of PDU Data Field at thebottom of the Packet View.

Figure 5-4 shows the contents of frame 26, the PDU Data value is 0x0EFE 00, where 0EFE represents the ProtocolID and 00 represents the “Get Meter ID” Protocol Command as seen on Figure 2-1.Figure 5-4. G3-PLC MAC Message Get EUI64

Figure 5-5 shows the contents of frame 27, the PDU Data value is 0x0EFE 01 4846415714039013, where 01represents the “SetMeterID” command and 4846415714039013 the Meter EUI64.Figure 5-5. G3-PLC MAC Message Set EUI64



Figure 5-6 shows the contents of frame 29, the PDU Data value is 0x0EFE 02, where 02 represents the “GetData”command.Figure 5-6. G3-PLC MAC Message Get Data

Figure 5-7 shows the contents of frame 31, the PDU Data value is 0x0EFE 03 00000004, where 03 represents the“SetData” command and 00000004 the data to be shown on IHD.Figure 5-7. G3-PLC MAC Message Set Data

On the other hand, the G3-PLC MAC IHD console can be accessed through the USB-UART0 connector and aterminal program like PuTTY or Tera Term as shown in Figure 5-8.Figure 5-8. G3-PLC MAC IHD Console

The console shows traces about what is happening on the finite state machine and a menu with options. Pressingsome letters on the keyboard creates “KEYBOARD_X” events as seen on Figure 4-1. For example, when ‘d’ key ispressed, the IHD triggers a data request to the Meter. After the process finishes, the IHD updates the data shown onthe board display as shown in Figure 5-9.



Figure 5-9. G3-PLC MAC IHD Information on LCD Display



The Microchip WebsiteMicrochip provides online support via our website at http://www.microchip.com/. This website is used to make filesand information easily available to customers. Some of the content available includes:

• Product Support – Data sheets and errata, application notes and sample programs, design resources, user’sguides and hardware support documents, latest software releases and archived software

• General Technical Support – Frequently Asked Questions (FAQs), technical support requests, onlinediscussion groups, Microchip design partner program member listing

• Business of Microchip – Product selector and ordering guides, latest Microchip press releases, listing ofseminars and events, listings of Microchip sales offices, distributors and factory representatives

Product Change Notification ServiceMicrochip’s product change notification service helps keep customers current on Microchip products. Subscribers willreceive email notification whenever there are changes, updates, revisions or errata related to a specified productfamily or development tool of interest.

To register, go to http://www.microchip.com/pcn and follow the registration instructions.

Customer SupportUsers of Microchip products can receive assistance through several channels:

• Distributor or Representative• Local Sales Office• Embedded Solutions Engineer (ESE)• Technical Support

Customers should contact their distributor, representative or ESE for support. Local sales offices are also available tohelp customers. A listing of sales offices and locations is included in this document.

Technical support is available through the website at: http://www.microchip.com/support

Microchip Devices Code Protection FeatureNote the following details of the code protection feature on Microchip devices:

• Microchip products meet the specification contained in their particular Microchip Data Sheet.• Microchip believes that its family of products is one of the most secure families of its kind on the market today,

when used in the intended manner and under normal conditions.• There are dishonest and possibly illegal methods used to breach the code protection feature. All of these

methods, to our knowledge, require using the Microchip products in a manner outside the operatingspecifications contained in Microchip’s Data Sheets. Most likely, the person doing so is engaged in theft ofintellectual property.

• Microchip is willing to work with the customer who is concerned about the integrity of their code.• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code

protection does not mean that we are guaranteeing the product as “unbreakable.”

Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protectionfeatures of our products. Attempts to break Microchip’s code protection feature may be a violation of the DigitalMillennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, youmay have a right to sue for relief under that Act.

Legal NoticeInformation contained in this publication regarding device applications and the like is provided only for yourconvenience and may be superseded by updates. It is your responsibility to ensure that your application meets with


http://www.microchip.com/http://www.microchip.com/pcnhttp://www.microchip.com/support

your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHEREXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION,INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY ORFITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchipdevices in life support and/or safety applications is entirely at the buyer’s risk, and the buyer agrees to defend,indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from suchuse. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights unlessotherwise stated.

TrademarksThe Microchip name and logo, the Microchip logo, Adaptec, AnyRate, AVR, AVR logo, AVR Freaks, BesTime,BitCloud, chipKIT, chipKIT logo, CryptoMemory, CryptoRF, dsPIC, FlashFlex, flexPWR, HELDO, IGLOO, JukeBlox,KeeLoq, Kleer, LANCheck, LinkMD, maXStylus, maXTouch, MediaLB, megaAVR, Microsemi, Microsemi logo, MOST,MOST logo, MPLAB, OptoLyzer, PackeTime, PIC, picoPower, PICSTART, PIC32 logo, PolarFire, Prochip Designer,QTouch, SAM-BA, SenGenuity, SpyNIC, SST, SST Logo, SuperFlash, Symmetricom, SyncServer, Tachyon,TempTrackr, TimeSource, tinyAVR, UNI/O, Vectron, and XMEGA are registered trademarks of Microchip TechnologyIncorporated in the U.S.A. and other countries.

APT, ClockWorks, The Embedded Control Solutions Company, EtherSynch, FlashTec, Hyper Speed Control,HyperLight Load, IntelliMOS, Libero, motorBench, mTouch, Powermite 3, Precision Edge, ProASIC, ProASIC Plus,ProASIC Plus logo, Quiet-Wire, SmartFusion, SyncWorld, Temux, TimeCesium, TimeHub, TimePictra, TimeProvider,Vite, WinPath, and ZL are registered trademarks of Microchip Technology Incorporated in the U.S.A.

Adjacent Key Suppression, AKS, Analog-for-the-Digital Age, Any Capacitor, AnyIn, AnyOut, BlueSky, BodyCom,CodeGuard, CryptoAuthentication, CryptoAutomotive, CryptoCompanion, CryptoController, dsPICDEM,dsPICDEM.net, Dynamic Average Matching, DAM, ECAN, EtherGREEN, In-Circuit Serial Programming, ICSP,INICnet, Inter-Chip Connectivity, JitterBlocker, KleerNet, KleerNet logo, memBrain, Mindi, MiWi, MPASM, MPF,MPLAB Certified logo, MPLIB, MPLINK, MultiTRAK, NetDetach, Omniscient Code Generation, PICDEM,PICDEM.net, PICkit, PICtail, PowerSmart, PureSilicon, QMatrix, REAL ICE, Ripple Blocker, SAM-ICE, Serial QuadI/O, SMART-I.S., SQI, SuperSwitcher, SuperSwitcher II, Total Endurance, TSHARC, USBCheck, VariSense,ViewSpan, WiperLock, Wireless DNA, and ZENA are trademarks of Microchip Technology Incorporated in the U.S.A.and other countries.

SQTP is a service mark of Microchip Technology Incorporated in the U.S.A.

The Adaptec logo, Frequency on Demand, Silicon Storage Technology, and Symmcom are registered trademarks ofMicrochip Technology Inc. in other countries.

GestIC is a registered trademark of Microchip Technology Germany II GmbH & Co. KG, a subsidiary of MicrochipTechnology Inc., in other countries.

All other trademarks mentioned herein are property of their respective companies.© 2020, Microchip Technology Incorporated, Printed in the U.S.A., All Rights Reserved.

ISBN: 978-1-5224-5562-2

Quality Management SystemFor information regarding Microchip’s Quality Management Systems, please visit http://www.microchip.com/quality.


http://www.microchip.com/quality

AMERICAS ASIA/PACIFIC ASIA/PACIFIC EUROPECorporate Office2355 West Chandler Blvd.Chandler, AZ 85224-6199Tel: 480-792-7200Fax: 480-792-7277Technical Support:http://www.microchip.com/supportWeb Address:http://www.microchip.comAtlantaDuluth, GATel: 678-957-9614Fax: 678-957-1455Austin, TXTel: 512-257-3370BostonWestborough, MATel: 774-760-0087Fax: 774-760-0088ChicagoItasca, ILTel: 630-285-0071Fax: 630-285-0075DallasAddison, TXTel: 972-818-7423Fax: 972-818-2924DetroitNovi, MITel: 248-848-4000Houston, TXTel: 281-894-5983IndianapolisNoblesville, INTel: 317-773-8323Fax: 317-773-5453Tel: 317-536-2380Los AngelesMission Viejo, CATel: 949-462-9523Fax: 949-462-9608Tel: 951-273-7800Raleigh, NCTel: 919-844-7510New York, NYTel: 631-435-6000San Jose, CATel: 408-735-9110Tel: 408-436-4270Canada - TorontoTel: 905-695-1980Fax: 905-695-2078

Australia - SydneyTel: 61-2-9868-6733China - BeijingTel: 86-10-8569-7000China - ChengduTel: 86-28-8665-5511China - ChongqingTel: 86-23-8980-9588China - DongguanTel: 86-769-8702-9880China - GuangzhouTel: 86-20-8755-8029China - HangzhouTel: 86-571-8792-8115China - Hong Kong SARTel: 852-2943-5100China - NanjingTel: 86-25-8473-2460China - QingdaoTel: 86-532-8502-7355China - ShanghaiTel: 86-21-3326-8000China - ShenyangTel: 86-24-2334-2829China - ShenzhenTel: 86-755-8864-2200China - SuzhouTel: 86-186-6233-1526China - WuhanTel: 86-27-5980-5300China - XianTel: 86-29-8833-7252China - XiamenTel: 86-592-2388138China - ZhuhaiTel: 86-756-3210040

India - BangaloreTel: 91-80-3090-4444India - New DelhiTel: 91-11-4160-8631India - PuneTel: 91-20-4121-0141Japan - OsakaTel: 81-6-6152-7160Japan - TokyoTel: 81-3-6880- 3770Korea - DaeguTel: 82-53-744-4301Korea - SeoulTel: 82-2-554-7200Malaysia - Kuala LumpurTel: 60-3-7651-7906Malaysia - PenangTel: 60-4-227-8870Philippines - ManilaTel: 63-2-634-9065SingaporeTel: 65-6334-8870Taiwan - Hsin ChuTel: 886-3-577-8366Taiwan - KaohsiungTel: 886-7-213-7830Taiwan - TaipeiTel: 886-2-2508-8600Thailand - BangkokTel: 66-2-694-1351Vietnam - Ho Chi MinhTel: 84-28-5448-2100

Austria - WelsTel: 43-7242-2244-39Fax: 43-7242-2244-393Denmark - CopenhagenTel: 45-4450-2828Fax: 45-4485-2829Finland - EspooTel: 358-9-4520-820France - ParisTel: 33-1-69-53-63-20Fax: 33-1-69-30-90-79Germany - GarchingTel: 49-8931-9700Germany - HaanTel: 49-2129-3766400Germany - HeilbronnTel: 49-7131-72400Germany - KarlsruheTel: 49-721-625370Germany - MunichTel: 49-89-627-144-0Fax: 49-89-627-144-44Germany - RosenheimTel: 49-8031-354-560Israel - Ra’ananaTel: 972-9-744-7705Italy - MilanTel: 39-0331-742611Fax: 39-0331-466781Italy - PadovaTel: 39-049-7625286Netherlands - DrunenTel: 31-416-690399Fax: 31-416-690340Norway - TrondheimTel: 47-72884388Poland - WarsawTel: 48-22-3325737Romania - BucharestTel: 40-21-407-87-50Spain - MadridTel: 34-91-708-08-90Fax: 34-91-708-08-91Sweden - GothenbergTel: 46-31-704-60-40Sweden - StockholmTel: 46-8-5090-4654UK - WokinghamTel: 44-118-921-5800Fax: 44-118-921-5820

Worldwide Sales and Service


http://www.microchip.com/supporthttp://www.microchip.com

SummaryTable of Contents1. Introduction2. Protocol Description3. Hardware Description4. Software Description4.1. G3-PLC Coordinator4.2. G3-PLC Device4.3. G3-PLC MAC In Home Display

5. Start-up the ApplicationThe Microchip WebsiteProduct Change Notification ServiceCustomer SupportMicrochip Devices Code Protection FeatureLegal NoticeTrademarksQuality Management SystemWorldwide Sales and Service

G3-PLC Communication between Meter and In Home...

Documents

Transcript of G3-PLC Communication between Meter and In Home...