Engee documentation

GOOSE TX

Page in progress.

Formation of a GOOSE message from a set of fields for further transmission of all types of data over Ethernet according to IEC 61850-7-2 and IEC 61850-8-1.

blockType: SubSystem

Path in the library:

/Physical Modeling/Electrical/Communication Protocols/IEC 61850/GOOSE/GOOSE TX

Description

Block GOOSE TX It is used to generate a GOOSE message from a set of fields for further transmission of all types of data over Ethernet according to IEC 61850-7-2 and IEC 61850-8-1.

Ports

Input

# allData — BusSignal type signal according to Table A.2 of IEC61850-8-1
BusSignal

Details

A BusSignal type signal that is generated by a block Bus Creator or similar. The type of each signal in the BusSignal is assigned according to the Data types of entries parameter. The number and order of the signals in the BusSignal must correspond to the number and order of the elements of the Data types of entries parameter.

Data types

BusSignal

Complex numbers support

No

# Seconds — time in seconds since midnight on January 1, 1970
scalar

Details

It is recorded in a GOOSE message, at the last data change (event).

Data types

uint64

Complex numbers support

No

# Nanoseconds — the number of nanoseconds that have passed since the beginning of the second
scalar

Details

It is recorded in a GOOSE message, at the last data change (event).

Data types

uint64

Complex numbers support

No

# simulation — the value of the simulation field
scalar

Details

If the value of the simulation field is true, then the message and its value were issued by the simulation module and are not real values.

Data types

boolean

Complex numbers support

No

# confRev — configuration revision version
scalar

Details

The integer must be between 0 and 4,294,967,295.

Data types

Int64

Complex numbers support

No

# ndsCom — indication of the need for commissioning
scalar

Details
Data types

boolean

Complex numbers support

No

# simulated — the highest bit of the field is Reserved 1
scalar

Details

The highest bit of the Reserved 1 field indicates that the device is in test mode.

Data types

boolean

Complex numbers support

No

Output

# Size — GOOSE message size
scalar

Details

The size of the GOOSE message, as the number of bytes transmitted. No more than the value of the parameter Maximum message size block RITM-ETH-RAW TX.

Data types

uint32

Complex numbers support

No

# Data — a generated GOOSE message in the form of a set of bytes
vector

Details
Data types

uint8

Complex numbers support

No

Parameters

MAC addresses

# Enable MAC addresses inputs — enabling/disabling the ability to set the MAC address via the Source MAC input

Details
Default value

false (switched off)

Program usage name

enable_MAC_input

Evaluatable

Yes

# Source MAC address — MAC address of the source of transmission of GOOSE messages

Details

MAC address of the source of transmission of GOOSE messages in the form of an array of 6 bytes.

Default value

UInt8[0x00, 0x00, 0x00, 0x00, 0x00, 0x00]

Program usage name

source_MAC

Evaluatable

Yes

# Destination MAC address — MAC address of the GOOSE message receiver

Details

The MAC address of the receiver of GOOSE messages in the form of an array of 6 bytes. For example, for multicast, MAC addresses in the range 01:0C are assigned to streams.:CD:01:00:00-01:0C:CD:01:01:FF.

Default value

UInt8[0x01, 0x0c, 0xcd, 0x01, 0x00, 0x01]

Program usage name

destination_MAC

Evaluatable

Yes

VLAN

# Enable VLAN — the button for enabling/disabling VLAN field generation

Details
Default value

true (switched on)

Program usage name

enable_VLAN

Evaluatable

Yes

# VLAN priority — traffic priority tag in the format uint8.

Details
Default value

4

Program usage name

VLAN_priority

Evaluatable

Yes

# VLAN ID (VID) — network stream ID (12 bits) in the format uint16

Details
Default value

0

Program usage name

VID

Evaluatable

Yes

General fields

# APPID — the value of the APPID message identification tag

Details

Specifying the value of the APPID message identification tag (the standard provides 0x8000-0xBFFF for message class 1A, 0x0000-0x3FFF for message class 1, however, it is possible to set a different value).

Default value

0x1111

Program usage name

APPID

Evaluatable

Yes

# gocbRef — specifying the value of the gocbRef GOOSE message field

Details
Default value

"Engee\$gocb"

Program usage name

gocbRef

Evaluatable

Yes

# datSet — specifying the value of the datSet GOOSE message field

Details
Default value

"Engee\$GOOSE"

Program usage name

datSet

Evaluatable

Yes

# goID — specifying the value of the goID GOOSE message field

Details
Default value

"Engee"

Program usage name

goID

Evaluatable

Yes

allData

# Data types of entries — specifying the data type of the elements supplied to the allData port as a vector

Details

Specifying the data type of the Data elements of the allData field in the form of a vector, where the ordinal number of the vector element corresponds to the input number of the block allData element No…​.. Depending on the value of the vector element, the signal is assigned the data type according to the table:

Vector element value Data types

Data type

Comments

1

Boolean

Scalar

2

INT8

Scalar

3

INT16

Scalar

4

INT32

Scalar

5

INT64

Scalar

6

INT8U

Scalar

7

INT16U

Scalar

8

INT24U

(unused data type)

9

INT32U

Scalar

10

FLOAT32

Scalar

11

ENUMERATED

Scalar, equivalent to INT8

12

CODED ENUM

A bit string; the block is received as a vector of two numbers in the range of UInt8 values, the first is the number of unused ones

13

OCTET STRING

Vector from UInt8, maximum length of 20

14

VISIBLE STRING

Vector from UInt8, maximum length 35

15

TimeStamp

A vector of two integers, the first is UNIX time in seconds, the second is nanoseconds

16

Quality

A bit string; represented by a numeric value, can be submitted from the GOOSE Quality block

Default value

[1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16]

Program usage name

allData_types

Evaluatable

Yes

# Encode data into structures — enabling/disabling the ability to pack data or part of GOOSE message data into a structure format

Details
Default value

true (switched on)

Program usage name

enable_encoding_data_into_structures

Evaluatable

Yes

# Sequence of structures — an array of vectors with the numbers of elements to be grouped into structures

Details

A Tuple type array of Vector{Int64}, which contains vectors with element numbers. These vectors will be grouped into structures.

Each individual vector inside the main array is a separate structure inside the allData GOOSE message field. The grouping of elements within the structure vector should occur from the smaller element number to the larger one. The signals inside the vector must be located at the adjacent inputs of the block. An example, you can — [3 4 5] cannot — [1 3 5].

The grouping of structure vectors inside a Tuple array should occur in a similar way: from the vector with the lowest element numbers to the vector with the highest element numbers. An example, you can — {[1 2 3] [4 5]}, {[1 2] [4 5]}, {[1 2] [3 4]}, not allowed — {[4 5] [1 2 3]}, {[4 5] [1 2], [3 4] [1 2]}.

Elements that are not included in any of the vectors inside the Tuple array will be encapsulated in a GOOSE message outside the structure, sequentially, according to the input number they occupy. Example, {[1 2] [4 5]} — the composition of the allData field: 1 and 2 signals in the structure, the third signal outside the structure, 4 and 5 signals in the structure, {[3 4]} — the composition of the allData field: 1 and 2 signals outside the structure, 3 and 4 signals in the structure, 5 signal outside the structure.

Default value

([1, 2, 3], [5, 6])

Program usage name

sequence_of_structures

Evaluatable

Yes

Timing

# Retransmission time in stable conditions, s — The value of the normal transmission time interval between GOOSE messages in seconds

Details
Default value

5

Program usage name

T0

Evaluatable

Yes

# Retransmission times after events, s — vector of values of transmission time intervals T1 …​ Tp between GOOSE messages, after changing at least one of the message data attributes

Details
Default value

[0.01, 0.04, 2.5]

Program usage name

retransmission_times

Evaluatable

Yes

# Retransmission counts — vector of the number of transmission time intervals T1 …​ Tp between GOOSE messages until the normal transmission period is reached

Details

By default, the values Retransmission times after events and Retransmission counts mean that after data changes, they will be resent 4 times with a range of 0.01 seconds, 3 times with a range of 0.04 seconds, and 2 times with a range of 2.5 seconds.

Default value

[4, 3, 2]

Program usage name

retransmission_counts

Evaluatable

Yes

Sample time

# Sample time, s — the calculation step that the block will work with GOOSE TX

Details

The calculation step must be a multiple of the main calculation step specified in the model settings. Inheritance is not supported.

Default value

0.00025

Program usage name

sample_time

Evaluatable

Yes