EI_API_CIP_addAssemblyMemberCustomMapped()

uint32_t EI_API_CIP_addAssemblyMemberCustomMapped	(	T *	pCipNode_p,
		uint16_t	assemblyInstanceId_p,
		EI_API_CIP_SAssemCustomMap_t *	pCustomAssembMap
	)

Add a member to an assembly member list with customized mapping.

This function adds the given attribute to the given assembly instance. It also gives the user the possibility to implemented Set and Get functions for customized mapping between the Attribute and its Assembly representation.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	assemblyInstanceId_p	Assembly instance identifier.
[in]	pCustomAssembMap	Pointer to the mapping descriptor

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"
 
// in this example we create 2 instaces of a class (ClassID=0x70) and for each instance we create instanceAttribute (ID=0x01)
// Then we create an Assembly instance (InstanceID=0x71) and add 2 member to it.
// These members will use customized mapping function.
// The mapping between the Assembly representation and the Attributes is as follows:
 
//                                        | 0xFF  <------------------>  Set Bit 6  |
// Attribute0x01-Class0x70-Instance0x01 --|                                        |-- Assembly representation byte
//                                        | 0x00  <------------------> Clear Bit 6 |
 
//                                        | 0xFF  <------------------>  Set Bit 7  |
// Attribute0x01-Class0x70-Instance0x02 --|                                        |-- Assembly representation byte
//                                        | 0x00  <------------------> Clear Bit 7 |
 
 static EI_API_CIP_EAssemb_Return_Code_t cbGetCustomMap( const EI_API_CIP_SAssemMapData_t *pAttrMapData, EI_API_CIP_STransferBuffer_t *pProduceBuffer)
 {
    EI_API_CIP_EAssemb_Return_Code_t retValue = ASSEMB_SERVICE_NO_RESPONSE;
    static const uint8_t mapArray[] = {(1<<6) , (1<<7)};
    uint8_t u8var;
 
    if((0x70 == pAttrMapData->classId) && (0x01 == pAttrMapData->attributeId))
    {
        if((1 == pAttrMapData->instanceId) || (2 == pAttrMapData->instanceId))
        {
            // bit position 6 will represent the status of Attribute0x01-Class0x70-Instance0x01
            // bit position 7 will represent the status of Attribute0x01-Class0x70-Instance0x02
            u8var = mapArray[pAttrMapData->instanceId - 1];
            // Map from Byte representation to Bit in Assembly representation
            if(0xFF == pAttrMapData->pAttribBuf[0])
            {
                pProduceBuffer->p8uDataBuf[0] |= u8var;  //set the corresponding bit
            }
            else
            {
                pProduceBuffer->p8uDataBuf[0] &= ~u8var; //clear the corresponding bit
            }
            pProduceBuffer->u16uActData = 1;
            retValue = ASSEMB_SERVICE_RESPONSE_OK;
        }
    }
 
     return retValue;
 }
 
 
 static EI_API_CIP_EAssemb_Return_Code_t cbSetCustomMap( EI_API_CIP_SAssemMapData_t *pAttrMapData, const EI_API_CIP_STransferBuffer_t *pConsumeBuffer)
 {
     EI_API_CIP_EAssemb_Return_Code_t retValue = ASSEMB_SERVICE_NO_RESPONSE;
     static const uint8_t maskArray[] = {(1<<6) , (1<<7)};
 
    if((0x70 == pAttrMapData->classId) && (0x01 == pAttrMapData->attributeId))
    {
        if((1 == pAttrMapData->instanceId) || (2 == pAttrMapData->instanceId))
        {
 
            // bit position 6 will represent the status of Attribute0x01-Class0x70-Instance0x01
            // bit position 7 will represent the status of Attribute0x01-Class0x70-Instance0x02
            // Map From Bit representation to byte representation
            if(pConsumeBuffer->p8uDataBuf[pConsumeBuffer->u16uActData] & maskArray[pAttrMapData->instanceId - 1])
            {
                pAttrMapData->pAttribBuf[0] = 0xFF;
            }
            else
            {
                pAttrMapData->pAttribBuf[0] = 0x00;
            }
            retValue = ASSEMB_SERVICE_RESPONSE_OK;
        }
    }
 
     return retValue;
 }
 
...
 
 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 defualtValue = 0;
 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);
 // Crearte another instance of the same class
 errCode = EI_API_CIP_createInstance(pEI_API_CIP_NODE, classId, instanceId + 1);
 
 // Add instance services to created instances
 OSAL_MEMORY_memset(&service, 0, sizeof(EI_API_CIP_SService_t));
 service.code = EI_API_CIP_eSC_GETATTRSINGLE;
 errCode = EI_API_CIP_addInstanceService(pEI_API_CIP_NODE, classId, instanceId, &service);
 errCode = EI_API_CIP_addInstanceService(pEI_API_CIP_NODE, classId, instanceId + 1, &service);
 service.code = EI_API_CIP_eSC_SETATTRSINGLE;
 errCode = EI_API_CIP_addInstanceService(pEI_API_CIP_NODE, classId, instanceId, &service);
 errCode = EI_API_CIP_addInstanceService(pEI_API_CIP_NODE, classId, instanceId + 1, &service);
 // Add attribute with ID = 0x01
 // of type USINT and read-write access under the created instances
 attrId = 0x01;
 
 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;
 attr.pvValue = &defualtValue;
 
 errCode = EI_API_CIP_addInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr);
 errCode = EI_API_CIP_setInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr);
 errCode = EI_API_CIP_addInstanceAttr(pEI_API_CIP_NODE, classId, instanceId + 1, &attr);
 errCode = EI_API_CIP_setInstanceAttr(pEI_API_CIP_NODE, classId, instanceId + 1, &attr);
 
 
 // Under pEI_API_CIP_NODE, create assembly instance with ID = 0x71, with read-write access
 assemblyInstanceId = 0x71;
 errCode = EI_API_CIP_createAssembly(pEI_API_CIP_NODE, assemblyInstanceId, EI_API_CIP_eAR_GET_AND_SET);
 
 ...
 
 EI_API_CIP_SAssemCustomMap_t assembCustomMapCfg = {0};
 // Add custom mapped assembly members
 
 for(uint16_t i=1; i<=2; i++)
 {
     // both assembly members will occupy the same byte.
     // So, we Set .assemblyMemberLength to 1 only for one of them
     assembCustomMapCfg.assemblyMemberLength = (1==i)?(1):0;
 
     assembCustomMapCfg.mappedClassId = classId;
     assembCustomMapCfg.mappedInstanceId = i;
     assembCustomMapCfg.mappedAttributeId = 1;
     assembCustomMapCfg.fuCustomGet = cbGetCustomMap;
     assembCustomMapCfg.fuCustomSet = cbSetCustomMap;
 
     errCode = EI_API_CIP_addAssemblyMemberCustomMapped(pEI_API_CIP_NODE, assemblyInstanceId, &assembCustomMapCfg);
 }

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