ProSoft Technology ProLinx ASCII Driver Manual Download Page 1

 

 
 

 

ASCII 

ProLinx Standalone 

Generic ASCII Serial Communication Module 

Driver Manual 

July 07, 2008 

 

 

Summary of Contents for ProLinx ASCII

Page 1: ...ASCII ProLinx Standalone Generic ASCII Serial Communication Module Driver Manual July 07 2008 ...

Page 2: ...anual or the product may be made at any time These changes will be made periodically to correct technical inaccuracies or typographical errors Important Installation Instructions Power input and output wiring must be in accordance with Class I Division 2 wiring methods Article 501 4 b of the National Electrical Code NFPA 70 and in accordance with the authority having jurisdiction The following war...

Page 3: ...ADIO MODULE AS THE PRIMARY RADIO COMPONENT THE COMPACT FLASH RADIO MODULE DOES NOT HAVE AN FXX ID LABE THE COMPACT FLASH RADIO MODULE HAS NO USER SERVICABLE PARTS C THIS DEVICE COMPLIES WITH PART 15 OF THE FCC RULES OPERATION IS SUBJECT TO THE FOLLOWING TWO CONDITIONS 1 THIS DEVICE MAY NOT VAUSE HARMFUL INTERFERENCE AND 2 THIS DEVICE MUST ACCEPT ANY INTERFERENCE RECEIVED INCLUDING INTERFERENCE THA...

Page 4: ...s turn off power before replacing or wiring modules C Warning Explosion Hazard Do not disconnect equipment unless power has been switched off or the area is known to be non hazardous Your Feedback Please We always want you to feel that you made the right decision to use our products If you have suggestions comments compliments or complaints about the product documentation or support please write o...

Page 5: ...esources 7 2 FUNCTIONALITY 9 2 1 Data Flow 9 3 MODES OF OPERATION 13 3 1 Data Flow 13 3 2 Termination of Received Data 15 4 ASCII PROTOCOL CONFIGURATION 19 4 1 ASCII Port 0 19 5 DRIVER STATUS DATA 25 6 LED INDICATORS 29 6 1 Base Module LEDs 29 6 2 LEDs for Port 0 Serial Port 30 6 3 4101 Series LEDs 30 7 SUPPORT SERVICE WARRANTY 31 7 1 Return Material Authorization RMA Policies and Conditions 31 7 ...

Page 6: ...Contents ASCII ProLinx Standalone Generic ASCII Serial Communication Module Page 6 of 40 ProSoft Technology Inc July 7 2008 ...

Page 7: ...essage timeout inter character delay or packet size length Receive database location 1 disable receiver 0 to 3896 Transmit buffer size 255 bytes Transmit characters with pacing 0 to 65535 millisecond delay between each transmitted character Transmit database location 1 disable transmitter 0 to 3896 Communication Configuration o Baud Rate 110 to 115 200 o Parity None Odd Even o Data Bits 5 to 8 o S...

Page 8: ...ASCII ProLinx Standalone Introduction Generic ASCII Serial Communication Module Page 8 of 40 ProSoft Technology Inc July 7 2008 ...

Page 9: ...ination condition for a received message this signals the end of the message When the receive driver observes this character in the input stream it takes all received characters and places them in the internal database In both receive and transmit operations a signal is required to determine when new data is received or must be transmitted The first word in the two data area is used for this purpo...

Page 10: ...ived before placing the data into the data block Because the data received may contain an odd number of bytes the length of the message received will be incremented by 1 when an odd number of bytes are received and the swap option is utilized This is to avoid losing the last byte of data in the message 2 1 2 Transmit Data Data to transmit by the transmit driver is placed in the module s internal d...

Page 11: ...ro the whole data packet will be transmitted as fast as the transmit driver can function Word 3 of the data block contains the number of bytes present in the transmit data area to send out the ASCII port Words 4 to 131 contain the actual data to transmit If the swap option is utilized the transmit driver will swap each byte in the words received before transmitting them Care should be taken if an ...

Page 12: ...ASCII ProLinx Standalone Functionality Generic ASCII Serial Communication Module Page 12 of 40 ProSoft Technology Inc July 7 2008 ...

Page 13: ...tion port on the module is configured independently to interface with serial communication devices The sub sections that follow describe the three possible types of communication devices that can be attached to application ports receive only transmit only and transmit receive mode 3 1 1 Receive Only Mode A port on the module configured to function in receive only mode is set up to only receive dat...

Page 14: ... module s internal database received from an external source to an ASCII device When the transmit driver Tx Driver recognizes a new write block containing data data placed in the module s internal database it transmits this data out to the port The sequence number used in the block will be different that that of the previous block and therefore signals that the packet is fully assembled and ready ...

Page 15: ...llustration shows the data flow when the port is configured for transmit receive mode Configuring a Port for Transmit Receive Mode In order to set a port to both receive data and transmit data to an ASCII device ensure that the Rx DB Start parameter and the Tx DB Start parameter both contain values that specify data storage starting locations A 1 value in either parameter will disable the particul...

Page 16: ...will be configured for stream mode Any characters received on the port are immediately sent to the processor The processor must buffer and assemble a packet of information if this mode is selected as required by the application If the data can be handled by the processor in this mode and it is appropriate for your application this is the fastest method of communication between the device and the p...

Page 17: ...Modes of Operation ASCII ProLinx Standalone Generic ASCII Serial Communication Module ProSoft Technology Inc Page 17 of 40 July 7 2008 ...

Page 18: ...ASCII ProLinx Standalone Modes of Operation Generic ASCII Serial Communication Module Page 18 of 40 ProSoft Technology Inc July 7 2008 ...

Page 19: ...ppropriate ASCII port After setting up the configuration file download it to the module using ProSoft Configuration Builder 4 1 ASCII Port 0 ASCII PORT 0 Enabled Y RS Interface 0 0 RS 232 1 RS 485 2 RS 422 Rx DB Start 200 Tx DB Start 0 Baud Rate 19200 Parity N The coded values are as follows N None O Odd E Even M Mark and S Space Data Bits 8 Valid entries for this field are 5 6 7 and 8 Stop Bits 1...

Page 20: ... receive data Refer to Receive Data page 10 for detailed information on Rx data structure 4 1 4 Tx DB Start 1 or 0 to 3896 This parameter specifies the starting location in the internal database where the transmit data will be stored The buffer holds 130 words however the first three words of the data area define the sequence number last write byte count and the Rx message length If the parameter ...

Page 21: ...ding the data 4 1 10 RTS Off 0 to 65535 This parameter specifies the number of milliseconds to delay after sending the data frame before the RTS line is dropped 4 1 11 Handshaking Handshake code of N Y D X This parameter specifies the handshaking used on the port The code values are as follows N No hardware or software handshaking Y RTS CTS hardware handshaking D DTR DSR hardware handshaking and X...

Page 22: ...to 65535 This parameter is used if bit 1 is set in the Type parameter The parameter sets the number of milliseconds to wait after the first character is received on the port before automatically sending the data to the processor 4 1 17 Rx Delay 0 to 65535 This parameter is used if bit 2 is set in the Type parameter The parameter sets the number of milliseconds to wait between each character receiv...

Page 23: ...smitting a message out the port This pre send delay is applied before the RTS on time This may be required when communicating with slow devices 4 1 21 Swap Tx Data Bytes Yes or No This parameter determines if the data to be transmitted by the module will have the byte order of the data swapped If the parameter is set to No no byte swapping will occur If the parameter is set to Yes the odd byte wil...

Page 24: ...ASCII ProLinx Standalone ASCII Protocol Configuration Generic ASCII Serial Communication Module Page 24 of 40 ProSoft Technology Inc July 7 2008 ...

Page 25: ...gister Description 13000 Receive State 1 Listening for data 1 Receiving Port Data 2 Waiting for Backplane transfer 13001 Receive character count 13002 Receive message count 13003 Transmit State 0 Waiting for Data to Send 1 RTS On 2 RTS Timeout 3 Sending data 4 Waiting for RTS Off 5 RTS turned off 30 Intercharacter Delay 31 Intercharacter Delay 32 Intercharacter Delay 100 Message Delay before Trans...

Page 26: ...ransmit message count 13016 Configuration error word 13017 to 13019 No Valid Data Port 2 Status Data Status Register Description 13020 Receive State 1 Listening for data 1 Receiving Port Data 2 Waiting for Backplane transfer 13021 Receive character count 13022 Receive message count 13023 Transmit State 0 Waiting for Data to Send 1 RTS On 2 RTS Timeout 3 Sending data 4 Waiting for RTS Off 5 RTS tur...

Page 27: ... word 13037 to 13039 No Valid Data If the module is configured correctly the configuration error word should have a value of zero Any other value indicates a configuration error Use the value in the configuration error word to determine which set of parameters are invalid in the driver configuration area The following table lists the bits associated with each configuration error in the word Bit Co...

Page 28: ...lone Driver Status Data Generic ASCII Serial Communication Module Page 28 of 40 ProSoft Technology Inc July 7 2008 Bit Code Description 13 0x2000 Invalid Tx Timeout 14 0x4000 Invalid RS interface selected 0 to 2 15 0x8000 ...

Page 29: ...o the power terminals Verify that the other LEDs for operational and functional status Off Normal operation Fault Red Solid A critical error has occurred Program executable has failed or has been user terminated and is no longer running Press Reset p b or cycle power to clear error If not use the Debug procedures described later in this manual Off Normal operation Cfg Amber Solid The unit is in th...

Page 30: ...ebug Configuration mode is active applies to modules that support pass through on Debug port such as DFCM units If CFG LED is not on a critical error has occurred Program executable has failed or has been user terminated and is no longer running Press Reset p b or cycle power to clear error If not use the Debug procedures described later in this manual Off Normal operation CFG Amber Solid If Fault...

Page 31: ... o LED patterns 2 Information about the processor and user data files as viewed through and LED patterns on the processor 3 Details about the serial devices interfaced if any 7 1 Return Material Authorization RMA Policies and Conditions The following RMA Policies and Conditions collectively RMA Policies apply to any returned Product These RMA Policies are subject to change by ProSoft without notic...

Page 32: ...defect is the power supply o 3350 o 3300 o 1500 All 7 1 3 All Product Returns a In order to return a Product for repair exchange or otherwise the Customer must obtain a Returned Material Authorization RMA number from ProSoft and comply with ProSoft shipping instructions b In the event that the Customer experiences a problem with the Product for any reason Customer should contact ProSoft Technical ...

Page 33: ...rms of this Limited Warranty All sales of software or other intellectual property are in addition subject to any license agreement accompanying such software or other intellectual property 7 2 1 What Is Covered By This Warranty a Warranty On New Products ProSoft warrants to the original purchaser that the Product that is the subject of the sale will 1 conform to and perform in accordance with publ...

Page 34: ...y IEC 61131 3 C or any variant of C programming languages not furnished by ProSoft v use of the Product for purposes other than those for which it was designed vi any other abuse misapplication neglect or misuse by the Customer vii accident improper testing or causes external to the Product such as but not limited to exposure to extremes of temperature or humidity power failure or power surges or ...

Page 35: ...luding attorney s fees and expenses related to any claim investigation litigation or proceeding whether or not ProSoft is a party which arises or is alleged to arise from Buyer s acts or omissions under these Terms or in any way with respect to the Products Without limiting the foregoing Buyer at its own expense shall indemnify and hold harmless ProSoft and defend or settle any action brought agai...

Page 36: ...o so may void this Warranty with respect to such software and or other intellectual property 7 2 7 Disclaimer of all Other Warranties The Warranty set forth in What Is Covered By This Warranty page 33 are in lieu of all other warranties express or implied including but not limited to the implied warranties of merchantability and fitness for a particular purpose 7 2 8 No Other Warranties Unless mod...

Page 37: ...ite http www prosoft technology com support http www prosoft technology com support E mail address support prosoft technology com mailto support prosoft technology com Asia Pacific 603 7724 2080 support asia prosoft technology com mailto support asia prosoft technology com Languages spoken include Chinese English Europe location in Toulouse France 33 0 5 34 36 87 20 support EMEA prosoft technology...

Page 38: ...ASCII ProLinx Standalone Support Service Warranty Generic ASCII Serial Communication Module Page 38 of 40 ProSoft Technology Inc July 7 2008 ...

Page 39: ...t 0 Serial Port 30 Limitation of Remedies 35 LIMITED WARRANTY 33 M Modes of Operation 13 N No Other Warranties 36 P Parity 20 Please Read This Notice 2 Procedures for Return of Units Out of Warranty 32 Procedures for Return of Units Under Warranty 31 Product Installation Warning 4 ProLinx Modules with Ethernet Ports 3 ProLinx Plus with Radio 3 ProLinx Series C 4000 ProLinx Plus 5000 4 Purchasing W...

Page 40: ... Standalone Index Generic ASCII Serial Communication Module Page 40 of 40 ProSoft Technology Inc July 7 2008 W What Is Covered By This Warranty 33 36 What Is Not Covered By This Warranty 34 Y Your Feedback Please 4 ...

Reviews: