The Programming API allows to program the ConfigString and/or the IdentString of a single node in the system.
The Programming API has no initialization parameters.
The Programming service assumes that the target node has received a Hello.Get command. Programming is started by calling Ucs_Prog_Start(). It requires the following parameters:
Reference to the UNICENS instance (Ucs_Inst_t).
The node position address of the the node to be programmed.
Signature of the the node to be programmed as it was reported by Hello.Status during the Node Discovery (Ucs_Signature_t).
Defines the set of MemIDs (see command_list) (Ucs_Prg_SessionType_t).
Array of programming tasks of type Ucs_Prg_Command_t. Currently each entry corresponds to one ExtendedNetworkControl.MemoryWrite command. The array ends with an entry whose data_length is 0 or data is NULL .
Represents the memory resource to be written.
Defines the memory location at which the writing operation starts.
Sets the number of memory units to be written. Memory units can be unsigned bytes, unsigned words or unsigned masked data depending on the memory type.
Total length of data.
Callback providing the result of the Programming task (Ucs_Prg_ReportCb_t).
When the Programming service finishes, it provides its result via the result_fptr callback function.
Result values of the Programming service (Ucs_Prg_ResCode_t).
Describes the function where an error occurred (Ucs_Prg_Func_t).
Length of the following error parameter field parm. It is 0 if no error occurred.
Pointer to the parameters of a potential error message. The meaning of these parameters can be derived from function and the respective EXC functions.
User reference as provided in Ucs_InitData_t::user_ptr