Node Scripting

Provides service function to allow execution of custom scripts in remote Nodes. More...

Data Structures
struct	Ucs_Ns_ConfigMsg_t
	Structure of a ConfigMsg used in Node-Script. This structure is used for the transmitted messages which contains the command to execute as well as for the expected result which returns from the corresponding node. More...
struct	Ucs_Ns_Script_t
	Structure of a node-script used to configure a remote node. More...

Callback Functions
typedef void(*	Ucs_Ns_SynchronizeNodeCb_t )(uint16_t node_address, Ucs_Ns_SyncResult_t result, void *user_ptr)
	Function signature of result callback used by Ucs_Ns_SynchronizeNode().
typedef void(*	Ucs_Ns_ResultCb_t )(uint16_t node_address, Ucs_Ns_ResultCode_t result, Ucs_Ns_ErrorInfo_t error_info, void *ucs_user_ptr)
	Function signature used for the results of the Scripting Manager.

Enumerations
enum	Ucs_Ns_ResultCode_t {   UCS_NS_RES_SUCCESS = 0x00U,   UCS_NS_RES_ERR_TIMEOUT = 0x01U,   UCS_NS_RES_ERR_PAYLOAD = 0x02U,   UCS_NS_RES_ERR_OPTYPE = 0x03U,   UCS_NS_RES_ERR_TX = 0x04U,   UCS_NS_RES_ERR_SYNC = 0x05U }
	Result codes of the Node Script Management. More...
enum	Ucs_Ns_SyncResult_t {   UCS_NS_SYNC_SUCCESS = 0x00U,   UCS_NS_SYNC_ERROR = 0x01U }
	Result codes of node synchronization. More...

Functions
Ucs_Return_t	Ucs_Ns_Run (Ucs_Inst_t *self, uint16_t node_address, UCS_NS_CONST Ucs_Ns_Script_t *script_list_ptr, uint8_t script_list_size, Ucs_Ns_ResultCb_t result_fptr)
	Runs a given script list on the given node.

Detailed Description

Provides service function to allow execution of custom scripts in remote Nodes.