View MVI46-MCM_1758281.PDF datasheet online --- IC-ON-LINE

Datasheet File OCR Text:

MVI46-MCM slc platform modbus interface module user manual december 27, 2004
please read this notice successful application of this module requires a reasonable working knowledge of the slc platform modbus interface module hardware and the application in which the combination is to be used. for this reason, it is important that those responsible for im plementation satisfy themselves that the combination will meet the needs of the application without exposing personnel or equipment to unsafe or inappropriate working conditions. this manual is provided to assist the user. every attempt has been made to assure that the information provided is accurate and a true reflection of the pro duct's installation requirements. in order to assure a complete understanding of the operation of the pr oduct, the user should read all applicable allen- bradley documentation on the oper ation of the a-b hardware. under no conditions will prosoft technology, inc. be re sponsible or liable for indirect or consequential damages resulting from the use or application of the product. reproduction of the contents of this manual, in whole or in part, without written permission from prosoft technology, inc. is prohibited. information in this manual is subject to change without notice and does not represent a commitment on the part of prosoft technology, inc. improvements and/or changes in this manual or the product may be made at any time. these changes will be made periodically to correct technical inaccuracies or typographical errors. prosoft technology, inc. 1675 chester avenue, 2 nd floor bakersfield, ca 93301 (661) 716-5100 (661) 716-5101 (fax) www.prosoft-technology.com copyright ? prosoft technology, inc. 2000 ? 2004. all rights reserved. MVI46-MCM user manual december 27, 2004
table of contents MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 3 of 81 december 27, 2004 table of contents please read th is notice ........................................................................................................ .. 2 1 product specif ications ................................................................................................... 5 1.1 general specifications................................................................................................... 5 1.1.1 slave functional specifications .................................................................................... 5 1.1.2 modbus master function al specific ations .................................................................... 6 1.1.3 physical....................................................................................................................... .. 6 1.1.4 slc interface ................................................................................................................ 6 1.2 hardware speci fications................................................................................................ 6 2 functional overview......................................................................................................... 9 2.1 general co ncepts........................................................................................................... 9 2.1.1 main logic loop............................................................................................................ 9 2.1.2 slc processor no t in run.......................................................................................... 10 2.1.3 backplane data transfer ............................................................................................ 10 2.2 normal data transfer ................................................................................................... 12 2.3 configuration da ta transfer........................................................................................ 12 2.3.1 module configur ation data ......................................................................................... 12 2.4 slave status data ......................................................................................................... 13 2.5 command contro l blocks ........................................................................................... 14 2.5.1 event co mmand ......................................................................................................... 15 2.5.2 command cont rol....................................................................................................... 15 2.5.3 write config uration ..................................................................................................... 16 2.5.4 warm b oot .................................................................................................................. 17 2.5.5 cold b oot .................................................................................................................... 17 data flow between MVI46-MCM module and sl c process or................................................ 17 2.5.6 slave dr iver ................................................................................................................ 17 2.5.7 master driv er mode .................................................................................................... 18 3 module configuration ................................................................................................... 23 3.1 power up ....................................................................................................................... 23
MVI46-MCM ? slc platform table of contents modbus interface module page 4 of 81 prosoft technology, inc. december 27, 2004 3.2 changing parameters during oper ation ....................................................................23 3.3 setting up th e module ..................................................................................................24 3.4 module da ta...................................................................................................................2 5 3.4.1 configurati on data ......................................................................................................25 4 ladder logic................................................................................................................... .....29 4.1 mcm main ......................................................................................................................2 9 4.2 mcm da ta....................................................................................................................... 30 4.3 mcm cmds.....................................................................................................................30 5 diagnostics and tr oubleshoo ting ...........................................................................35 5.1 reading status data from the module .......................................................................35 5.1.1 required ha rdware .....................................................................................................35 5.1.2 required so ftware.......................................................................................................35 5.1.3 using the port..............................................................................................................36 5.1.4 menu opti ons ..............................................................................................................36 5.2 led status i ndicators...................................................................................................47 5.2.1 clearing a faul t condition...........................................................................................49 5.2.2 troublesho oting...........................................................................................................49 6 cable connec tions ...........................................................................................................51 6.1 modbus communicat ion ports....................................................................................51 6.1.1 connecting the cable to the co nnector ......................................................................51 6.1.2 setting the ju mpers ....................................................................................................53 appendix a - MVI46-MCM database defi nition ..................................................................55 appendix b ? MVI46-MCM stat us data de finiti on............................................................57 appendix c ? MVI46-MCM config uration data definiti on............................................59 appendix d ? MVI46-MCM command co ntrol.....................................................................69 appendix e ? mvi46-mc m configu ration.............................................................................71 support, service, and warra nty .......................................................................................79
product specifications MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 5 of 81 december 27, 2004 1 product specifications the MVI46-MCM (?modbus commu nication module?) product allows allen-bradley slc i/o compatible processors to easily interface with other modbus protocol compatible devices. compatible devices include not only modicon plc's (which all support the modbus protocol) but also a wide assortment of end devices. 1.1 general specifications the MVI46-MCM module acts as a gateway between the modbus network and the allen-bradley backplane. the data transfer from the slc processor is asynchronous from the actions on the modbus network. a 5000-word register space in the module is used to exchange data between the processor and the modbus network. some of the general specifications include: ? support for the storage and transfer of up to 5000 registers to/from the slc processor's data files ? module memory usage that is completely user definable ? two ports to emulate any combinati on of modbus master or slave device ? configurable parameters include: protocol : rtu or ascii baud rate : 110 to 115,200 parity : none, odd and even data bits : 5 to 8 stop bits : 1 or 2 rts on and off timing : 0 to 65535 milliseconds minimum response delay : 0 to 65535 milliseconds use of cts modem line : yes or no device routing paths : 1 to 64 floating-point support 1.1.1 slave functional specifications the MVI46-MCM module accepts modbus function code commands of 1, 2, 3, 4, 5, 6, 8, 15 and 16 from an attached modbus master unit. a port configured as a modbus slave permits a remote master to interact with all data contained in the module. this data can be derived from other modbus slave devices on the network through a master port or from the slc processor.
MVI46-MCM ? slc platform product specifications modbus interface module page 6 of 81 prosoft technology, inc. december 27, 2004 1.1.2 modbus master functional specifications a port configured as a virtual modbus ma ster device on the MVI46-MCM module will actively issue modbus commands to other nodes on the modbus network. one hundred commands are supported on each port. additionally, the master ports have an optimized polling characteristic that will poll slaves with communication problems less frequently. the slc processor can be programmed to control the activity on the port by actively selecting commands from the command list to execute or issuing commands directly from the ladder logic. the slc processor also has the ability to control the scanning of slaves on the port. polling of individual slaves can be selectively controlled (enabled/disabled) through the ladder logic. 1.1.3 physical this module is designed by prosoft technology and incorporates licensed technology from allen-bradley (slc backplane technology). ? slc form factor - single slot ? connections: 2? rj45 connectors for support of rs-232, rs-422 or rs-485 interfaces 1? rj45 rs-232 configuration tool connector 1.1.4 slc interface ? operation via simple ladder logic ? complete set up and monitoring of module through rslogix 500 software ? slc backplane interface via i/o access ? slc 5/02 (m0/m1 compatible) or higher is required ? module configuration and communication configuration data is transferred to the MVI46-MCM from the m1 file. 1.2 hardware specifications the MVI46-MCM module is designed by prosoft technology and incorporates licensed technology from allen-bradley (slc backplane technology). ? current loads: 800 ma @ 5v (from backplane) ? operating temperature: 0 to 60 deg c (32 to 140 deg f) ? storage temperature: -40 to 85 deg c (-40 to 185 def f) ? relative humidity: 5-95% (w/o condensation)
product specifications MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 7 of 81 december 27, 2004 ? modbus port connector: two rj45 connectors (rj45 to db9 cable shipped with unit) supporting rs-232, rs-422 and rs-485 interfaces (rj45 to db9 cables shipped with unit) ? configuration connector: rj45 rs-232 connector (rj45 to db9 cable shipped with unit)
MVI46-MCM ? slc platform product specifications modbus interface module page 8 of 81 prosoft technology, inc. december 27, 2004
functional overvi ew MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 9 of 81 december 27, 2004 2 functional overview this section gives the reader a functional overview of the MVI46-MCM module. details associated with the ladder logic and the memory-map are not covered in this section (refer to the module set up section). a thorough understanding of the information contained in this document is required for successful implementation of the module in a user application. if you are not familiar with the data transfer and modbus protocol operations, read this section before setting up the module. 2.1 general concepts the following discussion covers several concepts that are key to understanding the operation of the MVI46-MCM module. 1. on power up the module begins performing the following logical functions: a. initialize hardware components b. initialize slc backplane driver c. test and clear all ram d. initialize the serial communication ports 2. waits for module configuration from the slc processor 3. allocate and initialize module register space 4. enable slave driver on selected ports 5. enable master driver on selected port if configured once the module has received the module configuration, the module will begin communicating with other nodes on the network, depending on the configuration. 2.1.1 main logic loop upon completing the power up configuration process, the module enters an infinite loop that performs the following functions:
MVI46-MCM ? slc platform functional overview modbus interface module page 10 of 81 prosoft technology, inc. december 27, 2004 call i/o handler - transfers data between module and processor (user, status, configuration, etc.) call serial port driver (configuration/debug port) - rx and tx buffer routines are interrupt driven - call to serial port routines checks to see if there is any data in the buffer, and depending on the value will either service the buffer or wait for more characters call i/o handler call cfg/dbg port driver call modbus driver - if modbus master port, poll slaves using command list - if modbus slave port, respond to commands received from power up logic call modbus driver 2.1.2 slc processor not in run anytime the module detects that the processor has gone out of the run mode (i.e., fault or pgm), the modbus ports will be shut down. when the processor is returned to a running state, the module will resume communications on the network. no backplane data transfers occur when the processor is not in run mode. 2.1.3 backplane data transfer the MVI46-MCM module is unique in the way that the slc backplane is used. all data for the module is contained in the module?s m1 file. data is moved between the module and the slc processor across the backplane using the module's m-files. the slc scan rate and the communication load on the module determine the update frequency of the m-files. the cop instruction can be used to move data between user data files and the module?s m1 file. the following diagram displays the data transfer method used to move data between the slc processor, the MVI46-MCM module and the mcm network.
functional overvi ew MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 11 of 81 december 27, 2004 modbus port drivers master driver logic master driver logic slave driver logic slave driver logic module?s internal database mvi46 - mcm module to modbus network ladder logic transfers data from module?s m1 file to data areas in the processor slc processor user data files slc processor ladder logic transfers data from processor data areas to m1 file m1 file status read data write data special control blocks m0 file configuration data ladder logic transfers configuration from processor data areas to m0 file special block handling special block handling ladder logic processes special control command as shown in the previous diagram, all data transferred between the module and the processor over the backplane is through the m0 and m1 files. ladder logic must be written in the slc processor to interface the m-file data with data defined in the user- defined data files in the slc. all data used by the module is stored in its internal database. the following diagram displays the layout of the database: 5000 registers for user data register data status and config module?s internal database structure ? m1 file 0 4999 5000 7799 2800 words of configuration and status data 7800 7999 8000 9999 cmd control extra data a rea 200 words of command control 2000 words of data only available to communication ports user data contained in this database is continuously read from the m1 file. the configuration data is only updated in the m1 file after each configuration request by
MVI46-MCM ? slc platform functional overview modbus interface module page 12 of 81 prosoft technology, inc. december 27, 2004 the module to the slc. all data in the m1 file is available to devices on the modbus networks. this permits data to be transferred from these devices to the slc using the user data area. additionally, remote devices can alter the module?s configuration, read the status data, and issue control commands. block identification codes are used to define specific functions to the module. the block identification codes used by the module are listed in the following table: block range descriptions 1000 event port 1 2000 event port 2 3000 to 3001 port 1 slave polling control 3100 to 3101 port 2 slave polling control 5000 to 5006 port 1 command control 5100 to 5106 port 2 command control 9000 configuration request from module 9001 configuration ready from controller 9997 write configuration to controller 9998 warm-boot control block 9999 cold-boot control block each block has a defined structure depending on the data content and the function of the data transfer as defined in the following sections. 2.2 normal data transfer this version of the module provides for direct access to the data in the module. all data related to the module is stored in the module?s m1 file. to read data from the module, simply use the cop instruction to copy data from the module?s m1 file to a user data file. to write data to the module, use the cop instruction to copy data from a user file to the module?s m1 file. registers 0 to 4999 are those that should be used for user data. all other registers are reserved for other module functions. 2.3 configuration data transfer when the module performs a restart operation, it will request configuration information from the slc processor. this data is transferred to the module in a specially formatted write block in the m0 file. the module will poll for this information by placing the value 9000 in word 0 of the m0 file. the ladder logic must construct the requested block in order to configure the module. refer to the module set up section for a description of the data objects used with the blocks and the ladder logic required. the format of the block for configuration is given in the following section. 2.3.1 module configuration data this block is used to send configuration information from the processor to the module. the data is transferred in a block with an identification code of 9001. the structure of the block is displayed in the following table: m0 offset description length 0 9001 1 1-6 backplane setup 6
functional overvi ew MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 13 of 81 december 27, 2004 m0 offset description length 10-39 port 1 configuration 30 40-69 port 2 configuration 30 70-79 port 1 command # 0 definition 10 80-89 port 1 command # 1 definition 10 90-1059 port 1 command # 2 to # 98 980 1060-1069 port 1 command # 99 definition 10 1070-1079 port 2 command # 0 definition 10 1080-1089 port 2 command # 1 definition 10 1090-2059 port 2 command # 2 to # 98 980 2060-2069 port 2 command # 99 definition 10 if there are any errors in the configuration, the bit associated with the error will be set in one of the two configuration error words. the error must be corrected before the module starts its normal mode of operation. 2.4 slave status data slave status data is used to send status information of each slave device on a master port. slaves attached to the master port can have one of the following states: 0 the slave is inactive and not defined in the command list for the master port. 1 the slave is actively being polled or controlled by the master port. 2 the master port has failed to communicate with the slave device. communications with the slave is suspended for a user defin ed period based on the scanning of the command list. 3 communications with the slave has been disabled by the ladder logic. no communication will occur with the slave until th is state is cleared by the ladder logic. slaves are defined to the system when the module initializes the master command list. each slave defined will be set to a state of one in this initial step. if the master port fails to communicate with a slave device (retry count expired on a command), the master will set the state of the slave to a value of 2 in the status table. this suspends communication with the slave device for a user specified scan count ( error delay counter value in the module configuration for each port). each time a command in the list is scanned that has the address of a suspended slave, the delay counter value will be decremented. when the value reaches zero, the slave state will be set to one. this will enable polling of the slave. in order to read the slave status table, ladder logic must be written and the slave status data must be located in the user data area. the module will constantly update the user defined data area with the slave data for each modbus master port. this data can be transferred to a user-defined file in the processor using the cop instruction. ladder logic can be written to override the value in the slave status table to disable slaves (state value of 3) by sending a special block of data from the processor to the slave. port 1 slaves are disabled using block 3000, and port 2 slaves are disabled using block 3100. each block contains the slave node addresses to disable.
MVI46-MCM ? slc platform functional overview modbus interface module page 14 of 81 prosoft technology, inc. december 27, 2004 the structure of the block is displayed in the following table: m1 offset description length 7800 3000 or 3100 1 7801 number of slaves in block 1 7802-7927 slave indexes 126 the module will respond with a block with the same identification code received and indicate the number of slaves acted on with the block. the format of this response block is shown in the following table: m0 offset description length 0 3000 or 3100 1 1 number of slaves processed 1 ladder logic can be written to override the value in the slave status table to enable the slave (state value of 1) by sending a special block. port 1 slaves are enabled using block 3001, and port 2 slaves are enabled using block 3101. each block contains the slave node addresses to enable. the format of the block is shown in the following table: m0 offset description length 7800 3001 or 3101 1 7801 number of slaves in block 1 7802-7927 slave indexes 126 the module will respond with a block with the same identification code received and indicate the number of slaves acted on with the block. the format of this response block is shown in the following table: m0 offset description length 0 3001 or 3101 1 1 number of slaves processed 1 2.5 command control blocks command control blocks are special blocks used to control the module or request special data from the module. the current version of the software supports five command control blocks: event command control, command control, write configuration, warm boot and cold boot.
functional overvi ew MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 15 of 81 december 27, 2004 2.5.1 event command event command control blocks are used to send modbus commands directly from the ladder logic to one of the master ports. the format for these blocks is shown in the following table: m1 offset description length 7800 1000 or 2000 1 7801 internal db address 1 7802 point count 1 7803 swap code 1 7804 node address 1 7805 function code 1 7806 device address 1 the block number defines the modbus port to be considered. block 1000 commands are directed to port 1, and block 2000 commands are directed to port 2. the parameters passed with the block are used to construct the command. the internal db address parameter specifies the module's database location to associate with the command. the point count parameter defines the number of registers for the command. the swap code is used to change the word or byte order. the node address parameter is used to define the device on the modbus network to consider. the function code parameter is one of those defined in the prosoft modbus command set documentation. when the block is received, the module will process it and place the command in the command queue. the module will respond to each event command block with a read block in the following format: m0 offset description length 0 1000 or 2000 1 1 0=fail, 1=success 1 the ladder logic can use word one of the block to determine if the command was added to the command queue of the module. the command will only fail if the command queue for the port is full (100 commands for each queue) or the command requested is invalid. 2.5.2 command control command control blocks are used to place commands from the command list into the command queue. each port has a command queue of up to 100 commands. the module services commands in the queue before the master command list. this gives high priority to commands in the queue. commands placed in the queue through this mechanism must be defined in the master command list. under normal command list execution, the module will only execute co mmands with the enable parameter set to one or two. if the value is set to zero, the command is skipped. commands may be placed in the command list with an enable parameter set to zero. these commands can then be executed using the command control blocks.
MVI46-MCM ? slc platform functional overview modbus interface module page 16 of 81 prosoft technology, inc. december 27, 2004 one to six commands can be placed in the command queue with a single request. the format of the block is shown in the following table: m1 offset description length 7800 5001-5006 or 5101-5106 1 7801 command index 1 7802 command index 1 7803 command index 1 7804 command index 1 7805 command index 1 7806 command index 1 blocks in the range of 5001 to 5006 are used for port 1, while blocks in the range of 5101 to 5106 are used for port 2. the last digit in the block code defines the number of commands to process in the block. for example, a block code of 5003 contains 3 command indexes that are to be used with port 1. the command index parameters in the block have a range of 0 to 99 and correspond to the master command list entries. the module responds to a command control block with a block containing the number of commands added to the command queue for the port. the format of the block is shown in the following table: m0 offset description length 0 5000-5006 or 5100-5106 1 1 number of commands added to comm and queue 1 2.5.3 write configuration this block is sent from the slc processor to the module to force the module to write it?s current configuration back to the processor. this function is used when the module's configuration has been altered remotely using database write operations. the write block contains a value of 9997 in the first word. the module responds with a block containing the module configuration data. ladder logic must be written to handle the receipt of the block. the block transferred from the module is as follows: m0 offset description length 0 9001 1 1-9 backplane setup 9 10-39 port 1 configuration 30 40-69 port 2 configuration 30 70-79 port 1 command # 0 definition 10 80-89 port 1 command # 1 definition 10 90-1059 port 1 command # 2 to # 98 980 1060-1069 port 1 command # 99 definition 10 1070-1079 port 2 command # 0 definition 10 1080-1089 port 2 command # 1 definition 10
functional overvi ew MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 17 of 81 december 27, 2004 m0 offset description length 1090-2059 port 2 command # 2 to # 98 980 2060-2069 port 2 command # 99 definition 10 ladder logic must be written to process this block of information and place the data received in the correct data files in the slc. the processor requests this block of information using the following write block: m1 offset description length 7800 9997 1 2.5.4 warm boot this block is sent from the slc processor to the module when the module is required to perform a warm-boot (software reset) operation. this block is commonly sent to the module any time configuration data modifications are made in the configuration data area. this forces the module to read the new configuration information and restart. the structure of the control block is shown in the following table: m1 offset description length 7800 9998 1 2.5.5 cold boot this block is sent from the slc processor to the module when the module is required to perform the cold boot (hardware reset) operation. this block is sent to the module when a hardware problem is detect ed by the ladder logic that requires a hardware reset. the structure of the control block is shown in the following table: m1 offset description length 7800 9999 1 data flow between mvi46 -mcm module and slc processor the following discussion describes the flow of data between the two pieces of hardware (slc processor and MVI46-MCM module) and other nodes on the modbus network under the module?s different operating modes. each port on the module is configured to emulate a modb us master device or a modbus slave device. the operation of each port is dependent on this configuration. the following sections discuss the operation of each mode. 2.5.6 slave driver the slave driver mode allows the MVI46-MCM module to respond to data read and write commands issued by a master on the modbus network. the following flow chart and associated table describe the flow of data in and out of the module.
MVI46-MCM ? slc platform functional overview modbus interface module page 18 of 81 prosoft technology, inc. december 27, 2004 module_s database slc user data files slave mode driver m0 & m1 files configuration data status from module register data storage m1 file processor memory mcm module backplane interface configuration status 4 2 3 5 1 3 register data (0 to 4999) step description 1 the modbus slave port driver receives t he configuration information from the slc processor. this information is used to conf igure the serial port and define the slave node characteristics. 2 a host device, such as an allen-bradley pl c or an mmi package issues a read or write command to the module?s node address. t he port driver qualifies the message before accepting it into the module. 3 once the module accepts the command, the data is immediately transferred to or from the internal database in the module. if the command is a read command, the data is read out of the database and a response message is buil t. if the command is a write command, the data is written directly into the database and the m1 file and a response message is built. 4 once the data processing has been completed in step 3, the response is issued to the originating master node. 5 counters are available in the status block t hat permit the ladder logic program to determine the level of activity of the slave driver. review the module set up section for a complete list of the parameters that must be defined for a slave port. 2.5.7 master driver mode in the master mode of operation, the MVI46-MCM module is responsible for issuing read or write commands to slave devices on the modbus network. these commands are user configured in the module via the master command list received from the slc processor or issued directly from the slc processor (event command control). command status is returned to the processor for each individual command in the command list status block. the location of this status block in the module's internal database is user-defined. the following flow chart and associated table describe the flow of data in and out of the module.
functional overvi ew MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 19 of 81 december 27, 2004 master mode driver mcm memory configuration master command list status 3 1 2 4 5 register data (0 to 4999) module?s database slc user data files m0 & m1 files configuration data status from module register data storage processor memory backplane interface event cmd data event cmd data command control command control m0 & m1 files 4 m1 file step description 1 the master driver obtains configuration data from the slc processor. the configuration data obtained includes the number of comm ands and the master command list. these values are used by the master driver to det ermine the type of commands to be issued to the other nodes on the modbus network (see the module set up section). 2 once configured, the master driver begins transmitting read and/or write commands to the other nodes on the network. if writing data to another node, the data for the write command is obtained from the module's internal database to build the command. 3 presuming successful processing by the nod e specified in the command, a response message is received into the master driver for processing. 4 data received from the node on the network is passed into the module's internal database and the m1 file, assuming a read command. 5 status is returned to the slc processor for each command in the master command list. refer to the module set up section for a complete description of the parameters required to define the virtual modbus master port. refer to the mcm driver documentation for a complete discussion of the structure and content of each command. care must be taken in constructing each command in the list for predictable operation of the module. if two commands write to the same internal database address of the module, the results will not be as desired. all commands containing invalid data are ignored by the module. 2.5.7.1. master command list in order to function in the master mode, the module?s master command list must be defined. this list contains up to 100 individual entries, with each entry containing the information required to construct a valid command. this includes the following: ? command enable code ((0) disabled, (1) continuous or (2) conditional) ? internal address ? module?s internal address associated with the command.
MVI46-MCM ? slc platform functional overview modbus interface module page 20 of 81 prosoft technology, inc. december 27, 2004 ? poll interval time ? minimum number of seconds between issuance of command (0 to 65535) ? count ? the number of words to be transferred. ? swap code ? swap code used with the command ((1) swap words, (2) swap bytes and words, (3) swap bytes) ? node address ? device id ? function code ? function code for the command. ? device address ? address in the device associated with the command. modbus command structure function code enable code internal address poll interval time count swap code node address function code device address fc1 code bit seconds count 0 node 1 register fc2 code bit seconds count 0 node 2 register fc3 code register seconds count code node 3 register fc4 code register seconds count code node 4 register fc5 code bit seconds count 0 node 5 register fc6 code register seconds count code node 6 register fc15 code bit seconds count 0 node 15 register fc16 code register seconds count code node 16 register node address = destination address for message as the list is read in from the processor and as the commands are processed, an error value is maintained in the module for each command. this error list can be transferred to the processor. the errors generated by the module are displayed in the following tables:
functional overvi ew MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 21 of 81 december 27, 2004 standard modbus protocol errors code description 1 illegal function 2 illegal data address 3 illegal data value 4 failure in associated device 5 acknowledge 6 busy, rejected message module communication error codes code description -1 cts modem control line not set before transmit -2 timeout while transmitting message -11 timeout waiting for response after request 253 incorrect slave address in response 254 incorrect function code in response 255 invalid crc/lrc value in response command list entry errors code description -41 invalid enable code -42 internal address > maximum address -43 invalid node address (<0 or > 255) -44 count parameter set to 0 -45 invalid function code -46 invalid swap code
MVI46-MCM ? slc platform functional overview modbus interface module page 22 of 81 prosoft technology, inc. december 27, 2004
module configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 23 of 81 december 27, 2004 3 module configuration in order for the MVI46-MCM module to function, a minimum amount of configuration data must be transferred to the module. the following table provides an overview of the different types of configuration data that the module will require, depending on the operating modes to be supported. module register address functional modes affected name description 5000-5009 data transfer general module configuration this section of the conf iguration data contains the module configurati on data that defines the data transfer between the module and the slc processor. 5010-5039 and 5040-5069 master and slave port configuration these sections are used to define the characteristics of each of the modbus serial communication ports on the module. these parameters must be set correctly for proper module operation. 5070-5869 and 5870-6669 master master command list if the module?s master mode functionality is to be supported on a port, the master command list must be set up. refer to the setting up the module section for a description of the configuration of the module. the MVI46-MCM module must be configured at least once when the card is first powered, and any time thereafter when the parameters must be changed. 3.1 power up on power up, the module enters into a logical loop waiting to receive configuration data from the processor. upon receipt, the module will begin execution of the command list if it is present. 3.2 changing parameters during operation a copy of the module's configuration dat a is mapped in the module's m1 file as displayed in the previous table. these values are initialized when the module first receives its configuration from the slc processor. any node on the network can change this data. a master port on the module may poll a slave for the data or a slave port could receive the data from a remote master unit. the module will not use this data until it is commanded. ladder logic can be written to issue a write configuration command block (9997) to the module. a remote device can set a value of 9997 at address 7800 (n46:0) in the module to download the configuration to the processor. alternatively, the configuration/debug port on the module can be used to issue the command directly to the module. all three of these methods will force the module to download the configuration to the slc processor. ladder logic must exist
MVI46-MCM ? slc platform module configuration modbus interface module page 24 of 81 prosoft technology, inc. december 27, 2004 in the processor to accept the block sent by the module. if everything is configured correctly, the module can receive its configuration from a remote device. the ladder logic requirement section defines the minimum ladder logic required to apply the module in a user application. the logic is simple to understand and implement. go to the ladder logic section for a complete discussion of the ladder logic requirements. 3.3 setting up the module setup of the MVI46-MCM module only requires software configuration using the rslogix 500 program. the easiest method to implement the module is to start with the example provided with the module (mvi46mcm.rss). when installing this module in an existing application, simply copy the elements required from the example ladder logic to the application. note: the module can only be added to a project using the software in offline mode. the first step in setting up the module is to define the module to the system. select the io configuration option from the pr ogram screen. this displays the following dialog box: select the other module from the list. this causes the program to display the following dialog box:
module configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 25 of 81 december 27, 2004 enter the module io card id number as 12835, and then select the ok command button. double-click the mouse on the m odule just added to the rack. fill in the following dialog box presented as shown in the example: select the ok command button to apply these settings to the module. then, close the io configuration dialog box. the next step in the module?s setup is to define the user defined data areas to hold the configuration, port command lists, status and read and write database areas. at this point, take the time to fill in the configuration values in the mcm configuration data table. refer to the module data section of this document for information on configuring the module. the last step in the module setup is to add the ladder logic. if the example ladder logic is used, adjust the ladder to fit the application. when the ladder example is not used, copy the example ladder logic to your application and alter as necessary. the module is now set up and ready to be used with your application. insert the module in the rack and attach the modbus serial communication cables. download the new application to the controller and place the processor in run mode. if all the configuration parameters are set correctly and the module is attached to a modbus network, the module?s application led (app led) should remain off and the backplane activity led (bp act) should blink very rapidly. refer to the diagnostics and troubleshooting section of this manual if you encounter errors. attach a computer or terminal to debug/configuration port on the module and check the status of the module using the resident debugger in the module. 3.4 module data all data related to the MVI46-MCM module is stored in user defined data areas. the user is responsible for setting up the data areas to match the specific application for which the module is used. each data area is discussed in the following sections. 3.4.1 configuration data configuration of the module is performed by filling in a user defined data table. in the example ladder logic, file n10 is used to store the general module configuration
MVI46-MCM ? slc platform module configuration modbus interface module page 26 of 81 prosoft technology, inc. december 27, 2004 information. n11 is used to store the command list for port 1. n12 is used to store the command list for port 2. each register in the files has an associated symbol and description to aid in filling in the data. appendix e lists the items that must be configured for the module and their associated location in the m0 file. 3.4.1.1. backplane parameters in this revision of the module, all data to be transferred between the slc processor and the module is held in the module?s m1 file. this simplifies the ladder logic. in order to read data in the module, copy the specific data area in the m1 file into a user defined file. repeat this operation for each data area. remember, the maximum data area that can be copied with the cop instruction is 128 words. in order to write data to the module, copy the data in the user defined file to the specific data area in the m1 file. the read and write data operations should be limited to the m1 words 0 to 4999. the modules status data can be read from the m1 file starting at register 7200. only one parameter is used in this section of the configuration. the error status pointer parameter is used to define the location in the module?s database where the error/status data is stored. if the value is set to ?1, the data will not be stored in the user data area. a value between 0 and 4939 will cause the module?s program to store the data at the specified location. 3.4.1.2. port parameters these parameters are used to define the operation of each of the modbus ports on the module. refer to the appendix for a definition of each parameter. 3.4.1.3. master commands these records are used to define the commands in the master command list. each parameter is described in the following table: parameter description enable this parameter is used to define if t he command is executed or disregarded. the following values are valid: 0=disables the command and it will not execute. 1=the command will be consid ered for execution each scan of the command list and will be controlled by the pollint parameter. and 2=the command will only execute if the dat a associated with the command has changed since the command was last issued. this option is only available for write commands. intaddress this parameter specifies the starti ng internal register address to be associated with the command. valid entry for this parameter is 0 to 4999 for register address (0 to 65535 for bit address). polllnt this parameter defines the minimum num ber of seconds to wait between the execution of continuous commands (enable=1). this poll interval command can be used to lighten the communications load on a busy network. valid entry for this parameter is 0 to 65535. count this parameter defines the number of registers to be considered by the command. valid entry for this parameter is dependent on the modbus specification for the command.
module configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 27 of 81 december 27, 2004 parameter description swap this parameter is used to specify if the data used in the command must be altered when a modbus function code 3 is used to read data from a node on the network. values that can be assigned are as follows: 0=no swapping of data, 1=swap word values, 2=swap word and byte values and 3=swap byte values. this option is used when interfacing the module with ascii and floating-point data on other devices. node this parameter is used to assign the modbus slave node address for the module to reach with the command on the modbus network. this parameter can be assigned values from 0 to 255. most modbus networks limit the upper value to 247. func this parameter specifies the modbus function to be performed by the command. valid entries are 1, 2, 3, 4, 5, 6, 15 and 16. devaddress this parameter defines the starting addr ess in the device being considered by the command. values entered in this field are dependent on the node's database definition. refer to the specif ic manufacture's database definition for the device to determine the location of the data to be interfaced. 3.4.1.4. status data this data area is used to view the status of the module. this data can be used to monitor the state of the module at a "real-time rate". refer to the appendix for a complete listing of the data stored in this object. this data can be read from the module?s m1 file starting at register 7600. user data file n30 is defined in the example ladder logic for this purpose. 3.4.1.5. user data all user data is stored in the module?s m1 file in registers 0 to 4999. this 5000-word area is directly accessible from the ladder logic. the cop instruction should be used to move blocks of data between the user data files and the module?s m1 file. this limits the number of accesses to the m1 data area and provides faster system response. in the example ladder logic, n31 is used to hold data read from the module, and n32 is used to store data to write to the module. 3.4.1.6. slave polling control and status two data areas can be allocated in the slc to hold the polling status of each slave on the master ports. this status data can be used to determine which slaves are currently active on the port, are in communications error, or have their polling suspended and disabled. if the configuration supplies an address where this data resides, copy the data from the m1 file to the reserved files in the slc. using special blocks, the processor can enable or disable the polling of selected slaves.
MVI46-MCM ? slc platform module configuration modbus interface module page 28 of 81 prosoft technology, inc. december 27, 2004
ladder logic MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 29 of 81 december 27, 2004 4 ladder logic ladder logic is required for application of the MVI46-MCM module. tasks that must be handled by the ladder logic are module configuration, data transfer, special block handling and status data transfer. this section discusses each aspect of the ladder logic as required by the module. additionally, a power-up handler should be written to handle the initialization of the module's data and to clear any processor fault conditions. 4.1 mcm main the mcm main routine is used to recognize the presence of configuration requests, special command request and response messages and data transfer between the module and the processor. the following rung is used to save the current control word found in the m0 file: word 0 of the m0 file is used by the module to indicate the response to a special command instruction or to request the module?s configuration. during normal program execution, this register should have a value of zero. if any other value is present, the data transfer function will not be executed. the following rung is used to execute the data transfer function (mcm data, u:3) when the control word is set to zero. the following rung is called each scan to process any special command request and response messages.
MVI46-MCM ? slc platform ladder logic modbus interface module page 30 of 81 prosoft technology, inc. december 27, 2004 4.2 mcm data the mcm data task is responsible for handling the transfer of data between the processor user defined files and the module?s m1 file. in this simple example, the status data is copied from m1:1.7200 to n30:0; 200-words of read data are copied from the m1 file to n31; and 200-words of data are written from n32 to the m1 file. the logic to perform these tasks is shown in the following rung: 4.3 mcm cmds the mcm cmds subroutine is used to handle special block processing. this includes module configuration requests from the module and processor induced commands. each time the module perform a restart or warm-boot operation, the module will request its configuration from the slc processor. this request is made by placing a value of 9000 in the m0:1.0 register. when the ladder logic recognizes the value of 9000 in the control register, it copies the configuration information from the n10 file and the master port commands from the n11 and n12 file. after completing this task, the processor places a value of 9001 into the control register. this signals to the module that the configuration is ready to process. the module will continually wait for the value of 9001 in the control register. after the module is successfully configured, it will place a value of 0 in the control register so that normal data transfer can occur. example ladder logic to configure the module is shown in the following rung.
ladder logic MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 31 of 81 december 27, 2004 the slc processor can request a cold-boot operation of the module by placing a value of 9999 in the m1 register 7800 (command control register). ladder logic to perform this task is shown in the following example: the slc processor can request a warm boot operation of the module by placing a value of 9998 in the m1 register 7800 (command control register). ladder logic to perform this task is shown in the following rung.
MVI46-MCM ? slc platform ladder logic modbus interface module page 32 of 81 prosoft technology, inc. december 27, 2004 user defined commands can be constructed and sent to a modbus master port on the module under processor control. in order to perform this task, the command must be constructed or stored in a user-defined file. in the example ladder logic, file n42 is used to store a single command. under program control, this command is sent to modbus master port 1 on the module. the contents of n42 is shown in the following example: after the module processes the command event request, it will set the value in m1:1.7800 to zero and place the command event request code in m0:1.0. the ladder
ladder logic MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 33 of 81 december 27, 2004 logic can use the information returned from the module in m0:1.1 to perform more processing or simply ignore the data (as shown in the following rung). the following rung is used to control the slave poll list for the modbus master port 1. the processor can enable or disable a slav e in the poll list by placing the slave node address into logic like that shown. the logic shown is used to disable polling for slave unit 2. similar logic is given in the example ladder logic to enable the same slave unit. during normal program execution in the module, the command list is processed from the first enabled command to the last. the processor can place commands in the command list (enabled or disabled commands) in the command queue. the queue has a higher priority and all commands in the queue will execute before the normal command list is processed. ladder logic to place commands 1 and 2 into the command queue is shown in the following example:
MVI46-MCM ? slc platform ladder logic modbus interface module page 34 of 81 prosoft technology, inc. december 27, 2004 the configuration information can be transferred from the module to the processor with block 9997. this rung copies the configuration information from m0 to the n:10 configuration file.
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 35 of 81 december 27, 2004 5 diagnostics and troubleshooting the module provides diagnostic information in three forms to the user. 1) status data values are transferred from the module to the controller tags in the slc processor. 2) all data contained in the module can be viewed through the configuration/debug port to an attached terminal emulator. 3) led status indicators on the front of the module yield information on the modules status. the following sections explain how to obtain the status data from the module and the meaning of the individual led's on the module. 5.1 reading status da ta from the module the MVI46-MCM module returns a 33-word status data block that can be used to determine the module?s operating status. this data is located in the module's database at registers 7200 to 7232 and at the location specified in the configuration. this data is transferred to the slc processor continuously with each read block. for a complete listing of the status data object, refer to the module set up section. 5.1.1 required hardware the hardware requirements to interface with the configuration/debugger port are not too stringent. a personal computer with a standard serial port should suffice. for optimal performance, the minimum is required: 80468 based processor (pentium preferred) 1 megabyte of memory at least one serial communications port available additionally, a null-modem cable is r equired between your pc and the port. the module's port has a db-9 male connector at the end of a rj-45 to db-9 pigtail. the rj-45 end of the cable is to be placed in the MVI46-MCM port 1 connector (top port). the cable required is shown in the following diagram: 2 3 5 rxd txd com MVI46-MCM configuration/debug port cable db-9 male rxd txd com rs-232 host 5.1.2 required software the software required on your personal computer to interface with the configuration/debugger port is operating system dependent. tested software includes the following:
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 36 of 81 prosoft technology, inc. december 27, 2004 dos procomm, ps-term and several ot her terminal emulation programs windows 3.1 terminal windows 95/98 hyperterminal and ps-term windows nt/2000/xp hyperterminal linux minicom any ascii terminal emulation software pa ckage provided with your operating system should work as long as it can be configured as follows: baud rate 57,600 parity none data bits 8 stop bits 1 file transfer protocol zmodem 5.1.3 using the port the following steps are required to interface with the configuration/debugger port: 1. connect your computer to the m odule's port using a null-modem cable. 2. start the terminal emulation program on your computer and configure the communication parameters to those shown in the required software section (57,600k, n, 8, 1). 3. enter the '?' character on your computer. if everything is set up correctly, the port's menu is displayed. if there is no response from the module, check the communication setup and the cable. in addition, make sure you are connected to the correct port on your computer and the module. 5.1.4 menu options features available through the use of the configuration/debug port on the mvi46- mcm module are all reached using single keystrokes on your computer. there is a single main menu and several sub-menus presented on the port. to view the current selections available, press the '?' key on your computer. if you are in main menu mode, the following menu is displayed:
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 37 of 81 december 27, 2004 if this menu is not displayed, press the 'm' key to display the main menu. all facilities offered by the configuration/debugger are shown on the main menu. each option is discussed in the following sections: 5.1.4.1. a=data analyzer selection of this menu option places the program in analyzer menu mode. this mode of operation is used to display modbus messages generated and received by the module. to view the menu options available in this mode, press the '?' key and the following menu is displayed: this tool is extremely useful in determining the operation of the module and nodes on the network of each port. the parameters shown at the bottom of the display show the current analyzer settings. each of the menu options is discussed in the following sections: 5.1.4.1.1. 1=select port 1 this option is used to select modbus port 1 for analysis. data displayed when in analyzer mode will relate to this port.
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 38 of 81 prosoft technology, inc. december 27, 2004 5.1.4.1.2. 2=select port 2 this option is used to select the modbus port 2 for analysis. data displayed when in analyzer mode will relate to this port. 5.1.4.1.3. 5=1 msec ticks this option is used to generate 1-millisecond timing marks on the display. this may help when determining communication-timing characteristics. 5.1.4.1.4. 6=5 msec ticks this option is used to generate 5-millisecond timing marks on the display. this may help when determining communication-timing characteristics. 5.1.4.1.5. 7=10 msec ticks this option is used to generate 10-millisecond timing marks on the display. this may help when determining communication-timing characteristics. 5.1.4.1.6. 8=50 msec ticks this option is used to generate 50-millisecond timing marks on the display. this may help when determining communication-timing characteristics. 5.1.4.1.7. 9=100 msec ticks this option is used to generate 100-millisecond timing marks on the display. this may help when determining communication-timing characteristics. 5.1.4.1.8. 0=no msec ticks this option is used to turn the display of timing marks off. 5.1.4.1.9. h=hex format this option is used to select the display of the data in hexadecimal format. this format is most useful when viewing modbus rtu protocol messages. 5.1.4.1.10. a=ascii format this option is used to select the display of the data in ascii format. this format is most useful when viewing modbus ascii protocol messages. 5.1.4.1.11. b=start this option is used to start the data analyzer. after the key is pressed, all data transmitted and received on the currently se lected port is displayed. an example display is shown:
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 39 of 81 december 27, 2004 the following table describes the special characters used in the display: [ ] data enclosed in these characters represent data received on the port. < > data enclosed in these characters represent data transmitted on the port. these characters are inserted when the rts line is driven high on the port. these characters are inserted when the rts line is dropped low on the port. these characters are displayed when the cts line is recognized high. _tt_ these characters are displayed when the timing mark interval has been reached. this paramet er is user defined. 5.1.4.1.12. s=stop this option is used to stop the analyzer. use this option to freeze the display so the data can be analyzed. to restart the analyzer, press the 'b' key. warning -- when in analyzer mode, program execut ion will slow down. only use this tool during a trouble-shooting session. disable the analyzer before leaving the module to run in its normal mode. 5.1.4.1.13. m = main menu this menu option is used to return to the main menu mode. 5.1.4.2. b=block transfer statistics this menu option is used to display the configuration and statistics of the backplane data transfer operations. after selecting this option, the following is displayed. selecting this option at one-second intervals can be used to determine the number of blocks transferred each second.
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 40 of 81 prosoft technology, inc. december 27, 2004 5.1.4.3. c=module configuration this option displays the general module configuration information for the mvi46- mcm module. after selecting the option, the following screen is displayed. 5.1.4.4. d=modbus database view selection of this menu option places the program in database view menu mode. this mode of operation is used to display the module's internal database values. to view the menu options available in this mode, press the '?' key and the following menu is displayed. all data contained in the module's database is available for viewing using the menu options. each option available on the menu is discussed in the following sections. 5.1.4.5. 0-9 register pages 0-9000 this menu option is used to jump to a specific set of registers in the database and display the data. the keys perform the following functions.
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 41 of 81 december 27, 2004 key function 0 display registers 0 to 99 1 display registers 1000 to 1099 2 display registers 2000 to 2099 3 display registers 3000 to 3099 4 display registers 4000 to 4099 5 display registers 5000 to 5099 6 display registers 6000 to 6099 7 display registers 7000 to 7099 8 display registers 8000 to 8099 9 display registers 9000 to 9099 5.1.4.6. s=show again this menu option is used to display the current page of 100 registers in the database. example output of the database display is shown: 5.1.4.6.1. - = back 5 pages this menu option is used to skip the previous 500 registers of data for viewing and display the data. 5.1.4.6.2. p = previous page this menu option is used to select and display the previous 100 registers of data. 5.1.4.6.3. + = skip 5 pages this menu option is used to skip 500 registers of data and to display the new page of data. 5.1.4.6.4. n = next page this menu option is used to select the next 100 registers of data for viewing and displays the data. 5.1.4.6.5. d = decimal display this menu option is used to display the data on the current page in decimal format.
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 42 of 81 prosoft technology, inc. december 27, 2004 5.1.4.6.6. h = hexadecimal display this menu option is used to display the data on the current page in hexadecimal format. 5.1.4.6.7. f = float display this menu option is used to display the data on the current page in floating-point format. the program assumes that the values are aligned on even register boundaries. if floating-point values are not aligned as such, they will not be displayed properly. 5.1.4.6.8. a = ascii display this menu option is used to display the data on the current page in ascii format. this is useful for regions of the database that contain ascii data. 5.1.4.6.9. m = main menu this menu option is used to return to the main menu mode. 5.1.4.7. e and f=master command errors (ports 1 and 2) selection of these menu options places the program in master command error menu mode for the specified port. this mode of operation is used to display multiple pages of master command list error/status data. to view the menu options available in this mode, press the '?' key and the following menu is displayed. each menu option is discussed in the following sections: 5.1.4.7.1. s = show again this option is used to display the current page of master command error/status data. after selecting the option, the following screen is displayed. each value displayed on the screen corresponds to the error/status code for the associated master command list index. refer to the module set up section for complete listing and interpretation of the codes displayed.
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 43 of 81 december 27, 2004 5.1.4.7.2. - = back 2 pages this option is used to skip back 20 commands and display the data. 5.1.4.7.3. p = previous page this option is used to display the previous page of data. 5.1.4.7.4. + = skip 2 pages this option is used to skip past the next 20 commands and display the data. 5.1.4.7.5. n = next page this option is used to display the next page of master command list error/status data. 5.1.4.7.6. d = decimal display this option is used to change the display of the data to decimal format. 5.1.4.7.7. h = hexadecimal display this option is used to change the display of error/status data to hexadecimal format. 5.1.4.7.8. m = main menu this option is used to return the program to main menu mode. 5.1.4.8. i and j=master command list (ports 1 and 2) selection of these menu options places the program in master command list menu mode for the specified port. this mode of operation is used to display multiple pages of master command list data. to view the m enu options available in this mode, press the '?' key and the following menu is displayed. each option on the menu is discussed in the following sections: 5.1.4.8.1. s = show again this option is used to display the current page of master commands. ten commands are displayed on each page as shown in the following example:
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 44 of 81 prosoft technology, inc. december 27, 2004 5.1.4.8.2. - = back 5 pages this menu option is used to display the master command list data after skipping the previous 50 commands. 5.1.4.8.3. p = previous page this menu option is used to display the previous page of master command list data. 5.1.4.8.4. + = skip 5 pages this menu option is used to display the master command list data after skipping the next 50 commands. 5.1.4.8.5. n = next page this menu option is used to display the next page of master command list data. 5.1.4.8.6. m = main menu this option is used to return to the main menu mode of operation. 5.1.4.9. o and p=slave status list (port 1 and 2) selection of these menu options displays the 256 slave status values associated with the ports. values shown have the following definitions: 0 = slave is not used, 1 = slave being actively polled, 2 = slave suspended and 3 = slave disabled.
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 45 of 81 december 27, 2004 5.1.4.10. v=version information this option is used to view the current version of the software for the module and other important values. after selecting the option, the following is displayed. this information may be requested when calling for technical support on the product. values at the bottom of the display are important in determining module operation. the program scan counter value is incremented each time a module's program cycle is complete. this value can be used to determine the frequency of program execution by pressing the 'v' key at one-second intervals. 5.1.4.11. w=warm boot module this option is selected when a warm-boot operation is required of the module. this request is usually made after configuration changes are set in the slc processor's controller tags data area to implement the changes. after selecting the option, the following is displayed.
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 46 of 81 prosoft technology, inc. december 27, 2004 5.1.4.12. y=transfer module cfg to processor this option is used to transfer the current configuration data in the module to the slc processor. ladder logic must exist in the processor to successfully implement this option. after selecting the option, the following is displayed for successful operation. if the operation is not successful, an error code is returned. error codes returned are as follows: code description 0 transfer successful -1 error transferring module configuration data (block ?9000) after successful data transfer, the module performs a warm boot operation to read in the new data. 5.1.4.13. 1 and 2=communication status (ports 1 and 2) these options are used to display the communication status and statistics of the specified modbus port. this information can be informative when trouble-shooting network problems. after selecting the option, the following information is displayed. 5.1.4.14. 6 and 7=port configuration (ports 1 and 2) these options are used to display the configuration information for the selected modbus port. after selecting the option, the following information is displayed.
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 47 of 81 december 27, 2004 5.1.4.15. esc=exit program this option is used to exit the program and to display the operating system prompt. this option should only be selected if instructed by the prosoft technical support group. if you select the option, the module will cease operation. data will no longer be transferred between the modbus ports and the module and between the slc processor and the module. this might cause an upset to a currently running process. 5.2 led status indicators the led's will indicate the module?s operating status as follows: prosoft module color status indication on data is being transferred between the module and a remote terminal using the configuration/debug port. p1 green off no data is being transferred on the configurat ion/debug port. on data is being transferred between the module and the modbus network on its modbus port 1. p2 green off no data is being transferred on the port. on data is being transferred between the module and the modbus network on its modbus port 2. p3 green off no data is being transferred on the port. on the MVI46-MCM is working normally. app amber off the MVI46-MCM module program has recognized a communication error on one of its modbus ports. on the led is on when the module is performing a write operation on the backplane. bp act amber off the led is off when the module is performing a read operation on the backplane. under normal operation, the led should blink rapidly on and off.
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 48 of 81 prosoft technology, inc. december 27, 2004 prosoft module color status indication off the card is not receiving any power and is not securely plugged into the rack. green the module is operating normally. ok red/ green red the program has detected an error or is being configured. if the led remains red for over 10 seconds, the program has probably halted. remove the card from the rack and re-insert the card to restart the module's program. off the battery voltage is ok and functioning. bat red on the battery voltage is low or the battery is not present. replace the battery on the module. during module configuration, the act/flt led is red and the app and bp act led?s will be on. if the led?s are latched in this mode for a long period of time, check the configuration error words in the configuration request block. the structure of the block is shown in the following table. m0 offset description length 0 9000 1 1 spare 1 2 port 1 configuration errors 1 3 port 2 configuration errors 1 the port configuration error words have the following definitions : bit description v alue 0 type code is not valid. enter a value from 0 ( master ) to 1 ( slave ) . 0x0001 1 protocol parameter is not valid. 0x0002 2 termination t y pe parameter is not valid. 0x0004 3 baud rate parameter is not valid. 0x0008 4 parit y parameter is not valid. 0x0010 5 data bits parameter is not valid. 0x0020 6 stop bits parameter is not valid. 0x0040 7 command count parameter is not valid. 0x0080 8 retry count parameter is not valid. 0x0100 9 spare 0x0200 10 spare 0x0400 11 spare 0x0800 12 spare 0x1000 13 spare 0x2000 14 spare 0x4000 15 spare 0x8000 correct any invalid data in the configuration for proper module operation. when the configuration contains a valid parameter set, all the bits in the configuration words will be clear. this does not indicate that the configuration is valid for the user application. make sure each parameter is set correctly for the specific application. if the app, bp act and act/flt led?s blink at a rate of every one-second, call prosoft technology, inc. support. there is a serious problem with the module, and it will have to be sent back to prosoft.
diagnostics and troubleshooting MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 49 of 81 december 27, 2004 5.2.1 clearing a fault condition typically, if the act/fault led on the front of the module becomes illuminated red for over ten seconds, a hardware problem has been detected in the module or the program has exited. to attempt to clear the condition: 1. remove the card from the rack and re-insert the card in the rack 2. verify the configuration data being transferred to the module from the slc processor if the module?s act/fault led does not turn green, make sure the module is inserted completely into the rack. if this does not cure the problem, contact the factory. 5.2.2 troubleshooting in order to assist in the troubleshooting of the module, the following table has been put together to assist you. please use the fo llowing to help in using the module, but if you have additional questions or problems, please do not hesitate to contact us. the entries in this section have been placed in the order in which the problems would most likely occur after powering up the module. problem description steps to take processor fault be sure that the module is plu gged into the slot that has been configured for the MVI46-MCM module. assure that the slot in the rack c onfiguration has been set up correctly: processor i/o led flashes this indicates there is a problem with backplane communications. be certain this and all modules in the rack are configured in the processor. bp act led remains off or blinks slowly this indicates that backplane transfe r operations are failing. use the configuration/debug port facility to check this. to establish backplane communications make su re of the following: the backplane driver is loaded in the module. the module is configured for read and write block data transfer. the ladder logic handles all read and write block situations. the module is configur ed in the processor. ok led remains red the program has halted or a critical error has occurred. connect to the configuration/debug port to see if the module is running. if the program has halted, remove the card from the rack and re-insert the card in the rack.
MVI46-MCM ? slc platform diagnostics and troubleshooting modbus interface module page 50 of 81 prosoft technology, inc. december 27, 2004
cable connections MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 51 of 81 december 27, 2004 6 cable connections the MVI46-MCM module has the following communication connections on the module: ? two modbus communication ports (rj45 connector) ? one rs-232 configuration/debug port (rj45 connector) communication p1 p2 p3 a pp bp bat ok module configuration/ debug port mcm slave serial port 2 mcm master or backup slave serial port 3 6.1 modbus communication ports the MVI46-MCM module has two physical modbus connectors with a rj45 plug located on the front of the module. 6.1.1 connecting the cable to the connector prosoft provides two rj45 to male db-9 pigtails to permit simpler interfacing to other devices. the module's mcm ports can be configured to operate in rs-232, rs-422 or rs-485 mode. the interface to be associated with a port is set with jumpers on the module. there is a jumper for each of the two ports ( see setting the jumpers). additionally, the use of the modem control lines is user definable. each interface is described in the following sections.
MVI46-MCM ? slc platform cable connections modbus interface module page 52 of 81 prosoft technology, inc. december 27, 2004 6.1.1.1. rs-232 when the rs-232 interface is selected, the use of the modem control lines is user definable. if no modem control lines are used, the cable to connect to the port is as shown in the following example: 2 3 5 rxd txd com MVI46-MCM modbus port rs-232 cable (no handshaking) db-9 male rxd txd com rs-232 host the rts line is controlled by the rts on and off parameters set for the port. if the cts line is used (usually only required fo r half-duplex modems), the rts and cts lines must either be connected together or connected to the modem. the following diagram displays the cable required when connecting the port to a modem. 2 3 5 rxd txd com MVI46-MCM modbus port rs-232 cable (use cts line and modem) db-9 male txd rxd com modem 7 rts rts 8 cts cts 6.1.1.2. rs-485 when the rs-485 interface is used, a single two or three wire cable is required. the use of the ground is optional and dependent on the rs-485 network. the cable required for this interface is shown in the following diagram: 1 8 5 txd/rxd+ txd/rxd- gnd MVI46-MCM modbus port rs-485 db-9 male txd/rxd- txd/rxd+ gnd rs-485 device 6.1.1.3. rs-422 when the rs-422 interface is used, a four or five wire cable is required. the use of the ground is optional and dependent on the rs-422 network. the cable required for this interface is shown in the following diagram:
cable connections MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 53 of 81 december 27, 2004 1 8 5 txd+ txd- com MVI46-MCM modbus port rs-422 cable db-9 male rxd- rxd+ com rs-422 device 2 rxd+ txd+ 6 rxd- txd- 6.1.2 setting the jumpers if using an interface other than rs-232 (default), you must change the jumpers on the module to the appropriate interface. the following diagram shows the jumper configurations for the MVI46-MCM module: 6.1.2.1. rs-232 configuration/debug port this port is physically a rj-45 connection. a rj-45 to db-9 pigtail cable is shipped with the module. this port permits a pc based terminal emulation program to view configuration and status data in the module and to control the module. the cable for communications on this port is shown in the following diagram: 2 3 5 rxd txd com mvi46-mbp configuration/debug port cable db-9 male rxd txd com rs-232 host
MVI46-MCM ? slc platform cable connections modbus interface module page 54 of 81 prosoft technology, inc. december 27, 2004
appendix a - MVI46-MCM databas e definition MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 55 of 81 december 27, 2004 appendix a - MVI46-MCM database definition this appendix contains a listing of the internal database of the MVI46-MCM module. this information can be used to interface other devices to the data contained in the module. register range modbus low modbus high content size 0-4999 40001 45000 user data 5000 5000-5009 45001 45010 backplane configuration 10 5010-5039 45011 45040 port 1 setup 30 5040-5069 45041 45070 port 2 setup 30 5070-6069 45071 46070 port 1 commands 1000 6070-7069 46071 47070 port 2 commands 1000 7200-7232 47201 47233 misc. status data 33 7600-7799 47601 48000 command control 200 the user data area is used to hold data collected from other nodes on the network (master read commands) or data received from the processor (write blocks). additionally, this data area is used as a data source for the processor (read blocks) or other nodes on the network (write commands). detailed definition of the miscellaneous status data area can be found in appendix b. definition of the configuration data areas can be found in the data definition section of this document and in appendix c. appendix d contains a discussion of the command control section of the database.
MVI46-MCM ? slc platform appendix a - mv i46-mcm database definition modbus interface module page 56 of 81 prosoft technology, inc. december 27, 2004
appendix b ? MVI46-MCM status data definition MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 57 of 81 december 27, 2004 appendix b ? MVI46-MCM status data definition this appendix contains a description of the data present in the status data area. this data is constantly transferred from the module to the m1 data area. m1 file content description 7200 program scan count this value is incremented each time a complete program cycle occurs in the module. 7201-7202 product code these two registers contain the product code of ?mcm4?. 7203-7204 product version these two registers contain the product version for the currently running software. 7205-7206 operating system these two registers cont ain the month and year values for the program operating system. 7207-7208 run number these two registers contain the run number value for the currently running software. 7209 port 1 command list requests this field contains the number of requests made from this port to slave devices on the network. 7210 port 1 command list response this field contains the number of slave response messages received on the port. 7211 port 1 command list errors this field contains the number of command errors processed on the port. these errors could be due to a bad response or command. 7212 port 1 requests this field contains the total number of messages sent out of the port. 7213 port 1 responses this field contains the total number of messages received on the port. 7214 port 1 errors sent this field contains the total number of message errors sent out of the port. 7215 port 1 errors received this field contains the total number of message errors received on the port. 7216 port 2 command list requests this field contains the number of requests made from this port to slave devices on the network. 7217 port 2 command list response this field contains the number of slave response messages received on the port. 7218 port 2 command list errors this field contains the number of command errors processed on the port. these errors could be due to a bad response or command. 7219 port 2 requests this field contains the total number of messages sent out of the port. 7220 port 2 responses this field contains the total number of messages received on the port. 7221 port 2 errors sent this field contains the total number of message errors sent out of the port. 7222 port 2 errors received this field contains the total number of message errors received on the port. 7223 read block count this field contains the total number of read blocks transferred from the module to the processor.
MVI46-MCM ? slc platform appendix b ? MVI46-MCM status data definition modbus interface module page 58 of 81 prosoft technology, inc. december 27, 2004 m1 file content description 7224 write block count this field contains the total number of write blocks transferred from the processor to the module. 7225 parse block count not used in this version of the module. 7226 command event block count this field contains the total number of command event blocks received from the processor. 7227 command block count this field contains the total number of command blocks received from the processor. 7228 error block count this field contains the total number of block errors recognized by the module.
appendix c ? MVI46-MCM configurati on data definition MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 59 of 81 december 27, 2004 appendix c ? MVI46-MCM configuration data definition this appendix contains listings of the MVI46-MCM module's database that are related to the module's configuration. this data is available to any node on the network and is read from the slc processor when the module first initializes. group register content description backplane setup 5000 write start reg not used in this version of the software 5001 write reg count not used in this version of the software 5002 read start reg not used in this version of the software 5003 read reg count not used in this version of the software 5004 backplane fail not used in this version of the software 5005 error status pointer this parameter spec ifies the register location in the module?s database where module status data is stored. if a value less than 0 is entered, the data will not be stored in the database. if the value specified is in the range of 0 to 4940, the data is placed in the user data area. 5006 spare 5007 spare 5008 spare 5009 spare port 1 setup 5010 enable this parameter is used to define if this port will be used. if the parameter is set to 0, the port is disabled. a value of 1 enables the port. 5011 type this parameter defines if the port emulates a master or slave device. enter 0 to emulate a master device and 1 to emulate a slave device. 5012 float flag this flag specifies if the floating-point data access functionality is to be used. if the float flag is set to y, modbus functions 3,6, and 16 will interpret floating point values for registers as specified by the two following parameters. 5013 float start this parameter defines the first register of floating-point data. all requests with register values greater than or equal to this value will be considered floating-point data requests. this parameter is only used if the float flag is enabled. for example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered floating-point data.
MVI46-MCM ? slc platform appendix c ? MVI46-MCM configuration data definition modbus interface module page 60 of 81 prosoft technology, inc. december 27, 2004 group register content description 5014 float offset this parameter defines the start register for floating-point data in the internal database. this parameter is onl y used if the float flag is enabled. for example, if the float offset value is set to 3000 and the float start parameter is set to 7000, data requests for register 7000 will use the internal modbus register 3000. 5015 protocol 0=modbus rtu, 1=modbus ascii 5016 baud rate this is the baud rate to be used on the port. enter the baud rate as a value. for example, to select 19k baud, enter 19200. exceptions: 38400 baud, enter 384. 57600 enter 576. 115000 enter 115. 5017 parity this is the parity code to be used on the port. the coded values are as follows: 0=none 1=odd 2=even 5018 data bits this parameter sets the number of data bits for each word used by the protocol. enter a value in the range of 5 to 8. 5019 stop bits this parameter sets the number of stop bits to be used with each data value sent. enter a value of 1 or 2. 5020 rts on delay this parameter sets the number of milliseconds to delay after rts is asserted before the data will be transmitted. enter a value in the range of 0 to 65535. 5021 rts off delay this parameter sets the number of milliseconds to delay after the last byte of data is sent before the rts modem signal will be set low. enter a value in the range of 0 to 65535. 5022 minimum response delay this parameter sets the number of milliseconds to wait before a response message is sent out of the port. this parameter is required when interfacing to a slow responding device. enter a value in the range of 0 to 65535. 5023 use cts line this parameter specif ies if the cts modem control line is to be used. if the parameter is set to 0, the cts line will not be monitored. if the parameter is set to 1, the cts line will be monitored and must be high before the module will send data. normally, this parameter is required when half-duplex modems are used for communication (2-wire).
appendix c ? MVI46-MCM configurati on data definition MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 61 of 81 december 27, 2004 group register content description 5024 slave id this parameter defines the virtual modbus slave address for the internal database. any requests received by the port with this address will be processed by the module. be certain each device has a unique address on the network. 5025 bit input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 2 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database. 5026 word input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 4 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database. 5027 output offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 1, 5, or 15 commands. for example, if the value is set to 100, an address request of 0 will return the value at register 100 in the database. 5028 holding register offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus 3, 6, or 16 commands. for example, if the value is set to 50, an address request of 0 will return the value at register 50 in the database. 5029 command count this parameter specifies the number of commands to be processed for the port. enter a value of 0 to 100. 5030 minimum command delay this parameter specifies the number of milliseconds to wait between the initial issuance of a command. this parameter can be used to delay all commands sent to slaves to avoid ?flooding? commands on the network. this parameter does not affect retries of a command as they will be issued when failure is recognized. enter a value in the range of 0 to 65535. 5031 command error pointer this parameter sets the address in the internal modbus database where the command error data is placed. if the value is set to ?1, the data will not be transferred to the database. enter a value of 0 to 4999.
MVI46-MCM ? slc platform appendix c ? MVI46-MCM configuration data definition modbus interface module page 62 of 81 prosoft technology, inc. december 27, 2004 group register content description 5032 response timeout this parameter represents the message response timeout period in 1 ms increments. this is the time that a port configured as a master will wait before re- transmitting a command if no response is received from the addressed slave. the value is set depending on to communication network used and the expected response time of the slowest device on the network. 5033 retry count this parameter specifies the number of times a command is retried if it fails. enter a value in the range of 0 to 10. 5034 error delay count this parameter specifies the number of polls to be skipped on the slave before trying to re-establish communications. after the slave fails to respond, the master will skip commands to be sent to the slave the number of times entered in the parameter. enter a value in the range of 0 to 65535. 5035 reserved 5036 guard band timer use packet gap timeout for messages (yes or no). use only in multi-drop applications. 5037 guard band timeout a value of 0 uses the default baud rate or you can set a timeout value in milliseconds. port 2 setup 5040 enable this parameter is used to define if this port will be used. if the parameter is set to 0, the port is disabled. a value of 1 enables the port. 5041 type this parameter defines if the port emulates a master or slave device. enter 0 to emulate a master device and 1 to emulate a slave device. 5042 float flag this flag specifies if the floating-point data access functionality is to be used. if the float flag is set to y, modbus functions 3,6, and 16 will interpret floating point values for registers as specified by the two following parameters. 5043 float start this parameter defines the first register of floating-point data. all requests with register values greater than or equal to this value will be considered floating-point data requests. this parameter is only used if the float flag is enabled. for example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered floating-point data. 5044 float offset this parameter defines the start register for floating-point data in the internal database. this parameter is onl y used if the float flag is enabled. for example, if the float offset value is set to 3000 and the float start parameter is set to 7000, data requests for register 7000 will use the internal modbus register 3000.
appendix c ? MVI46-MCM configurati on data definition MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 63 of 81 december 27, 2004 group register content description 5045 protocol 0=modbus rtu, 1=modbus ascii 5046 baud rate this is the baud rate to be used on the port. enter the baud rate as a value. for example, to select 19k baud, enter 19200. exceptions: 38400 baud, enter 384. 57600 enter 576. 115000 enter 115. 5047 parity this is the parity code to be used on the port. the coded values are as follows: 0=none 1=odd 2=even 5048 data bits this parameter sets the number of data bits for each word used by the protocol. enter a value in the range of 5 to 8. 5049 stop bits this parameter sets the number of stop bits to be used with each data value sent. enter a value of 1 or 2. 5050 rts on delay this parameter sets the number of milliseconds to delay after rts is asserted before the data will be transmitted. enter a value in the range of 0 to 65535. 5051 rts off delay this parameter sets the number of milliseconds to delay after the last byte of data is sent before the rts modem signal will be set low. enter a value in the range of 0 to 65535. 5052 minimum response delay this parameter sets the number of milliseconds to wait before a response message is sent out of the port. this parameter is required when interfacing to a slow responding device. enter a value in the range of 0 to 65535. 5053 use cts line this parameter specif ies if the cts modem control line is to be used. if the parameter is set to 0, the cts line will not be monitored. if the parameter is set to 1, the cts line will be monitored and must be high before the module will send data. normally, this parameter is required when half-duplex modems are used for communication (2-wire). 5054 slave id this parameter defines the virtual modbus slave address for the internal database. any requests received by the port with this address will be processed by the module. be certain each device has a unique address on the network. 5055 bit input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 2 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database.
MVI46-MCM ? slc platform appendix c ? MVI46-MCM configuration data definition modbus interface module page 64 of 81 prosoft technology, inc. december 27, 2004 group register content description 5056 word input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 4 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database. 5057 output offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 1, 5, or 15 commands. for example, if the value is set to 100, an address request of 0 will return the value at register 100 in the database. 5058 holding register offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus 3, 6, or 16 commands. for example, if the value is set to 50, an address request of 0 will return the value at register 50 in the database. 5059 command count this parameter specifies the number of commands to be processed for the port. enter a value of 0 to 100. 5060 minimum command delay this parameter specifies the number of milliseconds to wait between the initial issuance of a command. this parameter can be used to delay all commands sent to slaves to avoid ?flooding? commands on the network. this parameter does not affect retries of a command as they will be issued when failure is recognized. enter a value in the range of 0 to 65535. 5061 command error pointer this parameter sets the address in the internal modbus database where the command error data will be placed. if the value is set to ?1, the data will not be transferred to the database. enter a value of 0 to 4999. 5062 response timeout this parameter represents the message response timeout period in 1 ms increments. this is the time that a port configured as a master will wait before re- transmitting a command if no response is received from the addressed slave. the value is set depending on to communication network used and the expected response time of the slowest device on the network. 5063 retry count this parameter specifies the number of times a command will be retried if it fails. enter a value in the range of 0 to 10.
appendix c ? MVI46-MCM configurati on data definition MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 65 of 81 december 27, 2004 group register content description 5064 error delay count this parameter specifies the number of polls to be skipped on the slave before trying to re-establish communications. after the slave fails to respond, the master will skip commands to be sent to the slave the number of times entered in the parameter. enter a value in the range of 0 to 65535. 5065 reserved 5066 use guard band timer use packet gap timeout for messages (yes or no). use only in multi-drop applications. 5066 guard band timeout a value of 0 uses the default baud rate or you can set a timeout value in milliseconds (0 to 65535). port 1 commands 5200-5209 command #1 this set of registers contains the parameters for the first command in the master command list. the structure of this data area is as described in the data object section of the documentation. 5210-5219 command #2 command #2 dataset 6190-6199 command #100 command #100 dataset port 2 commands 6200-6209 command #1 this set of registers contains the parameters for the first command in the master command list. the structure of this data area is as described in the data object section of the documentation. 6210-6219 command #2 command #2 dataset 7190-7199 command #100 command #100 dataset misc. status 7200 program scan count this value is incremented each time a complete program cycle occurs in the module. 7201 product code these two registers contain the product code of ?mcm4?. 7202 7203 product version these two registers contain the product version for the currently running software. 7204 7205 operating system these two registers contain the month and year values for the program operating system. 7206 7207 run number these two registers contain the run number value for the currently running software. 7208 7209 port 1 command list requests this field contains the number of requests made from this port to slave devices on the network. 7210 port 1 command list response this field contains the number of slave response messages received on the port.
MVI46-MCM ? slc platform appendix c ? MVI46-MCM configuration data definition modbus interface module page 66 of 81 prosoft technology, inc. december 27, 2004 group register content description 7211 port 1 command list errors this field contains the number of command errors processed on the port. these errors could be due to a bad response or command. 7212 port 1 requests this field contains the total number of messages sent out the port. 7213 port 1 responses this field contains the total number of messages received on the port. 7214 port 1 errors sent this field contains the total number of message errors sent out the port. 7215 port 1 errors received this field contains the total number of message errors received on the port. 7216 port 2 command list requests this field contains the number of requests made from this port to slave devices on the network. 7217 port 2 command list response this field contains the number of slave response messages received on the port. 7218 port 2 command list errors this field contains the number of command errors processed on the port. these errors could be due to a bad response or command. 7219 port 2 requests this field contains the total number of messages sent out the port. 7220 port 2 responses this field contains the total number of messages received on the port. 7221 port 2 errors sent this field contains the total number of message errors sent out the port. 7222 port 2 errors received this field contains the total number of message errors received on the port. 7223 read block count this field contains the total number of read blocks transferred from the module to the processor. 7224 write block count this field contains the total number of write blocks transferred from the processor to the module. 7225 parse block count this field contains the total number of blocks successfully parsed that were received from the processor. 7226 command event block count this field contains the total number of command event blocks received from the processor. 7227 command block count this field contains the total number of command blocks received from the processor. 7228 error block count this field contains the total number of block errors recognized by the module. 7229 port 1 current error/index for a slave port, this field contains the value of the current error code returned. for a master port, this field contains the index of the currently executing command.
appendix c ? MVI46-MCM configurati on data definition MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 67 of 81 december 27, 2004 group register content description 7230 port 1 last error/index for a slave port, this field contains the value of the last error code returned. for a master port, this field contains the index of the command with an error. 7231 port 2 current error/index for a slave port, this field contains the value of the current error code returned. for a master port, this field contains the index of the currently executing command. 7232 port 2 last error/index for a slave port, this field contains the value of the last error code returned. for a master port, this field contains the index of the command with an error. command control 7800 command code enter one of the valid control command codes in this register to control the module (9997, 9998, or 9999). refer to appendix d for more information. 7801 command data reserved for future use. ? ? ? 7999 command data reserved for future use.
MVI46-MCM ? slc platform appendix c ? MVI46-MCM configuration data definition modbus interface module page 68 of 81 prosoft technology, inc. december 27, 2004
appendix d ? MVI46-MCM remote configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 69 of 81 december 27, 2004 appendix d ? MVI46-MCM remote configuration remote configuration data can be received from other nodes on the network that can control the MVI46-MCM module. specific values are written to regions of this block to change the module?s configuration parameters. currently, the module is programmed to handle the receipt of the following requests: write configuration to processor, warm boot and cold boot. the remote node controls the module by writing one of the following values to register 7800 (modbus address 47801): 9997 write configuration in database to the processor and warm boot the module. 9998 warm boot the module. 9999 cold boot the module. the control register is cleared (a value of 0) after the operation is executed with the exception of the 9997 command. if the module fails to successfully transfer the configuration to the processor, an error code will be returned in the control register as follows: 0 no error, transfer successful -1 error transferring general configuration information. ladder logic must be written to handle the 9997 command. no ladder logic is required when using the warm or cold boot commands.
MVI46-MCM ? slc platform appendix d ? MVI46-MCM remote configuration modbus interface module page 70 of 81 prosoft technology, inc. december 27, 2004
appendix e ? MVI46-MCM configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 71 of 81 december 27, 2004 appendix e ? MVI46-MCM configuration this appendix contains listings of the MVI46-MCM configuration data required in the m0 file. the module requests data after a restart or warm-boot operation. the module will continually request the data until a valid configuration is received. group file m0 offset content description backplane setup n10:0 1 write start reg not used in this version of the software n10:1 2 write reg count not used in this version of the software n10:2 3 read start reg not used in this version of the software n10:3 4 read reg count not used in this version of the software n10:4 5 backplane fail not used in this version of the software n10:5 6 error status pointer this parameter spec ifies the register location in the module?s database where module status data is stored. if a value less than 0 is entered, the data will not be stored in the database. if the value specified is in the range of 0 to 4940, the data is placed in the user data area. n10:6 7 spare n10:7 8 spare n10:8 9 spare n10:9 10 spare port 1 setup n10:10 11 enable this parameter is used to define if this port will be used. if the parameter is set to 0, the port is disabled. a value of 1 enables the port. n10:11 12 type this parameter defines if the port emulates a master or slave device. enter 0 to emulate a master device and 1 to emulate a slave device. n10:12 13 float flag this flag specifies if the floating-point data access functionality is to be used. if the float flag is set to y, modbus functions 3,6, and 16 will interpret floating point values for registers as specified by the two following parameters.
MVI46-MCM ? slc platform appendix e ? MVI46-MCM configuration modbus interface module page 72 of 81 prosoft technology, inc. december 27, 2004 group file m0 offset content description n10:13 14 float start this parameter defines the first register of floating-point data. all requests with register values greater than or equal to this value will be considered floating-point data requests. this parameter is only used if the float flag is enabled. for example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered floating-point data. n10:14 15 float offset this parameter defines the start register for floating-point data in the internal database. this parameter is only used if the float flag is enabled. for example, if the float offset value is set to 3000 and the float start parameter is set to 7000, data requests for register 7000 will use the internal modbus register 3000. n10:15 16 protocol 0=rtu, 1=ascii n10:16 17 baud rate this is the baud rate to be used on the port. enter the baud rate as a value. for example, to select 19k baud, enter 19200. exceptions: 38400 baud, enter 384. 57600 enter 576. 115000 enter 115. n10:17 18 parity this is the parity code to be used on the port. the coded values are as follows: 0=none 1=odd 2=even n10:18 19 data bits this parameter sets the number of data bits for each word used by the protocol. enter a value in the range of 5 to 8. n10:19 20 stop bits this parameter sets the number of stop bits to be used with each data value sent. enter a value of 1 or 2. n10:20 21 rts on delay this parameter sets the number of milliseconds to delay after rts is asserted before the data will be transmitted. enter a value in the range of 0 to 65535. n10:21 22 rts off delay this parameter sets the number of milliseconds to delay after the last byte of data is s ent before the rts modem signal will be set low. enter a value in the range of 0 to 65535.
appendix e ? MVI46-MCM configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 73 of 81 december 27, 2004 group file m0 offset content description n10:22 23 minimum response delay this parameter sets the number of milliseconds to wait before a response message is sent out of the port. this parameter is required when interfacing to a slow responding device. enter a value in the range of 0 to 65535. n10:23 24 use cts line this parameter specifies if the cts modem control line is to be used. if the parameter is set to 0, the cts line will not be monitored. if the parameter is set to 1, the cts line will be monitored and must be high before the module will send data. normally, this parameter is required when half- duplex modems are used for communication (2-wire). n10:24 25 slave id this parameter defines the virtual modbus slave address for the internal database. any requests received by the port with this address will be processed by the module. be certain each device has a unique address on the network. n10:25 26 bit input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 2 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database. n10:26 27 word input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 4 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database. n10:27 28 output offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 1, 5, or 15 commands. for example, if the value is set to 100, an address request of 0 will return the value at register 100 in the database. n10:28 29 holding register offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus 3, 6, or 16 commands. for example, if the value is set to 50, an address request of 0 will return the value at register 50 in the database.
MVI46-MCM ? slc platform appendix e ? MVI46-MCM configuration modbus interface module page 74 of 81 prosoft technology, inc. december 27, 2004 group file m0 offset content description n10:29 30 command count this parameter specifies the number of commands to be processed for the port. enter a value of 0 to 100. n10:30 31 minimum command delay this parameter specifies the number of milliseconds to wait between the initial issuance of a command. this parameter can be used to delay all commands sent to slaves to avoid ?flooding? commands on the network. this parameter does not affect retries of a command as they will be issued when failure is re cognized. enter a value in the range of 0 to 65535. n10:31 32 command error pointer this parameter sets the address in the internal modbus database where the command error data will be placed. if the value is set to ?1, the data will not be transferred to the database. enter a value of 0 to 4999. n10:32 33 response timeout this parameter represents the message response timeout period in 1 ms increments. this is the time that a port configured as a master will wait before re-transmitting a command if no response is received from the addressed slave. the value is set depending on to communication network used and the expected response time of the slowest device on the network. n10:33 34 retry count this parameter specifies the number of times a command will be retried if it fails. enter a value in the range of 0 to 10. n10:34 35 error delay count this parameter specifies the number of polls to be skipped on the slave before trying to re-establish communications. after the slave fails to respond, the master will skip commands to be sent to the slave the number of times entered in the parameter. enter a value in the range of 0 to 65535. n10:35 36 reserved n10:36 37 use guard band timer use packet gap timeout for messages (yes or no). use only in multi-drop applications. n10:37 38 guard band timeout a value of 0 uses the default baud rate or you can set a value in milliseconds (0 to 65535) n10:38 39 spare n10:39 40 spare
appendix e ? MVI46-MCM configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 75 of 81 december 27, 2004 group file m0 offset content description port 2 setup n10:40 41 enable this parameter is used to define if this port will be used. if the parameter is set to 0, the port is disabled. a value of 1 enables the port. n10:41 42 type this parameter defines if the port emulates a master or slave device. enter 0 to emulate a master device and 1 to emulate a slave device. n10:42 43 float flag this flag specifies if the floating-point data access functionality is to be used. if the float flag is set to y, modbus functions 3,6, and 16 will interpret floating point values for registers as specified by the two following parameters. n10:43 44 float start this parameter defines the first register of floating-point data. all requests with register values greater than or equal to this value will be considered floating-point data requests. this parameter is only used if the float flag is enabled. for example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered floating-point data. n10:44 45 float offset this parameter defines the start register for floating-point data in the internal database. this parameter is only used if the float flag is enabled. for example, if the float offset value is set to 3000 and the float start parameter is set to 7000, data requests for register 7000 will use the internal modbus register 3000. n10:45 46 protocol 0=rtu, 1=ascii n10:46 47 baud rate this is the baud rate to be used on the port. enter the baud rate as a value. for example, to select 19k baud, enter 19200. exceptions: 38400 baud, enter 384. 57600 enter 576. 115000 enter 115. n10:47 48 parity this is the parity code to be used on the port. the coded values are as follows: 0=none 1=odd 2=even n10:48 49 data bits this parameter sets the number of data bits for each word used by the protocol. enter a value in the range of 5 to 8. n10:49 50 stop bits this parameter sets the number of stop bits to be used with each data value sent. enter a value of 1 or 2.
MVI46-MCM ? slc platform appendix e ? MVI46-MCM configuration modbus interface module page 76 of 81 prosoft technology, inc. december 27, 2004 group file m0 offset content description n10:50 51 rts on delay this parameter sets the number of milliseconds to delay after rts is asserted before the data will be transmitted. enter a value in the range of 0 to 65535. n10:51 52 rts off delay this parameter sets the number of milliseconds to delay after the last byte of data is s ent before the rts modem signal will be set low. enter a value in the range of 0 to 65535. n10:52 53 minimum response delay this parameter sets the number of milliseconds to wait before a response message is sent out of the port. this parameter is required when interfacing to a slow responding device. enter a value in the range of 0 to 65535. n10:53 54 use cts line this parameter specifies if the cts modem control line is to be used. if the parameter is set to 0, the cts line will not be monitored. if the parameter is set to 1, the cts line will be monitored and must be high before the module will send data. normally, this parameter is required when half- duplex modems are used for communication (2-wire). n10:54 55 slave id this parameter defines the virtual modbus slave address for the internal database. any requests received by the port with this address will be processed by the module. be certain each device has a unique address on the network. n10:55 56 bit input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 2 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database. n10:56 57 word input offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 4 commands. for example, if the value is set to 150, an address request of 0 will return the value at register 150 in the database.
appendix e ? MVI46-MCM configuration MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 77 of 81 december 27, 2004 group file m0 offset content description n10:57 58 output offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus function 1, 5, or 15 commands. for example, if the value is set to 100, an address request of 0 will return the value at register 100 in the database. n10:58 59 holding register offset this parameter specifies the offset address in the internal modbus database that is to be used with network requests for modbus 3, 6, or 16 commands. for example, if the value is set to 50, an address request of 0 will return the value at register 50 in the database. n10:59 60 command count this parameter specifies the number of commands to be processed for the port. enter a value of 0 to 100. n10:60 61 minimum command delay this parameter specifies the number of milliseconds to wait between the initial issuance of a command. this parameter can be used to delay all commands sent to slaves to avoid ?flooding? commands on the network. this parameter does not affect retries of a command as they will be issued when failure is re cognized. enter a value in the range of 0 to 65535. n10:61 62 command error pointer this parameter sets the address in the internal modbus database where the command error data will be placed. if the value is set to ?1, the data will not be transferred to the database. enter a value of 0 to 4999. n10:62 63 response timeout this parameter represents the message response timeout period in 1 ms increments. this is the time that a port configured as a master will wait before re-transmitting a command if no response is received from the addressed slave. the value is set depending on to communication network used and the expected response time of the slowest device on the network. n10:63 64 retry count this parameter specifies the number of times a command will be retried if it fails. enter a value in the range of 0 to 10.
MVI46-MCM ? slc platform appendix e ? MVI46-MCM configuration modbus interface module page 78 of 81 prosoft technology, inc. december 27, 2004 group file m0 offset content description n10:64 65 error delay count this parameter specifies the number of polls to be skipped on the slave before trying to re-establish communications. after the slave fails to respond, the master will skip commands to be sent to the slave the number of times entered in the parameter. enter a value in the range of 0 to 65535. n10:65 66 reserved n10:66 67 use guard band timer use packet gap timeout for messages (yes or no). use only in multi-drop applications. n10:67 68 guard band timeout a value of 0 uses the default baud rate or you can set a timeout value in milliseconds (0 to 65535). n10:68 69 spare n10:69 70 spare port 1 commands n11:0 to n11:09 71 to 80 command #1 this set of registers contains the parameters for the first command in the master command list. the structure of this data area is as described in the data object section of the documentation. n11:10 to n11:19 81 to 90 command #2 command #2 dataset 1061 to 1070 command #100 command #100 dataset port 2 commands n12:0 to n12:09 1071 to 1080 command #1 this set of registers contains the parameters for the first command in the master command list. the structure of this data area is as described in the data object section of the documentation. n12:10 to n12:19 1081 to 1090 command #2 command #2 dataset 2061 to 2070 command #100 command #100 dataset
support, service, and warranty MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 79 of 81 december 27, 2004 support, service, and warranty technical support prosoft technology survives on its ability to provide meaningful support to its customers. should any questions or problems ar ise, please feel free to contact us at: internet web site: http://www.prosoft-technology.com/support e-mail address: support@prosoft-technology.com phone (661) 716-5100 (661) 716-5101 (fax) postal mail prosoft technology, inc. 1675 chester avenue, second floor bakersfield, ca 93301 before calling for support, please prepare yourself for the call. in order to provide the best and quickest support possible, we will most likely ask for the following information (you may wish to fax it to us prior to calling): 1. product version number 2. system hierarchy 3. module configuration and contents of mcm.cfg file 4. module operation - configuration/debug status information - led patterns 5. information about the processor and data areas as viewed through rslogix 500 and led patterns on the processor 6. details about the serial network an after-hours answering system (on the bakersfield number) allows pager access to one of our qualified technical and/or application support engineers at any time to answer the questions that are important to you. module service and repair the MVI46-MCM card is an electronic product, designed and manufactured to function under somewhat adverse conditions. as with any product, through age, misapplication, or any one of many possible problems the card may require repair. when purchased from prosoft technology, the module has a one-year parts and labor warranty according to the limits specified in the warranty. replacement and/or returns should be directed to the distributor from whom the product was purchased. if you need to return the card for repair, obtain an rma number from prosoft technology. please call the factory for this number and display the number prominently on the outside of the shipping carton used to return the card.
MVI46-MCM ? slc platform support, service, and warranty modbus interface module page 80 of 81 prosoft technology, inc. december 27, 2004 general warranty policy prosoft technology, inc. (hereinafter referred to as prosoft) warrants that the product shall conform to and perform in accordance with published technical specifications and the accompanying written materials, and shall be free of defects in materials and workmanship, for the period of time herein indicated, such warranty period commencing upon receipt of the product. this warranty is limited to the repair and/or replacement, at prosoft's election, of defective or non-conforming product, and prosoft shall not be responsible for the failure of the product to perform specified functions, or any other non-conformance caused by or attributable to: (a) any misapplication or misuse of the product; (b) failure of customer to adhere to any of prosoft's specifications or instructions; (c) neglect of, abuse of, or accident to, the product; or (d) any associated or complementary equipment or software not furnished by prosoft. limited warranty service may be obtained by delivering the product to prosoft and providing proof of purchase or receipt date. customer agrees to insure the product or assume the risk of loss or damage in transit, to prepay shipping charges to prosoft, and to use the original shipping container or equivalent. contact prosoft customer service for further information. limitation of liability except as expressly provided herein, prosoft makes no warrant of any kind, expressed or implied, with respect to any equipment, parts or services provided pursuant to this agreement, including but not li mited to the implied warranties of merchant ability and fitness for a particular purpose. neither prosoft or its dealer shall be liable for any other damages, including but not limited to direct, indirect, incidental, special or consequential damages, whether in an action in contract or tort (including negligence and strict liability), such as, but not limited to, loss of anticipated profits or benefits resulting from, or ar ising out of, or in connection with the use or furnishing of equipment, parts or services hereunder or the performance, use or inability to use the same, even if prosoft or its dealer's total liability exceed the price paid for the product. where directed by state law, some of the above exclusions or limitations may not be applicable in some states. this warranty provides specific legal rights; other rights that vary from state to state may also exist. this warranty shall not be applicable to the extent that any provisions of this warranty are prohibited by any federal, state or municipal law that cannot be preempted. hardware product warranty details warranty period: prosoft warranties hardware product for a period of one (1) year. warranty procedure: upon return of the hardware product prosoft will, at its option, repair or replace product at no additional charge, freight prepaid, except as set forth below. repair parts and replacement produc t will be furnished on an exchange basis and will be either reconditioned or new. all replaced product and parts become the
support, service, and warranty MVI46-MCM ? slc platform modbus interface module prosoft technology, inc. page 81 of 81 december 27, 2004 property of prosoft. if prosoft determines that the product is not under warranty, it will, at the customer's option, repair the product using current prosoft standard rates for parts and labor, and return the product freight collect. - - - - - - - - - - - - - - - - end of manual - - - - - - - - - - - - - - - - -

▲Up To Search▲

Price & Availability of MVI46-MCM

	To Download MVI46-MCM Datasheet File
If you can't view the Datasheet, Please click here to try to view without PDF Reader .