EI_API_CIP_addRoutableInstanceAttr()

uint32_t EI_API_CIP_addRoutableInstanceAttr	(	T *	pCipNode_p,
		uint16_t	classId_p,
		uint16_t	instanceId_p,
		EI_API_CIP_SAttr_t *	pAttr_p,
		uint8_t	linkAddr_p
	)

Add an attribute to an routable instance.

This function adds a attribute to a instance with the class and instance identifier passed as parameter. The parameter details are passed as a struct of type EI_API_CIP_SAttr_t. Target instance is encoded by instance ID and link address.

Remarks

For details about encoding please see EI_API_CIP_createRoutableInstance.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	classId_p	Class identifier.
[in]	instanceId_p	Instance identifier.
[in]	pAttr_p	Pointer to struct of attribute parameters.
[in]	linkAddr_p	Link address used to encode the target instance ID.

Returns

EI_API_CIP_EError_t as uint32_t value.

Return values

EI_API_CIP_eERR_OK	Success.
EI_API_CIP_eERR_GENERAL	Instance encoding failed.
EI_API_CIP_eERR_NODE_INVALID	CIP node is invalid, possibly EI_API_CIP_NODE_new() was not called.
EI_API_CIP_eERR_CLASS_BLACKLIST	Operation on the CIP object with specified identifier (class ID) are not allowed.
EI_API_CIP_eERR_CLASS_DOES_NOT_EXIST	Class does not exists in CIP node dictionary.
EI_API_CIP_eERR_INSTANCE_DOES_NOT_EXIST	Instance does not exist in CIP node dictionary.
EI_API_CIP_eERR_ATTRIBUTE_ALREADY_EXIST	Attribute already exists in class or instance.
EI_API_CIP_eERR_ATTRIBUTE_NOT_IMPLEMENTED	Attribute function not implemented.
EI_API_CIP_eERR_ATTRIBUTE_CDT_SIZE	Passed constructed data type size for e.g. farray not within valid range.
EI_API_CIP_eERR_MEMALLOC	Memory allocation error.
EI_API_CIP_eERR_ATTRIBUTE_EDT_SIZE	Passed elementary data type size for e.g. short string not within valid range.
EI_API_CIP_eERR_INSTANCE_UNKNOWN_STATE	Unknown state during class operation reached.

Example

#include "EI_API.h"
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
EI_API_CIP_NODE_T* pEI_API_CIP_NODE = NULL;
EI_API_CIP_SAttr_t attr;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
uint16_t classId      = 0x10D;
uint16_t instanceId   = 0x01;
uint8_t  maxLinkAddr  = 8;
uint8_t  linkAddr     = 0;
 
// Create a new adapter first
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
// Create a CIP node next
EI_API_CIP_NODE_InitParams_t initParams;
initParams.maxInstanceNum = 256;
 
pEI_API_CIP_NODE = EI_API_CIP_NODE_new(&initParams);
 
// Create a class
errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, classId);
 
EI_API_CIP_setRoutingMaxLinkAddr(pEI_API_CIP_NODE, maxLinkAddr);
 
linkAddr = 1;
 
// Create routable instance in class. Instance 1 is encoded to 60671 decimal.
errCode = EI_API_CIP_createRoutableInstance(pEI_API_CIP_NODE, classId, 0x0001, linkAddr);    // Instance 1
 
// Attribute parameter set
attr.id = 0x300;
attr.accessRule = EI_API_CIP_eAR_GET_AND_SET;
attr.edt = EI_API_CIP_eEDT_USINT;
attr.edtSize = 0;
attr.cdtSize = 0;
 
// Add attribute with ID equal 1 under previously created instance.
errCode = EI_API_CIP_addRoutableInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr, linkAddr);

See also

EI_API_CIP_createClass EI_API_CIP_setRoutingMaxLinkAddr EI_API_CIP_createRoutableInstance EI_API_CIP_SAttr_t EI_API_CIP_EEdt_t EI_API_CIP_ECdt_t EI_API_CIP_EAr_t