A-B RIO Adapter for SoftPLC® Runtime

# RIOSLAVE Driver Configuration for SoftPLC Runtime Software.
# This file uses an "s-expression" format, which is like XML but uses
# parentheses instead of angle bracketed keywords.  The syntax of s-expression
# files is well documented and can be googled.  The grammar, on the other hand,
# unlike the syntax, is application specific.  SoftPLC uses '#' to indicate
# a single line comment. If the first non-blank character is #, then this
# line is a single line comment.  Single line comments cannot follow
# any other token on the same line.  Multiline 'C' style comments are also
# supported: /* followed by an eventual */
#
# S-expressions are thought to be more human readable than XML
# and are easy to parse with a programming language.  Parentheses are balanced.
#
# The supported "grammar" is documented in the next several lines of comments.
#
# Grammar rules are declared like this, for example:
# (timeout_mult <4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 > )
# This means "timeout_mul" is a keyword and it can be followed with
#   4, 8, 16, 32, 64, 128, 256, or 512.  The '|' means "or". e.g. (timeout_mult 4)
#
# If something is wrapped in angle brackets <> in a grammar rule, this means
# it is a grouping.  Only one of the choices in a grouping may actually be used.
# Angle brackets, being only part of the grammar definition, are never actually
# used in real configuration statements.
#
# If something is wrapped in square brackets [] in a grammar rule, this means
# whatever appears in the brackets is optional.  If omitted, then a default value
# will be used and the default is defined in the grammar rule by a comment following
# a ':'.  The square brackets, being only part of the grammar definition,
# are never actually used in real configuration statements.
#
# White spaces includeing tabs and newlines (CR, LF, etc.) are all ignored.

#------ Grammar Rules: ----------
# (rioslave                             ` the master containing element.
#                                       ` every nested element is contained within
#                                       ` this master element.
#   (driver_version VERSION_NUM)        ` VERSION_NUM must be 2
#   (port PORT_NUMBER ...)              ` see below for (port).
#   [(port PORT_NUMBER ...) ...]        ` (port) may occur multiple times.
#   )                                   ` end of (rioslave)
#
# Details on nested elements:

# Element (port ...)
# contains data for a particular bluehose port.  It will consist of one or more
# (rack_part) elements.
#
# (port PORT_NUMBER                     ` PORT_NUMBER says which bluehose port to use
#                                       ` Smart4: 0, 1, or 2.
#                                       ` NeoPAC: 1 or 2
#   (baudrate BAUDRATE)                 ` BAUDRATE must be 57600, 115200 or 230400
#   [(termination_resistor <yes|no>)]   ` default: "no"
#   [(debug BIT_MAP)]                   ` BIT_MAP may be 0 or non-zero and
#                                       ` controls debug logging statements
#                                       ` default: 0
#   (rack_part ...)                     ` See below for (rack_part)
#   [(rack_part ...) ...]               ` (rack_part) may occur multiple times
#   )                                   ` end of (port)

# Element (rack_part)
# contains data for a particular adapter. A (rack_part) normally corresponds to
# an adapter and will take an Allen-Bradley remote IO address range length of
# either 2, 4, 6 or 8 words in an octal numeric format.  The data transfered to
# an adapter is mapped into the SoftPLC datatable for both directions: inputs
# and outputs.  This is done with four different types of elements, two for
# digital data and two for block transfer data: (inputs), (outputs), (bt_read),
# and (bt_write).
#
# (rack_part <OCTAL_RACK_NUM><STARTING_WORD_IN_RACK>-<OCTAL_RACK_NUM><LAST_WORD_IN_RACK>
#   (inputs ...)                        ` see below, optional and at most one
#   (outputs ...)                       ` see below, only one allowed
#   [(bt_read ...) ...]                 ` see below, multiple allowed
#   [(bt_write ...) ...]                ` see below, multiple allowed
#   )                                   ` end of (rack_part)

# Element (inputs)
# contains the SoftPLC datatable address where the adapter emulation should retrieve
# input words from.  The range (count) of words at the supplied starting DT_ADDRESS is
# implicit in the (rack_part) word range.  For example, (rack_part 010-017 ...)
# says that 8 words are mapped, numbered 0 thru 7.  Or (rack_part 126-127 ...)
# says 2 words are mapped, again starting at DT_ADDRESS given in the (inputs) element.
# (inputs DT_ADDRESS
#   )                                   ` end of (inputs)

# Element (outputs)
# contains the SoftPLC datatable address where the adapter emulation should stuff
# output words to.  The range (count) of words at the supplied starting DT_ADDRESS is
# implicit in the (rack_part) word range.  For example, (rack_part 010-017 ...)
# says that 8 words are mapped, numbered 0 thru 7.  Or (rack_part 126-127 ...)
# says 2 words are mapped, again starting at DT_ADDRESS given in the (outputs) element.
# (outputs DT_ADDRESS
#   )                                   ` end of (outputs)

# Element (bt_read)
# contains a mapping of an I/O slot in the main processor's memory to a datatable
# memory block in this slave machine.
# (bt_read <OCTAL_RACK_NUM><WORD_IN_RACK>,<0|1>
#                                       ` WORD_IN_RACK range: 0 to 7.
#                                       ` e.g. 063,1 and in this example:
#                                       ` OCTAL_RACK_NUM is 06,
#                                       ` group is WORD_IN_RACK is 3, and
#                                       ` slot comes after the comma and is 1
#                                       ` indicating the hi-byte (1 for hi byte/slot,
#                                       ` 0 for low byte/slot)
#   (src DT_ADDRESS)                    ` starting datatable word address of block
#   (size WORD_COUNT)                   ` WORD_COUNT is no. words to xfer in the read
#                                       ` range: 1 to 64
#   )                                   ` end of (bt_read)

# Element (bt_write)
# contains a mapping of an I/O slot in the main processor's memory to a datatable
# memory block in this slave machine.
# (bt_write <OCTAL_RACK_NUM><WORD_IN_RACK>,<0|1>
#                                       ` see (bt_read) above
#   (dst DT_ADDRESS)                    ` starting datatable word address of block
#   (size WORD_COUNT)                   ` WORD_COUNT is no. words to xfer in the write
#                                       ` range: 1 to 64
#                                       ` If the master tries to write more than this
#                                       ` then the excess words are not written.
#   )                                   ` end of (bt_write)

# end of intro comments and grammar rules.
# Next comes actual configuration statements:

(rioslave (driver_version 2)
  (port 1
    (baudrate 57600)
    #(debug 0x1)
    #(termination_resistor yes)

    (rack_part 020-027  (inputs  N17:0)(outputs N7:0)
      (bt_write 022,0  (dst N7:300) (size 10) )
      (bt_read  022,0  (src N17:008)(size 64) )
      (bt_write 022,1  (dst N7:310) (size 10) )
      (bt_read  022,1  (src N17:100)(size 64) )
      )         /* end of rack_part */

    (rack_part 044-045 (inputs N17:8)(outputs N7:8))

    )           /* end of port */

  (port 2
    (rack_part 010-011 (inputs N117:0)(outputs N100:0))
    )
  )             /* end of rioslave */

; Configuration file for SoftPLC TLM "RIOSLAVE".
; Comments start with a semicolon.


[DRIVER]
; Set to 0 normally, 1 for full RIO network logging (using console redirection)
DEBUG=2

; Which COM port, either 5 or 6 are typically allowed for a Smart.
; And 0 is allowed for a Neo
INTERFACE=0

; BAUDRATE may be one of: 57600, 115200 or 230400
BAUDRATE=57600


; TERMINATION_RESISTOR may be yes or no, and possibly adds a 120 ohm
; termination resistor via this software setting
TERMINATION_RESISTOR=no

; For PLC-2 master only:
; if this TLM is acting as a last adapter, set to yes
; else set to no
LAST_ADAPTER=no

; A block of 1 word(s) that hold(s):
; [0]: RIO Master Mode
STATUS_WORDS=N17:200

;   IOBusAddr Defined:
;
;   IOBusAddr is used in the rows below, and is rack number and an even io group
;   address of the start of a quarter rack of AB RIO.  For example:
;
;   I:036
;   ^ ==^
;   | ^ |
;   | | +--------- I/O group number, must be even, one of: 0,2,4, or 6
;   | |
;   | +----------- 2 digit octal rack number 0 to 76, but further limited by
;   |              your RIO master, i.e. by your PLC.  We start from rack zero.
;   |
;   +------------- I or O meaning read or write to the rack, respectively.
;                  Use I under [INPUTS], and O under [OUTPUTS]


; The IOBusAddr are the addresses actually used on the RIO cabling systems, and
; are therefore relative to the master RIO scanner.

[INPUTS]
;DatatableAddr      IOBusAddr       NumWords
I:004               I:024           4


[OUTPUTS]
;DatatableAddr      IOBusAddr       NumWords
O:004               O:024           4


; [BLOCKTRANSFER_READS] and [BLOCKTRANSFER_WRITES] sections create a mapping of
; an I/O slot in the main processor's memory to a datatable memory block in this
; slave machine. From 1 to 64 words can be transfered for each BT READ or WRITE,
; and for both slot=0 and slot=1 of each I/O word.

[BLOCKTRANSFER_READS]
;DatatableAddr      IOBusAddr       NumWords (1-64)     Slot (0-1)
;N7:0100             I:027           64                  1


[BLOCKTRANSFER_WRITES]
;N10:0               O:024           10                  1