Overview

This group defines all functions for access of device parameters in a common way.

Each device contains an object dictionary. An object dictionary contains all objects (device parameters) that can be accessed via CSI. An object is identified by its index and subindex.

Collaboration diagram for Device Parameter Access:

Functions
CSI_API long	CsiDevReadLargeObject (struct CsiDev pDev, uint16_t ObjDicIdx, uint8_t ObjDicSub, void pDataBuffer, uint16_t BufferSize)
	This function reads object dictionary entries with a data size > 4 bytes. More...

CSI_API long	CsiDevReadObject (struct CsiDev pDev, uint16_t ObjDicIdx, uint8_t ObjDicSub, uint32_t pRxDWord)
	This function reads up to 4 bytes of data from device object dictionary. More...

CSI_API long	CsiDevWriteLargeObject (struct CsiDev pDev, uint16_t ObjDicIdx, uint8_t ObjDicSub, void pDataBuffer, uint32_t DataSize, CsiDataTransferCallback Callback)
	This function writes object dictionary entries with a data size > 4 bytes. More...

CSI_API long	CsiDevWriteObject (struct CsiDev *pDev, uint16_t ObjDicIdx, uint8_t ObjDicSub, uint32_t TxDWord)
	This function writes up to 4 bytes of data into device object dictionary. More...

Function Documentation

CSI_API long CsiDevReadLargeObject	(	struct CsiDev *	pDev,
		uint16_t	ObjDicIdx,
		uint8_t	ObjDicSub,
		void *	pDataBuffer,
		uint16_t	BufferSize
	)

This function reads object dictionary entries with a data size > 4 bytes.

Parameters

[in]	pDev	Device to read data from
[in]	ObjDicIdx	Index into device object dictionary
[in]	ObjDicSub	Sub entry of object dictionary entry
[in]	pDataBuffer	Stores the data
[in]	BufferSize	Size of the buffer given in pDataBuffer

Return values

>=	0 Data bytes stored into buffer
<0	Error code

 {
     return CsiBusReadLargeData(pDev->pBus, pDev->NodeId, ObjDicIdx, ObjDicSub,
         (uint8_t*)pDataBuffer, BufferSize);
 }

Here is the call graph for this function:

CSI_API long CsiDevReadObject	(	struct CsiDev *	pDev,
		uint16_t	ObjDicIdx,
		uint8_t	ObjDicSub,
		uint32_t *	pRxDWord
	)

This function reads up to 4 bytes of data from device object dictionary.

Parameters

[in]	pDev	Device to read data from
[in]	ObjDicIdx	Index into device object dictionary
[in]	ObjDicSub	Sub entry of object dictionary entry
[in]	pRxDWord	Points to DWord buffer for storage of received data

Returns: Error code - ERR_NOERR indicates success

Referenced by Nem_GetAxisLen(), Nem_GetDevCfg(), Nem_GetHomeOffset(), Nem_GetPosIs(), NemGetLastDevErr(), NemReadStatusWord(), NemV4DevInit(), NemV4EnableForceMonitoring(), NemV4GetLastDevErr(), NemV4GetPosIs(), NemV4ReadAnalogInput(), NemV4ReadDigitalInputs(), and NemV4ReadStatusWord().

 {
     if (CSI_SERIAL_PROTOCOL_V1 == pDev->SerProtocolVersion)
     {
         return CsiBusReadData(pDev->pBus, pDev->NodeId, ObjDicIdx, ObjDicSub, pRxDWord);
     }
     else
     {
         return CsiBusReadDataV2(pDev->pBus, pDev->NodeId, ObjDicIdx, ObjDicSub, pRxDWord);
     }
 }

Here is the call graph for this function:

CSI_API long CsiDevWriteLargeObject	(	struct CsiDev *	pDev,
		uint16_t	ObjDicIdx,
		uint8_t	ObjDicSub,
		void *	pDataBuffer,
		uint32_t	DataSize,
		CsiDataTransferCallback	Callback
	)

This function writes object dictionary entries with a data size > 4 bytes.

Parameters

[in]	pDev	Device to write to
[in]	ObjDicIdx	Index into device object dictionary
[in]	ObjDicSub	Sub entry of object dictionary entry
[in]	pDataBuffer	Stores the data
[in]	DataSize	Size of the data given in pDataBuffer
[in]	Callback	A callback function that will be called after each packet that has been transfered (e.g. to show a progress bar)

Returns: Error code - ERR_NOERR indicates success

 {
     return CsiBusWriteLargeData(pDev->pBus, pDev->NodeId, ObjDicIdx, ObjDicSub,
         (uint8_t*)pDataBuffer, DataSize, Callback);
 }

Here is the call graph for this function:

CSI_API long CsiDevWriteObject	(	struct CsiDev *	pDev,
		uint16_t	ObjDicIdx,
		uint8_t	ObjDicSub,
		uint32_t	TxDWord
	)

This function writes up to 4 bytes of data into device object dictionary.

Parameters

[in]	pDev	Device to write to
[in]	ObjDicIdx	Index into device object dictionary
[in]	ObjDicSub	Sub entry of object dictionary entry
[in]	TxDWord	Points to DWord that contains data to write

Returns: Error code - ERR_NOERR indicates success

Referenced by Nem_ClearErrHist(), Nem_MoveToPos(), Nem_SetControlWord(), Nem_SetHomePos(), Nem_SetHomingMode(), Nem_SetHomingSpeed(), Nem_SetOpMode(), NemSwitchValve(), NemV4_ClearErrHist(), NemV4_SetControlWord(), NemV4_SetOpMode(), NemV4EnableForceMonitoring(), NemV4MoveToPos(), NemV4WriteDigitalOutputs(), and NemV4WriteForceLimit().

 {
     if (CSI_SERIAL_PROTOCOL_V1 == pDev->SerProtocolVersion)
     {
         return CsiBusWriteData(pDev->pBus, pDev->NodeId, ObjDicIdx, ObjDicSub, TxDWord);
     }
     else
     {
         return CsiBusWriteDataV2(pDev->pBus, pDev->NodeId, ObjDicIdx, ObjDicSub, TxDWord);
     }
 }

Here is the call graph for this function:

Overview

Functions

Function Documentation