EI_API_CIP_addRoutableInstanceService()

uint32_t EI_API_CIP_addRoutableInstanceService	(	T *	pCipNode_p,
		uint16_t	classId_p,
		uint16_t	instanceId_p,
		EI_API_CIP_SService_t *	pService_p,
		uint8_t	linkAddr_p
	)

Add one or more service/s to the routable class instance.

This function adds one or more service/s to the class with the class and instance identifiers passed as parameters classId_p and instanceId_p. Target instance is encoded by instance ID and link address.

Remarks

The service EI_API_CIP_eSC_SETATTRSINGLE includes EI_API_CIP_eSC_GETATTRSINGLE, so its not necessary for a bitwise operation (or) for example (EI_API_CIP_eSC_GETATTRSINGLE | EI_API_CIP_eSC_SETATTRSINGLE). 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]	pService_p	Service or services the class will support.
[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_SERVICE_ALREADY_EXIST	Service already exist.
EI_API_CIP_eERR_SERVICE_PARAMETER	Wrong or invalid service parameters.
EI_API_CIP_eERR_SERVICE_INVALID	Service is invalid, possibly NULL pointer.
EI_API_CIP_eERR_MEMALLOC	Memory allocation error.
EI_API_CIP_eERR_NOT_IMPLEMENTED	Not implemented function.
EI_API_CIP_eERR_CLASS_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;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
uint16_t classId      = 0x10D;
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);
 
errCode = 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
 
// Add services to instance 0x01 for the class with classId
// Example for Get_Attribute_Single
EI_API_CIP_SService_t srvc;
srvc.code = EI_API_CIP_eSC_GETATTRSINGLE;
 
errCode = EI_API_CIP_addRoutableInstanceService(pEI_API_CIP_NODE, classId, 0x0001, &srvc, linkAddr);

See also

EI_API_CIP_createClass EI_API_CIP_setRoutingMaxLinkAddr EI_API_CIP_createRoutableInstance EI_API_CIP_ESc_t EI_API_CIP_EError_t