Telegesis ETRX2USB Command Manual Download Page 48

Page: 48 / 101

R305 AT Commands

- 48 -

AT Command Manual (Rev 3.05)

4 S-Registers

Most S-Registers of the ETRX2 can be read and written locally as well as remotely. The S-
Registers are summarised in the table below.

S-Register Overview

Local R/W

Remote R/W

S00

Channel Mask

( / )

S01

Transmit Power Level

( / )

S02

Preferred PAN ID

( / )

S03

Preferred Extended PAN ID

( / )

S04

Local EUI

( /-)

S05

Local NodeID

( /-)

S06

Parent‟s EUI

( /-)

S07

Parent

‟s NodeID

( /-)

S08

Network Key

(-/ )

S09

Link Key

(-/ )

S0A

Main Function

( / )

S0B

User Readable Name

( / )

S0C

Password

( / )

S0D

Device Information

( /-)

S0E

Prompt Enable 1

( / )

S0F

Prompt Enable 2

( / )

S10

Extended Function

( / )

S11

Device Specific

( / )

S12

UART Setup

( / )

S13

Pull-up enable

( / )

S14

Pull-down enable

( / )

S15

I/O Configuration

( / )

S16

Data Direction of I/O Port

(volatile)

( / )

S17

Initial Value of S16

( / )

S18

Output Buffer of I/O Port

(volatile)

( / )

S19

Initial Value of S18

( / )

S1A

Input Buffer of I/O Port

(volatile)

( /-)

S1B

Special Function pin 1

(volatile)

( / )

S1C

Initial Value of S1B

( / )

S1D

Special Function Pin 2

(volatile)

( / )

S1E

Initial Value of S1D

( / )

S1F

A/D1 (ETRX3: ADC0)

( /-)

S20

A/D2 (ETRX3: ADC1)

( /-)

S21

A/D3 (ETRX3: ADC2)

( /-)

S22

A/D4 (ETRX3: ADC3)

( /-)

S23

Immediate functionality at IRQ0

( / )

S24

Immediate functionality at IRQ1

( / )

S25

Immediate functionality at IRQ2

( / )

S26

Immediate functionality at IRQ3

( / )

Password Protected Registers

Summary of Contents for ETRX2USB

Page 1: ...T Commands ETRX2 and ETRX3 series AT Command Dictionary 3 05 2011 Telegesis UK Ltd AT Command Manual March 2011 Rev 3 05 ETRX2 and ETRX3 Series ZigBee Modules AT Command Dictionary AT Command Dictiona...

Page 2: ...l Configuration Commands 12 2 6 Network Control Configuration Commands 18 2 7 Messaging 33 3 LIST OF ERROR CODES 46 4 S REGISTERS 48 4 1 Recovery of the Factory Default Settings 50 4 2 S Registers for...

Page 3: ...lity to your products Telegesis ZigBee Modules fast integration opportunities and the shortest possible time to market for your product Important note Using the AT Command interface described in this...

Page 4: ...PRO network and use its routing capabilities Modules running the Telegesis AT Command set can allow 3rd party nodes to join into a network consisting of Telegesis nodes and use its routing capabilitie...

Page 5: ...assuming that PAN still exists though an end device may need to find a new parent and it may have missed an update of the network key Certain S registers will have been reset to default values though...

Page 6: ...nd ATXXX This command executes routines of the module and returns parameters Table 1 Types of AT commands When bit 7 of S12 is set each individual reply or prompt is additionally started with the STX...

Page 7: ...s A D1 A D2 or ADC0 ADC1 FN0130 EUI64 NodeID ioread sequence no S46 A D1 A D2 A D3 A D4 A data message has been received at the sink The number of ADC data fields depends on how many ADCs are activate...

Page 8: ...s of receiver and sender RSSI I O data and S46 counter of sender PWRCHANGE XXXX Local node has changed Power Mode to XXXX AddrResp errorcode NodeID EUI64 Response to an address request also triggered...

Page 9: ...tain the network connectivity ZigBee End Devices do not poll for data instead their incoming messages are relayed immediately by their parent without being buffered This means that ZEDs must not be pu...

Page 10: ...AT JN Join Network AT JPAN Join Specific Pan AT SJN Silent Join AT DASSL Disassociate Local Device From Pan AT DASSR Disassociate Remote Node From PAN ZDO AT N Display Network Information AT NTABLE D...

Page 11: ...oadcast AT BCASTB Transmit A Broadcast Of Binary Data AT UCAST Transmit A Unicast AT UCASTB Transmit A Unicast Of Binary Data AT SCAST Transmit Data To The Sink AT SCASTB Transmit Binary Data To The S...

Page 12: ...are reset All non volatile S Registers keep the user defined values if the module was part of a PAN it will remain part of it SW release R300 F Restore Factory Defaults Execute Command AT F Response M...

Page 13: ...en by EUI64 password represents the remote node s 8 character password After completion a soft reset is caused on the remote end SW release R304 PASSTHROUGH Pass new Firmware Image To Remote Node ETRX...

Page 14: ...Series operation was interrupted and the target device therefore remains in the bootloader In case the target device has been reset channel 13 must be used for recovering For more information on over...

Page 15: ...ich is to be read The result when reading a single bit will always be 0 or 1 Write Command ATSXX x x data password Examples ATS00 3FFC ATS0AE 1 password Notes Some S Registers require a password for w...

Page 16: ...s of the remote S Register are following in case of a successful read only Write Command ATREMS address XX x x data password Examples ATREMS 000D6F0000012345 00 3FFC ATREMS 000D6F0000012345 0AE 1 pass...

Page 17: ...RROR errorcode The data is written to the remote S register number XX on all nodes addressed by the multicast group ID The data format for each individual S Register is given in the S Register descrip...

Page 18: ...y on the respective channel see description in Section 8 Channels masked out in S00 are not scanned SW release R300 PANSCAN Scan For Active PANs Execute Command AT PANSCAN Use on All nodes Note Scanni...

Page 19: ...s are used instead of random ones given the selected IDs are not already in use by other networks within range SW release R300 JN Join Network Execute Command AT JN Use on All nodes which are not part...

Page 20: ...deID nwk update ID Silent joining is joining via the commissioning method All data required to enter the network is provided to the node so that no joining procedure itself is required The node will a...

Page 21: ...NodeID or address table index Use on All Devices Note Use with care when targeting a Coordinator It will not be able to rejoin the PAN Response SEQ XX OK or ERROR errorcode errorcode represents the e...

Page 22: ...starting from the requested index Can be used to find the identity of all ZigBee devices in the network including non Telegesis devices Prompt example NTable NodeID errorcode Length 03 No Type EUI ID...

Page 23: ...sting its routing table starting from the requested index Prompt example RTable NodeID errorcode Length 40 No Dest Next Status 00 1234 ABCD 00 01 4321 739D 00 02 0000 0000 03 In this example the routi...

Page 24: ...s EUI64 ZDO Execute Command AT EUIREQ Address NodeID XX Where Address is the EUI64 NodeID or address table entry of the node which is to be interrogated about the node with the NodeID specified in No...

Page 25: ...d in section 3 Prompt example NodeDesc NodeID errorcode NodeDesc 0D57 Type FFD ComplexDesc No UserDesc No APSFlags 00 FreqBand 40 MacCap 8E ManufCode 1010 MaxBufSize 52 MaxInSize 0080 SrvMask 0000 Max...

Page 26: ...quence number of the unicast is stated using the SEQ XX prompt When acknowledged or not the accompanying ACK XX or NACK XX prompt is displayed SW release R302 ACTEPDESC Request Node s Active Endpoint...

Page 27: ...vices Response SEQ XX OK or ERROR errorcode errorcode represents the error code explained in section 3 Prompt SimpleDesc NodeID errorcode EP XX ProfileID XXXX DeviceID XXXXvXX InCluster Cluster List O...

Page 28: ...or an errorcode other than 00 will be displayed and the prompt will end after the errorcode Where NodeID is the Remote node s NodeID In addition all endpoints of this node matching the search criterio...

Page 29: ...p to 30 hops which will be used when sending any message to a remote node which is part of the listed devices SW release R300 FNDSR Find the Source Route to a remote device Execute Command AT FNDSR ad...

Page 30: ...AT REJOIN b If b is set to 0 join without the known network key unencrypted and if b is set to 1 join encrypted Use on SED MED Notes Polling a parent on an end device that has lost its parent will aut...

Page 31: ...zz MED EUI64 NodeID syy zz SED EUI64 NodeID syy zz ZED EUI64 NodeID syy zz Parameters nn ranging from 00 to 30 errorcode represents the error code explained in section 3 In case bit C of register S10...

Page 32: ...used if Network has been started as non TC network bit 9 of S0A set Response OK or ERROR errorcode errorcode represents the error code explained in section 3 SW release R302 BECOMENM Make the local d...

Page 33: ...l nodes on a network Response OK or ERROR errorcode errorcode represents the error code explained in section 3 Parameters Optional XX ranging from 0B to 1A SW release R304 2 7 Messaging ATABLE Display...

Page 34: ...e For Multicasts to be displayed using the MCAST prompt endpoint 01 must be selected as the target endpoint The multicast table is cleared by a reset Response No ID EP 00 1234 01 01 0000 00 02 0000 00...

Page 35: ...shows successful transmission Successful transmission does not guarantee successful reception To make sure data has been received by a specific node use a unicast message Only neighbours which are up...

Page 36: ...from 00 to 52 hexadecimal nn ranging from 00 to 30 decimal A maximum of 82 bytes are sent with attached EUI only 74 bytes The response OK shows successful transmission Successful transmission does not...

Page 37: ...ither be suppressed nor foreseen Response SEQ XX OK or ERROR errorcode Where errorcode represents the error code explained in section 4 Prompt ACK XX or NACK XX Up to 82 bytes are sent to the node up...

Page 38: ...ent can neither be suppressed nor foreseen Response data being entered SEQ XX OK or ERROR errorcode Prompt ACK XX or NACK XX Parameters XX ranging from 00 to 52 hex After the prompt a number of XX cha...

Page 39: ...ase a source route is known The latter event can neither be suppressed nor foreseen Response SEQ XX OK or ERROR errorcode Where errorcode represents the error code explained in section 3 Prompt ACK XX...

Page 40: ...n neither be suppressed nor foreseen Response data being entered SEQ XX OK or ERROR errorcode Parameters XX ranging from 00 to 52 hex After the prompt a number of XX characters are expected to be ente...

Page 41: ...esired prompt Use multicasts sparingly They are a form of broadcast so any node may only repeat or originate up to 8 multicasts in every 8 second interval Response OK or ERROR errorcode Where errorcod...

Page 42: ...ered errorcode represents the error code explained in section 3 In case bit 9 of S10 is set a timeout error is generated if no character is received for 1 second Parameters XX ranging from 00 to 52 he...

Page 43: ...ction 3 and XX is the sequence number of the unicast Remote Prompt DataMODE NodeID EUI64 OPEN Where NodeID is the NodeID of the remote node and EUI64 is its EUI64 Prompt DataMODE NodeID EUI64 errorcod...

Page 44: ...mote node s EUI64 NodeID or address table index Use on All Devices Response SEQ XX OK or ERROR errorcode Prompt ACK XX or NACK XX errorcode represents the error code explained in section 3 Plays a tun...

Page 45: ...ll only travel one hop Use with great care Raw data messages are not ZigBee compliant and may even leak into other PANs Response data being entered OK or ERROR errorcode Parameters XX ranging from 00...

Page 46: ...ode has run out of Buffers 19 Trying to write read only register 1A Data Mode Refused by Remote Node 1B Connection Lost in Data Mode 1C Remote node is already in Data Mode 20 Invalid password 25 Canno...

Page 47: ...vice Move to new Parent Failed 98 Cannot join ZigBee 2006 Network as Router A1 More than 8 broadcasts were sent within 8 seconds AB Trying to join but no beacons could be heard AC Network key was sent...

Page 48: ...Information S0E Prompt Enable 1 S0F Prompt Enable 2 S10 Extended Function S11 Device Specific S12 UART Setup S13 Pull up enable S14 Pull down enable S15 I O Configuration S16 Data Direction of I O Po...

Page 49: ...S37 Timer Counter 7 S38 Functionality for Timer Counter 7 S39 Power mode volatile S3A Initial Power Mode S3B Start up Functionality Plaintext A S3C Start up Functionality Plaintext B S3D Supply Volta...

Page 50: ...the Factory Default Settings If the unit seems to be unresponsive to commands on the serial port this is most often due to the unit having been set into a power down mode or the set up for the serial...

Page 51: ...RS Variants 7FFF Others FFFF SW release R302 S01 Transmit Power Level Description The device s transmit power level in dBm Operations R W LOCAL R W REMOTE Notes The output power of the PA and LR varia...

Page 52: ...nnel In this case a random PAN ID will be used instead When joining only a PAN with the ID stored in S02 will be joined unless S02 is set to 0000 In this case the next best PAN which allows joining is...

Page 53: ...Note Reading this register while not associated with a network will result in an undefined return value Operations R LOCAL R REMOTE Storage Non Volatile Parameters NodeID Range 0000 FFFF Factory Defa...

Page 54: ...iption The network key which can be written using the password The default password for R3xx is password Operations W LOCAL W REMOTE Write operation ATS08 key password ATREMS address 08 key password B...

Page 55: ...LOCAL W REMOTE Write operation ATS09 key password ATREMS address 09 key password Becomes effective When Joining or establishing a PAN Storage Non Volatile Range From 0 to 2128 1 The 128 bit trust cent...

Page 56: ...represents a 16 bit hexadecimal number Range 0000 to FFFF Bit E F Device Selection Bit F Bit E Device Type 0 0 Router FFD 1 0 End Device 0 1 Sleepy End Device 1 1 Mobile End Device Bit D Reserved Bit...

Page 57: ...comes effective Instantly Storage Non Volatile Parameters cccccccccccccccc Name with up to 16 characters Factory Default Telegesis SW release R302 S0C Password Description The local node s password Op...

Page 58: ...atile Parameters XXXX Where XXXX represents a 16 bit hexadecimal number Range 0000 to FFFF Bit F Set Disable prompt when entering binary data Bit E Set Disable UCAST MCAST BCAST data Bit D Set Disable...

Page 59: ...hexadecimal number Range 0000 to 01FF Bit 9 Bit F Reserved Bit 8 Set Show unhandled messages received by Endpoints 3 and above Bit 7 Set Hide AddrResp prompt Bit 6 Set Hide Network Manager Warning Bi...

Page 60: ...the last hop when devices report to AT SN or AT ANNCE Bit B Set UCASTs and SCASTs wait for ACK Bit A Set Disable playing Tune when receiving AT IDENT Bit 9 Set Enable one second character timeout whe...

Page 61: ...PB7 ETRX3 is PWM as defined by S1B S1D Unset Standard I O pin Bit E Set Enable Boost Mode Bit D Set Present 1 2V A D Reference at I O0 during measurement ETRX2 only Bit C Set I O8 turns into A D3 whic...

Page 62: ...ive Note that in case the 128 byte output buffer of the ETRX2 is full data will be dropped The parity settings do not affect the bytes transmitted over the air Storage Non Volatile Parameters XXXX Whe...

Page 63: ...s R W LOCAL R W REMOTE Becomes effective After Reset Note To achieve ultra low current consumption it is recommended not to use the built in pull ups and leave this register in its default state Stora...

Page 64: ...To achieve ultra low current consumption it is recommended not to use the built in pull downs and leave this register in its default state On the ETRX3 series this register is Reserved and currently n...

Page 65: ...XXX represents a 32 bit hexadecimal number bit 31 reserved bit 30 reserved bit 29 reserved bit 28 reserved bit 27 reserved bit 26 reserved bit 25 reserved bit 24 reserved bit 23 reserved PC7 bit 22 re...

Page 66: ...a Direction of I O Port Description The data direction of the module s I O port Operations R W LOCAL R W REMOTE Becomes effective Instantly Note On the LR variants of the ETRX3 PC5 is reserved and can...

Page 67: ...xxx BA98 7654 3210 e g setting bit 7 to 1 will cause I O7 to drive high if defined as an output in S16 ETRX3 representing the I O pins xxxxxxxx PC7 PC0 PB7 PB0 PA7 PA0 e g setting bit 7 to 1 will caus...

Page 68: ...xxxxxxxx PC7 PC0 PB7 PB0 PA7 PA0 S1A represents the logic level at each pin of the I O port Factory Default n a SW release R300 S1B PWM Pin Top Value Description The mode of operation for the special...

Page 69: ...R W LOCAL R W REMOTE Becomes effective Instantly Storage Volatile Parameters XXXX Range 0000 to FFFF If the special function pin is enabled by setting bit F of S11 this register represents the compar...

Page 70: ...ined in case the corresponding A D converter has not been enabled Range ETRX2 0000 04B0 0 1200 ETRX3 0000 2EE0 0 12000 SW release R300 S20 A D2 Reading ETRX3 series ADC1 Description The analogue readi...

Page 71: ...ined in case the corresponding A D converter has not been enabled Range ETRX2 0000 04B0 0 1200 ETRX3 0000 2EE0 0 12000 SW release R300 S22 A D4 Reading ETRX3 series ADC3 Description The analogue readi...

Page 72: ...rk triggers an event The remaining 8 events are timed events Registers S29 to S38 control those 8 timers and their corresponding events Please note that the first 4 timers are used by default for netw...

Page 73: ...O10 ETRX3 PB0 Description Describes the immediate action taken on IRQ2 Operations R W LOCAL R W REMOTE Becomes effective Instantly Storage Non Volatile Parameters XXXX If set to 0 the functionality is...

Page 74: ...etwork or message functions Storage Non Volatile Parameters XXXX If set to 0 the functionality is disabled Please see section 5 for a list of available functionalities Factory Default 0000 none SW rel...

Page 75: ...ered When reading this register the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 0004 1s interval SW releas...

Page 76: ...ister the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 00F0 1 min interval SW release R300 S2C Functionalit...

Page 77: ...When reading this register the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 00F4 1 min 1s interval SW relea...

Page 78: ...hen reading this register the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 00F2 1min interval SW release R3...

Page 79: ...event to be triggered When reading this register the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 0000 SW...

Page 80: ...event to be triggered When reading this register the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 0000 SW...

Page 81: ...event to be triggered When reading this register the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 0000 SW...

Page 82: ...event to be triggered When reading this register the threshold rather than the actual timer counter value is displayed If set to 0 the corresponding functionality is disabled Factory Default 0000 SW...

Page 83: ...Mode Description The module s power mode after start up and reset Operations R W LOCAL R W REMOTE Becomes effective After hard or soft reset Storage Non Volatile Parameters XXXX Range 0000 0003 The mo...

Page 84: ...5 Operations R W LOCAL R W REMOTE Becomes effective Instantly Storage Non Volatile Parameters Up to 50 characters Factory Default BUTTON4 SW release R300 S3D Supply Voltage Description The Supply vol...

Page 85: ...table entry 1 to endpoint 1 the AT command layer s endpoint is set with the setting of this register is created instantly and after a reset Factory Default 0000 SW release R300 S3F Multicast Table En...

Page 86: ...ssdd Where ss is the hexadecimal source endpoint and dd is the hexadecimal destination endpoint Factory Default Defined in S41 SW release R300 S41 Initial Setting of S40 Description The initial setti...

Page 87: ...e Instantly Storage Volatile Parameters XXXX The cluster ID of any xCAST message Factory Default Defined in S43 SW release R300 S43 Initial Setting of S42 Description The initial setting of S42 stored...

Page 88: ...44 Description The initial setting of S44 stored in non volatile memory Operations R W LOCAL R W REMOTE Becomes effective After Soft or Hard Reset Storage Non Volatile Parameters XXXX The profile ID o...

Page 89: ...4 of the ZigBee specification Factory Default C110 SW release R302 S48 Endpoint 2 Profile ID Description Register defining the Profile ID of the Node s endpoint 2 Operations R W LOCAL R W REMOTE Becom...

Page 90: ...o leading 0 s Factory Default 0000 SW release R302 S4B Endpoint 2 Input Cluster List Description Register defining the input cluster list of the device attached to the Node s endpoint 2 Operations R W...

Page 91: ...of 12 x 16 bit cluster IDs separated by commas The list may have any length from 0 to 12 clusters Factory Default 0000 SW release R302 S4D Mobile End Device Poll Timeout Description Register defining...

Page 92: ...in a timeout of 5 Minutes whereas the maximum number results in a timeout of approximately 48 days Maximum 0EFF Factory Default 0605 SW release R303 S4F MAC Timeout Description Register defining the M...

Page 93: ...triggered from there on Note No functionality on COOs 0014 Check for other devices on the network If no other devices could be found for three consecutive tries attempt a rejoin using the known netwo...

Page 94: ...0302 Clear S46 0400 Show status on ETRX2 I O3 ETRX3 PA7 LED on pin driven low no connection Blinking fast Auto searching for PAN Blinking slow connected to PAN The accompanying counter register defin...

Page 95: ...peration Notes Sleep modes 1 3 should not be used on a router or coordinator however it was found that mode 1 may work on a router with light to medium network traffic Successful operation of a router...

Page 96: ...dBm 28 mA TX 3dBm 28 mA TX 1dBm 28 mA TX 43dBm Table 9 Power Consumption Mode Router COO MED SED MCU Radio Timers I MCU Radio Timers I 0 Awake Awake User defined 28mA Awake Asleep User defined 9 5mA 1...

Page 97: ...o the SNR signal noise ratio The graph below shows the relation between the SNR and the LQI reading on the EM250 which is the basis of the ETRX2 series of modules Figure 1 LQI vs SNR source Ember From...

Page 98: ...nd radio power so that the quietest channel can be selected for a new network if you want to measure the RSSI of incoming messages you must set bit C of register S10 see page 60 The EM250 and EM35x So...

Page 99: ...using an extra R2xx device as shown in the step by step guide below Figure 2 Cloning from an R305 device R305 S00 0004 R305 channel 13 R305 S00 0004 R2xx R2xx Start with 3 modules Set the channel mask...

Page 100: ...rve the right to make modifications and or improvements without prior notification All information is correct at time of issue Telegesis UK Ltd does not convey any license under its patent rights or a...

Page 101: ...ork use the following settings Write your own Link Key into S09 on every device If you do this off line it can never be hacked Set bit 8 of register S0A on all devices that will join the PAN Use Pre C...

Search results

Summary of Contents for ETRX2USB

Reviews:

Telegesis ETRX2USB, Command Manual, Page: 48 / 101

Search results

Summary of Contents for ETRX2USB

Reviews: