View JD2D3-CDS-6F_2172660.PDF datasheet online --- IC-ON-LINE

Datasheet File OCR Text:

maxstream 355 south 520 west, suite 180 lindon, ut 84042 phone: (801) 765-9885 fax: (801) 765-9895 rf-xperts@maxstream.net www.maxstream.net (l ive chat support) 9xtend-pkg-r? rs-232/485 rf modem 9xtend rs-232/485 rf modem interfacing protocol rf modem operation rf modem configuration rf communication modes appendices product manual v2.x4x for rf modem part numbers: xt09-pk...-r... 1 watt transmit power, 256-bit aes encryption m100171 2007.01.04
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc., ? confidential ? & ? proprietary ?\? all ? rights ? reserved ? ????? ii ? 2007 maxstream, inc. all rights reserved the ? contents ? of ? this ? manual ? may ? not ? be ? transmitted ? or ? reproduced ? in ? any ? form ? or ? by ? any ? means ? without ? the ? written ? permission ? of ? maxstream, ? inc. xtend? ? is ? a ? trademark ? of ? maxstream, ? inc. aes ? encryption ? source ? code ? ? 2007, ? dr. ? brian ? gladman, ? worcester, ? uk. ? all ? rights ? reserved. conditions: ?\? distributions ? of ? aes ? source ? code ? include ? the ? above ? copyright ? notice, ? this ? list ? of ? conditions ? and ? disclaimer. \? distributions ? in ? binary ? form ? include ? the ? above ? copyright ? notice, ? this ? list ? of ? con \ ditions ? and ? disclaimer ? in ? the ? documentation ? and/or ? other ? associated ? materials. \? the ? copyright ? holder ? s ? name ? is ? not ? used ? to ? endorse ? products ? built ? using ? this ? software ? without ? specific ? written ? permission. alternatively, ? provided ? that ? this ? notice ? is ? retained ? in ? full, ? this ? product ? may ? be ? dis \ tributed ? under ? the ? terms ? of ? the ? gnu ? general ? public ? license ? (gpl), ? in ? which ? case ? the ? provisions ? of ? the ? gpl ? apply ? instead ? of ? those ? given ? above. disclaimer ?\? this ? aes ? software ? is ? provided ?? as ? is ?? with ? no ? explicit ? or ? implied ? war \ ranties ? in ? respect ? of ? its ? properties, ? including, ? but ? not ? limited ? to, ? correctness ? and/or ? fitness ? for ? purpose. technical ? support: ? phone: ? (801) ? 765 \ 9885 e \ mail: ? rf \ xperts@maxstream.net live ? chat: ? www.maxstream.net
contents 9xtend? ? rs \ 232/485 ? rf ? modem ? ? ? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc., ? confidential ? & ? proprietary ?\? all ? rights ? reserved ? ????? iii 1. 9xtend rs-232/485 rf modem 4 1.1. key features 4 1.1.1. worldwide acceptance 4 1.2. specifications 5 1.3. external interface 6 2. interfacing protocol 7 2.1. rs-232 operation 7 2.1.1. dip switch settings and pin signals 7 2.1.2. wiring diagrams 8 2.2. rs-485 (2-wire) operation 9 2.2.1. dip switch settings and pin signals 9 2.2.2. wiring diagram 9 2.3. rs-485 (4-wire) & rs-422 operation 10 2.3.1. dip switch settings and pin signals 10 2.3.2. wiring diagrams 10 3. rf modem operation 12 3.1. serial communications 12 3.1.1. rs-232 and rs-485/422 data flow 12 3.1.2. host and rf modem settings 12 3.1.3. flow control 13 3.1.4. transparent operation 14 3.1.5. api operation 14 3.2. modes of operation 15 3.2.1. idle mode 15 3.2.2. transmit mode 15 3.2.3. receive mode 17 3.2.4. sleep mode 18 3.2.5. command mode 20 4. rf modem configuration 22 4.1. automatic dip switch configurations 22 4.2. programming examples 23 4.2.1. at commands 23 4.2.2. binary commands 24 4.3. command reference table 25 4.4. command descriptions 27 4.5. api operation 45 4.5.1. api frame specifications 45 4.5.2. api types 46 5. rf communication modes 48 5.1. addressing 49 5.1.1. address recognition 49 5.2. basic communications 50 5.2.1. streaming mode (default) 50 5.2.2. multi-transmit mode 51 5.2.3. repeater mode 52 5.2.4. polling mode (basic) 55 5.3. acknowledged communications 56 5.3.1. acknowledged mode 56 5.3.2. polling mode (acknowledged) 58 appendix a: agency certifications 59 fcc (united states) certification 59 labeling requirements 59 fcc notices 59 limited modular approval 60 fcc-approved antennas 60 ic (industry canada) certification 63 labeling requirements 63 c-tick (australia) certification 63 power requirements 63 appendix b: development guide 64 rs-232 accessories kit contents 64 adapters 65 appendix c: additional information 67 1-year warranty 67 ordering information 67 contact maxstream 68
? 1 2007 1 maxstream, 1 inc. 11111 4 1. 1 9xtend 1 rs , 232/485 1 rf 1 modem the 9xtend rf modem affords oems and integrators an easy-to-use rf solution that sustains re liable delivery of data between remote devices. out-of-box, the modem is configured to immediately sustain long range wireless links between devices. simply feed serial data into one modem, then the data will surface on the other end of the wireless link. the modem transfers a standard asynchronous serial data stream between devices. 1.1. key features long range data integrity 1 watt power output (variable 1mw - 1w) range (@9,600 bps throughput data rate): ? indoor/urban: up to 3000? (900 m) ? outdoor rf line-of-sight: up to 14 miles (22 km) w/dipole antenna ? outdoor rf line-of-sight: up to 40 miles (64 km) w/high-gain antenna range (@115,200 bps throughput data rate): ? indoor/urban: up to 1500? (450 m) ? outdoor rf line-of-sight: up to 7 miles (11 km) w/dipole antenna ? outdoor rf line-of-sight: up to 20 miles (32 km) w/high-gain antenna continuous rf data stream up to 115,200 bps receiver sensitivity: -110 dbm (@ 9600 baud), ? 100 dbm (@ 115200 baud) advanced networking & security true peer-to-peer (no master device required), point-to-point, point-to-multipoint & multidrop retries and acknowledgements fhss (frequency hopping spread spectrum) 10 hopping channels, each with over 65,000 unique network addr esses available 256-bit aes encryption (aes algorithm is fips-197 certified) low power 7 - 28 v supply voltage pin, serial port and cyclic software sleep modes supported easy-to-use no configuration necessary for out-of box rf communications external dip switch configuration free x-ctu software (testing and configuration software) rf modems easily configured using standard at & binary commands transparent operation (wireless links replace serial wires) portable (small form-factor easily fits into a wide range of data systems) software-selectable i/ o interfacing rates modbus, cts , rts , dcd , dtr (& more) i/o support multiple data formats supported (parity, start and stop bits, etc.) xii? interference immunity free & unlimited technical support 1.1.1. worldwide acceptance fcc approved (usa) refer to appendix a [p59] for fcc requirements. systems that include xtend rf modems inherit maxstream?s certifications. ism (industrial, scientific & medical) license-free 902-928 mhz frequency band manufactured under iso 9001:2000 registered standards esd (electrostatic discharge) immunity - esd-hardened and iec1000-4-2 (level 4) tested 9xtend rf modems are optimized for use in the us , canada , australia and israel
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 5 chapter ? 1 ?\? 9xtend ? rs \ 232/485 ? rf ? modem 1.2. specifications out-of-box, the 9xtend rf modem is configured to provide immediate long range wireless links between devices. the modem can be configured to support additional functionality through the use of standard at and binary commands [refer to the command mode [p20] & modem configu- ration [p22] sections for more information.]. tabl e ? 1 \ 01. 9xtend \ pkg \ r ? rs \ 232/485 ? rf ? modem ? specifications 9xtend 900 mhz rs-232/485 rf modem specifications performance @9600 bps throughput data rate @115200 bps throughput data rate transmit power output (software selectable using pl command) 1mw - 1 watt 1mw - 1 watt indoor/urban range up to 3000? (900 m) up to 1500? (450 m) outdoor rf line-of-sight range up to 14 miles (22 km) w/ dipole antenna up to 40 miles (64 km) w/ high-gain antenna up to 7 miles (11 km) w/ dipole antenna up to 20 miles (32 km) w/ high-gain antenna interface data rate (software selectable using bd command) 1200 ? 230400 bps 1200 ? 230400 bps throughput data rate (software selectable using br command) 9,600 bps 115,200 bps rf data rate 10,000 bps 125,000 bps receiver sensitivity -110 dbm -100 dbm power requirements supply voltage 7 - 28v 7 - 28v receive current 110 ma 110 ma pin sleep power-down 17 ma 17 ma serial port sleep power down 45 ma 45 ma idle currents 16 sec cyclic sleep (sm=8) 20 ma 19 ma 8 sec cyclic sleep (sm=7) 21 ma 19 ma 4 sec cyclic sleep (sm=6) 24 ma 20 ma 2 sec cyclic sleep (sm=5) 30 ma 22 ma 1 sec cyclic sleep (sm=4) 39 ma 25 ma networking & security frequency 902-928 mhz spread spectrum fhss (frequency hopping spread spectrum) modulation fsk (frequency shift keying) network topologies supported peer-t o-peer (?master/slave? relations hip not required), point-to-poi nt, point-to-multipoint & mult idrop channel capacity 10 hop sequences share 50 frequencies encryption 256-bit aes encryption ? refer to the ky command [p34] to implement physical properties rf modem board size 2.750? x 5.500? x 1.125? (6.99cm x 13.97? x 2.86cm) weight 7.1 oz. (200g) serial connector db-9 operating temperature -40 to 85o c (industrial) antenna connector rpsma (reverse-polarity sma) impedance 50 ohms unbalanced certifications (partial list) fcc part 15.247 our-9xtend industry canada (ic) 4214a-9xtend tabl e ? 1 \ 02. 9xtend \ pkg \ r ? rs \ 232/485 ? rf ? modem ? specifications ?\? relative ? to ? user \ selected ? tx ? power ? output power requirements (tx currents relative to each tx power output option) transmit power output 1 mw 10 mw 100 mw 500 mw 1 w typical transmit current @9.6 kbps (9 vdc supply voltage) 110 ma 145 ma 250 ma 510 ma 900 ma typical transmit current @115.2 kbps) (9 vdc supply voltage) 110 ma 140 ma 245 ma 500 ma 800 ma
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 6 chapter ? 1 ?\? 9xtend ? rs \ 232/485 ? rf ? modem 1.3. external interface figure ? 1 \ 03. dip ? switch ? settings ? of ? the ? xtib \ r ? (rs \ 232/485) ? interface ? board 1-01a. config (configuration) switch figure ? 1 \ 01. front ? view the config switch provides an al ternate method for entering into command mode. to enter command mode at the default rf data rate of the modem, hold the config switch down for two seconds. 1-01b. i/o & power leds leds indicate modem activity as follows: yellow (top led) = serial data out (to host) green (middle) = serial data in (from host) red (bottom) = power/tx indicator (red light is on when powered; it pulses on/off briefly during rf transmission.) 1-01c. db-9 serial port standard female db-9 (rs-232) connector. this connector can be also used for rs-485 and rs-422 connections. 1-01d. rssi leds rssi leds indicate the amount of fade margin present in an active wireless link. fade margin is de fined as the difference between the incoming signal strength 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 margin) 1-01e. power connector 7-28 vdc* power connector (center positive, 5.5/2.1mm) 1-02a. dip switch figure ? 1 \ 02. back ? view during each power-on sequence (res et or boot), the modem is auto- matically configured according to th e positions of the dip switch. the dip switch provides integrators with a limited number of external programming options. [refer to figu re 1-03 for configuration options] 1-02b. antenna port the antenna port is a 50 rf signal connector for connecting to an external antenna. the connector type is rpsma (reverse polarity sma) female. the connector has th reads on the outside of a barrel and a male center conductor. 1 \ 01a. config ? switch 1 \ 01b. i/o ? & ? power ? leds 1 \ 01c. db \ 9 ? serial ? port 1 \ 01d rssi ? leds 1 \ 01e. power ? connector ? * ? note: ? the ? xtend ? rf ? modem ? can ? accept ? voltages ? as ? low ? as ? 5v. ? contact ? maxstream ? technical ? support ? (801) ? 765 \ 9885 ? to ? implement ? this ? option. 1 \ 02a. dip ? switch 1 \ 02b. antenna ? conector refer ? to ? the ? tables ? in ? the ? ?a u t o m a t i c ? dip ? switch ? configurations? ? section ? [p22] ? regarding ? configurations ? trig \ gered ? by ? the ? positions ? of ? the ? dip ? switch ? (during ? power \ up).
? ? 2007 ? maxstream, ? inc. ????? 7 2. ? interfacing ? protocol the 9xtend rs-232/485 rf modem supports the following interfacing protocols: ? rs-232 ? rs-485 (2-wire) half-duplex ? rs-485 (4-wire) and rs-422 2.1. rs-232 operation 2.1.1. dip switch settings and pin signals * ? the ? ?pin ? reference ? name? ? provides ? an ? associative ? tag ? that ? references ? commands ? used ? to ? define ? pin ? behaviors. ? gpi ? stands ? for ?? general ? purpose ? input ?? and ? gpo ? stands ? for ?? general ? purpose ? output ? . ? as ? an ? example, ? the ? cd ? command ? is ? used ? to ? define ? the ? behavior ? of ? gpo2 ? (db \ 9 ? pin ? number ? 1). ? the ? ?pin ? reference ? name? ? is ? the ? name ? used ? when ? referring ? to ? xtend ? commands ? and ? parameters. tab le ? 2 \ 01. rs \ 232 ? signals ? and ? their ? implementations ? on ? the ? xtend ? rf ? modem ? (low \ asserted ? signals ? are ? distinguished ? by ? horizontal ? line ? over ? pin ? name.) db-9 pin rs-232 name pin reference name* description implementation 1 dcd gpo2 data-carrier-detect connected to dsr (pin6) 2 rxd do received data serial data exiting the rf modem (to host) 3 txd di transmitted data serial data entering into the 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 / command mode provides rts flow control or enables command mode 8 cts gpo1 clear-to-send provides cts flow control 9 ri - ring indicator optional power input that is connected internally to the positive lead of the front power connector figure ? 2 \ 01. rs \ 232 ? dip ? switch ? settings dip ? switch ? settings ? are ? read ? and ? applied ? only ? while ? powering \ on. figure ? 2 \ 02. pins ? used ? on ? the ? female ? rs \ 232 ? (db \ 9) ? serial ? connector
9xtend? 1 rs , 232/485 1 rf 1 modem 1,1 product 1 manual 1 v2.x4x 1 [2007.01.04] ? 1 2007 1 maxstream, 1 inc. 11111 8 chapter 1 2 1,1 interfacing 1 protocol 2.1.2. wiring diagrams figure 1 2 , 03. rs , 232 1 dte 1 device 1 (male 1 db , 9 1 connector) 1 wired 1 to 1 a 1 dce 1 rf 1 modem 1 (female 1 db , 9) 11 figure 1 2 , 04. dce 1 rf 1 modem 1 (female 1 db , 9 1 connector) 1 wired 1 to 1 an 1 rs , 232 1 dce 1 device 1 (male 1 db , 9) 11 sample wireless connection: dte <--> dce dce <--> dce figure 1 2 , 05. typical 1 wireless 1 link 1 between 1 dte 1 and 1 dce 1 devices
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 9 chapter ? 2 ?\? interfacing ? protocol 2.2. rs-485 (2-wire) operation 2.2.1. dip switch settings and pin signals note: refer to figure 2-15 and fi gure 2-16 for the rj-45 connect or pin designat ions used in rs-485/422 environments. 2.2.2. wiring diagram figure ? 2 \ 09. xtend ? rf ? modem ? in ? an ? rs \ 485 ? (2 \ wire) ? half \ duplex ? environment tab le ? 2 \ 02. rs \ 485 ? (2 \ wire ? half \ duplex) ? signals ? and ? their ? implementations ? on ? the ? xtend ? rf ? modem db-9 pin rs-485 name description implementation 2 t/r- (tra) negative data line transmit serial data to and from the rf modem 5 gnd ground signal ground 8 t/r+ (trb) positive data line transmit serial data to and from the rf modem 9pwr power optional power input that is connected internally to the front power connector 1, 3, 4, 6, 7 not used figure ? 2 \ 06. rs \ 485 ? (2 \ wire) ? half \ duplex dip ? switch ? settings figure ? 2 \ 07. pins ? used ? on ? the ? female ? rs \ 232 ? (db \ 9) ? serial ? connector figure ? 2 \ 08. rs \ 485 ? (2 \ wire) ? w/ ? termination ? (optional) termination ? is ? the ? 120 ? ? resistor ? between ? t+ ? and ? t \ . dip ? switch ? settings ? are ? read ? and ? applied ? only ? while ? powering \ on.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 10 chapter ? 2 ?\? interfacing ? protocol 2.3. rs-485 (4-wire) & rs-422 operation 2.3.1. dip switch settings and pin signals 2.3.2. wiring diagrams figure ? 2 \ 13. xtend ? rf ? modem ? in ? an ? rs \ 485 ? (4 \ wire) ? environment tab le ? 2 \ 03. rs \ 485/422 ? (4 \ wire) ? signals ? and ? their ? implementations ? on ? the ? xtend ? rf ? modem db-9 pin rs-485/422 name description implementation 2t- (ta) transmit negative data line serial data sent from the rf modem 3r- (ra) receive negative data line serial data received by the rf modem 5 gnd signal ground ground 7 r+ (rb) receive positive data line serial data received by the rf modem 8t+ (tb) transmit positive data line serial data sent from the rf modem 9pwr power optional power input that is connected internally to the front power connector 1, 4, 6 not used figure ? 2 \ 10. rs \ 485 ? (2 \ wire) ? half \ duplex dip ? switch ? settings figure ? 2 \ 11. pins ? used ? on ? the ? female ? rs \ 232 ? (db \ 9) ? serial ? connector figure ? 2 \ 12. rs \ 485 ? (2 \ wire) ? w/ ? termination ? (optional) termination ? is ? the ? 120 ? ? resistor ? between ? t+ ? and ? t \ . dip ? switch ? settings ? are ? read ? and ? applied ? only ? while ? powering \ on.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 11 chapter ? 2 ?\? interfacing ? protocol figure ? 2 \ 14. xtend ? rf ? modem ? in ? an ? rs \ 422 ? environment rs-485/422 connection guidelines the rs-485/422 protocol provides a solution for wired communications that can tolerate high noise and push signals over long cable lengths. rs-485/422 signals can communicate as far as 4000 feet (1200 m). rs-232 signals are suitable for cable distances up to 100 feet (30.5 m). rs-485 offers multi-drop capability in which up to 32 nodes can be connected. the rs-422 proto- col is used for point-to-point communications. suggestions for integrating the xtend rf modem with the rs-485/422 protocol: figure ? 2 \ 15. male ? db \ 9 ? to ? rj \ 45 ? adapter ? (yellow) figure ? 2 \ 16. female ? db \ 9 ? to ? rj \ 45 ? adapter ? (green) an xtend rs-232/485 rf modem ?acce ssories kit? is available that in cludes connectors that facilitate rs-485/422 and other serial communications. refer to the development guide in appendix b [p64] for information regarding the connectors and tools included in the kit. 1. when using ethernet twisted pa ir cabling: select wires so that t+ and t- are connected to each wire in a twisted pair. likewise, select wires so that r+ and r- are connected to a twisted pair. (for example, tie the green and white/green wires to t+ and t-.) 2. for straight-through ethernet cable (not cros s-over cable) - the following wiring pattern works well: pin3 to t+, pin4 to r+, pin5 to r-, pin6 to t- 3. note that the connecting cable only requir es 4 wires (even though there are 8 wires). 4. when using phone cabling (rj-11) - pin2 in the cable maps to pin3 on opposite end of cable and pin1 maps to pin4 respectively.
? ? 2007 ? maxstream, ? inc. ????? 12 3. ? rf ? modem ? operation warning: when operating at 1 watt po wer output, observe a minimum separati on distance of 2' (0.6m) between modems. transmitting in close proximity of other modems can damage modem front ends. 3.1. serial communications 3.1.1. rs-232 and rs-485/422 data flow the xtend rs-232/485 rf modem interfaces to a host device through a standard db-9 connector. devices that have a standard db-9 (rs-232) serial port can connect direct ly through the pins of the modem as shown in the figure below. figure ? 3 \ 01. system ? data ? flow ? in ? an ? rs \ 232 ? environment 3.1.2. host and rf modem settings serial communications between a host and an xtend rf modem are dependent upon having matching baud rate, parity, stop bit & number of data bits settings. fa ilure to enter the modem into at command mode is most commonly due to baud rate mismatch. refer to the table below to ensure host serial port settings match those of the modem. both the rf modem and host (pc) settings can be viewed and adjusted using maxstream's propri- etary x-ctu software. after connecting an rf mode m to a pc via their respective serial connec- tions, use the "terminal" or "modem configuratio n" tabs to configure rf modem settings. use the "pc settings" tab to co nfigure host settings. tab le ? 3 \ 01. parameter ? va l u e s ? critical ? to ? serial ? communications ? between ? rf ? modem ? and ? host parameter setting xtend rf modem default parameter value baud (serial data rate) 9600 bps (br parameter = 3) number of data bits 8 (nb parameter = 0) parity none (nb parameter = 0) number of stop bits 1 (nb parameter = 0)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 13 chapter ? 3 ?\? rf ? modem ? operation 3.1.3. flow control figure ? 3 \ 02. internal ? data ? flow ? diagram ? (the ? five ? most ? commonly \ used ? pin ? signals ? shown) di (data in) buffer and flow control when serial data enters the mode m through the di pin (data in), the data is stored in the di buffer until it can be processed. when the rb and ro parameter thresholds are sati sfied (refer to ?transmit mode? section for more information), the modem attempts to initialize an rf connection. if the modem is already receiv- ing rf data, the serial data is stored in the mo dem's di buffer. the di bu ffer stores at least 2.1 kb. if the di buffer becomes full, hardware or soft ware flow control must be implemented in order to prevent overflow (loss of data between the host and rf modem). how to eliminate the need for flow control: two cases in which the di buffer may become full and possibly overflow: hardware flow control (cts ) . when the di buffer is 17 bytes aw ay from being full; by default, the modem de-asserts cts (high) to signal to the host device to stop sending data [refer to ft (flow control threshold) and cs (g po1 configuration) commands]. cts is re-asserted after the di buffer has 34 bytes of memory available. software flow control (xon) . xon/xoff software flow contro l can be enabled using the fl (software flow control) command. this option only works with ascii data. do (data out) buffer when rf data is received, the data enters the do buffer and is sent out the serial port to a host device. once the do buffer reaches capacity, any additional incomi ng rf data is lost. the do buffer stores at least 2.1 kb. two cases in which the do buffer may become full and possibly overflow: hardware flow control (rts ) . if rts is enabled for flow control (rt parameter = 2), data will not be sent out the do buffer as long as rts (gpi1) is de-asserted. software flow control (xoff) . xon/xoff software flow contro l can be enabled using the fl (software flow control) command. this option only works with ascii data. 1. send messages that are smal ler than the di buffer size. th e size of the di buffer varies according to the packet size (pk parameter) and the parity setting (nb parameter) used. 2. interface at a lower baud rate (bd parame ter) than the rf data rate (br parameter). 1. if the serial interface data rate is set hi gher than the rf data rate of the modem, the modem will receive data from the host faster than it can transmit the data over-the-air. 2. if the modem is receiving a continuous stream of rf data or if the modem is monitoring data on a network, any serial data that arrive s on the di pin (data in ) is placed in the di buffer. the data in the di buffer will be tran smitted over-the-air when the modem no longer detects rf data in the network. 1. if the rf data rate is set higher than the interface data rate of the modem, the modem will receive data from the transmitting modem faster than it can send the data to the host. 2. if the host does not allow the modem to tran smit data out from th e do buffer because of being held off by hardware or software flow control.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 14 chapter ? 3 ?\? rf ? modem ? operation 3.1.4. transparent operation by default, xtend rf mo dems operate in transparent mode. the modems act as a serial line replacement - all uart data receiv ed through the di pin is queued up for rf transmission. when rf data is received, the data is sent out the do pin. when the ro (packetization timeout) parameter threshold is satisfied, the modem attempts to ini- tialize an rf transmission. if th e modem cannot immediately transmit (for instance, if it is already receiving rf data), the serial data continues to be stored in the di buffer. data is packetized and sent at any ro timeout or when th e maximum packet size is received. the modem operates as describe d above unless the command mode sequence is detected. the command mode sequence consists of three copies of th e command sequence character [cc parameter] surrounded by th e before and after guard times [bt & at parameters]. if the di buffer becomes full, hard ware or software flow control mu st be implemented in order to prevent overflow (loss of data between the host and modem). 3.1.5. api operation api (application programming interface) operation is an alternative to the default transparent operation. the api is frame-based and extends the level to which a host application can interact with the networking capabilities of the module. when in api mode, all data entering and leaving the rf modem is contained in frames that de fine operations or ev ents within the modem. transmit data frames (received through the di (data in) pin) include: ? 16-bit address receive data frames (sent out the do (data out) pin) include: ? showing a received rf packet (16 bits only) ? response to a tx (transmit) packet ? showing events such as ha rdware reset, watchdog rese t, asynchronous events, etc. the modem will send data frames to the application cont aining status packets; as well as source, rssi and payload information from received data packets. api operation option facilitates many oper ations such as the examples cited below: to implement api operations, refer to ?api operation? sections [p45]. -> change destination a ddresses without having to enter command mode -> receive success/failure status of each rf packet -> identify the source address of each received packet
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 15 chapter ? 3 ?\? rf ? modem ? operation 3.2. modes of operation xtend rf modems oper ate in five modes. figure ? 3 \ 03. modes ? of ? operation 3.2.1. idle mode when not receiving or transmitting data, the rf mo dem is in idle mode. the modem shifts into the other modes of operation under the following conditions: ? transmit mode (serial data is received in the di buffer) ? receive mode (valid rf data is received through the antenna) ? sleep mode (sleep mode condition is met) ? command mode (command mo de sequence is issued) 3.2.2. transmit mode when the first byte of serial da ta is received from the uart in the di buffer, the modem attempts to shift to transmit mode and initiate an rf connection with other modems. after transmission is complete, the modem returns to idle mode. rf transmission begins after either of the following criteria is met: figure ? 3 \ 04. transmit ? mode ? data ? flow the character timeout trigger can be disabled by se tting ro to zero. in this case, transmission will not begin until rb bytes have been received and are pending for rf transmission. the rb parameter may be set to any value between 1 and the rf packet size [refer to pk (max rf packet size) parameter], inclusive. note that transition to trans- mit mode cannot take place during rf reception; the rf reception must com- plete before the radio can transition into tran sm it mode . if rb or ro conditions are met, the modem initializes a communications channel. serial data in the di buffer is grouped into rf pack- ets (up to 2048 bytes in each packet, refer to pk command), converted to rf data and is transmit- ted over-the-air until the di buffer is empty. 1. rb bytes have been received by the ua rt and are pending for rf transmission. [refer to the rb (packetization threshold) command] 2. at least one character has been received by the uart an d is pending for rf transmission; and ro character time s of silence been observed on the uart. [refer to the ro (packetization timeout) command]
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 16 chapter ? 3 ?\? rf ? modem ? operation channel initialization is the process of sending an rf initializer that synchronizes receiving modems with the transmitting modem. during cha nnel initialization, incoming serial data accumu- lates in the di buffer. rf data, which includes the payload data, follows th e rf initializer. the payload includes up to the maximum packet size (pk command) bytes. as th e tx modem nears the end of the transmission, it inspects the di buffer to see if more data exists to be transmitted. this co uld be the case if more than pk bytes were originally pending in the di bu ffer or if more bytes arrived from the uart after the transmission began. if more data is pending, the transmitti ng modem assembles a subsequent packet for transmission. refer to the ?rf communication modes? section to view state diagrams that illustrate channel ini- tialization and the sequence of events that follow. rf packet figure ? 3 \ 05. rf ? packet ? components * when streaming multiple rf packets, the rf initia lizer is only sent in front of the first packet. rf initializer an rf initializer is sent each time a new connec tion sequence begins. the rf initializer contains channel information that notifies receiving modems of informatio n such as the hopping pattern used by the transmitting modem. the first tr ansmission always sends an rf initializer. an rf initializer can be of various lengths depe nding on the amount of time determined to be required to prepare a receiving modem. for example, a wake-up initializer is a type of rf initializer used to wake remote modems fro m sleep mode (refer to the fh, lh, ht and sm commands for more information). the length of the wake-up initia lizer should be longer than the length of time remote modems are in cyclic sleep. header the header contains network addressing informatio n that filters incoming rf data. the receiving modem checks for matching a hopping channel, vi d and destination address. data that does not pass through all three network filter layers is discarded. refer to the ?addressing? section of the ?rf comm unication modes? chapte r for more information. crc (cyclic redundancy check) to verify data integrity and provide built-in error checking, a 16-bit crc (cyclic redundancy check) is computed for the transmitted data and attached to the end of each rf packet. on the receiving end, the receiv ing modem computes the crc on all inco ming rf data. received data that has an invalid crc is discarded [ref er to the ?receive mode? section].
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 17 chapter ? 3 ?\? rf ? modem ? operation 3.2.3. receive mode if a modem detects rf da ta while operating in idle mode, th e modem transitions to receive mode to start receiving rf packets. once a packet is received, the modem checks the crc (cyclic redun- dancy check) to ensure that the data was transmitted without error. if the crc data bits on the incoming packet are invalid, the pa cket is discarded. if the crc is valid, the packet proceeds to the do buffer. figure ? 3 \ 06. receive ? mode ? data ? flow * ? refer ? to ? the ? ?a d d r e s s ? recognition? ? sec \ tion ? for ? more ? information ? regarding ? address ? recognition. the modem returns to idle mode when valid rf data is no longer detected or afte r an error is detected in the received rf data. if serial data is stored in the di buffer while the modem is in receive mode, the serial data will be transmitted af ter the modem is finished receiving data and returns to idle mode.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 18 chapter ? 3 ?\? rf ? modem ? operation 3.2.4. sleep mode software sleep sleep modes enable the modem to enter states of low-power consumption when not in use. three software sleep modes are supported: ? pin sleep (host controlled) ? serial port sleep (wake on serial port activity) ? cyclic sleep (wake on rf activity) in order to enter sleep mode, one of the followin g conditions must be me t (in addition to the modem having a non-zero sm parameter value): when in sleep mode, the modem will not transmit or receive data until the modem first transitions to idle mode. all sleep modes ar e enabled and disabled using sm command. transitions into and out of sleep modes are triggered by variou s mechanisms as shown in the table below. the sm (sleep mode) command is central to sett ing all sleep mode config urations. by default, sleep modes are disabled (sm = 0) and the modem remains in idle/receive mode. when in this state, the modem remains constantly ready to respond to serial or rf activity. pin sleep (sm = 1) ? pin/host-controlled ? typical power-down current: < 17 ma this mode is voltage level activated. when the gpi2 pin is asserted, the modem will finish any transmitting or receiving activity; enter idle mode ; then enter a state of sleep. when in pin sleep mode, the modem will not respond to serial or rf activity. after enabling pin sleep, the gp i2 pin controls whether the mode m is active or sleeping. when gpi2 is de-asserted, the modem is fully operational. when gpi2 is asserted, the modem transi- tions to sleep mode and remains in its lowest po wer-consuming state until the pin is de-asserted. this pin is only active if the mo dem is setup to operate in this mode; otherwise the pin is ignored. once in pin sleep, cts (gpo1) is de-asserted (high), indicating that data should not be sent to the modem. the pwr pin is also de-asserted (low) when the mo dem is in pin sleep mode. note: the modem will complete a transmission or reception before activating pin sleep. 1. the modem is idle (no data transmission or reception) for the amount of time defined by the st (time before sleep) parameter. [note: st is only active when sm = 4-5.] 2. gpi2 (sleep) is asserted (onl y for the ?pin sleep? option). tab le ? 3 \ 02. summary ? of ? sleep ? mode ? configurations sleep mode (setting) transition into sleep mode transition out of sleep mode (wake) related commands power consumption pin sleep (sm = 1) assert gpi2 pin - a micro controller can shut down and wake modems via the gpi2 pin. note: the modem will complete a transmission or reception before activating pin sleep. de-assert gpi2 pin (sm) < 17 ma serial port sleep (sm = 2) automatic transition to sleep mode occurs after a user-defined period of inactivity (no transmitting or receiving of data). period of inactivity is defined by the st (time before sleep) command. when a serial byte is received on the di pin (sm), st < 45 ma cyclic sleep (sm = 4 - 8) rf modem transitions in and out of sleep mode in cycles (user-selectable wake-up interval of time is set us ing the sm command). the cyclic sleep interval of time must be shorter than the interval of time that is defined by the lh (wake-up initializer timer) command. note: the modem can be forced into idle mode using the gpi2 pin if the pw (pin wake-up) command is issued. (sm), st, ht, lh, pw < 25 ma when sleeping (sm=4, 1 sec., @120k baud)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 19 chapter ? 3 ?\? rf ? modem ? operation serial port sleep (sm = 2) ? wake on serial port activity ? typical power-down current: < 45 ma serial port sleep is a sleep mode in which the modem runs in a low power state until serial data is detected on the di pin. the period of time the modem slee ps is determined by st (time before sleep) co mmand. once a character is received through the di pin, the modem retu rns to idle mode and is fully operational. cyclic sleep (sm = 4-8) ? typical power-down current: < 25 ma (when asleep) cyclic sleep modes allow modems to periodically wake and check for rf data. the modem wakes according to the times de signated by the cyclic sleep settin gs. if the modem detects a wake-up initializer during the time it is awake, the mo dem synchronizes with the transmitting modem and receives data after the wake-up initializer runs its duration. ot herwise, the mo dem returns to sleep mode and continues to cycle in and out of activity until a wake-up initializer is detected. while the modem is in cyclic sleep mode, cts (gpo1) is de-asserted (high) to indicate that data should not be sent to the modem. when the mode m awakens to listen for data, gpo1 is asserted and any data received on the di pin is transmit ted. the pwr pin is also de-asserted (low) when the modem is in cyclic sleep mode. the modem remains in sleep mode for a user-defined period of time ranging from 0.5 seconds to 16 seconds (sm parameters 4 through 8). after this interval of time, the modem returns to idle mode and listens for a va lid data packet for 100 ms. if the mo dem does not detect valid data (on any frequency), the modem returns to sleep mode. if valid data is detected, the modem transi- tions into receive mode and receives the incoming rf packets. the modem then returns to sleep mode after a period of inactivity determined by the st "time befo re sleep" parameter. the modem can also be configured to wake from cy clic sleep when the gpi2 pin is de-asserted. to configure a modem to operate in this manner, pw (pin wake-up) command must be issued. once the gpi2 pin is de-a sserted, the modem is forced into idle mode and can begin transmitting or receiving data. it remains active unt il data is no longer detected fo r the period of time specified by the st command, at which point it resumes its low-power cyclic state. cyclic scanning . each rf transmission consists of an rf initializer and payload. the rf initializer contains initialization information and all receiving modems must wake during the wake-up initial- izer portion of data transmission in order to be synchronized with the transmitting modem and receive the data. the cyclic interval time defined by the sm (sleep mode) command must be shorter than the interval time defined by lh (wake-up initializer timer) command. figure ? 3 \ 07. correct ? configuration ? (lh ? > ? sm): ? the ? length ? of ? the ? wake \ up ? initializer ? exceeds ? the ? time ? interval ? of ? cyclic ? sleep. ? the ? receiver ? is ? guaranteed ? to ? detect ? the ? wake \ up ? initializer ? and ? receive ? the ? accompanying ? payload ? data.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 20 chapter ? 3 ?\? rf ? modem ? operation 3.2.5. command mode to modify or read modem parameters, the modem must first enter into co mmand mode (state in which incoming characters ar e interpreted as commands). two command types are supported: ? at commands ? binary commands for modified parameter values to persist in th e modem registry, changes must be saved to non- volatile memory using the wr (write) command. ot herwise, parameters are restored to previously saved values when the modem is powered off and then on again. at command mode to enter at command mode: default at command mode sequence (for transition to command mode): ? no characters sent for one second [refer to the bt (guard time before) command] ? input three plus characte rs (?+++?) within one second [refer to the cc (command se quence character) command.] ? no characters sent for one second [refer to the at (guard time after) command.] all of the parameter values in the sequence can be modified to reflect user preferences. to send at commands: figure ? 3 \ 08. ? syntax ? for ? sending ? at ? commands ? to read a parameter value stored in the mo dem register, leave the parameter field blank. the preceding example would chan ge the modem?s destination address to "0x1f". to store the new value to non-volatile (long term) memory, the write (atwr) command must subsequently be sent before powering off the modem. system response. when a command is sent to the mode m, the modem will parse and execute the command. upon successful execution of a co mmand, the modem returns an ?ok? message. if execution of a command results in an erro r, the modem returns an ?error? message. to exit at command mode: for an example of programming the rf modem using at commands and descriptions of each config- urable parameter, refer to the "rf modem configuration" chapter [p22]. 1. send the 3-character command sequence "+++" and observe guard ti mes before and after the command characters. [refer to ?default at command mode sequence? below.] the ?ter- minal? tab (or other serial comm unications software) of the x- ctu software can be used to enter the sequence. [or] 2. assert (low) the config pin and turn the power going to the modem off and back on (or pulse the shdn pin). [if the modem is mounted to a maxstream rs-232/485 interface boar d, the result can be achieved by pressing the configuration switch down for 2 seconds.] send at commands and parameters using the syntax shown below. 1. if no valid at commands are received with in the time specified by ct (command mode timeout) command, the modem automatically returns to idle mode. [or] 2. send atcn (exit command mode) command.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 21 chapter ? 3 ?\? rf ? modem ? operation binary command mode sending and receiving parameter values using bi nary commands is the fastest way to change operating parameters of the modem. binary comm ands are used most often to sample signal strength [refer to db (received signal strength ) parameter] and/or error counts; or to change modem addresses and channels for polling systems when a quick response is necessary. since the sending and receiving of parameter values takes plac e through the same serial data path as 'live' data (received rf payload), interference betw een the two types of data can be a concern. common questions about using binary commands: ? what are the implications of asserting cmd while live data is being sent or received? ? after sending serial data, is there a mini mum time delay before cmd can be asserted? ? is a time delay required after cmd is de-a sserted before payload data can be sent? ? how does one discern between live data and data received in response to a command? the cmd pin (gpi1) must be asse rted in order to send binary commands to the modem. the cmd pin can be asserted to recognize binary command s anytime during the transmission or reception of data. the status of the cmd si gnal is only checked at the end of the stop bit as the byte is shifted into the serial port. the application does not allow contro l over when data is received, except by waiting for dead time between bursts of communication. if the command is sent in the middle of a stream of payload data to be transmitted, the command will essentially be executed in the order it is received. if the modem is continuously receiving data, the radio will wait for a break in the receiv ed data before executing the command. the cts signal will frame the response coming from the bina ry command request [refer to figure below]. a minimum time delay of 100 s (after the stop bit of the command byte has been sent) must be observed before the cmd pin can be de-asserte d. the command executes after all parameters associated with the command have been sent. if all parameters are not received within 0.5 sec- onds, the modem returns to idle mode. note: when parameters are sent, they are two bytes long with the least significant byte sent first. binary commands that return one parameter byte must be written with two parameter bytes. commands can be queried for their current valu e by sending the command logically ored (bit- wise) with the value 0x80 (hexadecimal) with cmd asserted. when the binary value is sent (with no parameters), the current valu e of the command parameter is sent back through the do pin. figure ? 3 \ 09. binary ? command ? write ? then ? read signal ? #4 ? is ? cmd signal ? #1 ? is ? the ? di ? signal ? signal ? #2 ? is ? the ? do ? signal ? from ? the ? radio signal ? #3 ? is ? cts ? in this graph, a value was written to a reg- ister 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 out of the modem. important: in order for the mo dem to recognize a binary command, the rt (gpi1 configuration) parameter must be set to one. if binary programm ing is not enabled (rt para meter value is not equal to ?1?), the modem will not recognize that the cmd pin is asserted and therefore will not recognize the data as binary commands. refer to [p24] for a binary programming exam ple (dt command exampl e returns two bytes).
? ? 2007 ? maxstream, ? inc. ????? 22 4. ? rf ? modem ? configuration 4.1. automatic dip sw itch configurations each time the rf modem is powered-on, at commands are sent to the on-board module as dic- tated by the positions of the dip switches. dip swit ch configurations are sent automatically during the power-on sequence and affect modem para meter values as shown in the table below. figure ? 4 \ 01. rf ? modem ? dip ? switches important : to avoid overwriting previously stored cust om configurations (due to the automatic con- figurations that take place each ti me the rf modem is powered-on), it is necessary to disable a pro- cessor located inside the modem. to disable the processor, turn switches 5 and 6 on (up). when switches 5 and 6 are on, only the cs command is sent [r efer to table below]. note: ? the ? results ? of ? sw ? 2, ? 5 ? & ? 6 ? on ? and ? sw ? 5 ? & ? 6 ? on ? are ? the ? same. tab le ? 4 \ 01. power \ up ? options ?\? commands ? sent ? as ? result ? of ? dip ? switch ? settings ? (sw ? = ? dip ? switch) switches condition behavior commands sent during power-up switches 1 & 2 (restore defaults / serial interfacing) if sw1 & sw2 are on (up) restore defaults atre atwr (restore defaults) (write defaults to non-volatile memory) if sw1 is on (up) rs-232 operation atcs 0 (rs-232, cts flow control) if sw1 is off (down) rs-485 or rs-422 operation atcs 3 (rs-485 or rs-422 operation) switches 5 & 6 (tx/rx modes) if sw5 & sw6 are off (down) multipoint base atmy 0 atdt ffff atmt 3 (source address) (destination address) (multi-transmit option) if sw5 is off (down) & sw6 is on (up) multipoint remote atam atdt 0 atmt 0 atrr a (auto-set my, my = unique) (destination address) (multi-transmit option) (retries) if sw5 is on (up) & sw6 is off (down) point-to-point atam atdt ffff atmt 3 (auto-set my, my = unique) (destination address) (multi-transmit option) if sw5 is on (up) & sw6 is on (up) user defined processor is disabled and at commands are not sent to the modem (except for cs command as shown below.) tab le ? 4 \ 02. user ? defined ? mode ? (switches ? 5 ? and ? 6 ? are ? on ? (up)) only dip switches on (up) condition command sent during power-up sw1, sw5 and sw6 if cs = 0, 1, 2 or 4 cs parameter remains the same if cs = 3 atcs 0 (rs-232 operation, cts flow control) sw2, sw5 and sw6 if cs = 2 atcs 2 (gpo1 high) if cs = 0, 1, 3 or 4 atcs 3 (rs-485/422 operation) sw5 and sw6 only if cs = 2 atcs 2 (gpo1 high) if cs = 0, 1, 3 or 4 atcs 3 (rs-485/422 operation)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 23 chapter ? 4 ?\? rf ? modem ? configuration 4.2. programming examples refer to the ?command mode? section [p20] for information regarding en trance into command mode, sending at commands and exiting command mode. 4.2.1. at commands maxstream has provided x-ctu software for prog ramming the modem using an extensive list of at commands. the x-ctu software pr ovides an interface that is divi ded into four tabs that facili- tate the following functions: ? pc settings tab - setup pc serial po rt to interface with an rf modem ? range test tab - test rf modem's range in varying environments ? terminal tab - configure and read xtend rf modem parameters using at commands ? modem configuration tab - configure and read rf modem parameters to install the x-ctu software: pc settings tab (x-ctu software) as stated in the serial commun ications section [p12]; in order to communicate data to the rf modem through the pc, the baud (serial data rate), da ta bit, parity and stop bit settings on the pc serial port must match those of the modem. the 'pc settings' tab provides a software user inter- face that facilitates the modifica tion of pc seri al port setting. pc setup figure ? 4 \ 02. setup ? for ? rf ? modem ? configurations ? through ? x \ ctu ? software terminal tab (x-ctu software) a terminal program has been built into the x-ctu so ftware and is located un der the 'terminal' tab. the terminal tab provides an easy-to- use interface for pr ogramming the modem. multiple at commands. multiple at commands can be ente red on one line with one carriage return at the end of the line. each command must be delimited by a comma (spaces in between are optional). the "at" prefix is only sent before th e first command and should not be included with subsequent commands in a line. system response. when a command is sent to the mode m, the modem will parse and execute the command. upon successful execution of a co mmand, the modem returns an "ok" message. if execution of a command results in an erro r, the modem returns an "error" message. double-click the ?setup_x-ctu.exe? file that is located on the maxstream cd and under the ?downloads? section of the following web pa ge: www.maxstream .net/helpdesk/download.php. then follow the prompts of the installation screens. 1. set the dip switch to rs-232 mode. [switches 1 & 5 are on (up) and the remaining 4 switches are off (down).] 2. connect the male db-9 connector of the pc with the female db-9 connector of the rf modem using an rs-232 cable. 3. power the rf modem thro ugh the power connector. 4. go to the pc settings tab and select parame ter values from the drop-down lists that match the current parameter va lues of the rf modem.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 24 chapter ? 4 ?\? rf ? modem ? configuration restore rf modem default parameters (using the ?terminal? tab of the x-ctu software) note: ? default ? parameter ? values ? of ? the ? rf ? modem ? can ? also ? be ? restored ? by ? selecting ? the ?? restore ?? button ? located ? on ? the ? ?modem ? configuration? ? tab ? [refer ? to ? the ? example ? below]. modem configuration tab sample configuration: re store rf modem defaults 4.2.2. binary commands to send binary commands: note: cts (gpo1) is high when a command is being exec uted. hardware flow control must be disabled as cts will hold off parameter bytes. example: both of the following examples restore the xtend modem's factory defaults and save the parameters to non-volatile memory. method 1 (one line per command) send at command +++ atre atwr atcn system response ok (enter into command mode) ok (restore rf mode m default parameter values) ok (write to non-volatile memory) ok (exit command mode) method 2 (multiple commands on one line) send at command +++ atre, wr atcn system response ok (enter into command mode) ok (execute multiple commands) ok (exit at command mode) example: utilize the x-ctu ?modem configuratio n? tab to restore defa ult parameter values. after establishing a connection between the modem and a pc [refer to the 'setup' section above], select the ?modem configuration? tab of the x-ctu software. 1. select the 'read' button. 2. select th e 'restore' button. example: use binary commands to change the rf modem's dest ination address to 0x1a0d and save the new address to non-volatile memory. 1. rt command must be set to '1' in at co mmand mode to enable binary programming. 2. assert cmd (pin 10 is driven hi gh). (enter binary command mode) 3. send bytes [parameter bytes must be 2 bytes long]: 00 (send dt (destination address) command) 0d (least significant byte of parameter bytes) 1a (most significant byte of parameter bytes) 08 (send wr (write) command) 4. de-assert cmd (gpi1 is driven lo w). (exit binary command mode) note: ?? do ? not ? send ? com \ mands ? to ? the ? modem ? during ? flash ? program \ ming ? (when ? parameters ? are ? being ? written ? to ? the ? modem ? registry). ?? wait ? for ? the ?? ok ?? sys \ tem ? response ? that ? fol \ lows ? the ? atwr ? command ? before ? enter \ ing ? the ? next ? command ? or ? use ? flow ? control. note: ?? do ? not ? send ? com \ mands ? to ? the ? modem ? during ? flash ? program \ ming ? (when ? parameters ? are ? being ? written ? to ? the ? modem ? registry). ?? wait ? for ? the ?? ok ?? sys \ tem ? response ? that ? fol \ lows ? the ? atwr ? command ? before ? enter \ ing ? the ? next ? command ? or ? use ? flow ? control.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 25 chapter ? 4 ?\? rf ? modem ? configuration 4.3. command re ference table tabl e ? 4 \ 03. xtend ? commands ? (the ? rf ? modems ? expect ? numerical ? values ? in ? hexadecimal. ? hexadecimal ? values ? are ? designated ? by ? a ? ?0x? ? prefix. ? decimal ? equivalents ? are ? designated ? by ? a ? ?d? ? suffix.) at command binary command at command name parameter range command category # bytes returned factory default %v 0x3b (59d) board voltage 0x2ccca - 0x5bffa [read-only] diagnostics 4 -- am 0x40 (64d) auto-set my -- networking & security -- -- ap v2.x20* -- api enable 0 - 2 serial interfacing 1 0 at 0x05 (5d) guard time after 2 - (atst-3) [x 100 msec] command mode options 2 0x0a (10d) bd 0x15 (21d) interface data rate 0 - 8 (standard rates) 0x39 - 0x1c9c38 (non-standard rates) serial interfacing 4 3 br 0x39 (57d) rf data rate 0 - 1 rf interfacing 1 1 bt 0x04 (4d) guard time before 0 - 0xffff [x 100 msec] command mode options 2 0x0a (10d) cc 0x13 (19d) command sequence character 0x20 - 0x7f command mode options 1 0x2b ["+"] (43d) cd 0x28 (40d) gpo2 configuration 0 - 4 serial interfacing 1 2 cf -- number base 0 - 2 command mode options 1 1 cn 0x09 (9d) exit command mode -- command mode options -- -- cs 0x1f (31d) gpo1 configuration 0 - 4 serial interfacing 1 0 ct 0x06 (6d) command mode timeout 2 - 0xffff [x 100 ms] command mode options 2 0xc8 (200d) db 0x36 (54d) received signal strengt h 0x6e - 0x28 [read-only] diagnostics 2 -- dt 0x00 (0d) destination address 0 - 0xffff networking & security 2 0 e0 0x0a (10d) echo off -- command mode options -- -- e1 0x0b (11d) echo on -- command 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) forced sync time 0 - 0xffff [x 10 msec] rf interfacing 2 0 ft 0x24 (36d) flow control threshold 0 - (di buffer size - 0x11) [bytes] serial interfacing 2 di buffer size minus 0x11 gd 0x10 (16d) receive good count 0 - 0xffff diagnostics 2 0 hp 0x11 (17d) hopping channel 0 - 9 networking & security 1 0 ht 0x03 (3d) time before wake-up initialize r 0 - 0xffff [x 100 msec] sleep (low power) 2 0xffff (65535d) hv -- hardware version 0 - 0xffff [read-only] diagnostics 2 -- id 0x27 (39d) modem vid 0x11 - 0x7fff (user-settable) 0x8000 - 0xffff (factory-set, read-only) networking & security 2 0x3332 (13106d) ky 0x3c (60d) aes encryption key 0 - (any other 64-digit hex valid key) networking & security 2 0 lh 0x0c (12d) wake-up initializer timer 0 - 0xff [x 100 msec] sleep (low power) 1 1 md v2.x20* 0x31 (49d) rf mode 0 - 6 networking & security 1 0 mk 0x12 (18d) address mask 0 - 0xffff networking & security 2 0xffff (65535d) mt 0x3d (61d) multi-transmit 0 - 0xff networking & security 1 0 my 0x2a (42d) source address 0 - 0xffff networking & security 2 0xffff (65535d) nb 0x23 (35d) parity 0 - 4 serial interfacing 1 0 pb v2.x20* 0x45 (69d) polling begin address 0 - 0xffff networking & security 2 0 pd v2.x20* 0x47 (71d) minimum polling delay 0 - 0xffff (base: (x 1 ms), remote: [x 10 ms]) networking & security 2 0
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 26 chapter ? 4 ?\? rf ? modem ? configuration * ? firmware ? version ? in ? which ? command ? and ? parameter ? options ? were ? first ? supported pe v2.x20* 0x46 (70d) polling end address 0 - 0xffff networking & security 2 0 pk 0x29 (41d) maximum rf packet size 1 - 0x800 [bytes] rf interfacing 2 varies pl 0x3a (58d) tx power level 0 - 4 rf interfacing 1 4 (1 watt) pw 0x1d (29d) pin wake-up 0 - 1 sleep (low power) 1 0 rb 0x20 (32d) packetization threshold 1 - current value of pk serial interfacing 2 0x800 (2048d) rc -- ambient power - single channel 0 - 0x31 [dbm, read-only] diagnostics 1 -- re 0x0e (14d) restore defaults -- (special) -- -- rm -- ambient power - all channels no parameter - 0x7d0 diagnostics 2 -- rn 0x19 (25d) delay slots 0 - 0xff [slots] networking & security 1 0 ro 0x21 (33d) packetization timeout 0 - 0xffff [x uart character time] serial interfacing 2 3 rp 0x22 (34d) rssi pwm timer 0 - 0xff [x 100 msec] diagnostics 1 0x20 (32d) rr 0x18 (24d) retries 0 - 0xff networking & security 1 0x0a (10d) rt 0x16 (22d) gpi1 configuration 0 - 2 serial interfacing 1 0 sb 0x37 (55d) stop bits 0 - 1 serial interfacing 1 0 sh 0x25 (37d) serial number high 0 - 0xffff [read-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) - 0x 7fff [x 100 msec] sleep (low power) 2 0x64 (100d) tp 0x38 (56d) board temperature 0 - 0x7f [read-only] diagnostics 1 -- tr 0x1b (27d) delivery failure count 0 - 0xffff [read-only] diagnostics 2 0 tt 0x1a (26d) streaming limit 0 - 0xffff [0 = disabled] networking & security 2 0 tx 0x3f (63d) transmit only 0 - 1 rf interfacing 1 0 vl -- firmware version - verbose returns string diagnostics -- -- vr 0x14 (20d) firmware version 0 - 0xffff [read-only] diagnostics 2 -- wa -- active warning numbers returns string diagnostics -- -- wn -- warning data returns string diagnostics -- -- wr 0x08 (8d) write -- (special) -- -- ws -- sticky warning numbers returns string diagnostics -- -- tabl e ? 4 \ 03. xtend ? commands ? (the ? rf ? modems ? expect ? numerical ? values ? in ? hexadecimal. ? hexadecimal ? values ? are ? designated ? by ? a ? ?0x? ? prefix. ? decimal ? equivalents ? are ? designated ? by ? a ? ?d? ? suffix.) at command binary command at command name parameter range command category # bytes returned factory default
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 27 chapter ? 4 ?\? rf ? modem ? configuration 4.4. command descriptions commands in this section are li sted alphabetically. command cate gories are designated between the "< >" symbols that follow each command title. by default, xtend rf modems expect numerical values in hexadecimal since the default value of the cf (number base) para meter is '1'. hexadec- imal values are designated by the "0x" pr efix and decimal values by the "d" suffix. %v (board voltage) command %v command is used to read the current voltage of the modem circuit board. sample output: 5.02 v (when atcf = 0) 5051f (when atcf = 1) * 5.02 (when atcf = 2) * when cf = 1 (default), a hex integer is shown that is equal to (voltage * 65536d). am (auto-set my) command am command is used to automatically set the my (source address) parameter from the factory- set serial number of the modem. the address is formed with bits 29, 28 and 13-0 of the serial number (in that order). the resulting value is displayed as a result of this command. ap (api enable) command the ap command is used to enable the modem to operate using the frame- based api operation. at (guard time after) command 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 second must elapse before and after the command sequence character. the times-of-silence surrounding the command sequence character are used to prevent inadvert- ent entrance into at command mode. at command: at%v binary command: 0x3b (59 decimal) parameter range (read-only): 0x2ccca - 0x5bffa (2.80 - 5.75 decimal) number of bytes returned: 4 at command: atam binary command: 0x40 (64 decimal) at command: atap parameter range: 0 - 2 parameter configuration 0 api disabled (transparent operation) 1 api enabled (w/out escaped characters) 2 api enabled (with escaped characters) default parameter value:0 number of bytes returned:1 minimum firmware version required: 2.x20 at command: atat binary command: 0x05 (5 decimal) parameter range: 2 - (atst-3), up to 0x7ffc [x 100 milliseconds] default parameter valu e: 0x0a (10 decimal) number of bytes returned: 2 related commands: bt (g uard time before), cc (command sequence character)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 28 chapter ? 4 ?\? rf ? modem ? configuration bd (interface data rate) command the bd command is used to set and read the serial interface data rate (baud rate) used between the rf modem and host. this parameter determines the rate at which serial data is sent to the mode m from the host. modified interface data rates do not take effect until the cn (exit at command mode) command is issued and the system returns the 'ok' response. when parameters 0-8 are sent to the modem, the respective interface data rates are used (as shown in the table on the right). the rf data rate is not affected by the bd param- eter. 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 non-standard baud rates (0x09 - 0x38) is invalid. non-standard interface data rates: any value above 0x38 will be interpreted as an actual baud rate. when a value above 0x38 is sent, the closest interface data rate represented by the number is stored in the bd register. for example, a rate of 19200 bps can be set by sending the following command line "atbd4b00". note: when using maxstream? s x-ctu software, non- standard interface data rates can only be set and read using the x-ctu ?terminal? tab. non-stan- dard rates are not accessible through the ?modem configuration? tab. when the bd command is sent with a non-standard interface data rate, the uart will adjust to accommodate the requested interface rate. in most cases, the cl ock resolution will cause the stored bd parameter to vary from the parameter th at was sent (refer to the table below). reading the bd command (send "atbd" command without an associated parameter value) will return the value actually stored in the modem?s bd register. br (rf data rate) command 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. parameters ? sent ? ve r s u s ? parameters ? stored bd parameter sent (hex) interface data rate (bps) bd parameter stored (hex) 0 1200 0 4 19,200 4 7 115,200 7 12c 300 12b 1c200 115,200 1b207 at command: atbd binary command: 0x15 (21 decimal) parameter ranges: 0 - 8 (standard rates) 0x39 - 0x1c9c38 (non-standard rates) parameter configuration (bps) 01200 12400 24800 39600 4 19200 5 38400 6 57600 7 115200 8 230400 default parameter value: 3 non-standard baud rates supported as of firmware v2.x20 number of bytes returned: 4 at command: atbr binary command: 0x39 (57 decimal) parameter range: 0 - 1 parameter baud (bps) configuration 09600 1 115200 default parameter value:1 number of bytes returned: 1
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 29 chapter ? 4 ?\? rf ? modem ? configuration bt (guard time before) command the cc command is used to set/read th e ascii character used between guard times of the at command mode sequence (bt + cc + at). this sequence enters the modem into at command mode so that data entering the modem (from the host) is recognized as commands instead of payload. cc (command sequence character) command the cc command is used to set/read th e ascii character used between guard times of the at command mode sequence (bt + cc + at). this sequence enters the modem into at command mode so that data entering the modem (from the host) is recognized as commands instead of payload. cd (gpo2 config uration) command cd command is used to select/read the behavior of the gpo2 line (pin 3). cf (number base) command cf command is used to set/read the comman d formatting setting. the following commands are always entered and read in hex, no matt er the cf setting: vr (firmware version) hv (hardware version) ky (aes encryption key) at command: atcc binary command: 0x13 (19 decimal) parameter range: 0x20 - 0x7f default parameter value: 0x2b (ascii ?+?) number of bytes returned: 1 related commands: at (guard time after), bt (guard time before) at command: atcc binary command: 0x13 (19 decimal) parameter range: 0x20 - 0x7f default parameter value: 0x2b (ascii ?+?) number of bytes returned: 1 related commands: at (guard time after), bt (guard time before) at command: atcd binary command: 0x28 (40 decimal) parameter range: 0 - 8 (standard rates) parameter configuration 0rx led 1default high 2default low 3(reserved) 4 rx led (valid address only) default parameter value: 2 number of bytes returned: 1 at command: atcf parameter range: 0 ? 2 parameter configuration 0 commands utilize default number base; decimal commands may output units 1 all commands forced to unsigned, unit-less hex 2 commands utilize their default number base; no units are output default parameter value: 1 number of bytes returned: 1
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 30 chapter ? 4 ?\? rf ? modem ? configuration cn (exit at command mode) command the cn command is used to explicitly exit the modem from at com- mand mode. cs (gpo1 config uration) command cs command is used to select 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 oper- ations). by default, gp01 provides rs-232 cts (clear-to- send) flow control. ct (command mode timeout) command the ct command is used to set and read the amount of inactive time that elapses before th e modem automatically exits from at command mode and returns to idle mode. use the cn (exit at command mode) command to exit at command mode manually. db (received signal strength) command db command is used to read the receive signal strength (in decibels relative to mil- liwatts) of the last rece ived packet. this parame- ter is useful in determin ing range characteristics of the rf modems under various conditions. in default mode, this command shows the power level in signed decimal format wi th the units (dbm). if cf = 1, the magnitude of the value is pre- sented in unsigned hex. if cf = 2, the value is presented in decimal, but without the units. sample output: -88 dbm (when atcf = 0) 58 (when atcf = 1) -88 (when atcf = 2) note: if the db register is re ad before the modem has received an rf packet, the modem will return a value of 0x8000 (which means an rf packet has not yet been received). at command: atcn binary command: 0x09 (9 decimal) at command: atcs binary command: 0x1f (31 decimal) parameter range: 0 - 4 parameter configuration 0 rs-232 cts flow control 1 rs-485 tx enable low 2high 3 rs-485 tx enable high 4low default parameter value: 0 number of bytes returned: 1 related commands: rt (gpi1 configuration), to (gp01 timeout) at command: atct binary command: 0x06 (6 decimal) parameter range: 2 - 0xffff [x 100 milliseconds] default parameter value: 0xc8 (200d) number of bytes returned: 2 related command: cn (exit at command mode) at command: atdb binary command: 0x36 (54 decimal) parameter range (read- only): 0x6e - 0x28 (-110 to -40 decimal) number of bytes returned: 2
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 31 chapter ? 4 ?\? rf ? modem ? configuration dt (destination address) command dt command is used to set/read the networking address of an rf modem. the modems utilize three filtration lay- ers: vendor id number (atid), channel (athp), and destination address (atdt). the dt com- mand assigns an address to a modem that enables it to communicate only with other modems having the same address. all modems that share the same dt parameter can communi- cate with each other. rf modems in the same network with a different de stination address (than th at of the transmitter) will listen to all transmissions to stay synchronized, but will not send any of the data out their serial ports. e0 (echo off) command e0 command turns off character echo in at command mode. by default, echo is off. e1 (echo on) command 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 the er command is used to set/ read the number of re ceive-errors. the error count records the number of packets partially received then aborted on a reception error. this value returns to 0 after a reset and is not non- volatile (value does not persist in the modem's memory after a power-up sequence). once the receive error count reaches its maximum value (up to 0xffff), it remains at its maximum count value until the maximum count value is ex plicitly changed or the modem is reset. the er parameter is not reset by pin, serial port or cyclic sleep modes. fh (force wake-up initializer) command the fh command is used to force a wake-up initiali zer to be sent on the next transmission. use only with cyclic sleep modes active on remote modems. atfh will not send a long header if atht = 0xffff. wr (write) command does not need to be issued with fh command. at command: atdt binary command: 0x00 parameter range: 0 - 0xffff default parameter value: 0 number of bytes returned: 2 related commands: hp (hopping channel), id (modem vid), mk (address mask), my (source address) at command: ate0 binary command: 0x0a (10 decimal) at command: ate1 binary command: 0x0b (11 decimal) at command: ater binary command: 0x0f (15 decimal) parameter range: 0 - 0xffff default parameter value: 0 number of bytes returned: 2 related commands: gd (receive good count) at command: atfh binary command: 0x0d (13 decimal)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 32 chapter ? 4 ?\? rf ? modem ? configuration fl (software flow control) command the fl command is used to configure software flow control. hardware flow control is implemented with the modem as the gp01 pin (cts pin of the oem rf module), which regulates when serial data can be transferred to the modem. fl command can be used to allow software flow control to also be enab led. the xon character used is 0x11 (17 decimal). the xoff character used is 0x13 (19 decimal) fs (forced synch time) command the fs command only applies to streaming data. normally , only the first packet of a continuous stream cont ains the full rf initial- izer. the rf modems then remain synchronized for subsequent packets of the stream. this parameter can be used to periodically force an rf initializer during such streaming. any break in uart character reception long enough to drain the di buffer (uart receive buffer) and cause a pause in rf data tr ansmission will also cause an rf initializer to be inserted on the next transmission. ft (flow control threshold) command the ft command is used to set/read the flow contro l threshold. when ft bytes have accumulated in the di buffer (uart receive), cts is de-asserted or the xoff soft- ware flow control char acter is transmitted. gd (receive go od count) command the gd command is used to set/ read the count of good received rf packets. its parameter value is reset to 0 after every reset and is not non-volatile (the parameter value does not persist in the rf modem's memory 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 reset. the gd parameter is not reset by pin, serial port or cyclic sleep modes. at command: atfl binary command: 0x07 (7 decimal) parameter range: 0 - 1 parameter configuration 0 disable software flow control 1 enable software flow control default parameter value: 0 number of bytes returned: 1 at command: atfs binary command: 0x3e (62 decimal) parameter range: 0 - 0xffff [x 10 milliseconds] default parameter value: 0 number of bytes returned: 2 at command: atft binary command: 0x24 (36 decimal) parameter range: 0 - (di buffer size minus 0x11) [bytes] default parameter value: di buffer size minus 0x11 (17 decimal) number of bytes returned: 2 at command: atgd binary command: 0x10 (16 decimal) parameter range: 0 - 0xffff default parameter value: 0 number of bytes returned: 2 related commands: er (receive error count)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 33 chapter ? 4 ?\? rf ? modem ? configuration hp (hopping channel) command the hp command is used to set/read the rf modem's hopping channel number. a channel is one of three layers of filtra- tion available to the modem. in order for modems to communicate with each other, the modems must have the same channel number since each channel uses a different hop- ping sequence. different channels can be used to prevent modems in one network from listening to transmissions of another. ht (time before wake-up initializer) command the ht command is used to set/read the time of in activity (no serial or rf data is sent or received) before a wake-up initial- izer is sent by a tx (tra nsmitting) rf modem. the ht parameter should be set shorter than inactiv- ity timeout [st command] time of any rx (receiving) modems operating in cyclic sleep (sm=4-8). the wake-up initializer sent by the tx modem instructs all rx modems to remain awake to receive rf data. from the rx modem perspe ctive: after ht time elapses and the inactivity timeout [st command] is met, the rx modem goes into cyclic sleep. in cyclic sleep, the rx modem wakes once per sleep interval [sm command] to check fo r a wake-up initializer. when a wake-up initializer is detected, the modem stays awake to receive data. the wake-up initializer must be longer than the cyclic sleep interval to ensure that slee ping modems detect incoming data. when ht time elapses, the tx modem knows it needs to send a wake-up initializer for all rx modems to remain awake and receive the next transmission. hv (hardware version) command the hv command is used to read the hardware version of the rf modem. id (modem vid) command the id command is used to set/read the vi d (vendor identification number) of the rf modem. rf modems must have matching vids in order to communicate. at command: athp binary command: 0x11 (17 decimal) parameter range: 0 - 9 default parameter value: 0 number of bytes returned: 1 related commands: id (modem vid), dt (destination address), mk (address mask) at command: atht binary command: 0x03 (3 decimal) parameter range: 0 - 0xffff [x 100 milliseconds] default parameter value: 0xffff (wake-up initializer will not be sent) number of bytes returned: 2 related commands: lh (wake-up initializer timer), sm (sleep mode), st (time before sleep) at command: athv parameter range: 0 - 0xffff [read-only] minimum firmware version required: v1.x80 at command: atid binary command: 0x27 (39 decimal) parameter range: 0x11 - 0x7fff (user-settable) 0 - 0x10 & 0x8000 - 0xffff (factory-set) default parameter value: 0x3332 (13106d) number of bytes returned: 2
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 34 chapter ? 4 ?\? rf ? modem ? configuration ky (aes encryption key) command the ky command is used to set the 256-bit aes (advanced encryption standard) key for encrypting/decrypting data. once set, the key cannot be read out of the modem by any means. the entire payload of the packet is encrypted using the key and the crc is computed across the ciphertext. when encryption is enabled, each packet carries an additional 16 bytes to convey the random cbc initialization vector (iv) to the receiv er(s). the ky value may be ?0? or any 256-bit value (= 64 hex digits = 32 bytes). any other value, including entering atky by itself with no para meters, causes an error. a modem with the wrong key (or no key) will rece ive encrypted data, but the data driven out the serial port will be mean ingless. likewise, a modem with a key will receive unencrypted data sent from a modem without a key, but the output will be meaningless. because cbc mode is utilized, repetitive data appears different ly in different transmissions du e to the randomly-generated iv. lh (wake-up initializer timer) command the lh command is used to set/read the duration of time during which the wake-up initializer is sent. when receiving modems are in cyclic sleep mode, they power- down after a period of inactivity (as specified by the st parameter) and will periodically wake and listen for transmitted data. in order for the receiving modems to remain awake, they must detect ~35ms of the wake-up initializer. lh command must be used whenever a receiving modem is operating in cyclic sleep mode. the wake-up initializer time must be longer than th e cyclic sleep time that [as determined by sm (sleep mode) parameter]. if the wake-up initializer time were less than the cyclic sleep interval, the connection would be at risk of miss ing the wake-up initializer transmission. refer to figures loated under th e sm command description to view diagrams of correct and incor- rect configurations. the images emphasize that the lh value must be greater than the sm value. md (rf mode) command the md command is used to select/read the settings that enable the polling and repeater modes on the modem. polling mode - a ?polling base? is responsible for polling remotes. a ?polling remote? requires a poll in order to transmit. repeater mode - a ?repeater? re-sends rf data unless the transmission is addressed to it or if the transmission has alre ady 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 communication modes? chapter for more information. at command: atky binary command: 0x3c (60 decimal) parameter range: 0 - (any other 64-digit hex valid key) default parameter value: 0 (disabled) number of bytes returned: 2 number base: always hexadecimal at command: atlh binary command: 0x0c (12 decimal) parameter range: 0 - 0xff [x 100 milliseconds] default parameter value: 1 number of bytes returned: 1 related commands: ht (time before wake-up initializer), sm (sleep mode), st (time before sleep) at command: atmd binary command: 0x31 (49 decimal) parameter range: 0 - 6 parameter configuration 0 transparent operation (repeater base) 1 [reserved - not used] 2 [reserved - not used] 3polling base 4 polling remote 5 repeater 6 repeater end node default parameter value: 0 number of bytes returned: 1 minimum firmware version required: 2.x20
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 35 chapter ? 4 ?\? rf ? modem ? configuration mk (address mask) command the mk command is used to set/read the address mask of a modem. all rf data packets contain the destination address of the tx (trans mitting) modem. when a packet is received, the tx modem destination address is logically "anded" (bitwise) with the address mask of the rx (receiving) modem. the resulting value must match the destination address or address mask of the rx modem for the packet to be received and sent out the rx modem's do (data out) pin. if the "anded" value does not match the destination address or address mask of the rx mode m, the packet is discarded. sniffer mode (when mk = 0): ack requests are ignored and every rx (receive) frame is sent to the uart, without regard for repeated frames. all ?0? values are treated as irrelevant values and ignored. mt (multi-transmit) command the mt command is used to enabled multiple transmissions of rf data packets. when multi-transmit mode is enabled (mt > 0), packets do not request an ack (acknowledgement) 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 ceives a packet with remaining forced retransm issions, it calculates the length of the packet and inhibits transmission for the amount of time required for all retransm issions. thereafter, a random number of delay slots are inserted between 0 and rn before tran smission is allowed from the receiving modem(s). this prevents all listening modems from transmitting at once upon conclusion of a multiple trans- mission event (when rn > 0). note: the actual number of forced transmissions is the parameter value plus one. for example, if mt = 1, two transmissions of each packet will be sent. my (source address) command the my command is used to set/read the so urce address of the rf modem. at command: atmk binary command: 0x12 (18 decimal) parameter range: 0 - 0xffff default parameter value: 0xffff (65535d) number of bytes returned: 2 related commands: dt (destination address), hp (hopping channel), id (modem vid), my (source address) at command: atmt binary command: 0x3d (61 decimal) parameter range: 0 - 0xff default parameter value:0 (no forced retransmissions) number of bytes returned: 1 related commands: networking (dt, mk, my, rn, tt), serial interfacin g (br, pk, rb, ro), rf interfacing (fs) at command: atmy binary command: 0x2a (42 decimal) parameter rang e: 0 - 0xffff default parameter value: 0xffff (disabled - dt (destination address) parameter serves as both source and destination address.) number of bytes returned: 2 related commands: dt (d estination address), hp (hopping channel), id (modem vid), mk (address mask)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 36 chapter ? 4 ?\? rf ? modem ? configuration nb (parity) command the nb command is used to select/read the parity se ttings of the rf modem for uart communications. pb (polling begin address) command pb command is used to set/read the modem?s poll ing begin address - the first address polled po lling mode is enabled. polling operations: the ?polling base? (md = 3) cycles through a sequential range of addresses, polling each ?polling remote? (md = 4). the base then waits for a response & proceeds to the next ?polling remote?. each ?polling remote? responds by sending the data from the data in buffer fol- lowing the rb & ro parameters. when there is no eligible data to send, the ?polling remote? will no t respond. the ?polling base? will move to the next address in the polling sequ ence after a short delay. pd (minimum polling delay) command the pd command is used to set/read polling delay (base, md=3) or polling timeout (remote, md=4). polling delay (base) is the time between polling cycles. the polling base will start the polling cycle after sending the first poll. after the polling cycle has completed, the timer is restarted. polling timeout (remote) is the amount of time the remote unit will hold data from the serial port before discarding it. data entered within the pd time of the poll is transmitted and not discarded. pe (polling end address) command pe command is used to set/read the modem?s polling end address - the last address polled when polling mode is enabled. polling operations : the ?polling base? (md = 3) cycles through a sequential range of addresses, polling each ?polling remote? (md = 4). the base then waits for a response & proceeds to the next ?polling remote?. each ?polling remote? responds by sending data from the di buffer following the rb & ro parameters. when there is no eligible data to send, the ?polling remote? will not respond. the ?polling base? will move to the next address in the polling sequence after a short delay. at command: atnb binary command: 0x23 (35 decimal) parameter range: 0 - 4 parameter configuration 0 8-bit (no parity or 7-bit (any parity) 18-bit even 28-bit odd 38-bit mark 48-bit space default parameter value: 0 number of bytes returned: 1 at command: atpb binary command: 0x45 (69 decimal) parameter rang e: 0 - 0xffff default parameter value: 0 number of bytes returned: 2 minimum firmware version required: 2.x20 related commands: md (rf mode), pe (polling end address), pd (minimum polling delay) at command: atpd binary command: 0x47 (71 decimal) parameter rang e: 0 - 0xffff (base: [x 1ms], remote: [x 10ms]) default parameter value: 0 number of bytes returned: 2 minimum firmware version required: 2.x20 related commands: md (r f mode), pb (polling begin address), pe (polling end address) at command: atpe binary command: 0x46 (70 decimal) parameter rang e: 0 - 0xffff default parameter value: 0 number of bytes returned: 2 minimum firmware version required: 2.x20 related commands: md (r f mode), pb (polling begin address), pd (minimum polling delay)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 37 chapter ? 4 ?\? rf ? modem ? configuration pk (maximum rf packet size) command the pk command is used to set/ read the maximum size of rf packets transmitted from an rf modem. the maximum packet size can be used along with th e rb and ro parameters to implicitly set the channel dwell time. if pk is set above 256 and br is subsequently changed to 0, pk will auto matically be lowered to 256 and a warning will be raised (refer to the br (rf data rate) and wn (warning data) com- mands for details). changes to the pk parameter may have a second- ary effect on the rb (packetization threshold) parameter. rb must always be less than or equal to pk. if pk is changed to a value that is less than the current value of rb, the rb value is automati- cally lowered 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 the pl command is used to set/ read the power level at which the rf modem transmits data. pw (pin wake-up) command under normal operation, an rf modem in cyclic sleep mode cycles from an active state to a low-powe r state at regular inter- vals until data is ready to be received. if the pw parameter is set to 1, the gpi2 pin (sleep) can be used to awaken the modem from cyclic sleep. when the gpi2 pin is de-asserted (low), the modem will be fully operational and will not go into cyclic sleep. once the gpi2 pin is asserted, the modem will remain active for the peri od of time specified by the st (time before slee p) parameter and will return to cyclic sleep mode (if no data is ready to be transmitted). pw command is only va lid if cyclic sleep has been enabled. at command: atpk binary command: 0x29 (41 decimal) parameter range: 1 - 0x800 [bytes] default parameter value:0x100* or 0x800* (256 or 2048 decimal) number of bytes returned: 2 related commands: br (rf data rate) rb (packetization threshol d), ro (packetization timeout), wn (warning data) at command: atpl binary command: 0x3a (58 decimal) parameter range: 0 - 4 parameter configuration 01 mw 110 mw 2 100 mw 3 500 mw 4 1000 mw (1 watt) default parameter value: 4 number of bytes returned: 1 at command: atpw binary command: 0x1d (29 decimal) parameter range: 0 - 1 parameter configuration 0 disabled 1enabled default parameter value: 0 number of bytes returned: 1 related commands: sm (sleep mode), st (time before sleep)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 38 chapter ? 4 ?\? rf ? modem ? configuration rb (packetization threshold) command the rb command is used to set/read the charac ter threshold value. rf transmission begins after data is received 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 of data) if pk (max. rf packet size) is lowered below the value of rb, rb is automatically lowered to match the pk value. if (ro = 0), rb bytes must be received before begi nning transmission. note: rb and ro criteria only apply to the first packet of a multi-packet transmission. if data remains in the di buffer after the first packet, tr ansmissions will continue in a streaming manner until there is no data left in the di buffer (uart receive buffer). rc (ambient power - si ngle channel) command the rc comm and is used to exam- ine and report the power level on a given channel. sample output: -78 dbm [when cf = 0] 4e [when cf = 1] -78 [when cf = 2] re (restore defaults) command the re command is used to restore all configurable parameters to their fac- tory default settings. the re command does not cause default values to be stored to non-volatile (persistent) memory. for the restored default settings to persist in the modem?s non-volatile memory and be saved in the event of rf modem reset or power-down, the wr (write) command must be issued prior to power-down or reset. rm (ambient power - all channels) command the rm command is used to examine and report power levels on all channels. if no parameter is gi ven, the channels are scanned one time. if a pa rameter is given, the channels are repeatedly scanned for that number of seconds. the maximum power level seen for each channel is report ed (i.e. peak hold). a graphical spectrum analyzer can be implemente d by repeatedly sendin g the rm command (with no arguments) and reading the resultant 50 power leve ls (this is easiest to do when cf = 1 or 2). sample output [when cf = 0]: ch 0: -100 dbm ch 1: -103 dbm ... ch 49: -99 dbm sample output [when cf = 1]: 64 67 ... 63 sample output [when cf = 2]: 100 -103 ? -99 at command: atrb binary command: 0x20 (32 decimal) parameter range: 0 - pk parameter value (up to 0x800 bytes) default parameter value: 0x800 bytes number of bytes returned: 2 related commands: br (rf data rate), pk (rf packet size), ro (p acketization timeout) at command: atrc parameter range (read- only): 0 - 0x31 [dbm] number of bytes returned: 1 related commands: rm (ambient power - all channels) at command: atre binary command: 0x0e (14 decimal) at command: atrm parameter range: no parameter - 0x7d0) number of bytes returned: 2 related commands: rc (ambient power - single channel)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 39 chapter ? 4 ?\? rf ? modem ? configuration rn (delay slots) command the rn command is used to set/read the time delay that the transmit- ting rf modem inserts before attempting to resend a packet. if the transmitting modem fails to receive an acknowle dgement after sending a packet, it inserts a random number of delay slots (ranging from 0 to (rn minus 1)) before attempt- ing to resend the packet. each delay slot is 5 msec (when br=1) and 54 msec (when br=0). if two modems attempt to transmit at the same time, the random time delay after packet failure allows only one modem to transmit the packet successfully; while the other modem waits until the channel available for rf transmission. rn command is only applicable if retries have been enabled [rr (retries) command] or if forced delays will be inserted into a transm ission [tt (streaming limit) command]. ro (packetization timeout) command the ro command is used to set/read the packetization timeout setting. rf transmission begins when data is in the di buffer and either of the following criteria are met: ? ro character times of silence on the uart receive lines (after rece iving at least 1 byte) ? rb characters have be en received by the uart rb and ro criteria only apply to the first packet of a multi-packet transmission. if data remains in the di buffer (uart receive) after the first packet, transmissions will continue in a streaming man- ner until there is no data left in the di buffer. when ro is the transmission-beginning criteria : the actual time between the reception of the last character from the uart and the beginning of rf transmission will be at least 800 sec longer than the actual ro time to allow for transmission setup. additionally, it is subject to 100- 200 sec of additional uncertainty, which could be significant for small values of ro at high uart bit rates. the correct uart character time (10, 11, or 12 bits) is calcul ated based on the following criteria: ?1 start bit ? 8 data bits ? 0 or 1 parity bit [as determined by the nb (parity) command) ? 1 or 2 stop bits [as determined by sb (stop bits) command] at command: atrn binary command: 0x19 (25 decimal) parameter range: 0 - 0xff [38 ms slots] default parameter value: 0 (no delay slots inserted) number of bytes returned: 1 related commands: rr (retries), tt (streaming limit) at command: atro binary command: 0x21 (33 decimal) parameter range: 0 - 0xffff [ x uart character times ] default parameter value: 3 number of bytes returned: 2 related commands: rb (packetization threshold)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 40 chapter ? 4 ?\? rf ? modem ? configuration rp (rssi pwm timer) command rp command is used to enable a pwm ("pulse width modulation") output on the config/rssi pin (pin 11 of the oem rf module). the pin is calibrated to show the difference between received signal strength and the sensi- tivity level of the rf modem. pwm pulses vary from zero to 95 percent. zero percent means the received rf signal is at or below the published sensitivity level of the modem. the following table shows db levels above sensitivity and pwm values (the total time period of the pwm output is 8.32 ms. pwm output consists of 40 steps and therefore the minimum step size is 0.208 ms.): a non-zero value defines the time that pwm output is active with the rssi value of the last received rf packet. after the set time when no rf packets are received, pwm output is set low (0 percent pwm) until another rf pa cket is received. 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 between pwm outp ut and config input. when the modem is pow- ered, the config pin is an input. during the po wer-up sequence, if rp parameter is a non-zero value, the config pin is configured as an output and set low until the first rf packet is received. with a non-zero rp parameter, the config pin is an input for rp ms after power up. rr (retries) command the rr command is used to set/read the ma ximum number of retries sent for a given rf pack et. when rr command is enabled (rr>0), rf pack et retries and acks (acknowledgement s) are enabled. exceptions: if the mt command in enabled (mt>0) or if a broadcas t destination address is used (dt = 0xffff); rf packet retries and acks are disabled. after transmitting a packet, the transmitting rf modem waits to receive an acknowledgement from a receiving modem. if the acknowledgement is no t received in the period of time specified by rn (delay slots) command, the or iginal packet is transmitted agai n. the rf packet is transmitted repeatedly until an acknowledge ment is received or until the packet is sent rr times. tab le ? 4 \ 04. pwm ? va l u e s dbm above sensitivity pwm percentage (high period / total period) 10 20% 20 35% 30 50% at command: atrp binary command: 0x22 (34 decimal) parameter range: 0 - 0xff [x 100 milliseconds] default parameter value: 0x20 (32d) number of bytes returned: 1 at command: atrr binary command: 0x18 (24 decimal) parameter range: 0 - 0xff default parameter value: 0x0a (10 decimal) number of bytes returned: 1
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 41 chapter ? 4 ?\? rf ? modem ? configuration rt (gpi1 configuration) command the rt command is used to set/read the behavior of the gpi1 pin (gpi1) of the oem rf module. the pi n can be configured to enable binary programming or rts flow control. sb (stop bits) command the sb command is used to set/read the number of stop bits in the data packet. sh (serial number high) command sh command is used to set/read the serial number high word of the rf modem. sl (serial number low) command sl command is used to set/read the serial number low word of the rf modem. at command: atrt binary command: 0x16 (22 decimal) parameter range: 0 - 2 parameter configuration 0 disabled 1 enable binary programming 2 enable rts flow control default parameter value: 0 number of bytes returned: 1 ld d (l d) at command: atsb binary command: 0x37 (55 decimal) parameter range: 0 - 1 parameter configuration 01 stop bit 12 stop bits default parameter value: 0 number of bytes returned: 1 at command: atsh binary command: 0x25 (37 decimal) parameter range (rea d-only): 0 - 0xffff default parameter value: varies number of bytes returned: 2 related commands: sl (serial number low) at command: atsl binary command: 0x26 (38 decimal) parameter range (read- only): 0 - 0xffff default parameter value: varies number of bytes returned: 2 related commands: sh (serial number high)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 42 chapter ? 4 ?\? rf ? modem ? configuration sm (sleep mode) command the sm command is used to set/read the rf modem's sleep mode set- tings that configure the modem to run in states that require minimal power consumption. st (time before sleep) command the st command is used to set/read the peri od of time (in millisec- onds) in which the rf modem remains inactive before entering sleep mode. for example, if the st pa rameter is set to 0x64 (100 decimal), the modem will enter into sleep mode after 10 seconds of inactivity (no transmit- ting or receiving). this command can only be used if cyclic sleep or serial port sleep mode settings have been selected using sm (s leep mode) command. tp (board temperature) command tp command is used to read the current temperature of the board. sample output: 26 c [when atcf = 0] 1a [when atcf = 1] 26 [when atcf = 2]. at command: atsm binary command: 0x01 parameter range: 0 - 8 (3 is reserved) parameter configuration 0 disabled 1pin 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 sleep 7 cyclic 8.0 second sleep 8 cyclic 16.0 second sleep default parameter value: 0 number of bytes returned: 1 related commands: pin sleep - pc (power-up mode), pw (pin wake-up) serial port sleep - st (time before sleep) cyclic sleep - st (time before sleep), lh (wake-up initializer timer), ht (time before wake-up initializer), pw (pin wake-up) at command: atst binary command: 0x02 (2 decimal) parameter range: (a tat+3) - 0x7fff [x 100 milliseconds] default parameter value: 0x64 (100 decimal) number of bytes returned: 2 related commands: sm (sleep mode), lh (wake-up initializer timer), ht (time before wake-up initializer) at command: attp binary command: 0x38 (56 decimal) parameter range (rea d-only): 0- 0x7f number of bytes returned: 1 related command: wn (warning data)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 43 chapter ? 4 ?\? rf ? modem ? configuration tr (transmit error count) command the tr comm and is used to report the number of retransmit failures. this number is incremented each time a packet is not acknowl- edged within the number of retransmits specified by the rr (retries) parameter. the number of packets therefore are counted that were not suc- cessfully received and subsequently discarded. the tr parameter is not no n-volatile and is reset to zero when the rf modem is reset. tt (streaming limit) command the tt command is used to set/read the limit on the number of bytes that can be sent out be fore a random delay is issued. if an rf modem is sending a continuous stream of rf data, a delay is inserted which stops its trans- mission and allows other modems time to trans- mit (once it sends tt bytes of data). inserted random delay lasts between 1 & 'rn + 1' delay slots, where each delay slot lasts 38 ms. the tt command can be used to simulate full-duplex behavior. tx (transmit only) command the tx command is used to set/ read the transmit/receive behaviors of the rf modem. setting a modem to tx-only (tx = 1) may reduce latency because the transmitting modem will never be confined to receiving data from other modems. vl (firmware version - verbose) the vl command is used to read the verbose firmware version of the rf modem. vr (firmware version - short) command 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 pro- grammed for operation in australia only. at command: attr binary command: 0x1b (27 decimal) parameter rang e: 0 - 0xffff default parameter value: 0 number of bytes returned: 2 related commands: rr (retries) at command: attt binary command: 0x1a (26 decimal) parameter range: 0 - 0xffff default parameter value: 0 (disabled) number of bytes returned: 2 related commands: rn (delay slots) at command: attx binary command: 0x3f (63 decimal) parameter range: 0 - 1 parameter configuration 0tx & rx 1tx-only default parameter value: 0 number of bytes returned: 1 at command: atvl parameter range: returns string default parameter value: 0 number of bytes returned: 2 at command: atvr binary command: 0x14 (20 decimal) parameter range (rea d-only): 0 - 0xffff number of bytes returned: 2
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 44 chapter ? 4 ?\? rf ? modem ? configuration wa (active warning numbers) command the wa command reports the warning numbers of all active warnings - one warning number per line. no further information is shown and warning counts are not reset. sample output (indicates warnings 1 and 3 are currently active): 1 3 ok wn (warning data) command wn command is used to report the following data for all active and sticky warnings: ? warning number & description ? number of occurrences since the last wn or ws command ? whether the warning is currently active warnings, which are not currently active and have not been active since the last issuance of the wn or ws commands, are not displayed. the wn command also resets all non-zero warning counts; except for warnings that are presently active, which are set to 1. sample output: warning 4: over-temperature 5 occurrences; presently inactive. wr (write) command <(special)> the wr command is used to write configurable parameters to non-volatile memory (values remain in the modem's memory until overwritten by another use of wr command). if changes are made without writing them to non- volatile memory, the modem will revert back to previously saved parameters the ne xt time the mode m is powered-on. if the non-volatile user configurat ion is not correct, wr will re-a ttempt (up to 3x). if all three attempts fail, the command wi ll return an error alert. ws (sticky warning numbers) command the ws command reports warning numbers of all warnings active since the last use of the ws or wn command (including any warn- ings which are currently active). this command also resets all non-zero warning counts, except for warnings that are presentl y active, which are set to 1. 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/wh en the voltage rises above the threshold, the warning is deactivated. th e module will not transmit below this voltage threshold. 2 over-voltage. this is caused if the supply voltage exceeds 5.75 v. transmission is not allowed while this warning is active. 3 under-temperature. this is caused if the temperature sensed by the module is less than -40 c. the module does not artificially limit operation while this warning is active, but module functionality is not guaranteed. 4 over-temperature. this is caused if the temperature sensed by the module is greater than 105 c. the module does not allow trans mission nor reception while this warning is active. the warning is deactivated when the temperature falls to 100 c. 5 power reduced. this is caused if the transmit power has to be reduced from the level programmed by pl command due to insufficie nt supply voltage. the 1 w power level requires 4.75 v or higher; 500 mw requires 3.0 v or higher; 100 mw, 10 mw and 1 mw require 2.8 v o r higher. 6 default calibration data in flash. this is caused if the module -specific power calibration data is either not present or is inv alid, or if none of the parameters have been modified from their default values. power levels may be incorrect. 7 default configuration parameters in flash. this is caused if user-modifiable parameters (i.e. those stored by a 'wr' command) i n flash are all the compiled-in default values. this is caused if the user configur ation is found to be not present or invalid at power-up and ther e is no custom configuration, or if no user-modifiable parameters have been modified from the compiled-in defaults. m odification of one or mor e parameters without the subsequen t wr to commit the changes to flash will not deactivate this warning, sinc e it reflects th e status of the parameters in flash. note that this warning does not reflect usage of the custom c onfiguration defaults, only usage of the compiled-in defaults. 8 default factory configuration parameters in flash. this is c aused if the factory parameters in flash are all the default values . this is caused if the factory configuration is found to be not present or invalid at power-up, or if no factory parameters have been modified. at command: atwa parameter range: retur ns string - one warning number per line. at command: atwn parameter range: returns string at command: atwr binary command: 0x08 at command: atws parameter range (r ead-only): 1 - 8 number of bytes returned: 1
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 45 chapter ? 4 ?\? rf ? modem ? configuration 4.5. api operation by default, xtend rf modems act as a serial line repl acement (transparent operation) - all uart data received through the di pin is queued up for rf transmission. when the modem receives an rf packet, the data is sent out the do pin with no additional information. inherent to transparent operation are the following behaviors: ? if modem parameter registers are to be set or queried, a special operation is required for transitioning the modem into command mode [refer to p20]. ? in point-to-multipoint systems, the application must send ex tra information so that the receiving modem(s) can dist inguish between data coming from different remotes. as an alternative to the defaul t transparent operation, api (a pplication programming interface) operations are available. api op eration requires that communic ation with the modem be done through a structured interface (dat a is communicated in frames in a defined order). the api spec- ifies how commands, command responses and mode m status messages are sent and received from the modem using a uart data frame. 4.5.1. api frame specifications two api modes are supported and both can be en abled using the ap (api enable) command. use the following ap parameter valu es to configure the modem to operate in a particular mode: ? ap = 0 (default): transparent operat ion (uart serial line replacement) api modes are disabled. ?ap = 1: api operation ?ap = 2: api operation (w ith escaped characters) any data received prior to the start delimiter is si lently discarded. if the frame is not received cor- rectly or if the checksum fails, the data is silently discarded. api operation (ap parameter = 1) when this api mode is enabled (ap = 1), the ua rt data frame structure is defined as follows: figure ? 4 \ 03. uart ? data ? frame ? structure: 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 ua rt data frame structure is defined as follows: figure ? 4 \ 04. uart ? data ? frame ? structure ?\? with ? escape ? control ? characters: 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. 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? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 46 chapter ? 4 ?\? rf ? modem ? configuration data bytes that need to be escaped: ? 0x7e ? frame delimiter ?0x7d ? escape ? 0x11 ? xon ? 0x13 ? xoff 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 frame delimiter and leng th) is calculated as: 0xff - (0x23 + 0x11) = (0xff - 0x34) = 0xcb. checksum to test data integrity, a checksum is ca lculated and verified on non-escaped data. to calculate : not including frame delimiters and length , add all bytes keepin g only the lowest 8 bits of the result an d subtract from 0xff. to verify : add all bytes (inc lude checksum, but not the delimiter and length). if the checksum is correct, the sum will equal 0xff. 4.5.2. api types frame data of the uart data frame form s an api-specific structure as follows: figure ? 4 \ 05. uart ? data ? frame ? & ? api \ specific ? structure: the cmdid frame (api-identifier) indicates which api messages will be contained in the cmddata frame (identifier-specific data). refer to the sections that follow for more information regarding the supported api types. note that mu lti-byte values ar e sent big endian. rf modem status api identifier: 0x8a rf modem status messages are sent from the modem in response to specific conditions. figure ? 4 \ 06. ? rf ? modem ? status ? frames example - raw uart data frame (before escaping interfering bytes): 0x7e 0x00 0x02 0x23 0x11 0xcb 0x11 needs to be escaped which re sults in the following frame: 0x7e 0x00 0x02 0x23 0x7d 0x31 0xcb length (bytes 2-3) checksum (byte n + 1) msb lsb 1 byte start delimiter (byte 1) 0x7e frame data (bytes 4- n ) api-specific structure identifier-specific data cmddata api identifier cmdid cmddata 0x8a length checksum start delimiter frame data identifier-specific data api identifier msb lsb 0x7e 1 byte api-specific structure status (byte 5) 0 = hardware reset 1 = watchdog timer reset
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 47 chapter ? 4 ?\? rf ? modem ? configuration tx (transmit) request: 16-bit address api identifier value: 0x01 a tx request message will cause the modem to send rf data as an rf packet. figure ? 4 \ 7. tx ? packet ? (16 \ bit ? address) ? frames figure ? 4 \ 8. example: ? tx ? packet ? api ? frames ?? tx (transmit) status api identifier value: 0x89 when a tx request is completed, the modem sends a tx status me ssage. this message will indi- cate if the packet was transmitted su ccessfully or if there was a failure. figure ? 4 \ 9. tx ? status ? frames note: ?status = 1? occurs when all retr ies are expired and no ack is received. ?status = 3? occurs when a packet is purged due to a ?polled remote? not receiving a poll. rx (receive) packet: 16-bit address api identifier value: 0x81 when the modem receives an rf packet, it is sent out the uart using this message type. figure ? 4 \ 10. rx ? packet ? (16 \ bit ? address) ? frames cmddata 0x01 length checksum start delimiter frame data identifier-specific data api identifier msb lsb 0x7e 1 byte api-specific structure frame id (byte 5) identifies the uart data frame for the host to correlate with a subsequent ack (acknowledgement). setting frame id to ?0' will disable response frame. destination address (bytes 6-7) msb first, lsb last. broadcast = 0xffff options (byte 8) 0 = standard 1 = disable ack rf data (byte(s) 9-n) up to 2048 bytes per packet * ? length ? [bytes] ? = ? api ? identifier ? + ? frame ? id ? + ? destination ? address ? + ? option ? + ? rf ? data ** ? ?r? ? value ? was ? arbitrarily ? selected checksum 0x18 byte 12 destination address bytes 6-7 0xffff option 0x00 byte 8 frame id** r (0x52) byte 5 length* bytes 2-3 0x00 0x08 api identifier 0x01 byte 4 start delimiter byte 1 0x7e rf data 1 (0x31) 2 (0x32) 3 (0x33) bytes 9-11 cmddata 0x89 length checksum start delimiter frame data identifier-specific data api identifier msb lsb 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 command response w ill be given. cmddata 0x81 length checksum start delimiter frame data identifier-specific data api identifier msb lsb 0x7e 1 byte api-specific structure bit 0 = ack bit 1 = indicate broadcast bits 2-7 [reserved] up to 2048 bytes per packet received signal strength indicator - hexadecimal equivalent of (-dbm) value. (for example: if rx signal strength = -40 dbm, ?0x28? (40 decimal) is returned) source address (bytes 5-6) rssi (byte 7) msb (most significant byte) first, lsb (least significant) last options (byte 8) rf data (byte(s) 9-n)
? ? 2007 ? maxstream, ? inc. ????? 48 5. ? rf ? communication ? modes the network configurations covered in this ch apter are described in terms of the following: ? network topology (point-to-point, point-to-multipoint or peer-to-peer) ? rf communication type (basic or acknowledged) ? rf mode (streaming, multi-transmit , repeater, acknowledged or polling) the following table provides a summary of the network configurations supported. * ? assume ? default ? values ? for ? parameters ? not ? listed. ? profiles ? do ? not ? reflect ? addressing ? implementations. ** ? am ? (auto \ set ? my) ? command ? must ? be ? issued ? through ? a ? terminal ? program ? such ? as ? the ? one ? incorporated ? in ? the ? x \ ctu ?? terminal ?? tab. tab le ? 5 \ 01. summary ? of ? network ? topologies ? supported ? by ? the ? xtend ? rs \ 232/485 ? rf ? modem point-to-point definition an rf data link between two modems. sample network profile * (broadcast communications) use default values for all modems. sample network profile * (acknowledged communications) all modems: atam [auto-set my (source address) parameter] ** atdt ffff [set destination address to 0xffff] basic rf modes streaming, multi-transmit, repeater acknowledged rf mode acknowledged mode point-to-multipoint definition rf data links between one base and multiple remotes. sample network profile * (basic communications) base: atmy 0 [set source address to 0x00] atdt ffff [set destination address to 0xffff] remotes: atam [auto-set my (source address) parameter] ** atdt 0 [set destination address to 0x00] sample network profile * (acknowledged communications) base: atmy 0 [set source address to 0x00] atdt ffff [set destination address to 0xffff] atrr 3 [set number of retries to 3] remotes: atam [auto-set my (source address) parameter] ** atdt 0 [set destination address to 0x00] atrr 3 [set number of retries to 3] basic rf modes streaming, multi-transmit, repeater, polling acknowledged rf modes acknowledged, polling peer-to-peer definition rf modems remain synchronized without use of master/server dependencies. each modem shares the roles of master and slave. maxstream's peer-to-peer architectu re features fast synch times (35ms to synchronize modems) and fast cold start times (50ms before transmission). sample network profile * (basic communications) use default values for all modems. sample network profile * (acknowledged communications) all modems: atam [auto-set my (source address) parameter] ** atdt ffff [set destination address to 0xffff] atrr 3 [set number of retries to 3] basic rf mode streaming acknowledged rf mode acknowledged
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 49 chapter ? 5 ?\? rf ? communication ? modes 5.1. addressing each rf packet contains addressing information that is used to fi lter incoming rf data. receiving modules inspect the hopping channel (hp paramete r), vendor identificati on number (id parame- ter) and destination addr ess (dt parameter) contained in each rf packet. data that does not pass through all three network secu rity layers is discarded. figure ? 5 \ 01. addressing ? layers ? contained ? in ? the ? rf ? packet ? header 5.1.1. address recognition transmissions can be addressed to a specific mo dem or group of modems using the dt (destina- tion address) and mk (address mask ) commands. a receiving modem will only accept a packet if it determines the packet is addressed to it, either as a global or local pa cket. the receiving modem makes this determination by inspecting the destin ation address of the packet and comparing it to its own address and address mask [refer to the figure below]. figure ? 5 \ 02. address ? recognition ? (@ ? the ? receiving ? rf ? modem) tx_dt ? = ? destination ? address ? of ? transmitting ? modem rx_dt ? = ? destination ? address ? of ? receiving ? modem rx_mk ? = ? address ? mask ? of ? receiving ? modem rx_my ? = ? source ? address ? of ? receiving ? modem ? the transmitting modem determines whether the pa cket is intended for a specific node (local address) or multiple nodes (global address) by comparing the packet's destination address (dt) and its own address mask (mk) [refer to the figu re below]. it is assumed that the address masks on the transmitting modem and receiving modem have been programmed to the same value for proper operation in each rf communication mode. figure ? 5 \ 03. address ? recognition ? (@ ? the ? transmitting ? rf ? modem)
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 50 chapter ? 5 ?\? rf ? communication ? modes 5.2. basic communications basic communications are accomplished through two sub-types: ? broadcast - by default, xtend rf modems communicate through broadcast communications and within a peer-to-pe er network topology. when any mo dem transmits, all other modems within range will receive the data and pa ss it directly to their host device. ? addressed - if addres sing parameters match are in order, received rf data is forwarded to the do (data out) buffer; otherwise, the rf data is discarded. when using basic communications, any functions such as acknowledgement s are handled at the application layer by the oem/in tegrator. the broadcast modes provide transparent communica- tions, meaning that the rf link simply replaces a wired link. 5.2.1. streaming mode (default) characteristics : highest data throughput lowest latency and jitter reduced immunity to interference transmissions never acknowledged (ack) by receiving module(s) required parameter values (tx modem) : rr (retries) = 0 related commands : networking (dt, mk, my), seri al interfacing (pk, rb, ro, tt) recommended use : mode is most appropriate for data sy stems more sensitive to latency and/or jitter than to occasional packet loss . for example: stream ing audio or video. connection sequence figure ? 5 \ 04. streaming ? mode ? state ? diagram ? (tx ? module) ? events & processes in this mode are common to all of the other rf modes. ? when streaming data, rb and ro parameters are only observed on the first packet. after transmission begins, the transmission event will con- tinue uninterrupted until the di buffer is empty or the streaming limit (tt parameter) is reached. as with the first packet, the payload of each subsequent packet includes up to the maximum packet size (pk parameter). the tt parameter (streaming li mit) is specified by the tx (transmitting) modem as the maximum number of bytes the tx module can send in one transmission event. after the tt parameter threshold is reached, the tx modem will force a random delay of 1 to rn delay slots (exactly 1 delay slot if rn = 0). subsequent packets are sent without an rf initializer since rx (receiving) modems remain synchronized with the tx modem for the duration of the transmission (from preceding packet information). however, due to interfere nce, some rx modems may lose data (and synchronization to the tx modem), particularly during long transmission events. once the tx modem has sent all pending data or has reached the tt limit, the transmission event ends. the tx modem will not transmit again for exactly rn delay slots if the local (i.e. tx modem's) rn parameter is set to a non- zero value. the rx modem(s) wi ll not transmit for a random number of delay slots between 0 and (rn-1) if the local (i.e. receiving module's) rn parame ter is set to a non-zero value. these delays are intended to lessen congestion fol- lowing long bursts of packet s from a single tx modem, dur- ing which several rx modems may have become ready to transmit.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 51 chapter ? 5 ?\? rf ? communication ? modes 5.2.2. multi-transmit mode attributes: reliable delivery through forced transmission of every rf packet every rf packet is sent exactly (mt + 1) times with no delays between packets diminished throughput and increased latency required parameter values (tx modem): mt (multi-transmit) >= 1 other related commands: networking (dt, mk, my, rn, tt), serial interfaci ng (br, pk, rb, ro), rf interfacing (fs) recommended use: use for applications that require reliable delivery without using retries and acknowledgements. connection sequence figure ? 5 \ 05. multi \ transmit ? mode ? state ? diagram ? (tx ? module) in multi-transmit mode, each packet is retrans- mitted mt times, for a total of (mt+1) trans- missions. there is no delay between retransmissions, and the tx (transmitting) modem will never rece ive rf data between retransmissions. each retransmission includes an rf initializer. a transmission event may include follow-on packets, each of which will be retransmitted mt times. the forced sync (fs) parameter is ignored in multi-transmit mode. the rb and ro parameters are not applied to follow-on packets, meaning that once trans- mission has begun, it will continue uninter- rupted until the di buffer is empty or the streaming limit (tt pa rameter) has been reached. as with the first packet, the payload of each follow-on packet includes up to the maximum packet size (pk parameter) bytes, and the tx modem checks for more pending data near the end of each packet. follow-on packets are not sent until all retransmissions of the previous packet are finished. the streaming limit (tt) is specified at the tx modem as the maximum number of bytes that the tx modem can send in one transmission event, which may consist of many packets. if the tt parameter is re ached, the tx modem will force a random delay of 1 to rn delay slots (exactly 1 delay slot if rn is zero). in multi- transmit mode, each packet is counted only once when tracking th e streaming limit (tt), no matter how many time s it is retransmitted. when an rx (receiving ) module receives a multi-transmit packet, it calculates the amount of time remaining in th e multi-transmit event, and inhibits its own transmissions for the dura- tion of the multi-transmit event, plus a random number of delay slots between 0 and (rn-1). if th e local rn parameter is zero, the delay is only for the calculated duration of the multi-transmit event. thus, an rx modem need only receive one of the transmissions, and it will keep off the channel until the tx modem is done. if follow-on packets are coming, the rx modems will move to the new frequency and li sten for the follow-on packet for a specific period of time.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 52 chapter ? 5 ?\? rf ? communication ? modes 5.2.3. repeater mode attributes: low power consumption minimized interference each rf packet is tagged wi th a unique packet id (pid). each repeater will repe at a packet only once (tracked by the pid). increased latency and decreased throughput (latency and throughput is determined by number of hops, not by number of repeaters. multiple repeaters within ra nge of source node count as one hop.) all rf packets propagate to every modem in the network (filtering rules apply). packet destination addresses (dt) determ ine which packets are sent out serial port and/or retransmitted. broadcast communications - each packet comes out every node exactly once. addressed communications - all modems see every packet. only the modem with a matching address will forwar d it to the do buffer (uart in). constraints: requires that each modem have a un ique my (source address) parameter. system must introduce just one packet at a time to the network for transmission (maximum number of bytes is de termined by the pk parameter). each hop (h) decreases network throughput by a factor of 1/(h+1). additional repeaters add network redundancy without decreasing throughput. suggestions: insert a variable delay before repe ating packets to avoid collisions (based on rssi). buffer any incoming serial data and dela y response packet transmissions until previous packet has cleared out of network. for best results, us e the ro and rb commands to ensure that the rf packets align with the underlying protocol packet s as the network can only accept one rf packet at a time. required parameter values (tx modem): md = 5 or 6, my = unique value (can be accom- plished by issuing the am (auto-set my) and wr (write) commands to all modems in the network) related commands: networking (md, dt, my, am), se rial interfacing (rn, pk, ro, rb) recommended use: use in networks where intermediary modems are needed to relay data to modems beyond the transmissi on range of the base modem. theory of operation oems and integrators can extend th e effective range and reliability of their data radio system by forwarding traffic through one or more repeaters. instea d of using routing tables and path discov- ery to establish dynamic paths through a network, the repeater system uses a sophisticated algo- rithm to propagate each rf pack et through the entire network. the network supports rf packets up to 2048 bytes (when the rf data rate is set at 9600 bps (br = 0)). the repeater network can operate using broadcast or addressed communications for multi- drop networks and works well in many systems with no special configuration. when in repeater mode, the network repeats ea ch message among all av ailable modems exactly one time. this mechanism eliminates the need for configuring specific routes. figure ? 5 \ 06. repeater ? network ? topology
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 53 chapter ? 5 ?\? rf ? communication ? modes repeater networ k configuration a network may consist of end nodes (en), end/re peater nodes (ern) and a base node (bn). the base node initiates all communications. a repeater network can be configured to operat e using basic broadcast or basic addressed com- munications. the addressing capabilities of the mo dem allow integrators to send a packet as a glo- bal packet (dt = 0xffff) and shift out of every modem in the network (basic broadcast). alternatively, the packet can be sent with a specific dt (destination address) parameter so that it is only accepted by a specific remote node (bas ic addressed). configuration instruction (bas ic broadcast communications) the configuration instructions above reflect conf iguration for a basic broa dcast repeater system. to configure a basic addressed repeater system, use the dt (destination address) parameter to assign unique addresses to each modem in the network. algorithm details ? packet id (pid) is composed of tx (transmi tting) modem my addre ss and packet sequence number. ? incoming packets with a pi d already found in the pid buffer will be ignored. ? each modem maintains a pid buffer 4 deep of previously received packets (managed as fifo). packets may be shifted out the se rial port and/or repeated depe nding on the dt parameter con- tained in the rf packet. repeat delay based on rssi a transmitted packet may be received by more that one repeat er at the same ti me. in order to reduce the probability that the repeaters will transmit at the same instant, resulting in a collision and possible data loss; an algori thm has been developed that will allow a variable back-off prior to retransmission of the packet by a repeater. the algorithm allows radios that receive the packet with a stronger rf signal (rssi) to have th e first opportunity to retransmit the packet. the rn (delay slots) parameter is used to conf igure this delay. set rn =0 (no delays) for small networks with few repeaters or re peaters that are not within range of each other. set rn=1 for systems with 2 to 5 repeaters that ma y be within range of each other. the actual length of the delay is computed by the formula: delay (ms) = l * ds ds = (-41-rssi)/10*rn)+randomint(0,rn) where l is the length of the transmitted packet in milliseconds, ds is the number of delay slots to wait, rssi is the received signal strength in dbm, rn is the value of the rn register and random- int(a,b) is a function that returns a random integer from a to b-0 assign each modem a unique my (source) address. (the am (auto-set my) command will con- figure a unique source address that is based on modem serial number.) enable basic broadcast communications (dt = 0xffff) or addresse d broadcast communica- tions (dt specifies a specific destination) configure pk, ro and rb to ensure that rf packet aligns with protocol packet. (ex. pk=0x100, rb=0x100, ro depends on baud rate). configure one or more repeat ers in the system (md = 5). configure remote nodes as destin ations (md = 6). this will ensure that the remote node waits for the repeater traffic to subsid e before it transmits a response. tab le ? 5 \ 02. dt ? (destination ? address) ? parameter ? truth ? table address match send out serial port? repeat? global yes yes local yes no none no yes
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 54 chapter ? 5 ?\? rf ? communication ? modes response packet delay as a packet propagates th rough the repeater network, if any no de receives the data and generates a quick response, the response needs to be delayed so as not to collide with subsequent retrans- missions of the original packet. to reduce coll isions, both repeater an d end node radios in a repeater network will delay transm ission of data shifted in the se rial port to allow any repeaters within 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 milliseconds, ds is the number of delay slots to wait, rssi is the received signal strength in dbm, and rn is the value of the rn register. use case - broadcast repeater network consider modems r1 through r10 each communic ating to a plc using the modbus protocol and spaced evenly in a line. all ten modems are conf igured as 'destinations & repeaters' within the scope of basic broadcast communications (md=5, am, dt=0xffff, pk=0x100, ro=0x03, rb=0x100, rn=1). the base host (bh) shifts payload that is destined for r10 to r1. r1 initializes rf communication and transmits payload to nodes r2 through r5 which are all within range of r1. the modems r2 through r5 receive the rf packet and retransmit the packet simultaneously. they also send the data out the serial ports, to the plcs. bandwidth considerations using broadcast repeaters in a network reduces the overall netw ork data throughput as each repeater must buffer an en tire packet before retransmitting it . for example: if the destination is within range of the transmitter and the packet is 32-bytes long, the transmission will take 12ms on an xtend modem operating at 115,200 baud. if the same packet must propagate through two repeaters, it will take 12ms to a rrive at the first repeater, 12ms to get to the second and a final 12ms to reach the destination for a total of 36ms . taking into account uart transfer times (~1ms/ byte at 9600 baud), a server to send a 32-byte query and receive a 32-b yte response is about 200ms, allowing for 5 polls per second. with the two repeaters in the path, the same query/ response sequence would take about 500ms for 2 polls per second. generally, network throughput will decrease by a factor of 1/(r+1), with r representing the num- ber of repeaters between th e source and destination. tab le ? 5 \ 03. commands ? used ? to ? configure ? repeater ? functions at command binary command at command name range # bytes returned factory default am 0x3a (58d) auto-set my - - - dt 0x00 (0d) destination address 0 - 0xffff 2 0 md 0x3c (60d) rf mode 0 - 6 1 0 my 0x2a (42d) source address 0 - 0xffff 2 0xffff rn 0x19 (25d) delay slots 0 - 0xff [slots] 1 0 wr 0x08 (8d) write - - -
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 55 chapter ? 5 ?\? rf ? communication ? modes 5.2.4. polling mode (basic) note: polling mode (basic) and polling mode (ack nowledged) [p58] operate in the same way. the only difference between the two mode s is in their means of achieving reliable delivery of data. in polling mode (basic), reliable delivery is achieved using multiple transmissions. attributes: utilizes high percentage of available network bandwidth eliminates collisions works with reliable delivery (rr or mt parameters) supports binary data transfers base modem requests packets from remote mode m by polling a sequential range of addresses base modem is configured to specif y the range of addresses being polled uses inter-character delay to create rf packet lengths aligned with protocol packet lengths up to 2048 bytes long. required parameter values (base): md (rf mode) = 3, pb (polling begin address), pe (polling end address) required parameter value (remote): md (rf mode) = 4 related commands: networking (mt, pd, dt, my, am) constraints: the minimum time interval between polling cycles is configurable. however, if the remote modems cannot all be processed wi thin that time interval, the polling cycle is ineffective (i.e. it will impose no additional delay). in or der to ensure a pause be tween polling cycles, pd must be set to a value which is la rge enough to accommodate the pause. recommended use: use for point-to-multipoint applications that require reliable delivery of data. use this mode when it is critical that a base modem be able to di scern data coming from multiple modems. theory of operation a ?polling base? modem will cycle through a sequential range of addresses. the ?polling base? will poll each ?polling remote? modem, wait for a resp onse, then poll the next remote address in the sequence. each ?polling remote? will respond by sending the data from its di (data in) buffer fol- lowing the rb (packetization threshold) & ro (packetization timeout) parameters. when there is no eligible data to send, the ?polling remote? will not respond. the ?polling base? will poll the next address in the polling sequ ence after a short delay. polling base configuration: polling remote configuration: set the md (rf mode) parameter (md = 3). set my (source address) parameter (my = 0). set the sequential range of polling addresses using the pb (polling begin address) and pe (polling end address) parameters. (optional) enable basic reliable delivery (mt >= 0). note: acknowledged reliable delivery is also supported. refer to the ?polling mode - acknowledged? section fo r more information. (optional) use the pd (minimum polling delay) command to configure a delay between polls to slow down system (if needed). (optional) enable api mode to address remotes within polling range on a packet-by-packet basis. set the md (rf mode) parameter (md = 4). configure sequential source addresses for all remote modems using th e my (source address) command. set the dt (destination address) parameter to point to ?polling base? (dt = 0x0000). (optional) enable basic reliable delivery (mt >= 0). note: acknowledged reliable delivery is also supported. refer to the ?polling mode - acknowledged? section fo r more information.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 56 chapter ? 5 ?\? rf ? communication ? modes 5.3. acknowledged communications 5.3.1. acknowledged mode attributes: reliable delivery through positive acknowledgements for each packet throughput, latency and jitter vary depe nding on the quality of the channel and the strength of the signal. required parameter values (tx modem): rr (retries) >= 1 related commands: networking (dt, mk, rr), serial interfacing (pk, rn, ro, rb, tt) recommended use: use for applications that require reliable delivery. if messages are smaller than 256 bytes, use rb and ro commands to align rf packets to application packets. connection sequence figure ? 5 \ 07. acknowledged ? mode ? state ? diagram ? (tx ? modem) after sending a packet while in acknowledged mode, the tx (trans- mitting) modem listens for an ack (acknowledgement). if it receives the ack, it will either move on to sending a subsequent packet (if more transmit data is pending) or will wait for exactly rn random delay slots before allowing another trans- mission (if no more data is pending to be transmitted). if the tx modem does not receive the ack within the allotted time, it will retransmit the packet with a new rf initializer following the ack slot. there is no delay between the first ack slot and the first retransmission. subsequent retransmissions incur a delay of a random number of delay slots, between 0 and rn. if rn is set to 0 on the tx modem, there are never any back-off delays between retransmissions. note that during back-off delays, th e tx modem will go into idle mode and may receive rf data. this can have the effect of increasing the back-off delay, as the modem cannot return to transmit (or retransmit) mode as long as it is receiving rf data. after receiving and acknowledging a packet, the rx (receiving) modem will move to the next fre- quency and listen for either a retr ansmission or new data for a specif ic period of time. even if the tx modem has indicated that it has no more pend ing transmit data, it may not have received the previous ack, and so may retransmit the packet, po ssibly with no delay after the ack slot. in this case, the rx modem will always detect the immediate retransmission, which will hold off the com- munications channel and thereby reduce collisions. rx modems acknowledge each retransmission they receive, but they only pass the first copy of a pack et they receive out the uart. rb and ro parameters are not applied to subseq uent packets, meaning that once transmission has begun, it will continue unin terrupted until the di buffer is empty or the streaming limit (tt parameter) has been reached. as with the first packet, the payl oad of each subsequent packet includes up to the maximum packet size (pk parameter), and the tx modem checks for more pending data near the end of each packet.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 57 chapter ? 5 ?\? rf ? communication ? modes the tt parameter (streaming limit) specifies the maximum number of bytes that the tx modem will send in one transmission event, which may consist of many packets and retries. if the tt parameter is reached, the tx mode m will force a random delay of 1 to rn delay slots (exactly 1 delay slot if rn is zero). each packet is counted only once toward tt, no matter how many times the packet is retransmitted. subsequent packets in acknowledge d mode are similar to those in streaming mode, with the addi- tion of an ack between each packet, and the possibility of retransmissions. subsequent packets are sent without an rf initializer, as the rx modems are already synchronized to the tx modem from the preceding packet(s) and they remain synchronized for the duration of the transmission event. each retransmissi on of a packet includes an rf initializer. once the tx modem has sent all pending data or has reached the tt limit, the acknowledged transmission event is completed. the tx modem will not transmit again for exactly rn delay slots, if the local rn parameter is set to a non-zero value. the rx modem will not transmit for a random number of delay slots between 0 and (rn-1), if the local rn parameter is set to a non-zero value. these delays are intended to lessen congestion fo llowing long bursts of packets from a single tx modem, during which several rx modems may have themselves become ready to transmit.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 58 chapter ? 5 ?\? rf ? communication ? modes 5.3.2. polling mode (acknowledged) note: polling mode (acknowledged) and polling mode (basic) [p55] operate in the same way. the only difference between the two mode s is in their means of achieving reliable delivery of data. in polling mode (acknowledged), reli able delivery is achieved us ing retries and acknowledgements. attributes: utilizes high percentage of available network bandwidth eliminates collisions works with reliable delivery (rr or mt parameters) supports binary data transfers base modem requests packets from remote mode m by polling a sequential range of addresses base modem is configured to specif y the range of addresses being polled uses inter-character delay to create rf packet lengths aligned with protocol packet lengths up to 2048 bytes long. required parameter values (base): md (rf mode) = 3, pb (polling begin address), pe (polling end address) required parameter values (remote): md (rf mode) = 4 related commands: networking (rr, pd, dt, my, am) constraints: the minimum time interval between polling cycles is configurable. however, if the remote modems cannot all be processed wi thin that time interval, the polling cycle is ineffective (i.e. it will impose no additional delay). in or der to ensure a pause be tween polling cycles, pd must be set to a value which is la rge enough to accommodate the pause. recommended use: use for point-to-multipoint applications that require reliable delivery of data. use this mode when it is critical that a base modem be able to di scern data coming from multiple modems. theory of operation a ?polling base? modem will cycle through a sequential range of addresses. the ?polling base? will poll each ?polling remote? modem, wait for a resp onse, then poll the next remote address in the sequence. each ?polling remote? will respond by sending the data from its di (data in) buffer fol- lowing the rb (packetization threshold) & ro (packetization timeout) parameters. when there is no eligible data to send, the ?polling remote? will not respond. the ?polling base? will poll the next address in the polling sequ ence after a short delay. polling base configuration: polling remote configuration: set the md (rf mode) parameter (md = 3). set my (source address) parameter (my = 0). set the sequential range of polling addresses using the pb (polling begin address) and pe (polling end address) parameters. (optional) enable acknowledged reliable delivery (rr >= 0). note: basic reliable delivery is also supported. refer to the ?polling mode - basic section for more information. (optional) use the pd (minimum polling delay) command to configure a delay between polls to slow down system (if needed). (optional) enable api mode to address remotes within polling range on a packet-by-packet basis. set the md (rf mode) parameter (md = 4). configure sequential source addresses for all remote modems using th e my (source address) command. set the dt (destination address) parameter to point to ?polling base? (dt = 0x0000). (optional) enable acknowledged reliable delivery (rr >= 0). note: basic reliable delivery is also supported. refer to the ?polling mode - basic section for more information.
? ? 2007 ? maxstream, ? inc. ????? 59 appendix ? a: ? agency ? certifications fcc (united states) certification the xtend rs-232/485 rf modem complies with pa rt 15 of the fcc rules an d regulations. compli- ance with the labeling requirements, fcc noti ces and antenna usage gu idelines is required. in order to operate under maxstream?s fcc certific ation, oems/integrators must comply with the following regulations: labeling requirements warning: the original equipment manufactur er (oem) must ensure that fcc labeling requirements are met. this includes a clearly visible label on the outside of the final product enclosure that displays th e text shown in the figure below. figure ? a \ 01. required ? fcc ? label ? for ? oem ? products ? containing ? the ? xtend ? rs \ 232/485 ? rf ? modem ? fcc notices important: the xtend rs-232/485 rf modem has been certified by the fcc for use with other products without any further certification (as per fcc section 2.1091). modifications not expressly approved by maxstream could void the user's authority to operate the equipment. important: oems must test final product to comply with unintentional radiators (fcc section 15.107 & 15.109) before declaring compliance of their final product to part 15 of the fcc rules. important: the rf modem has been cert ified for remote and base radio applications. if the modem will be used for port able applications, the device must undergo sar testing. this equipment has been tested and found to comp ly with the limits for a class b digital device, pursuant to part 15 of the fcc rules. these limi ts are designed to provide reasonable protection against harmful interference in a residential installation. this equipment generates, uses and can radiate radio frequency energy and, if not installed and used in ac cordance with the instructions, 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 cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the inter- ference by one or more of the following measures: re-orient or relocate the receiving antenna, increase the separation between the equipment and receiver, connect equipment and receiver to outlets on different circui ts, or consult the dealer or an expe rienced radio/tv technician for help. 1. the oem/integrator must ensure that the text provided with this device [figure a-01] is placed on the outside of the final product an d within the final product operation manual. 2. the xtend rs-232/485 rf modem may only be used with antennas that have been tested and approved for use with this modem [refer to ?fcc-approved antennas? section]. contains fcc id: our-9xtend the enclosed device complies with part 15 of the fcc rules. operation is subject to the following two conditions: ( i. ) this device may not caus e harmful interference and ( ii. ) this device must accept any inter- ference received, including interference that may cause undesired operation.
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 60 appendix ? a: ? agency ? certifications limited modular approval power output is conducted at the antenna terminal and can be adjusted from 1 mill-watt to 1 watt at the oem level. this is an rf modem approved for limited modular use operating as a mobile transmitting device with respect to section 2.1091 and is limited to oem installation for mobile and fixed applications only. during final installation, end-users are prohibited from access to any pro- gramming parameters. professional installation adjustme nt is required for setting module power and antenna gain to meet eirp comp liance for high gain antenna(s). final antenna installation and operating configurat ions of this transmitter including antenna gain and cable loss must not exceed the eirp of the configuration used for calculating mpe. grantee (maxstream) must coordinate with oem integrators to ensure the end-users and installers of prod- ucts operating with the modem are provided with operating instructions to satisfy rf exposure requirements. the fcc grant is valid only when the device is sold to oem integr ators. integrators are instructed to ensure the end-user has no manual instructions to remove, adjust or install the device. fcc-approved antennas warning: this device has been tested with reverse polari ty sma connectors with the antennas listed in the tables of this sectio n. when integrated in to oem products, fixed antennas require installation preventing end-users from replacing them with non- approved antennas. antennas not listed in the tables must be tested to comply with fcc section 15.203 (unique antenna connectors) and section 15.247 (emissions). fixed base station and mobile applications maxstream rf modems are pre-fcc approved for use in fixed base stat ion and mobile applica- tions. when the antenna is mount ed at least 20cm (8") from near by persons, the application is considered a mobile application. portable applications and sar testing when the antenna is mounted closer than 20cm to nearby persons, then the application is consid- ered "portable" and requires an additional test be pe rformed on the final product. this test is called specific absorption rate (sar) testing and measures the emissions from the modem and how they affect the person. rf exposure this statement must be in cluded as a caution statement in oem product manuals. warning: this equipment is approved only for mobile and base station transmitting devices. antenna(s) us ed for this transmitter must be installed to provide a separation distance of at least 30 cm from all persons and must not be co-located or operating in conjunction with any other antenna or transmitter. note: the separation distance indicated in the ab ove is 30 cm, but any di stance greater than or equal to 23 cm can be used (per mpe evaluation).
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 61 appendix ? a: ? agency ? certifications antenna options (1-watt transmit power output or lower) tabl e ? a \ 01. half \ wave ? antennas ? (approved ? when ? operating ? at ? 1 \ watt ? power ? output ? or ? lower) * ? fcc ? regulations ? stipulate ? a ? 36 ? dbm ? eirp ? power ? requirement. ? users ? implementing ? antenna ? gain ? greater ? than ? 6.0 ? db ? must ? compensate ? for ? the ? added ? gain ? with ? cable ? loss. ? when ? operating ? at ? 1 ? w ? power ? output, ? the ? sum ? (in ? db) ? of ? cable ? loss ? and ? antenna ? gain ? shall ? not ? exceed ? 6.0 ? db. part number type connector gain application a09-hsm-7 straight half-wave rpsma 3.0 dbi fixed / mobile a09-hasm-675 articulated half-w ave rpsma 2.1 dbi fixed / mobile a09-habmm-p6i articulated half-wave w/ 6" pigtail mmcx 2.1 dbi fixed / mobile a09-habmm-6-p6i articulated half-wave w/ 6" pigtail mmcx 2.1 dbi fixed / mobile a09-hbmm-p6i straight half-wave w/ 6" pigtail mmcx 2.1 dbi fixed / mobile a09-hrsm right angle half-wave rpsma 2.1 dbi fixed a09-hasm-7 articulated half-wave rpsma 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 tabl e ? a \ 02. yagi ? antennas ? (approved ? when ? operating ? at ? 1 \ watt ? power ? output ? or ? lower) part number type connector gain required antenna cable loss application a09-y6 2 element yagi rpn 6.1 dbi 0.1 db* fixed / mobile a09-y7 3 element yagi rpn 7.1 dbi 1.1 db* fixed / mobile a09-y8 4 element yagi rpn 8.1 dbi 2.1 db* fixed / mobile a09-y6tm 2 element yagi rptnc 6.1 dbi 0.1 db* fixed / mobile a09-y7tm 3 element yagi rptnc 7.1 dbi 1.1 db* fixed / mobile a09-y8tm 4 element yagi rptnc 8.1 dbi 2.1 db* fixed / mobile tabl e ? a \ 03. omni \ directional ? base ? station ? antennas ? (approved ? when ? operating ? at ? 1 \ watt ? power ? output ? or ? lower) part number type connector gain required antenna cable loss application a09-f0 fiberglass base station rpn 0 dbi - fixed a09-f1 fiberglass base station rpn 1.0 dbi - fixed a09-f2 fiberglass base station rpn 2.1 dbi - fixed a09-f3 fiberglass base station rpn 3.1 dbi - fixed a09-f4 fiberglass base station rpn 4.1 dbi - fixed a09-f5 fiberglass base station rpn 5.1 dbi - fixed a09-f6 fiberglass base station rpn 6.1 dbi 0.1 db* fixed a09-f7 fiberglass base station rpn 7.1 dbi 1.1 db* fixed a09-f8 fiberglass base station rpn 8.1 dbi 2.1 db* fixed a09-w7 wire base station rpn 7.1 dbi 1.1 db* fixed a09-f0 fiberglass base station rpsma 0 dbi - fixed a09-f1 fiberglass base station rpsma 1.0 dbi - fixed a09-f2 fiberglass base station rpsma 2.1 dbi - fixed a09-f3 fiberglass base station rpsma 3.1 dbi - fixed a09-f4 fiberglass base station rpsma 4.1 dbi - fixed a09-f5 fiberglass base station rpsma 5.1 dbi - fixed a09-f6 fiberglass base station rpsma 6.1 dbi 0.1 db* fixed a09-f7 fiberglass base station rpsma 7.1 dbi 1.1 db* fixed a09-f8 fiberglass base station rpsma 8.1 dbi 2.1 db* fixed a09-w7sm wire base station rpsma 7.1 dbi 1.1 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 rptnc 3.1 dbi - fixed a09-f4tm fiberglass base station rptnc 4.1 dbi - fixed a09-f5tm fiberglass base station rptnc 5.1 dbi - fixed a09-f6tm fiberglass base station rptnc 6.1 dbi 0.1 db* fixed a09-f7tm fiberglass base station rptnc 7.1 dbi 1.1 db* fixed a09-f8tm fiberglass base station rptnc 8.1 dbi 2.1 db* fixed a09-w7tm wire base station rptnc 7.1 dbi 1.1 db* fixed
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 62 appendix ? a: ? agency ? certifications * ? fcc ? regulations ? stipulate ? a ? 36 ? dbm ? eirp ? power ? requirement. ? users ? implementing ? antenna ? gain ? greater ? than ? 6.0 ? db ? must ? compensate ? for ? the ? added ? gain ? with ? cable ? loss. ? when ? operating ? at ? 1 ? w ? power ? output, ? the ? sum ? (in ? db) ? of ? cable ? loss ? and ? antenna ? gain ? shall ? not ? exceed ? 6.0 ? db. antenna options (100 mw transmit power output or lower) tabl e ? a \ 04. mag ? mount ? antennas ? (approved ? when ? operating ? at ? 1 \ watt ? power ? output ? or ? lower) part number type connector gain required antenna cable loss application a09-m0sm mag mount rpsma 0 dbi - fixed a09-m2sm mag mount rpsma 2.1 dbi - fixed a09-m3sm mag mount rpsma 3.1 dbi - fixed a09-m5sm mag mount rpsma 5.1 dbi - fixed a09-m7sm mag mount rpsma 7.1 dbi -1.1 db* fixed a09-m8sm mag mount rpsma 8.1 dbi -2.1 db* fixed a09-m0tm mag mount rptnc 0 dbi - fixed a09-m2tm mag mount rptnc 2.1 dbi - fixed a09-m3tm mag mount rptnc 3.1 dbi - fixed a09-m5tm mag mount rptnc 5.1 dbi - fixed a09-m7tm mag mount rptnc 7.1 dbi -1.1 db* fixed a09-m8tm mag mount rptnc 8.1 dbi -2.1 db* fixed tabl e ? a \ 05. multi \ path ? antennas ? (approved ? when ? operating ? at ? 1 \ watt ? power ? output ? or ? lower) part number type connector gain application a09-dpsm-p12f omni directional permanent mount w/ 12ft pigtail rpsma 3.0 dbi fixed a09-d3nf-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 a09-d3tm-p12f omni directional w/ 12ft pigtail rptnc 3.0 dbi fixed a09-d3ptm omni directional permanent mount rptnc 3.0 dbi fixed a92-d4pnf 900 mhz / 2.4ghz permanent mount rpn 2.1 dbi fixed a92-d4p 900 mhz / 2.4ghz permanent mount rpsma 2.1 dbi fixed a92-d4ptm 900 mhz / 2.4ghz permanent mount rptnc 2.1 dbi fixed tabl e ? a \ 06. half \ wave ? antennas ? (approved ? when ? operating ? at ? 100 ? mw ? power ? output ? or ? lower) part number type connector gain application a09-qw quarter-wave wire permanent 1.9 dbi fixed / mobile a09-qramm 3 " quarter-wave wire mmcx 2.1 dbi fixed / mobile a09-qsm-3 quarter-wave straight rpsma 1.9 dbi fixed / mobile a09-qsm-3h heavy duty quarter-wave st raight rpsma 1.9 dbi fixed / mobile a09-qbmm-p6i quarter-wave w/ 6" pigtail mmcx 1.9 dbi fixed / mobile a09-qhrn miniature helical right angle solder permanent -1 dbi fixed / mobile a09-qhsn miniature helical right angle solder permanent -1 dbi fixed / mobile a09-qhsm-2 2" straight rpsma 1.9 dbi fixed / mobile a09-qhrsm-2 2" right angle rpsma 1.9 dbi fixed / mobile a09-qhrsm-170 1.7" right angle rpsma 1.9 dbi fixed / mobile a09-qrsm-380 3.8" right angl e rpsma 1.9 dbi fixed / mobile a09-qapm-520 5.2" articulated screw mount permanent 1.9 dbi fixed / mobile a09-qspm-3 3" straight screw mount permanent 1.9 dbi fixed / mobile a09-qapm-3 3" articulated screw mount permanent 1.9 dbi fixed / mobile a09-qapm-3h 3" articulated screw mount permanent 1.9 dbi fixed / mobile
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 63 appendix ? a: ? agency ? certifications ic (industry canada) certification labeling requirements labeling requirements for industry canada are simi lar to those of the fcc. a clearly visible label on the outside of the final product encl osure must display the following text: contains model 9xtend radio, ic: 4214a-9xtend the integrator is responsible for its product to co mply with ic ices-003 & fcc part 15, sub. b - unintentional radiators. ices-003 is the same as fcc part 15 sub. b and industry canada accepts fcc test report or cispr 22 test report for compliance with ices-003. c-tick (australia) certification power requirements regulations in australia stipulate a maximum of 30 dbm eirp (effective isotropic radiated power). the eirp equals the sum (in dbm) of power output, antenna gain and cable loss and cannot not exceed 30 dbm. figure ? a \ 02. eirp ? formula ? for ? australia note: the maximum eirp for the fcc (unite d states) and ic (canada) is 36 dbm. tabl e ? a \ 07. yagi ? antennas ? (approved ? when ? operating ? at ? 100 ? mw ? power ? output ? or ? lower) part number type connector gain application a09-y6 2 element yagi rpn 6.1 dbi fixed / mobile a09-y7 3 element yagi rpn 7.1 dbi fixed / mobile a09-y8 4 element yagi rpn 8.1 dbi fixed / mobile a09-y9 4 element yagi rpn 9.1 dbi fixed / mobile a09-y10 5 element yagi rpn 10.1 dbi fixed / mobile a09-y11 6 element yagi rpn 11.1 dbi fixed / mobile a09-y12 7 element yagi rpn 12.1 dbi fixed / mobile a09-y13 9 element yagi rpn 13.1 dbi fixed / mobile a09-y14 10 element yagi rpn 14.1 dbi fixed / mobile a09-y14 12 element yagi rpn 14.1 dbi fixed / mobile a09-y15 13 element yagi rpn 15.1 dbi fixed / mobile a09-y15 15 element yagi rpn 15.1 dbi fixed / mobile a09-y6tm 2 element yagi rptnc 6.1 dbi fixed / mobile a09-y7tm 3 element yagi rptnc 7.1 dbi fixed / mobile a09-y8tm 4 element yagi rptnc 8.1 dbi fixed / mobile a09-y9tm 4 element yagi rptnc 9.1 dbi fixed / mobile a09-y10tm 5 element yagi rptnc 10.1 dbi fixed / mobile a09-y11tm 6 element yagi rptnc 11.1 dbi fixed / 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 rptnc 14.1 dbi fixed / mobile a09-y15tm 13 element yagi rptnc 15.1 dbi fixed / mobile a09-y15tm 15 element yagi rptnc 15.1 dbi fixed / mobile
? ? 2007 ? maxstream, ? inc. ????? 64 appendix ? b: ? development ? guide rs-232 accessories kit contents the accessories listed below are included with xtend rf modems that carry the "-ra" suffix on the product number. for example: part number "xt 09-pkc-ra" includes the listed accessories and part number "xt09-pkc-r" does not. the accessories kit includes hardware and software needed for developing long range wireless links. for testing the modem's range, maxstream recommends the purchase of one rf modem with the accessories and one without. tab le ? b \ 01. contents ? of ? the ? xtend ? rs \ 232/485 ? accessories ? kit item qty. description part number quick start guide 1 familiarizes users with some of the modem?s most important functions. md0019 cd 1 contains documentation, software and tools needed for rf operation. md0030 xtend-pkg-r? rs-232/485 rf modem 1 long range 900 mhz rf modem with rpsma connector xt09-pkg 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 maxstream interface board and can be used to configure the modem to function as a repeater (for range testing) jd2d3-cdl-a null modem adapter (male-to-male) 1 connects to the female rs-232 (db-9) serial connector of the maxstream interface board and can be used to connect the modem to another dce (female db9) device jd2d2-cdn-a null modem adapter (female-to-female) 1 used to bypass radios to verify serial cabling is functionin g properly jd3d3-cdn-a male db-9 to rj-45 adapter 1 facilitates adapting the db-9 connector of the maxstream interface board to a cat5 cable (male db9 to female rj45) je1d2-cda-a female db-9 to rj-45 adapter 1 facilitates adapting the db-9 connector of the maxstream interface board to a cat5 cable (female db9 to female rj45) je1d3-cda-a power adapter 1 allows interface board to be powered by a 110 volt ac power supply jp4p2-9v10-6f rs-232 cable (6?) 1 connects interface board to devi ces having an rs-232 serial port JD2D3-CDS-6F
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 65 appendix ? b: ? development ? guide adapters the development kit includes several adapters that facilitate the following functions: ? performing range tests ? testing cables ? connecting to other rs-232 dce and dte devices ? connecting to terminal blocks or rj-45 (for rs-485/422 devices) null modem adapter (male-to-male) part number: jd2d2-cdn-a (black, db-9 m-m) the male-to-male null modem adapter is used to connect two dce devices. a dce device connects with a straight-through cable to the male serial port of a computer (dte). figure ? b \ 01. male ? null ? modem ? adapter ? and ? pinouts figure ? b \ 02. example ? of ? a ? maxstream ? radio ? modem ? (dce ? device) ? connecting ? to ? another ? dce ? device) null modem adapter (female-to-female) part number: jd3d3-cdn-a (gray, db-9 f-f) the female-to-female null modem adapter is used to verify serial cabling is functioning properly. to test ca bles, insert the female-to-female null modem adapter in place of a pair of mode m assemblies (rs-232 interface board + xtend rf modem) and test the connection without modems in the connection. figure ? b \ 03. female ? null ? modem ? adapter ? and ? pinouts serial loopback adapter part number: jd2d3-cdl-a (red, db-9 m-f) the serial loopback adapter is used for range testing. during a range test, the serial loopback adapter configures the modem to function as a repeater by looping serial data back into the radio for retransmission. figure ? b \ 04. serial ? loopback ? adapter ? and ? pinouts
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 66 appendix ? b: ? development ? guide male db-9 to rj-45 adapter part number: jd2d2-cdn-a (yellow) this adapter facilitates adap ting the db-9 connector of the maxstream interface board to a ca t5 cable (male db9 to female rj45). refer to the ?rs-485 (4-wire) & rs-422 operation? sections for rs-485/422 connection guidelines. figure ? b \ 05. male ? db \ 9 ? to ? rj \ 45 ? adapter ? and ? pinouts female db-9 to rj-45 adapter part number: jd3d3-cdn-a (green) this adapter facilitates adap ting the db-9 connector of the maxstream interface board to a cat5 cable (female db9 to female rj45). refer to the ?rs-485 (4-wire) & rs-422 operation? sections for rs-485/422 connection guidelines. figure ? b \ 6. female ? db \ 9 ? to ? rj \ 45 ? adapter ? and ? pinouts
? ? 2007 ? maxstream, ? inc. ????? 67 appendix ? c: ? additional ? information 1-year warranty xtend rf modems from maxstream, inc. (the "product") are warranted against defects in materi- als and workmanship under normal use, for a period of 1-year fro m the date of purchase. in the event of a product failure due to materials or wo rkmanship, maxstream will repair or replace the defective product. for warranty se rvice, return the defe ctive product to maxstream, shipping pre- paid, for prompt repair or replacement. the foregoing sets forth the full extent of maxstream's warranties regarding the product. repair or replacement at maxstream's option is the exclusive remedy. this warranty is given in lieu of all other warranties, express or implied, and maxstream specifically disclaims all warranties of merchantability or fitnes s for a particular purpose. in no event shall maxstream, its suppliers or licensors be liable for damages in excess of the purchase price of the product, for any loss of use, loss of time, inconvenience, commercial loss, lost profits or savings, or other incidental, special or conse- quential damages arising out of the use or inability to use the product, to the full extent such may be disclaimed by law. some states do not allow the exclusion or limitation of incidental or conseque ntial damages. therefore, the foregoing exclusions may not apply in all cases. this warranty provides specific legal rights. other rights which vary from stat e to state may also apply. ordering information figure ? c \ 01. ? divisions ? of ? the ? xtend ? rf ? modem ? part ? numbers ?
9xtend? ? rs \ 232/485 ? rf ? modem ?\? product ? manual ? v2.x4x ? [2007.01.04] ? ? 2007 ? maxstream, ? inc. ????? 68 appendix ? c: ? additional ? information contact maxstream free and unlimited technical suppo rt is included with every maxstream radio modem sold. for the best in wireless data solutions and su pport, please use the following resources: maxstream office hours are 8:00 am - 5:00 pm [u.s. mountain standard time] documentation: www.maxstream .net/helpdesk/download.php technical support: phone. (866) 765-9885 toll-free u.s.a. & canada (801) 765-9885 worldwide live chat. www.maxstream.net e-mail. rf-xperts@maxstream.net

▲Up To Search▲

Price & Availability of JD2D3-CDS-6F

	To Download JD2D3-CDS-6F Datasheet File
If you can't view the Datasheet, Please click here to try to view without PDF Reader .