EI_API_CIP_addAssemblyMember()

uint32_t EI_API_CIP_addAssemblyMember	(	T *	pCipNode_p,
		uint16_t	assemblyInstanceId_p,
		uint16_t	classId_p,
		uint16_t	instanceId_p,
		uint16_t	attributeId_p
	)

Add an member to an assembly member list.

This function adds the given attribute to the given assembly instance.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	assemblyInstanceId_p	Assembly instance identifier.
[in]	classId_p	Class identifier.
[in]	instanceId_p	Instance identifier.
[in]	attributeId_p	Attribute identifier.

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_INSTANCE_DOES_NOT_EXIST	Instance does not exist in CIP node dictionary.
EI_API_CIP_eERR_ATTRIBUTE_DOES_NOT_EXIST	Attribute does not exist in class or instance.
EI_API_CIP_eERR_ASSEMBLY_DOES_NOT_EXIST	The assembly with the given ID could not be found.
EI_API_CIP_eERR_ASSEMBLY_INVALID_ACCESSMODE	Attempted to add a read only attribute to a writable assembly.
EI_API_CIP_eERR_ASSEMBLY_MAXLENGTH_EXCEEDED	The total length of assemblies data exceeds the maximum connection size.
EI_API_CIP_eERR_MEMALLOC	Memory allocation error.
EI_API_CIP_eERR_GENERAL	General CIP error.

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;
uint16_t classId;
uint16_t instanceId;
uint16_t attrId;
uint16_t assemblyInstanceId;
 
// 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_createAssembly(pEI_API_CIP_NODE, assemblyInstanceId, EI_API_CIP_eAR_GET_AND_SET);
 
...
 
// Add assembly member
errCode = EI_API_CIP_addAssemblyMember(pEI_API_CIP_NODE, assemblyInstanceId, classId, instanceId, attrId);

See also

EI_API_CIP_createAssembly EI_API_CIP_getAssemblySize EI_API_CIP_getAssemblyData EI_API_CIP_setAssemblyData EI_API_CIP_SService_t EI_API_CIP_SAttr_t EI_API_CIP_EAr_t EI_API_CIP_EError_t