EI_API_CIP_setRoutingAssemblyData()

uint32_t EI_API_CIP_setRoutingAssemblyData	(	T *	pCipNode_p,
		uint16_t	assemblyInstanceId_p,
		void *	pSourceBuffer_p,
		uint16_t	sourceBufferLength_p,
		uint8_t	linkAddr_p
	)

Set routable assembly instance attribute data.

Set routable assembly instance attribute Data (Attribute ID 3). 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]	assemblyInstanceId_p	Assembly instance identifier.
[in]	pSourceBuffer_p	Pointer to data buffer.
[in]	sourceBufferLength_p	Size of data buffer.
[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_NODE_INVALID	CIP node is invalid, possibly EI_API_CIP_NODE_new() was not called.
EI_API_CIP_eERR_GENERAL	CIP error code.
EI_API_CIP_eERR_ASSEMBLY_DOES_NOT_EXIST	The assembly with the given ID could not be found.
EI_API_CIP_eERR_ASSEMBLY_INVALID_BUFFER	Invalid buffer pointer.
EI_API_CIP_eERR_ASSEMBLY_BAD_BUFFERSIZE	Buffer size does not match assembly members' size.

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_SService_t service;
 EI_API_CIP_SAttr_t attr;
 uint32_t errCode;
 
 uint8_t numInterfaces = 1;
 uint8_t linkAddr      = 1;
 uint16_t classId;
 uint16_t instanceId;
 uint16_t attrId;
 uint16_t assemblyInstanceId;
 uint8_t srcBuffer[1];
 
 // 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 class for holding data attributes
 classId = 0x70;
 errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, classId);
 
 // Define services on defined class
 service.getAttrAllResponseCnt = 0;
 service.callback = NULL;
 
 service.code = EI_API_CIP_eSC_GETATTRSINGLE;
 errCode = EI_API_CIP_addClassService(pEI_API_CIP_NODE, classId, &service);
 
 service.code = EI_API_CIP_eSC_SETATTRSINGLE;
 errCode = EI_API_CIP_addClassService(pEI_API_CIP_NODE, classId, &service);
 
 // Create instance with ID = 1, under defined class
 instanceId = 0x01;
 errCode = EI_API_CIP_createInstance(pEI_API_CIP_NODE, classId, instanceId);
 
 // Add attribute with ID = 0x300 (Vendor Specific Attribute ID Range)
 // of type USINT and read-write access under the created instance 0x01
 attrId = 0x300;
 
 attr.id         = attrId;
 attr.edt        = EI_API_CIP_eEDT_USINT;
 attr.cdt        = EI_API_CIP_eCDT_NO;
 attr.cdtSize    = 0;
 attr.accessRule = EI_API_CIP_eAR_GET_AND_SET;
 
 errCode = EI_API_CIP_addInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr);
 
 // Set value of instance attribute in the instance with ID = 0x01
 uint8_t value = 0xFF;
 attr.pvValue = &value;
 
 errCode = EI_API_CIP_setInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr);
 
 // Under pEI_API_CIP_NODE, create assembly instance with ID = 100, with read-write access
 assemblyInstanceId = 0x64;
 errCode = EI_API_CIP_createRoutingAssembly(pEI_API_CIP_NODE, assemblyInstanceId, EI_API_CIP_eAR_GET_AND_SET, linkAddr);
 
 ...
 
 // Add assembly member
 errCode = EI_API_CIP_addRoutingAssemblyMember(pEI_API_CIP_NODE, assemblyInstanceId, classId, instanceId, attrId, linkAddr);
 
 // Get attribute Size of assembly instance ID = 100, as number of bytes in attribute Data
 errCode = EI_API_CIP_getRoutingAssemblySize(pEI_API_CIP_NODE, assemblyInstanceId, &size, linkAddr)
 
 // Set assembly data, size of source buffer needs to be equal to size of Data attribute in bytes
 if (size == sizeof(srcBuffer))
 {
     srcBuffer[0] = 0x5A;
 
     errCode = EI_API_CIP_setRoutingAssemblyData(pEI_API_CIP_NODE, assemblyInstanceId, &srcBuffer, size, linkAddr);
 }

See also

EI_API_CIP_createRoutingAssembly EI_API_CIP_addRoutingAssemblyMember EI_API_CIP_getRoutingAssemblySize EI_API_CIP_getRoutingAssemblyData EI_API_CIP_EAr_t EI_API_CIP_EError_t