manualshive.com logo in svg

Digi XLR PRO, User Manual, Page: 57 / 106

Share
Download
Digi XLR PRO User Manual Download Page 57

API frame format

XLR PRO Radio Frequency (RF) Modem User Guide

57

Request, but also requires application layer addressing fields to be specified (endpoints, cluster ID, profile ID). An 
Explicit TX Request API frame causes the XLR PRO to send data as an RF packet to the specified destination, using the 
specified source and destination endpoints, cluster ID, and profile ID.

The 64-bit destination address should be set to 0x000000000000FFFF for a broadcast transmission (to all devices). For 
unicast transmissions the 64 bit address field should be set to the address of the desired destination node. The 
reserved field should be set to 0xFFFE. 

The broadcast radius can be set from 0 up to NH to 0xFF. If the broadcast radius exceeds the value of NH then the value 
of NH will be used as the radius. This parameter is only used for broadcast transmissions.

The maximum number of payload bytes can be read with the NP command.

Frame fields

Offset

Example

Description

Start delimiter

0

0x7E

Length

MSB 1

0x00

Number of bytes between the length and the checksum

LSB 2

0x1A

Frame-specific 

data 

Frame type

3

0x11

Frame ID

4

0x01

Identifies this command for correlation to a later 

response frame (0x8B) to this command. If set to 0, no 

response frame will be sent.

64-bit destination
address

MSB 5

0x00

Set to the 64-bit address of the destination device. The 

following address is also supported:

0x000000000000FFFF—Broadcast address

6

0x13

7

0xA2

8

0x00

9

0x01

10

0x23

11

0x84

LSB12

0x00

Reserved

 13

0xFF

Set to 0xFFFE.

 14

0xFE

Source endpoint 15

0xA0

Source endpoint for the transmission.

Destination 

endpoint

16

0xA1

Destination endpoint for the transmission.

Cluster ID

17

0x15

Cluster ID used in the transmission.

18

0x54

Profile ID

19

0xC1

Profile ID used in the transmission.

20

0x05

Broadcast radius 21

0x00

Sets the maximum number of hops a broadcast 

transmission can traverse. If set to 0, the transmission 

radius will be set to the network maximum hops value.

Transmit options 22

0x00

If the Transmit Options Bitfield is 0, then the TO 

parameter will be used.
Bitfield:
bit 0: Disable ACK
bits 6,7: b’01 - Point-Multipoint
               b’10 - Repeater mode (directed broadcast)
All other bits must be set to 0.

Data payload

23

0x54

Payload data that is sent to the destination device.

24

0x78

25

0x44

26

0x61

27

0x74

28

0x61

Checksum

29

0xDD

0xFF—The 8-bit sum of bytes from offset 3 to this byte.

Summary of Contents for XLR PRO

Page 1: ...User Guide XLR PRO Radio Frequency RF Modem...

Page 2: ...ranties of fitness or merchantability for a particular purpose Digi may make improvements and or changes in this manual or in the product s and or the program s described in this manual at any time Wa...

Page 3: ...PRO kit contents 13 Front panel 14 RJ45 serial port pinout 15 Hardware setup 16 Connect the hardware 16 Mount the XLR PRO 17 Mounting guidelines 17 Antenna placement 18 XLR PRO operation XLR PRO oper...

Page 4: ...mmands 33 MAC PHY level commands 34 Diagnostics commands MAC statistics and timeouts 35 RF network commands 36 RF addressing commands 36 Addressing discovery configuration commands 39 RF security comm...

Page 5: ...mote devices 63 Remote command responses 63 Network commissioning and diagnostics 64 Device configuration 64 Device placement 64 Loopback testing 64 Device discovery 64 Network discovery 64 Neighbor p...

Page 6: ...t Mode options 92 Configure serial mode options 93 Configure system options 94 Configure web configuration options 95 Configure XLR radio configuration options 96 Schedule configuration changes 97 Tro...

Page 7: ...Punch2 Technology leverages chirp spread spectrum CSS modulation to provide better receiver sensitivity multipath performance and interference rejection than is available through commonly used frequen...

Page 8: ...Hz Mexico ISM 902 to 928 MHz Brazil Australia ISM 915 to 928 MHz RF data rate 9 4 kb s to 3 2 Mb s Maximum transmit power software selectable 30 dBm 1 watt Rural range line of sight 1 2 Mb s up to 100...

Page 9: ...A 26 VDC 400 mA Environmental Operating temperature 40 C to 70 C Regulatory approvals Emissions immunity FCC Part 15B Hazardous locations Class I Division 2 Groups A B C and D Mexico Safety Mexico Rad...

Page 10: ...RO can transmit and receive serial data via a TCP or UDP connection from either of the front panel Ethernet ports Ethernet RF Bridging In Ethernet RF bridging mode an XLR PRO functions as an Ethernet...

Page 11: ...ata in and serial data out LEDs flash three times to indicate that five seconds have passed 2 Release the Reset button The XLR PRO resets Action LED Status Description Startup Power Solid Power LED gl...

Page 12: ...requency RF family of products includes the following publications Title Part Number Description XLR PRO Radio Frequency RF Module User Guide 90001407 Provides complete information on all XLR PRO Radi...

Page 13: ...equency RF Modem User Guide 13 XLR PRO hardware XLR PRO kit contents The following figure shows the XLR PRO accessories kit Item Description 1 XLR PRO 2 Power supply 3 Ethernet cable 4 Mini USB cable...

Page 14: ...Power over Ethernet PoE device Doing so can permanently damage the XLR PRO or PoE device and void the XLR PRO warranty 5 RJ45 DB9F adapter 6 Antenna 7 Note Australian kit only Power plug adapter kit...

Page 15: ...only Do not connect the serial RJ45 port to any Power over Ethernet PoE device Doing so could permanently damage the XLR PRO or PoE device and void the XLR PRO warranty Pin RS 232 RS 485 4 wire RS 48...

Page 16: ...Hardware setup XLR PRO Radio Frequency RF Modem User Guide 16 Hardware setup Connect the hardware The following figure shows how to connect the XLR PRO cables and antenna...

Page 17: ...ing a tool or lock and key or other means controlled by a responsible authority The XLR PRO provides mounting holes in the bottom of the unit by which you can mount the unit directly on a wall or atta...

Page 18: ...or DIN Rail bracket Do not alter or move the mounting holes To attach brackets to the XLR PRO use four 4 6 32x3 8 screws Do not use screws that are longer than 3 8 Antenna placement Mount the XLR PRO...

Page 19: ...cal starting point and the antenna as the physical endpoint for transferred data As long as an interface block is able to touch another block above or below the two interfaces can interact For example...

Page 20: ...O radios on the RF network should be treated as if they were a single Ethernet cable Consult a qualified network administrator to evaluate the radio deployment if multiple XLR PRO radios will be used...

Page 21: ...serial mode selection The following parameters must be configured to match the host device regardless of whether RS 232 or RS 485 is selected BD Baud rate See the AT command table for limits NB Parit...

Page 22: ...cept the incoming data If configuring the XLR PRO using XCTU the port number is displayed in hexadecimal DY Destination IP port See DX DX Destination IP address Tells the XLR PRO where to send data if...

Page 23: ...of the XLR PRO If the serial transmit buffer becomes full and system buffers are also full then the entire RF data packet is dropped Whenever data is received faster than it can be processed and trans...

Page 24: ...the application needs to know which device sent which packet Transparent operation features Simple interface All received serial data is transmitted unless the XLR PRO is in command mode The XLR PRO...

Page 25: ...ee plus characters within one second Command Sequence Character CC parameter 0x2B No characters sent for one second GT parameter 0x3E8 Once the AT command mode sequence has been issued the XLR PRO sen...

Page 26: ...For an example of programming the XLR PRO using AT Commands and descriptions of each configurable parameter see XLR PRO AT command reference tables on page 33 Serial recovery In the rare case that the...

Page 27: ...e image is validated in non volatile memory XLR PRO resets places the firmware image into the application area and validates it This process takes approximately 45 seconds after the reset Note XLR PRO...

Page 28: ...he MAC PHY Related parameters ID PL RR MT Networks are defined with a unique network identifier For XLR PRO radios to communicate you must configure them with the same network identifier The ID parame...

Page 29: ...ic serial or IP socket mode Serial data from serial or IP socket mode operates concurrently with Ethernet bridging If the XLR PRO sends serial and Ethernet traffic at the same time the traffic encount...

Page 30: ...ackets may be lost when BA is set to a broadcast address XLR PRO serial addressing basics Related parameters SH SL DH DL TO 64 bit addresses Each radio has a unique factory assigned IEEE 64 bit addres...

Page 31: ...nating node will send the broadcast multiple times By default a broadcast transmission is sent four times Essentially the extra transmissions become automatic retries without acknowledgments This will...

Page 32: ...ote The timeouts in this section are theoretical timeouts and not precisely accurate The application should pad the calculated maximum timeouts by a few hundred milliseconds When using API mode Tx Sta...

Page 33: ...an OK then performs a reset 100ms later RE Restore Defaults Restore module parameters to factory defaults WR Write Write parameter values to non volatile memory so that parameter modifications persis...

Page 34: ...LR PRO radios will receive data regardless of theBRvalueset BRdoesnotneedtomatchoneveryradioon the network 0 9 38 kb s 1 28 14 kb s 2 65 66 kb s 3 140 7 kb s 4 290 8 kb s 5 590 9 kb s 6 1 191 Mb s 7 2...

Page 35: ...he counter can be reset to any 16 bit value by appending a hexadecimal parameter to the command 0 0xFFFF 0 GD Good Packets Received This count is incremented whenever a good frame with a valid MAC hea...

Page 36: ...on this node When set this node will not propagate broadcasts and will not act as a repeater 0 2 2 BH Broadcast Hops The transmission hops for broadcast data transmissions Set to 0 for maximum radius...

Page 37: ...mode Example 2 Setting TO to 0x41 would cause all transmissions to be sent using point to multipoint with network acknowledgments disabled 0x40 0xBF bitfield Bits 4 5 must be set to 0 0x40 point to mu...

Page 38: ...d masks can have multiple options combined 0 7 bitfield 0 CI Cluster ID The application layer cluster ID value This value will be used as the cluster ID for all data transmissions Supported Cluster ID...

Page 39: ...with the matching NI Node Identifier string 2 OK or ERROR CR is returned 3 Command Mode is exited to allow immediate communication API Firmware 0xFFFE and 64 bit extended addresses are returned in an...

Page 40: ...CR 1 Byte Optionally included based on NO settings CR After the number of milliseconds as listed by the N parameter the command ends by returning a CR ND also accepts a Node Identifier NI as a paramet...

Page 41: ...es MANUFACTURER_ID CR 2 Bytes DIGI DEVICE TYPE CR 4 Bytes Optionally included based on NO settings RSSI OF LAST HOP CR 1 Byte Optionally included based on NO settings CR If the FN command is issued in...

Page 42: ...5 38 400b s 9 480 600b s 2 4 800b s 6 57 600b s 3 9 600b s 7 115 200b s 4 19 200b s 8 230 400b s If a non standard baud rate is needed a value above 0x5B9 can be entered to select a specific baud rate...

Page 43: ...t data is packetized in the API format 2 API mode is on with escaped sequences inserted to allow for control characters XON XOFF escape and the 0x7e delimiter to be passed as data 0 2 0 AO API Options...

Page 44: ...pact on RS 232 communication 0 No line termination 1 Line termination enabled 0 1 0 Command Name and description Range Default TP Temperature The temperature of the XLR PRO RF module in degrees Celsiu...

Page 45: ...andard value is entered After entering the specific baud rate IB can be queried to read the actual baud rate 0 9 and 0x5B9 0x70800 0x70800 480600 b s IP IP Protocol The IP protocol used for client and...

Page 46: ...Ethernet MAC address yyy is the last byte of the Ethernet MAC address If the Auto IP address of the XLR PRO conflicts with another address on the network then the Auto IP address will be incremented...

Page 47: ...xt field Up to 31 ASCII characters LX Latitude GPS latitude coordinates of the XLR PRO that is displayed on Device Cloud and in the web configuration This is a user defined text field the XLR PRO does...

Page 48: ...BE Ethernet RF Bridging Enable Enable or disable Ethernet RF bridging When enabled Ethernet traffic can be passed between up to 16 XLR PROs on the same RF network 0 Disable Ethernet RF bridging 1 Ena...

Page 49: ...RF Module Hardware Version Hardware version number of the XLR PRO RF module VH XLR PRO Baseboard Hardware Version Hardware version number of the XLR PRO Baseboard C Compatibility Hardware compatibili...

Page 50: ...ditional API frames with unknown frame types API frame format Two API modes are supported and both can be enabled using the AP API Enable command Use the following AP parameter values to configure the...

Page 51: ...sults in the following frame 0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB Note In the above example the length of the raw data excluding the checksum is 0x0002 and the checksum of the non escaped data excluding...

Page 52: ...keeping only the lowest 8 bits of the result and subtract the result from 0xFF To verify Add all bytes include checksum but not the delimiter and length If the checksum is correct the sum will equal 0...

Page 53: ...n unless the frame ID is set to 0 in the TX request If the packet cannot be delivered to the destination the transmit status frame will indicate the cause of failure The received data frame 0x90 or 0x...

Page 54: ...pe 0x09 Used to query or set XLR PRO parameters In contrast to the 0x08 AT Command API type new parameter values are Frame fields Offset Example Description Start delimiter 0 0x7E Length MSB 1 0x00 Nu...

Page 55: ...to all devices set the 64 bit destination address to 0x000000000000FFFF Unicast transmission For unicast transmissions set the 64 bit address field to the address of the desired destination node Set t...

Page 56: ...h and the checksum LSB 2 0x16 Frame specific data Frame type 3 0x10 Frame ID 4 0x01 Identifies this command for correlation to a later response frame 0x8B to this command If set to 0 no response frame...

Page 57: ...rame type 3 0x11 Frame ID 4 0x01 Identifies this command for correlation to a later response frame 0x8B to this command If set to 0 no response frame will be sent 64 bit destination address MSB 5 0x00...

Page 58: ...ver command Frame fields Offset Example Description Start delimiter 0 0x7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB 2 0x10 Frame specific data Frame type 3 0x17 Frame...

Page 59: ...then no response frame will be delivered AT command 5 0x42 Command Name Two ASCII characters that identify the AT command BD 6 0x44 Command status 7 0x00 The least significant nibble indicates the co...

Page 60: ...us 8 0x00 0x00 Success 0x01 MAC ACK Failure 0x02 Collision Avoidance Failure 0x21 Network ACK Failure 0x31 Internal Resource Error 0x32 Internal Error 0x74 Payload too large Discovery status 9 0x02 0x...

Page 61: ...s between the length and the checksum LSB 2 0x18 Frame specific data Frame type 3 0x91 64 bit source address MSB 4 0x00 64 bit address of sender 5 0x13 6 0xA2 7 0x00 8 0x40 9 0x52 10 0x2B LSB 11 0xAA...

Page 62: ...ID 0x55 the response would look like the above example Frame fields Offset Example Description Start delimiter 0 0x7E Length MSB 1 0x00 Number of bytes between the length and the checksum LSB 2 0x13...

Page 63: ...fect until the changes are applied For example changing the BD parameter will not change the actual serial interface rate on the remote until the changes are applied Changes can be applied using remot...

Page 64: ...k cluster ID depend on the AP setting AT Configuration AP 0 To send data to the loopback cluster ID on the data endpoint of a remote device set the CI command value to 0x12 The SE and DE commands shou...

Page 65: ...means that the responses are sent directly to the node which sent the FN command to the target node The response packet is output on the initiating radio in the same format as a network discovery fram...

Page 66: ...e GPM_DATA field or in the case of a READ the number of bytes requested Specify multi byte parameters using big endian byte ordering 8 varies GPM_DATA Payload byte offset Number of bytes Field name Ge...

Page 67: ...es an error occurred All other bits are reserved GPM_BLOCK_NUM Indicates the number of available GPM blocks GPM_START_INDEX Indicates the size in bytes of a GPM block GPM_NUM_BYTES Number of bytes in...

Page 68: ...command set to 0 GPM_DATA No data bytes should be specified for this command Field name Command specific description GPM_CMD_ID Set to WRITE 0x02 or ERASE_THEN_WRITE 0x03 GPM_OPTIONS At present there...

Page 69: ...1 0013A200407402AC FFFE E6 E6 0023 C105 00 C0 04 00 0016 0000 000F 3B Assuming all transmissions were successful and that flash block 22 was previously written with incrementing data the following API...

Page 70: ...id the XLR PRO will reset and begin using the new firmware Field name Command specific description GPM_CMD_ID Set to FIRMWARE_VERIFY 0x05 or FIRMWARE_VERIFY_AND_INSTALL 0x06 GPM_OPTIONS Set this field...

Page 71: ...ase the entire GPM Any user data stored in the GPM will be lost during an over the air upgrade Over the air firmware upgrades XLR PROs provide two methods of firmware update Local firmware update via...

Page 72: ...the uploaded data is invalid If the data is valid it will begin installing the application No installation will take place on invalid data Installing the application When the entire ebin file has been...

Page 73: ...parameters which have not been written to flash will be lost after the reset To avoid this write all parameters with the WR command before doing a firmware upgrade Because explicit API Tx frames can b...

Page 74: ...www digi com xctu 2 Launch the XCTU installer and follow the prompts on the installation screens Note For XLR PRO support make sure you install XCTU version 6 1 2 or later Download and install USB dr...

Page 75: ...meter 1 Locate the parameter in the XCTU configuration display Note Use the Search function in the upper right corner to quickly locate a parameter 2 Select a new value for the parameter 3 If you want...

Page 76: ...e settings Update firmware with XCTU Note To update XLR PRO firmware you need XCTU version 6 1 2 or above To update firmware using XCTU 1 Launch XCTU 2 Click Add devices or Discover devices to add the...

Page 77: ...the network and wait approximately one minute for DHCP to assign an address and then use XCTU to view the assigned address See Configuring the XLR PRO using XCTU on page 74 for details on using XCTU T...

Page 78: ...rnet Network options to configure Ethernet options for the XLR PRO Ethernet Network options are used for Ethernet socket mode only 1 From the XLR PRO Configuration and Management page select Ethernet...

Page 79: ...ult DNS address and static mode is configured OpenDns servers are used 5 Click Apply Set Ethernet RF bridging options By default bridging is disabled To enable bridging and set a destination address 1...

Page 80: ...Cloud server The default is devicecloud digi com which is the name of the US server For the Europe server enter devicecloud uk digi com 3 Click Apply Set XLR radio options To set XLR radio options 1...

Page 81: ...t the key is never displayed If you enter a new encryption key the key must match on all devices on the network 4 Click Apply Set XLR radio serial options To set XLR radio serial configuration options...

Page 82: ...nly used when traffic is initiated from the XLR PRO When traffic is initiated from the Ethernet interface the Destination IP address is the address of the external device Local Port Enter the local li...

Page 83: ...re file XLR PRO firmware files have the ebin extension 5 After selecting a firmware file click Update Firmware XLR PRO firmware is updated and the XLR PRO resets The amount of time needed to update th...

Page 84: ...Web UI Settings The Web UI Settings page appears 2 Enable or disable configuration and management via the Web UI To enable the Web UI select Enable Web Interface To disable the Web UI deselect Enable...

Page 85: ...rom the XLR PRO Configuration and Management page select Reboot The System Reboot Confirmation page appears 2 Click Reboot Restore factory default settings To restore the XLR PRO factory default setti...

Page 86: ...to www digi com cloud digi device cloud 2 Click Free Developer Account 3 Follow the online instructions to complete account registration You can upgrade your trial account to a paid account at any ti...

Page 87: ...Management Devices 4 Click Add Devices The Add Devices dialog appears Note You can use the Discover button to discover an XLR PRO device if the XLR PRO is connected to your local network 5 Select Mac...

Page 88: ...s 6 After fifteen seconds the XLR PRO power LED illuminates After about 30 seconds the new firmware is fully operational and running Configure XLR PRO with Device Cloud XLR PRO configuration includes...

Page 89: ...ct Enabled to enable Device Cloud management or select Disabled to disable Device Cloud management The default is enabled Device Cloud FQDN server If Device Cloud management is enabled enter the FQDN...

Page 90: ...to use for the XLR PRO in IPv4 format Default Gateway Enter the default gateway for the XLR PRO in IPv4 format 6 For static or DHCP addressing you can specify the Domain Name Server address DNS Addres...

Page 91: ...d Disabled Select Enabled to enable bridging or select Disabled to disable bridging The default is disabled Destination RF MAC address If bridging is enabled enter the destination RF MAC address for t...

Page 92: ...P operations The default is 9750 Remote Port Enter the destination IP port number for UDP and TCP operations The default is 9750 TCP Client timeout Enter the number of seconds the TCP client socket sh...

Page 93: ...t Protocol Select the protocol RS 232 or RS 485 RS 422 The default is RS 232 RS 232 RTS flow control Select RTS flow control for RS 232 disabled or UART clear to send The default is disabled RS 232 CT...

Page 94: ...n System 4 Set system options Description Enter a description for the XLR PRO radio Contact Enter contact information for the XLR PRO radio Location Enter the location of the XLR PRO radio 5 Apply the...

Page 95: ...isable the HTTP server The default is enabled User Name Password If the HTTP server is enabled you can set a user name and password to control access to the server The default HTTP server user name is...

Page 96: ...ing network IDs can communicate with each other RF data rate Select an RF Data Rate from the drop down list The default is 290 800 b s Encryption key Enter an AES encryption key for RF packets a 128 b...

Page 97: ...uration changes After changing one or more configuration options you can immediately apply the changes to the XLR PRO device or schedule a time for applying the configuration changes To schedule a tim...

Page 98: ...to 1 This will also disable IP socket mode so it would be advisable to connect the XLR PRO to your Ethernet network if configuration changes need to be made Ethernet issues LAN stopped working when X...

Page 99: ...O see XLR PRO approved antennas on page 103 To comply with RF exposure limits established in the ANSI C95 1 standards the distance between the antenna or antennas and the user should not be less than...

Page 100: ...igned to provide reasonable protection against harmful interference in a residential environment This equipment generates uses and can radiate radio frequency energy and if not installed and used in a...

Page 101: ...d or operating in conjunction with any other antenna or transmitter ATTENTIONCet quipement est approuv pour les p riph riques de transmission de mobile et station de base seulement Antenne s utilis e...

Page 102: ...IFETEL Manufacturer Digi International Inc Country USA Brand Digi The XLR Pro RF Modem for carries the following Mexican approval marks Mexico 1502CE10266 IFT RCPDIXL15 1494 Note Only the 2 1 dBi dip...

Page 103: ...Fixed 0 A09 F2 OMNI RPN 2 1 Fixed 0 A09 F3 OMNI RPN 3 1 Fixed 0 A09 F4 OMNI RPN 4 1 Fixed 0 A09 F5 OMNI RPN 5 1 Fixed 0 A09 F6 OMNI RPN 6 1 Fixed 0 1 A09 F7 OMNI RPN 7 1 Fixed 1 1 A09 F8 OMNI RPN 8 1...

Page 104: ...8 1 Fixed 2 1 A09 W7TM OMNI RPTNC 7 1 Fixed 1 1 A09 HSM 7 OMNI RPSMA 3 0 Fixed Mobile 0 A09 HASM 675 OMNI RPSMA 2 1 Fixed Mobile 0 A09 HABMM P61 OMNI MMCX 2 1 Fixed Mobile 0 A09 HABMM 6 P61 OMNI MMCX...

Page 105: ...ixed Mobile 7 1 A09 Y14 10 Element Yagi RPN 14 1 Fixed Mobile 8 1 A09 Y14 12 Element Yagi RPN 14 1 Fixed Mobile 8 1 A09 Y15 13 Element Yagi RPN 15 1 Fixed Mobile 9 1 A09 Y15 15 Element Yagi RPN 15 1 F...

Page 106: ...em User Guide 106 A09 Y15TM 13 Element Yagi RPTNC 15 1 Fixed Mobile 9 1 A09 Y15TM 15 Element Yagi RPTNC 15 1 Fixed Mobile 9 1 Max Gain 15 1 Part Number Type Connector Gain dBi Application Minimum Cabl...

Reviews:

No comments