FC 227 - Gateway

The gateway function code supports Harmony communication block devices. A Harmony communication block device can incorporate up to four communication ports, each of which provides a communication network for foreign devices. Function code 227 is used to make appropriate assignments of function code 228 to Harmony communication block communication ports and specify their communication parameters. Definition of this function code is required for all Harmony communication block devices.

 

NOTES:

  1. Function code 227 tunable specifications are not adaptable.

  2. This function code is not supported by IMMFP11/12 and HAC01 controllers.

  3. Function code 227 must reside in the same segment as the foreign device definition function code 228 to which it is mapped.

 

 

 

 

 

Outputs:

Blk

Type

Description

N

R

Primary communication block status with quality

N+1

R

Backup communication block status with quality

N+2

B

Communication port 1 status with quality

N+3

B

Communication port 2 status with quality

N+4

B

Communication port 3 status with quality

N+5

B

Communication port 4 status with quality

N+6

B

Spare output with quality

N+7

R4

Reserved output with quality

 

 

 

Specifications:

Spec

Tune

Default

Type

Range

Description

S1

N

Null

String

0 - 32

32-character device label

S2

N

Null

String

0 - 255

Harmony communication block configuration parameters

S3

N

2

I

Note 1

Block address of first foreign device definition for communication port 1

S4

N

Null

String

0 - 255

Communication port 1 configuration parameters

S5

N

2

I

Note 1

Block address of first foreign device definition for

communication port 2

S6

N

Null

String

0 - 255

Communication port 2 configuration parameters

S7

N

2

I

Note 1

Block address of first foreign device definition for

communication port 3

S8

N

Null

String

0 - 255

Communication port 3 configuration parameters

S9

N

2

I

Note 1

Block address of first foreign device definition for

communication port 4

S10

N

Null

String

0 - 255

Communication port 4 configuration parameters

S11

N

2

I

Note 1

Block address of override / status error inhibit /

simulation permit

S122

Y

0

B

0 or 1

Device status error inhibit

S13

N

0

B

0 or 1

Redundant gateway expected

S14

N

0

I

Full

Reserved for future use

S15

N

0

I

0 - 32,767

NVM buffer size

S16

N

2

I

Note 1

Block address of the next HSOE gateway function

code 227 or device definition function code 221.

S17

N

2

I

Note 1

Spare

S18

N

0.000

R

Full

Spare

S19

Y

Null

String

0 - 255

Spare

 

NOTES:

  1. Maximum values are: 9,998 for the BRC-100, BRC-200, BRC-300 and IMMFP11/12 and 31,998 for the BRC-400 and HAC

  2. The specification value active state is permitted to operate only when S11 of the gateway is enabled.

 

227.1  Specifications

 

S1

(Device label) Device label of string data type used as a logical address of the Harmony communication block. This label must match the device label configured in the Harmony communication block. The device label can be up to 32 characters long. For proper operation, the label cannot be null.

 

S2

(Harmony communication block configuration parameters) A string data type containing configuration information specific to the Harmony communication block. Refer to Gateway and Communication Port Configuration Parameters in this section for a description of the string format to be used.

 

S3

(Block address of first foreign device definition for communication port 1) Links the gateway function code 227 to the first foreign device definition function code 228 in the list of function codes 228 for communication port 1 of the Harmony communication block. The default value indicates that the communication port is not configured.

 

S4

(Communication port 1 configuration parameters) A string data type containing configuration information specific to the communication port 1 of the Harmony communication block. Refer to Gateway and Communication Port Configuration Parameters for a description of the string format to be used.

 

S5

(Block address of first foreign device definition for communication port 2) Links the gateway function code 227 to the first foreign device definition function code 228 in the list of function code 228 for communication port 2 of the Harmony communication block. The default value indicates that the communication port is not configured.

 

S6

(Communication port 2 configuration parameters) A string data type containing configuration information specific to the communication port 2 of the Harmony communication block. Refer to Gateway and Communication Port Configuration Parameters for a description of the string format to be used.

 

S7

(Block address of first foreign device definition for communication port 3) Links the gateway function code 227 to the first foreign device definition function code 228 in the list of function code 228 for communication port 3 of the Harmony communication block. The default value indicates that the communication port is not configured.

 

S8

(Communication port 3 configuration parameters) A string data type containing configuration information specific to the communication port 3 of the Harmony communication block. Refer to Gateway and Communication Port Configuration Parameters for a description of the string format to be used.

 

S9

(Block address of first foreign device definition for communication port 4) Links the gateway function code 227 to the first foreign device definition function code 228 in the list of function code 228 for communication port 4 of the Harmony communication block. The default value indicates that the communication port is not configured.

 

S10

(Communication port 4 configuration parameters) A string data type containing configuration information specific to the communication port 4 of the Harmony communication block. Refer to Gateway and Communication Port Configuration Parameters for a description of the string format to be used.

 

S11

(Block address of override / status error inhibit / simulation permit) Links to a function block which will provide a Boolean indication as to whether a particular feature is permitted. If the value from the attached Boolean output is zero, no override, status error inhibit, or simulation is permitted on any foreign device or channel of that foreign device. If the value from the attached Boolean output is one, override, status error inhibit, or simulation is permitted on any associated function block.

 

S12

(Device status error inhibit) If set to one, inhibits all status errors originating from the Harmony communication block from being included in the controller's status. The default value causes all Harmony communication block, foreign device, and channel errors to be included in the controller's status if not otherwise inhibited at the foreign device or channel level.

 

S13

(Redundant module expected) If set to one, a redundant module is always expected. If a redundant module is not found (function code 227 output N+1 = 1 and has BAD quality), the controller generates a module problem report. If set to zero, then no redundant module is expected, but may exist.

 

S14

Reserved for future use.

 

S15

(NVM buffer size) Specifies the minimum number of two-byte words to reserve for storage of uploaded Harmony communication block foreign configuration data received from the foreign side of the gateway (e.g., Foundation Fieldbus LAS files). This foreign configuration data is downloaded to the Harmony communication block upon the replacement of the Harmony communication block. The default value prevents the upload of the foreign configuration data. The IOR-800 module does not have foreign configuration data to store in the NVM buffer.

 

S16

(Block address of the next HSOE gateway function code 227 or device definition function code 221) This specification is required only when the digital inputs (function code 224) associated with the foreign device definition function code 228 are being used as part of a Harmony sequence of events (HSOE) system.

 

S17 through S19

Spare.

 

 

227.2   Outputs

 

The communication block status outputs (N, N+1) are the error summary of the communication block's overall operation status (i.e., Harmony network, redundancy, power, configuration status, and communication ports status) and error summary of all configured foreign devices and their channels.

 

N

Primary communication block status (0 = good, 1 = bad). Quality is set bad when function code 227 cannot communicate with the primary communication block.

 

N+1

Backup communication block status (0 = good, 1 = bad). Quality is set bad when function code 227 cannot communicate with the backup communication block.

 

N+2

Communication port 1 status (0 = good, 1 = bad). Quality is set bad when the communication port 1 is inoperative.

 

N+3

Communication port 2 status (0 = good, 1 = bad). Quality is set bad when the communication port 2 is inoperative.

 

N+4

Communication port 3 status (0 = good, 1 = bad). Quality is set bad when the communication port 3 is inoperative.

 

N+5

Communication port #4 status (0 = good, 1 = bad). Quality is set bad when the communication port 4 is inoperative.

 

N+6

Spare output with quality always set good.

 

N+7

Reserved output with quality always set good.

 

 

227.3   Gateway and Communication Port Configuration Parameters

 

NOTE: There are no configuration parameters defined at this time. The following description is for demonstration purposes only and does not describe an actual Harmony communication block (HCB) device. Refer to the product instruction document of the HCB device for information regarding the configuration parameters for the device and its communication ports.

 

The following format is used to specify Harmony communication block configuration parameters (S2) and communication port configuration parameters (S4, S6, S8, & S10) within a string data-type specification.

 

Pxx=string

 

where:

 

P

=   Parameter identifier

xx

=   One or two digit decimal parameter number.

string

=   One or two ASCII characters, not to exceed 255 characters.

 

Examples:

 

P1=1

P3=100

P12=5

 

The following rules pertain to parameter declarations:

 

Example:

 

P1='TCP IP'

 

 

Table 227-1 describes the possible parameter string values that can be used for S2 if the parameter identifier and number are P1.

 

 

 

227.4   Application

 

Figure 227-1 illustrates how foreign device definition function code 228 and channel function codes 222 through 225 are used in operation with the gateway function code 227.