manualshive.com logo in svg

Digi 9XTend-PKG-R RS-232, Руководство пользователя, Страница: 67 / 98

Поделиться
Скачать
Digi 9XTend-PKG-R RS-232 Скачать руководство пользователя страница 67

API operation

9XTend-PKG-R RS-232/485 RF Modem User Guide

67

•

In point-to-multipoint systems, the application must send extra information so that the receiving modem(s) can 

distinguish between data coming from different remotes.

As an alternative to the default Transparent Operation, API (Application Programming Interface) Operations are 

available. API operation requires that communication with the modem be done through a structured interface (data is 

communicated in frames in a defined order). The API specifies how commands, command responses and modem 

status messages are sent and received from the modem using a UART Data Frame.

API frame specifications

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 modem to operate in a particular mode:

•

AP = 0 (default): Transparent Operation (UART Serial line replacement)

API modes are disabled.

•

AP = 1: API Operation

•

AP = 2: API Operation (with escaped characters)

Any data received prior to the start delimiter is silently discarded. If the frame is not received correctly or if the 

checksum fails, the data is silently discarded.

API Operation (AP parameter = 1)

When this API mode is enabled (AP = 1), the UART data frame structure is defined as follows:

MSB = Most Significant Byte, LSB = Least Significant Byte

API Operation - with Escape Characters (AP parameter = 2)

When this API mode is enabled (AP = 2), the UART data frame structure is defined as follows::

MSB = Most Significant Byte, LSB = Least Significant Byte

Escape characters

When sending or receiving a UART data frame, specific data values must be escaped (flagged) so they do not interfere 

with the UART or UART data frame operation. To escape an interfering data byte, insert 0x7D and follow it with the 

byte to be escaped XOR’d with 0x20.

Data bytes that need to be escaped:

•

0x7E – Frame Delimiter

•

0x7D – Escape

Start Delimiter

(Byte 1)

Length

(Bytes 2-3)

Frame Data

(Bytes 4-n)

Checksum

(Byte n + 1)

0x7E

MSB

LSB

API-specific Structure

1 Byte

Start Delimiter

(Byte 1)

Length

(Bytes 2-3)

Frame Data

(Bytes 4-n)

Checksum

(Byte n + 1)

0x7E

MSB

LSB

API-specific Structure

1 Byte

Characters Escaped If Needed

Содержание 9XTend-PKG-R RS-232

Страница 1: ...User Guide 9XTend PKG R RS 232 422 485 RF Modem...

Страница 2: ...uct s and or the program s described in this manual at any time Range figure estimates within this guide are based on free air terrain with limited sources of interference Actual range will vary based...

Страница 3: ...als 16 Wiring diagram 17 RS 485 4 wire and RS 422 Operation 18 DIP switch settings and pin signals 18 Wiring diagrams 19 Operation Serial communications 21 RS 232 and RS 485 422 data flow 21 Host and...

Страница 4: ...ializer Command 49 HV Hardware Version Command 49 ID Modem VID Command 50 KY AES Encryption Key Command 50 LH Wake up Initializer Timer Command 50 MD RF Mode Command 51 MK Address Mask Command 52 MT M...

Страница 5: ...ledged RF mode 73 Peer to peer networks 73 Definition 73 Sample network profile Broadcast communications 73 Sample network profile Acknowledged communications 73 Basic RF modes 73 Acknowledged RF mode...

Страница 6: ...fication 84 FCC Part 15 Class B 84 IC Industry Canada Certification 85 RF Exposure 85 ACMA Australia 85 Power requirements 85 Legacy XTend Modem approved antennas 86 XTend vB Modem approved antennas 3...

Страница 7: ...B Modem Legacy modems have part numbers with the format XT09 PK and contain radio model XT09 XTend vB modems have part numbers with the format XTP9B PK and contain radio model XBP9X Key features Long...

Страница 8: ...interfacing rates MODBUS CTS RTS DCD DTR and more I O Support Multiple data formats supported parity start and stop bits etc XII Interference Immunity Worldwide acceptance FCC Approved USA Refer to A...

Страница 9: ...ce can still vary at any particular installation site dependent on both the physical environment in which the radio is installed and the amount of in band and out of band interference sources broadcas...

Страница 10: ...4 mA BR 1 20 mA 17 mA Specification Value Frequency 902 928 MHz Spread Spectrum FHSS Frequency Hopping Spread Spectrum Modulation FSK Frequency Shift Keying Network Topologies Supported Peer to Peer M...

Страница 11: ...hms unbalanced Regulatory approvals FCC Part 15B See Agency certifications on page 84 for important information Transmit power output 1 mW 10 mW 100 mW 500 mW 1 W Legacy Modem Typical transmit current...

Страница 12: ...and the modem s receiver sensitivity 3 LEDs ON Very Strong Signal 30 dB fade margin 2 LEDs ON Strong Signal 20 dB fade margin 1 LED ON Moderate Signal 10 dB fade margin 0 LED ON Weak Signal 10 dB fade...

Страница 13: ...RF Modem User Guide 13 DIP Switch Settings of the XTIB R RS 232 485 Interface Board Refer to the tables in Automatic DIP switch configurations on page 33 regarding configurations triggered by the posi...

Страница 14: ...m supports the following interfacing protocols RS 232 RS 485 2 wire Half duplex RS 485 4 wire and RS 422 RS 232 operation DIP switch settings and pin signals RS 232 DIP Switch Settings Pins used on th...

Страница 15: ...e RF modem from host 4 DTR GPI2 Data Terminal Ready Can enable Power Down on the RF modemy 5 GND Ground Signal Ground 6 DSR GPO2 Data Set Ready Connected to DCD pin1 7 RTS CMD GPI1 Request to Send Com...

Страница 16: ...F modem female DB 9 connector wired to an RS 232 DCE Device male DB 9 Sample wireless connection DTE DCE DCE DCE RS 485 2 wire operation DIP switch settings and pin signals RS 485 2 wire Half duplex D...

Страница 17: ...iagram shows the XTend RF Modem in an RS 485 2 wire half duplex environment t Termination is the 120 resistor between T and T DIP Switch settings are read and applied only while powering on DB 9 Pin R...

Страница 18: ...tional Termination is the 120 resistor between T and T DIP Switch settings are read and applied only while powering on DB 9 Pin RS 485 422 Name Description Implementation 2 T TA Transmit Negative Data...

Страница 19: ...ability in which up to 32 nodes can be connected The RS 422 protocol is used for point to point communications Suggestions for integrating the XTend RF Modem with the RS 485 422 protocol 1 When using...

Страница 20: ...apter yellow Female DB 9 to RJ 45 Adapter green An XTend RS 232 422 485 RF Modem Accessories Kit is available that includes connectors that facilitate RS 485 422 and other serial communications Refer...

Страница 21: ...own in the figure below The following figure shows the System Data Flow in an RS 232 environment Host and RF Modem settings Serial communications between a host and an XTend RF Modem are dependent upo...

Страница 22: ...rameter Two cases in which the DI Buffer may become full and possibly overflow 1 If the serial interface data rate is set higher than the RF data rate of the modem the modem will receive data from the...

Страница 23: ...ized and sent at any RO timeout or when the maximum packet size is received The modem operates as described above unless the Command Mode Sequence is detected The Command Mode Sequence consists of thr...

Страница 24: ...Serial communications 9XTend PKG R RS 232 485 RF Modem User Guide 24 Identify the source address of each received packet To implement API operations see API operation on page 66...

Страница 25: ...de Sequence is issued Transmit mode When the first byte of serial data is received from the UART in the DI buffer the modem attempts to shift to Transmit Mode and initiate an RF connection with other...

Страница 26: ...d over the air until the DI buffer is empty Channel initialization is the process of sending an RF initializer that synchronizes receiving modems with the transmitting modem During channel initializat...

Страница 27: ...and Destination Address Data that does not pass through all three network filter layers is discarded Refer to the Addressing section of the RF Communication Modes chapter for more information CRC Cyc...

Страница 28: ...modem first transitions to Idle Mode All Sleep Modes are enabled and disabled using SM Command Transitions into and out of Sleep Modes are triggered by various mechanisms as shown in the table below S...

Страница 29: ...ic Sleep SM 4 8 Cyclic Sleep Modes allow modems to periodically wake and check for RF data The modem wakes according to the times designated by the Cyclic sleep settings If the modem detects a wake up...

Страница 30: ...eter values to persist in the modem registry changes must be saved to non volatile memory using the WR Write command Otherwise parameters are restored to previously saved values when the modem is powe...

Страница 31: ...ameter values takes place through the same serial data path as live data received RF payload interference between the two types of data can be a concern Common questions about using binary commands Wh...

Страница 32: ...ommand Write then Read In this graph a value was written to a register and then read out to verify it While not in the middle of other received data note that the CTS signal outlines the data response...

Страница 33: ...ameter values as shown in the table below RF Modem DIP Switches The following table shows the Power up Options Commands sent as result of DIP Switch Settings SW DIP Switch Switches Condition Behavior...

Страница 34: ...rmation on the program and how to use it The help information is available at https docs digi com display XCTU XCTU Overview Switches 5 and 6 TX RX Modes If SW5 and SW6 are OFF down Multipoint Base AT...

Страница 35: ...are settings In XCTU you can load default module firmware settings onto a module in your device list To load default firmware settings 1 Switch to Configuration working mode 2 Select a module from the...

Страница 36: ...eference table This AT command information is provided for reference For additional details refer to the XTend and XTend vB RF module user s guides XTend Commands The RF modems expect numerical values...

Страница 37: ...Mode Options ER 0x0F 15d Receive Error Count 0 0xFFFF Diagnostics 2 0 FH 0x0D 13d Force Wake up Initializer Sleep Low Power FL 0x07 7d Software Flow Control 0 1 Serial Interfacing 1 0 FS 0x3E 62d Forc...

Страница 38: ...x 1 ms Remote x 10 ms Networking and Security 2 0 PE v2 x20 0x46 70d Polling End Address 0 0xFFFF Networking and Security 2 0 PK 0x29 41d Maximum RF Packet Size 1 0x800 Bytes RF Interfacing 2 varies...

Страница 39: ...ead only Diagnostics 2 varies SL 0x26 38d Serial Number Low 0 0xFFFF read only Diagnostics 2 varies SM 0x01 1d Sleep Mode 0 8 3 is reserved Sleep Low Power 1 0 ST 0x02 2d Time before Sleep ATAT 3 0x7F...

Страница 40: ...After command Command Mode Options AT Command is used to set read the time of silence that follows the command sequence character CC Command of the AT Command Mode Sequence BT CC AT By default 1 seco...

Страница 41: ...F data rate is not affected by the BD parameter If the interface data rate is set higher than the RF data rate a flow control configuration may need to be implemented The range between standard and no...

Страница 42: ...stored in the modem s BD register BR RF Data Rate command RF Interfacing The BR command is used to set and read the RF data rate rate that RF data is transmitted over the air of the modem BT Guard Ti...

Страница 43: ...nds instead of payload CD GPO2 Configuration Command Serial Interfacing CD Command is used to select read the behavior of the GPO2 line pin 3 AT Command ATCC Binary Command 0x13 19 decimal Parameter R...

Страница 44: ...t the behavior of the GP01 pin pin 9 This output can provide RS 232 flow control control the TX enable signal for RS 485 or RS 422 operations By default GP01 provides RS 232 CTS Clear to Send flow con...

Страница 45: ...e power level in signed decimal format with the units dBm If CF 1 the magnitude of the value is presented in unsigned hex If CF 2 the value is presented in decimal but without the units Sample Output...

Страница 46: ...Mode Options E1 Command enables character echo in AT Command Mode Each typed character will be echoed back to the terminal when ATE1 is active E0 Echo Off is the default ER Receive Error Count Command...

Страница 47: ...ow control to also be enabled The XON character used is 0x11 17 decimal The XOFF character used is 0x13 19 decimal FS Forced Sync Time Command RF Interfacing The FS command only applies to streaming d...

Страница 48: ...ry after a power up sequence Once the Receive Good Count reaches its maximum value up to 0xFFFF it remains at its maximum count value until the maximum count value is manually changed or the modem is...

Страница 49: ...ep In cyclic sleep the RX modem wakes once per sleep interval SM Command to check for a wake up initializer When a wake up initializer is detected the modem stays awake to receive data The wake up ini...

Страница 50: ...be meaningless Because CBC mode is utilized repetitive data appears differently in different transmissions due to the randomly generated IV LH Wake up Initializer Timer Command Sleep Low Power The LH...

Страница 51: ...if the transmission has already been detected A Repeater End Node handles repeated messages but will not repeat the message over the air Refer to the Polling and Repeater Mode sections of the RF Commu...

Страница 52: ...request an ACK acknowledgment from the receiving RF modem s MT takes precedence over RR so if both MT and RR are non zero then MT 1 packets will be sent with no ACK requests When a receiving modem re...

Страница 53: ...d proceeds to the next Polling Remote Each Polling Remote responds by sending the data from the Data In buffer following the RB and RO parameters When there is no eligible data to send the Polling Rem...

Страница 54: ...through a sequential range of addresses polling each Polling Remote MD 4 The base then waits for a response and proceeds to the next Polling Remote Each Polling Remote responds by sending data from t...

Страница 55: ...red to be equal to PK When BR 0 9600 baud the maximum PK value is 0x100 256d When BR 1 115 200 baud the maximum PK value is 0x800 2048d PL TX Power Level Command RF Interfacing The PL command is used...

Страница 56: ...eceived in the DI Buffer and either of the following criteria is met RB characters received by the UART RO character times of silence detected on the UART receive lines after receiving at least 1 Byte...

Страница 57: ...prior to power down or reset RM Ambient Power All Channels Command Diagnostics The RM command is used to examine and report power levels on all channels If no parameter is given the channels are scann...

Страница 58: ...teria are met RO character times of silence on the UART receive lines after receiving at least 1 byte RB characters have been received by the UART RB and RO criteria only apply to the first packet of...

Страница 59: ...eceived PWM output is also set low at power up A parameter value of 0xFF permanently enables PWM output and always reflects the value of the last received RF packet The Config RSSI pin is shared betwe...

Страница 60: ...erial Interfacing The RT command is used to set read the behavior of the GPI1 pin GPI1 of the OEM RF Module The pin can be configured to enable binary programming or RTS flow control SB Stop Bits Comm...

Страница 61: ...onfigure the modem to run in states that require minimal power consumption 1 2 stop bits Default Parameter Value 0 Number of bytes returned 1 AT Command ATSH Binary Command 0x25 37 decimal Parameter R...

Страница 62: ...sed to read the current temperature of the board 1 Pin Sleep 2 Serial Port Sleep 3 reserved 4 Cyclic 1 0 second sleep RF modem wakes every 1 0 seconds 5 Cyclic 2 0 second sleep 6 Cyclic 4 0 second sle...

Страница 63: ...is used to set read the limit on the number of bytes that can be sent out before a random delay is issued If an RF modem is sending a continuous stream of RF data a delay is inserted which stops its t...

Страница 64: ...hort Command Diagnostics The VR command is used to read the firmware version of the RF modem Note Firmware versions contain four significant digits A B C D If B 2 the modem is programmed for operation...

Страница 65: ...per line AT Command ATWN Parameter Range returns string Warning Description 1 Under voltage This is caused if the supply voltage falls below the minimum threshold for the lowest power level 2 8 V If...

Страница 66: ...set or queried a special operation is required for transitioning the modem into Command Mode see Command mode on page 30 6 Default calibration data in flash This is caused if the module specific power...

Страница 67: ...ped characters Any data received prior to the start delimiter is silently discarded If the frame is not received correctly or if the checksum fails the data is silently discarded API Operation AP para...

Страница 68: ...keeping only the lowest 8 bits of the result and subtract from 0xFF To verify Add all bytes include checksum but not the delimiter and length If the checksum is correct the sum will equal 0xFF API Ty...

Страница 69: ...cture Status Byte 5 0 Hardware reset 1 Watchdog timer reset cmdData 0x01 Length Checksum Start Delimiter Frame Data Identifier specific Data API Identifier MSB LSB 0x7E 1 Byte API specific Structure F...

Страница 70: ...0x7E 1 Byte API specific Structure Frame ID Byte 5 Status Byte 6 0 Success 1 No ACK Acknowledgement received Identifies UART data frame being reported Note If Frame ID 0 in the TX Request no AT Comman...

Страница 71: ...nition Point to point means an RF data link between two devices Sample network profile Broadcast communications Use the default values for all devices Sample network profile Acknowledged communication...

Страница 72: ...1 Send ATMY 0 to set the source address to 0x00 2 Send ATDT FFFF to set the destination address to 0xFFFF Remotes 1 Use XCTU or another terminal program to send the AM command See the AM command for...

Страница 73: ...igi s peer to peer architecture features fast synch times 35 ms to synchronize devices and fast cold start times 50 ms before transmission Sample network profile Broadcast communications Assume the de...

Страница 74: ...ress and address mask The transmitting device determines whether the packet is for a specific node local address or multiple nodes global address by comparing the packet s destination address DT and i...

Страница 75: ...o interference some RX devices may lose data and synchronization to the TX device particularly during long transmission events Once the TX device has sent all pending data or has reached the TT limit...

Страница 76: ...he amount of time remaining in the Multi transmit event and inhibits its own transmissions for the duration of the Multi transmit event plus a random number of delay slots between 0 and RN 1 If the lo...

Страница 77: ...all communications Both Repeater Nodes and End Nodes can source data allowing connection to host devices Repeater Nodes however are able to repeat information in a simple store and forward fashion As...

Страница 78: ...ly defines Repeater Nodes and repeater End Nodes Repeater Nodes forward messages on to other devices within range End Nodes do not The algorithm maintains a list of messages previously received in a b...

Страница 79: ...hin range to complete their retransmissions The time for this delay is computed by the formula Maximum Delay ms L DS DS 41 100 10 RN RN 1 Where L is the length of the transmitted packet in millisecond...

Страница 80: ...ence between the two modes is in their means of achieving reliable delivery of data Polling mode basic uses multiple transmissions to achieve reliable delivery Characteristics Uses a high percentage o...

Страница 81: ...e 83 5 Optional Use PD to configure a delay between polls to slow down the system if needed 6 Optional Enable API Mode to address remote devices within polling range on a packet by packet basis Config...

Страница 82: ...ve but they only pass the first copy of a packet they receive out the UART The device does not apply the RB and RO parameters to subsequent packets meaning that once transmission begins it continues u...

Страница 83: ...evice by polling a sequential range of addresses Base device is configured to specify the range of addresses being polled Uses inter character delay to create RF packet lengths aligned with protocol p...

Страница 84: ...with the instruction manual may cause harmful interference to radio communications However there is no guarantee that interference will not occur in a particular installation If this equipment does c...

Страница 85: ...uillage est susceptible d en compromettre le fonctionnement RF Exposure CAUTION This equipment is approved for mobile and base station transmitting devices only Antenna s used for this transmitter mus...

Страница 86: ...PSMA 2 1 dBi Fixed A09 HG Glass mounted half wave RPSMA 2 1 dBi Fixed A09 HATM Articulated half wave RPTNC 2 1 dBi Fixed A09 H Half wave dipole RPSMA 2 1 dBi Fixed Part Number Type Connector Gain Requ...

Страница 87: ...dB Fixed A09 F0TM Fiberglass Base Station RPTNC 0 dBi Fixed A09 F1TM Fiberglass Base Station RPTNC 1 0 dBi Fixed A09 F2TM Fiberglass Base Station RPTNC 2 1 dBi Fixed A09 F3TM Fiberglass Base Station R...

Страница 88: ...P12F omni directional magnetic mount w 12ft pigtail RPN 3 0 dBi Fixed A09 D3SM P12F omni directional w 12ft pigtail RPSMA 3 0 dBi Fixed A09 D3PNF omni directional permanent mount RPN 3 0 dBi Fixed A0...

Страница 89: ...1 9 dBi Fixed Mobile A09 QAPM 3H 3 Articulated screw mount Permanent 1 9 dBi Fixed Mobile Part Number Type Connector Gain Application Part Number Type Connector Gain Application A09 Y6 2 Element Yagi...

Страница 90: ...ixed Mobile A09 Y12TM 7 Element Yagi RPTNC 12 1 dBi Fixed Mobile A09 Y13TM 9 Element Yagi RPTNC 13 1 dBi Fixed Mobile A09 Y14TM 10 Element Yagi RPTNC 14 1 dBi Fixed Mobile A09 Y14TM 12 Element Yagi RP...

Страница 91: ...e A09 HASM 675 Articulated half wave RPSMA 2 1 dBi Fixed Mobile A09 HABMM P5I Swivel half wave with 5 pigtail MMCX 2 1 dBi Fixed Mobile A09 HBMM P5I Straight half wave with 6 pigtail MMCX 2 1 dBi Fixe...

Страница 92: ...i 14 0 dBi RPTNC 9 9 dB Fixed Mobile Part Number Type Gain Connector Required Antenna Cable Loss Application Part Number Type Gain Connector Required Antenna Cable Loss Application A09 F0NF Fiberglass...

Страница 93: ...ation 4 1 dBi RPTNC Fixed A09 F5TM Fiberglass Base Station 5 1 dBi RPTNC Fixed A09 F6TM Fiberglass Base Station 6 1 dBi RPTNC 0 9 dB Fixed A09 F7TM Fiberglass Base Station 7 1 dBi RPTNC 1 9 dB Fixed A...

Страница 94: ...Mobile A09 QSM 3 Quarter wave straight 1 9 dBi RPSMA Fixed Mobile A09 QSM 3H Heavy duty quarter wave straight 1 9 dBi RPSMA Fixed Mobile A09 QBMM P6I Quarter wave w 6 pigtail 1 9 dBi MMCX Fixed Mobil...

Страница 95: ...Antenna 1 900 MHz RPSMA 6 Half Wave dipole articulating A09 HASM 675 Serial Loopback Adapter 1 Connects to the female RS 232 DB 9 serial connector of the Digi Interface Board and can be used to config...

Страница 96: ...sed to connect two DCE devices A DCE device connects with a straight through cable to the male serial port of a computer DTE The following figure shows the Male NULL modem adapter and pinouts The foll...

Страница 97: ...re and RS 422 Operation sections for RS 485 422 connection guidelines The following figure shows a Male DB 9 to RJ 45 Adapter and pinouts Female DB 9 to RJ 45 adapter Part Number JE1D3 CDA A Green Thi...

Страница 98: ...RS 232 Accessories Kit contents 9XTend PKG R RS 232 485 RF Modem User Guide 98...

Отзывы:

Нет отзывов