Device

Overview

Functions and callback-prototypes to control the configuration and operational state of the IO device.

Typedefs
typedef void(*	PN_API_IOD_newModPullCbf) (PN_API_IOD_Handle_t *const pnHandle, const PN_API_IOD_DevAddr_t *const addr)
	Callback function prototype to indicate the pull of a module.
typedef void(*	PN_API_IOD_newModPlugCbf) (PN_API_IOD_Handle_t *const pnHandle, const PN_API_IOD_DevAddr_t *const addr, const uint32_t inDataLen, const uint32_t outDataLen)
	Callback function prototype to indicate the plug of a module.

Functions
uint32_t	PN_API_IOD_openDevice (PN_API_IOD_Handle_t *const pnHandle, uint16_t vendorId, uint16_t deviceId, PN_API_IOD_DevAnnotation_t *devAnnotation, PN_API_IOD_SnmpLldpParams_t *iodSnmpParam)
	Creates an IO device instance during startup procedure.
uint32_t	PN_API_IOD_closeDevice (PN_API_IOD_Handle_t *const pnHandle)
	Closes an IO device instance.
uint32_t	PN_API_IOD_startDevice (PN_API_IOD_Handle_t *const pnHandle)
	Starts communication with an IO device instance.
uint32_t	PN_API_IOD_stopDevice (PN_API_IOD_Handle_t *const pnHandle)
	Stops communication with an IO device instance.
uint32_t	PN_API_IOD_setupPDev (PN_API_IOD_Handle_t *const pnHandle, PN_API_IOD_SubmodListEntry_t *ioSubmodList, uint32_t ioSubmodListSize)
	Configures the PDev parameters of the IO device.
uint32_t	PN_API_IOD_setDeviceState (PN_API_IOD_Handle_t *const pnHandle, uint32_t devState)
	Sets the IO device state to either "operate" or "clear".
uint32_t	PN_API_IOD_plugSubmod (PN_API_IOD_Handle_t *const pnHandle, uint32_t api, PN_API_IOD_DevAddr_t *addr, uint32_t modId, uint32_t submodId, uint32_t inDataLen, uint32_t outDataLen, uint8_t im0Support, PN_API_IOD_Im0Data_t *im0Data, uint8_t iopsInitVal)
	Inserts a submodule into a subslot.
uint32_t	PN_API_IOD_plugSubmodList (PN_API_IOD_Handle_t *const pnHandle, const PN_API_IOD_SubmodListEntry_t *ioSubmodList, uint32_t ioSubmodListSize, const PN_API_IOD_Im0ListEntry_t *im0List, uint32_t im0ListSize, uint32_t *statusList)
	Inserts a list of submodules into subslots.
uint32_t	PN_API_IOD_pullSubmod (PN_API_IOD_Handle_t *const pnHandle, uint32_t api, PN_API_IOD_DevAddr_t *addr)
	Removes an installed submodule.
uint32_t	PN_API_IOD_getRealSubmod (PN_API_IOD_Handle_t *const pnHandle, PN_API_IOD_RealSubmod_t **realSubmod, uint32_t api, uint32_t slot, uint32_t subslot)
	Gets real information about a submodule.
uint32_t	PN_API_IOD_getRealSubmodList (PN_API_IOD_Handle_t *const pnHandle, PN_API_IOD_RealSubmod_t **realSubmodList, uint32_t *realSubmodListSize)
	Gets information about real submodule list.
uint32_t	PN_API_IOD_setRealSubmodStatus (PN_API_IOD_Handle_t *const pnHandle, PN_API_IOD_RealSubmod_t *realSubmod, PN_API_IOD_RealSubmodStatus_t submodStatus)
	Sets the operational status of a submodule.
#define	DEVICE_STATE_OPERATE   1
	Device state "operate".
#define	DEVICE_STATE_CLEAR   2
	Device state "clear".