User Guide for TG Terminal (IPD Project)
Contents
1. Read Attribute Write Attribute Sheduled Event OPT InfQut Evert Current Price scheduled Price Price Label Set Last MSG Figure 2 2 Button layout of the IPD panel Telegesis UK Limited User Guide telegesisi ETRX357 IPD Document No 2 3 Function of the Buttons The following table maps the buttons with their linked AT commands and a brief description is also given More information about a specific command and its prompt has been included in the IPD or Mock Meter manual Button Name Linked AT Command Description Module Control R3xx includes the buttons on both Mock Meter and IPD panels Info ATI Display Product Identification Information Z Reset ATZ Software Reset this will not change the previous S register settings such as link key and so on Factory Default AT amp F Restore Factory Defaults Clear all S Register setting Bootloader AT BLOAD Enter The Bootloader Menu will used to update firmware Display All S AT TOKDUMP Display All S Register Settings Remove All Keys AT RMALLKEYS Clear local key table Neighbour Table AT NTABLE Display Neighbour Table Routing Table AT RTABLE Display Routing Table Address Table AT ATABLE Display Address Table NWK Info AT N Display Network Information Help AT HELP Display All Available Commands Network Management Energy Scan AT ESCAN scan the background energy of all channels Scan for Pan AT PANSCAN Scan for active PANs Security Mode ATSOA Set security mode2. Mock Meter use the button This button is to use for the Mock Meter to LC Event e send a Load Control Event to the IPD In the Mock Meter part In the terminal for the IPD it will shows This means the IPD has received a load DRLCRECEIVED 00000001 0002A7F3 001C 0FF ee event and the event has been F 00 01 00 00 1A09 1A09 0A 00 00 DRLCSTART 00000001 0002A7F3 001C 0FFF 00 01 00 00 1A09 1A09 0A 00 00 In the terminal for the Mock Meter use the button In the terminal for the IPD it will shows This means the IPD has been instructed to DRLCCANCELED 00000001 00000000 001C 0FF Eed event and the event F 00 01 00 00 1A09 1A09 0A 00 00 Please note This document only gives some typical examples of the SE applications which can be built using the IPD and Mock Meter In fact the IPD AT command set has more functions that can be utilized with a properly selected series of AT commands For more information about the AT commands please check the provided manual Telegesis UK Limited De User Guide ETRX357 IPD S Document No 4 Contact Information Website www telegesis com E mail sales telegesis com Telegesis UK Ltd Abbey Barn Business Centre Abbey Barn Lane High Wycombe Bucks HP10 9QQ United Kingdom Tel 44 0 1494 510199 Fax 44 0 5603 436999
3. to establish network or join network please refer to S Register section in TG PM 0500 ETRX3 IPDDVK IPD Manual r1 Set Link Key ATSO9 Set preconfigured link key for establishing or joining a network Set NWK Key ATS08 set network key for establishing a network Form A Network AT EN Establish a Personal Area Network Telegesis UK Limited User Guide telegesisi ETRX357 IPD Document No PJOIN Switch on Permit Joining Flag Disas Local Disassociate Local Node from PAN Disas Remote Disassociate Remote Node from PAN Join any PAN Join an open network with matched preconfigured link key Join a Spec PAN Join specific PAN CBKE Initiate CBKE with ESI or a partner device ID Request AT IDREQ Request node s NodelD EUI request Request node s EUI Node Descriptor Request node s descriptor Power Des Request node s power descriptor ACT EP Request node s active endpoint list Simple Des Request endpoint s simple descriptor Match Des Find nodes which match a specific descriptor ANNCE Announce local device in the network y 5 2 5 ea Local BTable AT LBTABLE Display local binding table BSET Set local binding table entry Remote BTable Display remote binding table DEI BTable Clear local binding table entry Bind to Remote Create binding on remote device Del Remote B Delete binding on remote device BindMtr Bind the IPD to the mock meter UnbindMtr Unbind the IPD to the mock meter MockMeter Functions Tele
4. ETRX357 IPD SES User Guide 0500r2 User Guide Using Telegesis Terminal with ETRX3 IPD and Mock Meter Firmware IPD firmware version r300 Mock Meter firmware version r301 o n di ieee B e telegesisi3 2012 Telegesis UK Ltd ETRX357 IPD Devkit Telegesis UK Limited Table of Contents BE ATOU 0 E 2 Z Telegesis Terminal IP ANG isisatiecanontiersiandverenevininiadeniirwennsddsacdientnnenendnadedusioseamasisencdlavivocunssbvedadssiivensmelienienixessmenbraduilanis 3 2 1 MOCK Meter TT vassncsvsennusniasnanisysiaasnieriniavarmnansmceia eE Ea E E AEO diene E Ea 3 2 2 WD Ae NS Wet sscssinemenasetra neice eaeudlonin E E trea yemeneanevan tats 4 2 3 FUNCION ONNE Tlete ir 5 2 ee eru le TE 9 3 1 Network formation cccccccssssecesssseeesssneeeessneeeessaueesesueeeesaseesseaeeesesueeseseaeeeesseeeesesenseeessaeeeeeseneeeesenseeesenneneens 9 Stel MANNA eine de 9 3 1 2 Implementation Procedure cei lt ccscicictevsensccnstiessenseaesscieseintaslndeninncnos te scteinaled cacegecacsaubdlenactnsesaaeactavescsesiebsnun s 9 3 2 Kleeder 11 321 NAA CONAUON EE 11 3 2 2 Implementation Procedure cccccccccsssecesssecssseeceseecssneeesseeecesseeceseeesseaeesseaeeeseneesssneeesseeesssaeesseneeseeees 11 3 3 Wl Price COMMING WEE 13 SSC Want Re ee e 13 3 3 2 Implementation Procedure nsnannnneoenenennnonnaseennnnnennnnsnnnnnrnanrennrnnasrrnnnnnanrnnsrnnnnrnarrnnrrnnsrennnnnnnennneennnen 14 3 4 Get curr
5. Mock Meter 2 1 Mock Meter Panel Typically the Mock Meter should be a coordinator and trust centre in a network it supports multiple SE server clusters including Message Price Metering Load Control and Demand Response More information can be found in the Mock Meter manual The Mock Meter panel can be used to control the Mock Meter module and issue server related commands as well as display local information or response from the IPD Figure 2 1 shows the buttons It can be observed that the buttons are categorized into five groups Module control Network Management ZDO Binding and Mock Meter The function of the buttons will be introduced in a later section Module Control Raxx Figure 2 1 Button layout of the Mock meter panel fi a 2 2 IPD Panel In a typical scenario the IPD is a router device and joins a network formed by other devices such as the Mock meter It supports multiple SE client clusters such as Message Price Metering Load Control and Demand Response and so on More information can be found in the IPD manual The IPD panel as shown in Figure 2 2 can be used to control the IPD module and issue client commands as well as display local information or response from the Mock Meter The panel contains buttons which are categorized into five groups Module control Network form and leave ZDO Binding and Mock Meter The function of the buttons will be introduced in a later section Module Control Raxx
6. Mock Meter will send the price information in local price table entry 1 Alternatively the user can change the 1 to 0 and then click Send button Price information of entry O will be sent The terminal of the IPD will display the received price information for example PRICE 00000001 NORMAL 00000003 00 0840 10 40 00000000 003C 000000 12 FF FFEFFFFF FF FFFFFFEF FF FF 1 Note please be advised that according to SE 1 1 specification the event id the third parameter in above command should be increased if the user wants to publish new price entry If the Mock Meter terminal displays a response DF TREP 0700 00 8A it means duplicated price information has been received The user can use the manual and construct a new price entry on the Mock meter then send it to the IPD In addition the user can specify the target node and endpoint in this command In above example node ID and End point are not used In that case the MockMeter will use a binding table to send message This assumes that a binding entry has been added automatically during registration progress if the user has seen REGCOMPLETE 00 prompt in the terminal for IPD 3 4 Get current price Apart from receiving published price from the Mock Meter the IPD can request the current available price This test is to verify that the IPD can request Price information stored in the Mock Meter 3 4 1 Initial Condition Set up the Mock Meter and the IPD Run Teleg
7. READATR 0000 0A 0702 0000 Then click Send button The IPD will send a Read Attribute Request command to the Mock Meter to request the Metering Cluster s attribute Attribute ID 0000 Please note the end point must be changed to OA to read meter cluster attributes as Meter server cluster is supported on Endpoint OA of the Mock Meter The IPD panel displays a response for example RESPATTR 0702 0000 00 000000000000 The four parameters are Cluster ID Attribute ID Status Attribute Value Note if the status is not 0O it will be a error code In such a case the Attribute value will not be displayed The command line shows AT SETATR lt ClusterlD gt lt AttributelID gt lt AttrValue gt Please input the three parameters for example 0702 0000 000000000001 This will change the metering cluster attribute 0x0000 CurrentSummationDelivered The command line will show AT READATR 0000 01 Enter Parameter here gt Please change 01 to OA and input cluster ID and Attribute ID 0702 0000 Then click Send button The IPD will send a Read Attribute Request command to the Mock Meter to request the Metering Cluster s attribute Attribute ID 0000 CurrentsummationDelivered When the Mock Meter sends a The IPD panel display a response for example response the IPD panel will display it RESPATTR 0702 0000 00 000000000001 The four parameters are Cluster ID Attribute ID Status Attribute Value The
8. age 3 Application Examples This section gives several examples of utilizing Telegesis Terminal to test some SE applications upon the IPD and Mock Meter These applications are simple The user can practice them to gain further understanding of the IPD supported AT command sets and propose a marketing competitive IPD device 3 1 Network formation The objective of this test is to test that the Mock Meter can form a SE network and the IPD can join the formed network with proper security settings 3 1 1 Initial Condition Set up the Mock Meter and the IPD e g plug each into a PC Run Telegesis Terminal choose the serial ports for both the Mock Meter and IPD 3 1 2 Implementation Procedure Test Step Click the buttons in the Mock Meter This is to set security of the Mock Meter before forming panel following the order a network Then click the button in the Mock Meter The MockMeter will form a network with the security panel settings set in step 1 In the Mock Meter panel there will be some prompt to show a network is formed for Form A Network example JPAN 11 1789 9EF383A7AFA5BD61 FORM 0x00 OK REGCOMPLETE 00 This means a network is formed on channel 11 the PANID is 0x1789 and network power is 3 Also the Smart Energy registration progress is completed Network formation progress completed In the terminal for the Mock Meter click Open the network for 102 seconds to permit join PION Click the butto
9. e Mock Meter the IPD can request the last available message for local display This test is to test that the IPD can request a message stored in the Mock Meter 3 6 1 Initial Condition Set up the Mock Meter and the IPD Run Telegesis Terminal choose the serial ports for both the Mock Meter and IPD Mock Meter has formed a network IPD has joined the MockMeter s network and completed registration 3 6 2 Test Procedure In the terminal for the Mock Meter use the button This button is to use for the Mock Meter set a local message But it ewe will not send the message to the IPD until the IPD requests it In the Mock Meter part Get Last MSG In the IPD Function part In the IPD terminal it shows MESSAGE 00000001 00 0002A34E 0001 HELLO WORLD lf the user does not take any action after about a minute the IPD terminal will show MSGCANCEL 00000001 00 because the message validation time is set to 1 minute in step 1 3 7 Issue Load Control Event This test is to test that the Mock Meter sends a Load Control Event to the IPD and that the IPD takes proper actions after receiving the Event 3 7 1 Initial Condition Set up the Mock Meter and the IPD Open Telegesis Terminal choose the serial ports for both the Mock Meter and IPD Mock Meter has formed a network IPD has joined the Mock Meter s network and completed registration Telegesis UK Limited plge User Guide B Test Step In the terminal for the
10. e Mock Meter to the IPD for display In the Mock Meter part The terminal of the IPD will display the received price The displayed message includes information for example lt MessagelD gt lt MessageControl gt MESSAGE 00000001 00 00000000 0001 Hi Telegesis lt StartTime gt lt DurationinMinutes gt lt Message gt lf the user does not take any action after about a minute the IPD terminal will show MSGCANCEL 00000001 00 because the message validation time is set to 1 minute in step 1 H MSGCANCEL 00000001 00 has not disappeared after step 1 the user can test Cancel Message command by following the next two steps In the terminal for the Mock Meter use the button This command is to use for the Mock Meter to send a message to Cancel MSG the IPD for cancel message In the Mock Meter part The terminal of the IPD will display Note when the period for display message expired the prompt will also be shown even if the user does not send a AT CANCELMSG for cancellation MSGCANCEL 00000001 00 Note the user can specify the target node and endpoint in this command In above example node ID and End point are not used In that case the MockMeter will use a binding table to send message assunimg that a binding entry has been added automatically during registration progress if the user has seen REGCOMPLETE 00 prompt in the terminal for IPD 3 6 Get last message Apart from receiving a message sent by th
11. ent DC 15 SS DNR Tarte ONON ea E ees eee wetee tees Sects cncaceme secede pcesstenees eae ceceneseeasecieae 15 3 4 2 Implement Procedure E 15 3 5 Display and Cancel message Commande 15 SE elegant eEece 15 35 2 ee E 16 3 6 CAST SSS Ae EN 16 SS A enee 16 362 TeSt Gelee E 17 3 7 Issue Load Control Event 17 S WAAL AGI OP eege 17 Sre TOST el 18 GEN eenegen 19 0 n oo OLA telegesisii Telegesis UK Limited ETRX357 IPD 1 Introduction Telegesis have launched the SEP1 1 compliant ZigBee AT Command layer on the EM357 Ember platform The ZigBee SEP AT commands allow developers to build a ZigBee Smart Energy compliant In Premise Display without the need for any in depth knowledge of the ZigBee PRO stack To assist user in practising with the IPD AT command set a Mock Meter has been developed which can be used with the IPD for further develooment purpose Although a description of the supported AT command set has been included in the provided IPD AT command manual TG PM 0500 ETRX3 IPDDVK IPD Manual r1 and the AT command set can work with a serial port communication tool such as HyperTerminal Telegesis Terminal provides an easy way to start practising with the IPD and Mock Meter A pre configured panel is provided as shown in Figure 1 1 which contains multiple buttons It can be observed that each button has a specific name on it for example Info Bootloader help and so on The user can easily click one of the buttons
12. esis Terminal choose the serial ports for both the Mock Meter and IPD Mock Meter has formed a network IPD has joined the Mock Meter s network and completed registration 3 4 2 Implement Procedure wm we me Click the buttons in the terminal for the The Set Price buttons is used for the Mock Meter to Mock Meter following the order set local price information After set price the user must set an entry for it using Valid Price button Set Price 2 In the Mock Meter part Print Price can be used to check the set price Currently the entry 1 is used to store the user configured price Entry 0 is used to store default price information In the terminal for the IPD use The user can use IPD to request price information from the Mock meter Current Price In the IPD Function part The terminal of the IPD will display the received price information for example PRICE 00000001 BASE 00000004 00 0840 10 40 00000000 003C 00000015 FF FFFFFFFF FF FEFFFFEF F FF 1 3 5 Display and Cancel message command 3 5 1 Initial Condition Set up the Mock Meter and the IPD Run Telegesis Terminal choose the serial ports for both the Mock Meter and IPD 15 Mock Meter has formed a network IPD has joined the MockMeter s network and completed registration 3 5 2 Test Procedure In the terminal for the Mock Meter use the button This button will trigger a display message command to be sent Display MSG from th
13. gesis UK Limited ETRX357 IPD Get Time Set the local time on the mock meter Set Time AT GET TIME Get the local time on the mock meter Clear local price table Set Price AT SETPRICE Set a price entry in local price table 7 ege aen Valid Price AT PRCVALID Store the temporary price in the Price plug in LC Event Set and send a Load Control event Cancel Event Cancel a Load Control event IPD Functions Get Time Set the local time on the IPD Set Time Get the local time on the IPD Get Attribute Get value of a local ZCL attribute Set Attribute Set value of a local ZCL attribute Synctime Sync the IPD s clock with ESI Discover Device Discover SE device on the HAN Find Cluster Discover all supported clusters on a remote device Discover Attrs Discover supported attributes on a remote device Read Attribute AT READATR Gets an attribute from a remote device which supports a specified cluster Write Attribute AT WRITEATR Writes an attribute to a remote device which supports a specified cluster Scheduled Event AT GSE Get Scheduled Events from Mock Meter OPT In Out Event AT OPT Opt In or Out Event AT CURPRICE Gets the Current Pricing from the Mock Meter Scheduled Price AT SCHPRICE Gets all the Scheduled Pricing from the Mock Meter Price Label AT PRICELBL Gets the label assigned to the Price Tier 1 to 6 from the price cluster Get last MSG AT LASTMSG Gets the last message from the Mock Meter ACKMSG AT ACKMSG Used to acknowledge a mess
14. last parameter is CurrentSummationDelivered The user can manually change the value of CurrentSummationDelivered on the Mock Meter This scenario could be used in practise to get meter reading Please note in a real scenario multiple meter attributes are required to calculate the meter reading for example 0x0300 UnitofMeasure 0x0301 Multiplier 0x0302 Divisor 0x0303 SummationFormatting 0x0304 DemandFormatting 0x0305 HistoricalConsumptionFormatting 3 3 Publish price command This test is to test that the Mock Meter publishes the price and the IPD can display the received price information properly 3 3 1 Initial Condition Set up the Mock Meter and the IPD Run Telegesis Terminal choose the serial ports for both the Mock Meter and IPD Mock Meter has formed a network IPD has joined the MockMeter s network and completed registration set local price information After set price the user must set an entry for it using Valid Price button Note In the Mock Meter part __PrintPrice can be used to check the set price Currently the entry 1 is used to store the user configured price Entry 0 is used to store default price information Click the buttons in the terminal for the In the command line it should show Mock Meter Publish Price AT PUBLISHPRC 1 lt Enter Parameter here gt batteren F Please just delete lt Enter Parameter here gt then click In the Mock Meter part Send button The
15. ns in the IPD panel Set the security mode and link key for the IPD If the following the order key does not match with the Mock Meter s Link key the IPD cannot join the Mock Meter s network Scan and join a network The IPD will show a prompt to indicate it has join a network or an error code indicating the reason for failure to joini For example with a successful join the prompt includes JPAN 11 1789 9EF383A7AFA5BD61 KESTARTED KECOMPLETE REGSTARTED REGCOMPLETE 00 Note When the terminal of IPD shows REGCOMPLETE 00 it means that joining and registration progress has been successfully completed H an error code occurs please check the manual section 4 Please make sure the security setting is correct If the IPD leaves the network and wants to join again please use the button _Remave All Keys in Mock meter panel before permit join This will clear the previously registered key of the IPD The IPD joins the Mock meter s network and completes SE registration progress Then the user can practise communication between the IPD and Mock Meter Telegesis UK Limited 3 2 Read Server Attributes The objective of this test is to test that the IPD can send proper Read Attributes Request to the Mock Meter and the Mock Meter will then send a Read Attribute Response to the IPD In addition the IPD should properly display the response 3 2 1 Initial Condition Set up the Mock Meter and the IPD Run Telege
16. sis Terminal choose the serial ports for both the Mock Meter and IPD Mock Meter has formed a network IPD has joined the Mock Meter s network and completed registration 3 2 2 Implementation Procedure ee ee AT READATR 0000 01 lt Enter Parameter here gt Read Attribute l Please input cluster ID and Attribute ID use between In the IPD Function part them For example 0000 0000 Then click Send button The IPD will send a Read Attribute Request command to the Mock Meter to request the Basic Cluster s attribute Attribute ID 0000 When the Mock Meter sends a The IPD panel display a response for example response the IPD panel will display it RESPATTR 0000 0000 00 01 The four parameters are Cluster ID Attribute ID Status Attribute Value Note if the status is not 00 it will be a error code In such a case the Attribute value will not be displayed Click the button in the terminal for the The command line will show IPD e AT READATR 0000 01 lt Enter Parameter here gt Read Attribute l Please change 01 to OA and input cluster ID and In the IPD Function part Attribute ID use between them Telegesis UK Limited ETRX357 IPD the Mock Meter sends a response the IPD panel will display it Use the button in the Mock Meter terminal In the Mock Meter part Click the button in the terminal for the IPD Read Attribute In the IPD Function part For example AT
17. to issue an AT command D Telegesis Terminal V 3 1 0 COM49 EOIR EA Tetegesis Terminal V 3 1 0 COM15 File Commands Log Tools Help HA St f File Commands Log Tools Help 2 gt M Connection COM Port M4 Baud Rate f 9200 D Disconnect Moni Flow Control Parity Data Bits Connection COM Port y Baud Rate f 9200 z Disconnect E z Flow Control Parity Data Bits Status Connected to COM49 ATI Telegesis ETRX357 LR MOCKMTR R301 O0Z1ED1LOOO000002 0K Command Send DN Device List Enter the parameter in the Command box Module Control R3xx j Display ANS _ Remove All Keys _ Neighbour Table __ Routing Table Status Connected to COM15 ATI Telegesis ETRX357 IPD R300 0021ED1000000002 OK Command Send Ej Device List el Enter the parameter in the Command box Module Control R3xx Figure 1 1 Telegesis Terminal for IPD and Mock Meter This document provides a user guide to use the Telegesis Terminal Following sections will introduce the preconfigured panels for both IPD and Mock Meter then give several examples of using the Telegesis Terminal to implement applications for example network form and join publish price and so on User Guide 3 Sa Document No 2 Telegesis Terminal Pane This section introduces the pre configured Telegesis Terminal panels of both IPD and
Download Pdf Manuals
Related Search