Structure STRU_SOE

Validity: RC3E v33.5.19-3 (or later)

This keyword allows a variable of type STRU_SOE_IDN to be defined.

This variable is used by the soe_ridn() and soe_widn() functions to read/write SOE parameters.

It consists of the following information:

Field	Type	Description
rid	I32	Robox ID associated with the device
idn	I32	Number of the S or P parameter to be read or written
element	I32	Only if read - element to be read 0 is assumed as DATA () (see table element codes below)
cmd	I32	Only if write - management by commands - 0 (not command) 1,2,3 (see code table) If read set to 0
isp	I32	Parameter type selection : •if 0 you manage S-0-idn •if 1 it manages P-0-idn
datatype	I32	Type of data to read/write (see code table)
datalen	I32	If used for SOE_RIDN: maximum size in bytes of the area to store the response If used for SOE_WIDN: size in bytes of the data to be written.
phase	I32	Working phase/execution mode: •1, initialization pass-through execution () •-1, blocking execution initialization() •2, reserved RTE •3, reserved RTE •4, reserved RTE •5, reserved RTE •6, operation successfully executed •0, uninitialized or error •other, illegal value Only values marked with (**) ARE THE ONLY ones that can be written into this variable by the user. The blocking value (-1) is changed by the instruction, in case of consecutive executions of the SOE_RIDN or SOE_WIDN functions the value -1 MUST be reset before execution of the same
nric	I32	Number of characters received. Useful in case of arrays to deduce how many elements were received
res_1	I32	Reserved
res_2	I32	Reserved
res_3	I32[260]	Reserved

Table element codes:

Code Table:

	Code
1	Executed command procedure (with autocheck if ended)
2	Stop command procedure
3	Send the specified value to handle command procedure

Please enable JavaScript to view this site.