7.3.1.4.1.1 Read
This confirmed service may be used to read the value of a Record Data object. This service shall only be used in conjunction with the implicit AR, IO AR or Supervisor AR. In addition to
this common read service, additional services are defined for read specific application data.
All this read services use the same parameters, only the data field is different. Table 108 shows the parameters of the services. This service can also be used to read additional user and profile specific data.
The attribute Read Partial Access controls the behavior of the response in case the requested length is shorter than the length of the Record Data object (see attribute description).
Table 108 – Read
Parameter name req ind rsp cnf
Argument M M(=)
AREP M M(=)
API M M(=)
Target AR UUID U U(=)
Slot Number M M(=)
Subslot Number M M(=)
Index M M(=)
Seq Number M M(=)
Length M M(=)
Result(+) S S(=)
AREP M M(=)
Seq Number M M(=)
Length M M(=)
Data M M(=)
Result(-) S S(=)
AREP M M(=)
Seq Number M M(=)
Error Decode M M(=)
Error code 1 M M(=)
Error code 2 M M(=)
Add Data 1 M M(=)
Add Data 2 M M(=)
Argument
The argument shall convey the service specific parameters of the service request.
AREP
This parameter is the local identifier for the desired AR.
API If the scope of the record data object is subslot, slot or API, this parameter shall be used to address the desired AP.
Target AR UUID
If the scope of the record data object is application relation, this parameter shall be used in conjunction with the implicit AR to address the desired AR within the IO device.
Slot Number
If the scope of the record data object is subslot or slot, this parameter shall be used to address the desired slot (typically a module).
Subslot Number
If the scope of the record data object is subslot, this parameter shall be used to address the desired subslot (typically a submodule).
Index
The parameter Index shall be used to address the desired Record Data object. It is additionally used to derive the scope of the Record Data object.
Seq Number
The parameter Seq Number is used by the server to identify the duplication of services with a sequence number. The range of this service parameter is from 0 to 216 -1. The requesting application process shall provide a unique Seq Number to each outstanding service request. The parameter Seq Number shall be incremented for each service request during a session.
NOTE 1 If for example a write service request had the Seq Number set to “17”, a following read service request shall have the Seq Number set to “18”.
When starting a new session the sequence number shall start with the last value of the session before. A confirmation with a Seq Number that is not outstanding will be ignored.
An indication with a Seq Number that is not outstanding will be rejected. The Seq Number shall be maintained for each established AR separately.
Length
The parameter Length indicates the number of octets of a Input Data object that has to be read. The allowed length is from 20 to 232-256. If the requested length exceeds the actual length of the Input Data object element then the actual length with data shall be responded. If the requested length is shorter than the length of the Input Data object element then a parameter error shall be the result.
Result(+)
This parameter indicates that the service request succeeded.
Length
The parameter Length indicates the number of octets of the Data object that has been read.
Data
The parameter Data contains the value of the specific object which has been read and consists of the number of octets indicated in the Length. This parameter has to be composed of the data types defined in Clause 5. A specific meaning for the different services of this data exists, which is described in the special service parts. Table 109 shows the list of special read services.
Table 109 – Read Services
Service Name Chapter
Read Output Data 7.3.2.5.16
Read Output Substitute Data 7.3.2.5.17
Read Input Data 7.3.2.5.9
Read LogBook Data 7.3.3.3.1
Read Diagnosis in channel coding for one subslot 7.3.4.3.5 Read Diagnosis in all codings for one subslot 7.3.4.3.6 Read Maintenance required in channel coding for one subslot 7.3.4.3.7 Read Maintenance required in all codings for one subslot 7.3.4.3.8 Read Maintenance demanded in channel coding for one subslot 7.3.4.3.9 Read Maintenance demanded in all codings for one subslot 7.3.4.3.10 Read Diagnosis, Maintenance, Qualified and Status for one subslot 7.3.4.3.11
Service Name Chapter Read Diagnosis in channel coding for one slot 7.3.4.3.12 Read Diagnosis in all codings for one slot 7.3.4.3.13 Read Maintenance required in channel coding for one slot 7.3.4.3.14 Read Maintenance required in all codings for one slot 7.3.4.3.15 Read Maintenance demanded in channel coding for one slot 7.3.4.3.16 Read Maintenance demanded in all codings for one slot 7.3.4.3.17 Read Diagnosis, Maintenance, Qualified and Status for one slot 7.3.4.3.18 Read Diagnosis in channel coding for one AR 7.3.4.3.19 Read Diagnosis in all codings for one AR 7.3.4.3.20 Read Maintenance required in channel coding for one AR 7.3.4.3.21 Read Maintenance required in all codings for one AR 7.3.4.3.22 Read Maintenance demanded in channel coding for one AR 7.3.4.3.23 Read Maintenance demanded in all codings for one AR 7.3.4.3.24 Read Diagnosis, Maintenance, Qualified and Status for one AR 7.3.4.3.25 Read Diagnosis in channel coding for one API 7.3.4.3.26 Read Diagnosis in all codings for one API 7.3.4.3.27 Read Maintenance required in channel coding for one API 7.3.4.3.28 Read Maintenance required in all codings for one API 7.3.4.3.29 Read Maintenance demanded in channel coding for one API 7.3.4.3.30 Read Maintenance demanded in all codings for one API 7.3.4.3.31 Read Diagnosis, Maintenance, Qualified and Status for one API 7.3.4.3.32 Read Diagnosis, Maintenance, Qualified and Status for one device 7.3.4.3.33
Read Module Diff Block 7.3.6.3.15
Read API Data 7.3.6.3.17
Read I&M0 Filter Data 7.3.6.3.18
Read I&M0 Data 7.3.6.3.19
Read I&M1 Data 7.3.6.3.21
Read I&M2 Data 7.3.6.3.23
Read I&M3 Data 7.3.6.3.25
Read I&M4 Data 7.3.6.3.27
Read Autoconfiguration Data 7.3.6.3.28
Read Expected Identification 7.3.6.3.8
Read Real Identification 7.3.6.3.10
Read Isochronous Mode Data 7.3.7.3.2
Read PDev Data 7.3.8.3.1
Read PD Real Data 7.3.8.3.2
Read PD Expected Data 7.3.8.3.3
Read PD Interface Data Real 7.3.8.3.4
Read PD Interface Adjust 7.3.8.3.6
Read PD Interface MRP Data Real 7.3.8.3.7
Read PD Interface MRP Data Check 7.3.8.3.18
Read PD Interface MRP Data Adjust 7.3.8.3.20
Read PD Interface FSU Data Adjust 7.3.8.3.22
Read PD NC Data Check 7.3.8.3.24
Service Name Chapter
Read PD Sync Data 7.3.8.3.10
Read PD IR Data 7.3.8.3.8
Read PD IR Subframe Data 7.3.8.3.13
Read PD Port Data Real 7.3.8.3.25
Read PD Port Data Check 7.3.8.3.27
Read PD Port Data Adjust 7.3.8.3.29
Read PD Port FO Data Real 7.3.8.3.30
Read PD Port FO Data Check 7.3.8.3.32
Read PD Port FO Data Adjust 7.3.8.3.34
Read PD Port MRP Data Real 7.3.8.3.35
Read PD Port MRP Data Adjust 7.3.8.3.37
Read PD Port Statistic 7.3.8.3.38
Read PD Time Data 7.3.8.3.15
Read AR Data 7.3.9.5.1
Result(-)
This parameter indicates that the service request failed.
Error Decode
This parameter selects one Error scheme for Error code 1 and 2; its coding is specified in IEC 61158-6-10.
Type: Unsigned8
Allowed Value: PNIORW Error code 1
The Error code 1 assumes one of the following values:
read error, module failure, version conflict, feature not supported, user specific, invalid index, invalid slot/subslot, type conflict, invalid area, state conflict, access denied, invalid range, invalid parameter, invalid type, read constrain conflict, resource busy, resource unavailable, service cancelled.
Type: Unsigned16 Error code 2
The parameter Error code 2 is user specific.
Type: Unsigned8 Add Data 1
The parameter Add Data is API specific (profile). The value 0 shall be transmitted if no additional data 1 is defined.
Type: Unsigned 16
NOTE 2 Add Data 1 may be used by profile specifications to transmit specific error messages.
Add Data 2
The parameter Add Data is user specific. The value 0 shall be transmitted if no additional data 2 is defined.
Type: Unsigned 16
NOTE 3 Add Data 2 may be used by device vendors to transmit specific error messages.
The negative response shall contain the values Error Decode = "PNIORW", Error code 1 =
"invalid index", Error code 2 = "user specific" if the addressed submodule has output data only.
7.3.1.4.1.2 Read Query
This optional confirmed service may be used to read the value of a Record Data object. To optimize the access to many small data objects a server may offer different combinations of this data behind one Index. In this case, the content of the Record Data object is defined by the Selector. This service shall only be used in conjunction with the implicit AR, IO AR or Supervisor AR. Table 110 shows the parameters of the service.
The attribute Read Partial Access controls the behavior of the response in case the requested length is shorter than the length of the Record Data object (see attribute description).
Table 110 – Read Query
Parameter name req ind rsp cnf
Argument M M(=)
AREP M M(=)
API M M(=)
Target AR UUID U U(=)
Slot Number M M(=)
Subslot Number M M(=)
Index M M(=)
Seq Number M M(=)
Length M M(=)
Selector M M(=)
Result(+) S S(=)
AREP M M(=)
Seq Number M M(=)
Length M M(=)
Data M M(=)
Result(-) S S(=)
AREP M M(=)
Seq Number M M(=)
Error Decode M M(=)
Error code 1 M M(=)
Error code 2 M M(=)
Add Data 1 M M(=)
Add Data 2 M M(=)
Argument
The argument shall convey the service specific parameters of the service request.
AREP
This parameter is the local identifier for the desired AR.
API If the scope of the record data object is subslot, slot or API, this parameter shall be used to address the desired AP.
Target AR UUID
If the scope of the record data object is application relation, this parameter shall be used in conjunction with the implicit AR to address the desired AR within the IO device.
Slot Number
If the scope of the record data object is subslot or slot, this parameter shall be used to address the desired slot (typically a module).
Subslot Number
If the scope of the record data object is subslot, this parameter shall be used to address the desired subslot (typically a submodule).
Index
The parameter Index shall be used to address the desired Record Data object. It is additionally used to derive the scope of the Record Data object.
Seq Number
The parameter Seq Number is used by the server to identify the duplication of services with a sequence number. The range of this service parameter is from 0 to 216 -1. The requesting application process shall provide a unique Seq Number to each outstanding service request. The parameter Seq Number shall be incremented for each service request during a session.
NOTE 1 If for example a write service request had the Seq Number set to “17”, a following read service request shall have the Seq Number set to “18”.
When starting a new session the sequence number shall start with the last value of the session before. A confirmation with a Seq Number that is not outstanding will be ignored.
An indication with a Seq Number that is not outstanding will be rejected. The Seq Number shall be maintained for each established AR separately.
Length
The parameter Length indicates the number of octets of a Record Data object that has to be read. The allowed length is from 0 to 232-256.
Selector
The parameter Selector is used by the server to identify the requested data. To optimize the access to many small data objects a server may offer different combinations of this data behind one Index and select the requested collection with the Selector.
Result(+)
This parameter indicates that the service request succeeded.
Length
The parameter Length indicates the number of octets of the Data object that has been read.
Data
The parameter Data contains the value of the object which has been read and consists of the number of octets indicated in the Length. This parameter has to be composed of the data types defined in Clause 5.
Result(-)
This parameter indicates that the service request failed.
Error Decode
This parameter selects one Error scheme for Error code 1 and 2; its coding is specified in IEC 61158-6-10.
Type: Unsigned8
Allowed Value: PNIORW Error code 1
The Error code 1 assumes one of the following values:
read error, module failure, version conflict, feature not supported, user specific, invalid index, invalid slot/subslot, type conflict, invalid area, state conflict, access denied, invalid range, invalid parameter, invalid type, read constrain conflict, resource busy, resource unavailable, service cancelled.
Type: Unsigned16 Error code 2
The parameter Error code 2 is user specific.
Type: Unsigned8 Add Data 1
The parameter Add Data is API specific (profile). The value 0 shall be transmitted if no additional data 1 is defined.
Type: Unsigned 16
NOTE 2 Add Data 1 may be used by profile specifications to transmit specific error messages.
Add Data 2
The parameter Add Data is user specific. The value 0 shall be transmitted if no additional data 2 is defined.
Type: Unsigned 16
NOTE 3 Add Data 2 may be used by device vendors to transmit specific error messages.
The negative response shall contain the values Error Decode = "PNIORW", Error code 1 =
"invalid index", Error code 2 = "user specific" if the addressed submodule has output data only.
7.3.1.4.2 Write Services 7.3.1.4.2.1 Write
This confirmed service may be used to write the value of a Record Data object. This service shall only be used in conjunction with the IO AR or Supervisor AR. In addition to this common write service, additional services are defined for write specific application data. All this write services use the same parameters, only the data field is different. Table 111 shows the parameters of the services. This service can also be used to write additional user and profile specific data.
The attribute Write Partial Access controls the behavior of the response in case the requested length is shorter than the length of the Record Data object (see attribute description).
Table 111 – Write
Parameter name req ind rsp cnf
Argument M M(=)
AREP M M(=)
API M M(=)
Slot Number M M(=)
Subslot Number M M(=)
Index M M(=)
Seq Number M M(=)
Parameter name req ind rsp cnf
Length M M(=)
Data M M(=)
Prm Flag M
Result(+) S S(=)
AREP M M(=)
Seq Number M M(=)
Result(-) S S(=)
AREP M M(=)
Seq Number M M(=)
Error Decode M M(=)
Error code 1 M M(=)
Error code 2 M M(=)
Add Data 1 M M(=)
Add Data 2 M M(=)
Argument
The argument shall convey the service specific parameters of the service request.
AREP
This parameter is the local identifier for the desired AR.
API If the scope of the record data object is subslot, slot or API, this parameter shall be used to address the desired AP.
Slot Number
If the scope of the record data object is subslot or slot, this parameter shall be used to address the desired slot (typically a module).
Subslot Number
If the scope of the record data object is subslot, this parameter shall be used to address the desired subslot (typically a submodule).
Index
The parameter Index shall be used to address the desired Record Data object. It is additionally used to derive the scope of the Record Data object.
Seq Number
The parameter Seq Number is used by the server to identify the duplication of services with a sequence number. The range of this service parameter is from 0 to 216 -1. The requesting application process shall provide a unique Seq Number to each outstanding service request. The parameter Seq Number shall be incremented for each service request during a session.
NOTE 1 If for example a write service request had the Seq Number set to “17”, a following read service request shall have the Seq Number set to “18”.
When starting a new session the sequence number shall start with the last value of the session before. A confirmation with a Seq Number that is not outstanding will be ignored.
An indication with a Seq Number that is not outstanding will be rejected. The Seq Number shall be maintained for each established AR separately.
Length
The parameter Length indicates the number of octets of a Record Data object which has to be written. The allowed length is from 0 to 232-256.
Data
The parameter Data contains the value of the Record Data object which has to be written and consists of the number of octets indicated in the Length of the request. This parameter has to be composed of the data types defined in Clause 5. A specific meaning for the different services of this data exists, which is described in the special service parts.
Table 112 shows the list of special write services.
Table 112 – Write Services
Service Name Chapter
Write Substitute Value 7.3.2.5.18
Write I&M1 Data 7.3.6.3.20
Write I&M2 Data 7.3.6.3.22
Write I&M3 Data 7.3.6.3.24
Write I&M4 Data 7.3.6.3.26
Write Isochronous Mode Data 7.3.7.3.1 Write PD Interface Adjust 7.3.8.3.5
Write PD IR Data 7.3.8.3.7
Write PD IR Subframe Data 7.3.8.3.12
Write PD Sync Data 7.3.8.3.9
Write PD Interface MRP Data Check 7.3.8.3.17 Write PD Interface MRP Data Adjust 7.3.8.3.19 Write PD Interface FSU Data Adjust 7.3.8.3.21 Write PD NC Data Check 7.3.8.3.23 Write MRP Port Data Adjust 7.3.8.3.36 Write PD Port Data Check 7.3.8.3.26 Write PD Port Data Adjust 7.3.8.3.28 Write PD Port FO Data Check 7.3.8.3.32 Write PD Port FO Data Adjust 7.3.8.3.33 Write PD Port MRP Data Adjust 7.3.8.3.36
Write PD Time Data 7.3.8.3.14
Prm Flag
The local indication parameter shall contain the value TRUE while parameterization during the connection establishment phase. Otherwise, the value shall be set to FALSE.
Attribute type: Boolean
NOTE 2 This parameter is used to control the persistent storage of data. It is utilized in fast start-up procedure.
Result(+)
This parameter indicates that the service request succeeded.
Result(-)
This parameter indicates that the service request failed.
Error Decode
This parameter selects one Error scheme for Error code 1 and 2; its coding is specified in IEC 61158-6-10.
Type: Unsigned8
Allowed Value: PNIORW Error code 1
The Error code 1 assumes one of the following values:
read error, module failure, version conflict, feature not supported, user specific, invalid index, invalid slot/subslot, type conflict, invalid area, state conflict, access denied, invalid range, invalid parameter, invalid type, read constrain conflict, resource busy, resource unavailable, service cancelled.
Type: Unsigned16 Error code 2
The parameter Error code 2 is user specific.
Type: Unsigned8 Add Data 1
The parameter Add Data is API specific (profile). The value 0 shall be transmitted if no additional data 1 is defined.
Type: Unsigned 16
NOTE 3 Add Data 1 may be used by profile specifications to transmit specific error messages.
Add Data 2
The parameter Add Data is user specific. The value 0 shall be transmitted if no additional data 2 is defined.
Type: Unsigned 16
NOTE 4 Add Data 2 may be used by device vendors to transmit specific error messages.
The negative response shall contain the values Error Decode = "PNIORW", Error code 1 =
"invalid index", Error code 2 = "user specific" if the addressed submodule has output data only.
7.3.1.4.2.2 Write Combined Object Container
This confirmed service may be used to write the Comined Object Container to the combined object access point (see 7.1.4.5.6 for details). This service shall be used in conjunction with the IO AR or Supervisor AR.
The parameter structure and the meaning of the parameters is the same as described in the write service (see 7.3.1.4.2.1). Combined object Container belongs to a submodule, which is addressed by the default API (zero), its slot and subslot number. The parameter Index indentifies the combined object container’s data record index as specified in IEC 61158-6-10.
The parameter Data has a service specific structure and meaning. Table 113 shows the specific elements of Data for this service.
The service user shall only use this service if the used AR is connected to the addressed submodule, which shall be the access point of the combined object. The submodules addressed by API, Slot Number and Subslot Number of a particular container entry shall be part of the combined object. The index shall be supported by the submodule. Otherwise the service provider shall issue a negative response to the service and all data shall be ignored.