PROFINET Device4.2.0
 
Loading...
Searching...
No Matches
Types

Overview

Common defines, enums and structs.

Data Structures

struct  PN_API_IOD_SCallbacks
 Structure representing a set of callbacks. More...
 
struct  PN_API_IOD_DevAnnotation_t
 Device annotation. More...
 
struct  PN_API_IOD_DevAddr_t
 Module/Submodule address (logical/geographical). More...
 
struct  PN_API_IOD_Ownership_t
 Ownership information. More...
 
struct  PN_API_IOD_ExpSubmod_t
 Parameters submodule. More...
 
struct  PN_API_IOD_Exp_t
 Module/Submodule properties. More...
 
struct  PN_API_IOD_ArInfo_t
 AR information. More...
 
struct  PN_API_IOD_SubmodListEntry_t
 IO Submodule list. More...
 
struct  PN_API_IOD_Im0SwRevision_t
 IM software revision. More...
 
struct  PN_API_IOD_Im0Data_t
 IM0 Data structure. More...
 
struct  PN_API_IOD_Im1Data
 IM1 Data structure. More...
 
struct  PN_API_IOD_Im2Data
 IM2 Data structure. More...
 
struct  PN_API_IOD_Im3Data
 IM3 Data structure. More...
 
struct  PN_API_IOD_Im4Data
 IM4 Data structure. More...
 
struct  PN_API_IOD_Im0ListEntry_t
 IM0 list. More...
 
struct  PN_API_IOD_IodInstance_t
 IO Device instance. More...
 
struct  PN_API_IOD_RemaDataSubmodCfgInfo_t
 Remanent submodule configuration information. More...
 
struct  PN_API_IOD_SnmpLldpParams_t
 SNMP parameters. More...
 
struct  PN_API_IOD_ErrState_t
 
struct  PN_API_IOD_DevAlarmData_t
 Alarm data. More...
 
struct  PN_API_IOD_IpSuite_t
 IP configuration. More...
 
struct  PN_API_IOD_ioBlockHeader_t
 Profinet Block header. More...
 
struct  PN_API_IOD_RealSubmod_t
 Submodule information. More...
 
struct  PN_API_IOD_BufferLock_t
 Data buffer (DBAI). More...
 
struct  PN_API_IOD_DkVersion_t
 Profinet Stack version. More...
 

Typedefs

typedef struct PN_API_IOD_SCallbacks PN_API_IOD_Callbacks_t
 Structure representing a set of callbacks.
 
typedef void * PN_API_IOD_IsoObjHndl_t
 Isochronous object handle.
 
typedef struct PN_API_IOD_Handle PN_API_IOD_Handle_t
 API handle instance which holds IO device's info.
 
typedef struct PN_API_IOD_Im1Data PN_API_IOD_Im1Data_t
 IM1 Data structure.
 
typedef struct PN_API_IOD_Im2Data PN_API_IOD_Im2Data_t
 IM2 Data structure.
 
typedef struct PN_API_IOD_Im3Data PN_API_IOD_Im3Data_t
 IM3 Data structure.
 
typedef struct PN_API_IOD_Im4Data PN_API_IOD_Im4Data_t
 IM4 Data structure.
 

Enumerations

enum  PN_API_IOD_Im0Support_t { PN_API_IOD_Im0Nothing = 0x00 , PN_API_IOD_Im0Submodule = 0x01 , PN_API_IOD_Im0Module = 0x02 , PN_API_IOD_Im0Device = 0x04 }
 Type of IM0 support. More...
 
enum  PN_API_IOD_RemaDataType_t {
  PN_API_IOD_RemaDataMacAddr , PN_API_IOD_RemaDataDevName , PN_API_IOD_RemaDataIpSuite , PN_API_IOD_RemaDataPdevRecord ,
  PN_API_IOD_RemaDataIm1 , PN_API_IOD_RemaDataIm2 , PN_API_IOD_RemaDataIm3 , PN_API_IOD_RemaDataIm4 ,
  PN_API_IOD_RemaDataSnmpSysName , PN_API_IOD_RemaDataSnmpSysCont , PN_API_IOD_RemaDataSnmpSysLoc , PN_API_IOD_RemaDataPrivateData ,
  PN_API_IOD_RemaDataArFsu , PN_API_IOD_RemaDataSubmodCfg , PN_API_IOD_RemaDataVendorParam
}
 Type of remanent data. More...
 
enum  PN_API_IOD_Led_t {
  PN_API_IOD_LedRun = 1 , PN_API_IOD_LedMaint , PN_API_IOD_LedError , PN_API_IOD_LedSync ,
  PN_API_IOD_LedLinkP1 , PN_API_IOD_LedLinkP2 , PN_API_IOD_LedLinkP3 , PN_API_IOD_LedLinkP4 ,
  PN_API_IOD_LedActivP1 , PN_API_IOD_LedActivP2 , PN_API_IOD_LedActivP3 , PN_API_IOD_LedActivP4 ,
  PN_API_IOD_LedFo1 , PN_API_IOD_LedFo2 , PN_API_IOD_LedPower , PN_API_IOD_LedDiag ,
  PN_API_IOD_LedPenergy , PN_API_IOD_LedBlink , PN_API_IOD_LedUser00 , PN_API_IOD_LedUser01 ,
  PN_API_IOD_LedUser02 , PN_API_IOD_LedUser03 , PN_API_IOD_LedUser04 , PN_API_IOD_LedUser05 ,
  PN_API_IOD_LedUser06 , PN_API_IOD_LedUser07 , PN_API_IOD_LedUser08 , PN_API_IOD_LedUser09 ,
  PN_API_IOD_LedUser10 , PN_API_IOD_LedUser11 , PN_API_IOD_LedUser12 , PN_API_IOD_LedUser13 ,
  PN_API_IOD_LedUser14 , PN_API_IOD_LedUser15 , PN_API_IOD_LedMaxLeds
}
 Type for LEDs. More...
 
enum  PN_API_IOD_AddrType_t { PN_API_IOD_AddrLog = 0 , PN_API_IOD_AddrGeo = 1 , PN_API_IOD_AddrHndl = 2 }
 Address type. More...
 
enum  PN_API_IOD_AlarmType_t {
  PN_API_IOD_AlarmProc = 1 , PN_API_IOD_AlarmStatus , PN_API_IOD_AlarmChangeDiag , PN_API_IOD_AlarmExtChangeDiag ,
  PN_API_IOD_AlarmGenerateDiag , PN_API_IOD_AlarmReturnOfSubmod , PN_API_IOD_AlarmUploadRetrieval , PN_API_IOD_AlarmNumOfEntries = 7
}
 Alarm type. More...
 
enum  PN_API_IOD_InputUpdateState_t { PN_API_IOD_ArStartup = 0x0001 , PN_API_IOD_ArInData = 0x0002 }
 Input update state. More...
 
enum  PN_API_IOD_SubmodState_t { PN_API_IOD_StateNoSubmod , PN_API_IOD_StateWrongSubmod , PN_API_IOD_StateSubstitutedSubmod , PN_API_IOD_StateProperSubmod }
 Submodule state (currently not in use). More...
 
enum  PN_API_IOD_SubmodStatus_t { PN_API_IOD_SubmodStatusUnknown = 0 , PN_API_IOD_SubmodStatusStop = 1 , PN_API_IOD_SubmodStatusRun = 2 , PN_API_IOD_SubmodStatusAppReadyFollows = 3 }
 Submodule status. More...
 
enum  PN_API_IOD_RealSubmodStatus_t { PN_API_IOD_RealSubmodStatusStop = 0 , PN_API_IOD_RealSubmodStatusRun = 1 }
 Real Submodule status. More...
 
enum  PN_API_IOD_SubmodProp_t { PN_API_IOD_SubmodPropNoData = 0x00 , PN_API_IOD_SubmodPropIn = 0x01 , PN_API_IOD_SubmodPropOut = 0x02 , PN_API_IOD_SubmodPropIO = 0x03 }
 Submodule data direction. More...
 
enum  PN_API_IOD_ArType_t {
  PN_API_IOD_ArTypeSingle = 0x0001 , PN_API_IOD_ArTypeSupervisor = 0x0006 , PN_API_IOD_ArTypeSingleRtc3 = 0x0010 , PN_API_IOD_ArTypeSingleSysRedundancy = 0x0020 ,
  PN_API_IOD_ArTypeReserved
}
 AR type. More...
 
enum  PN_API_IOD_ArReason_t {
  PN_API_IOD_ArReasonNone = 0 , PN_API_IOD_ArReason1 = 1 , PN_API_IOD_ArReason2 = 2 , PN_API_IOD_ArReasonMem = 3 ,
  PN_API_IOD_ArReasonFrame = 4 , PN_API_IOD_ArReasonMiss = 5 , PN_API_IOD_ArReasonTimer = 6 , PN_API_IOD_ArReasonAlarm = 7 ,
  PN_API_IOD_ArReasonAlarmSend = 8 , PN_API_IOD_ArReasonAlarmAck = 9 , PN_API_IOD_ArReasonAlarmLen = 10 , PN_API_IOD_ArReasonAlarmInd = 11 ,
  PN_API_IOD_ArReasonRpc = 12 , PN_API_IOD_ArReasonAbort = 13 , PN_API_IOD_ArReasonReRun = 14 , PN_API_IOD_ArReasonRelease = 15 ,
  PN_API_IOD_ArReasonDevPassivated = 16 , PN_API_IOD_ArReasonDevRemoved = 17 , PN_API_IOD_ArReasonProtocol = 18 , PN_API_IOD_ArReasonNare = 19 ,
  PN_API_IOD_ArReasonRpcBind = 20 , PN_API_IOD_ArReasonRpcConnect = 21 , PN_API_IOD_ArReasonRpcRead = 22 , PN_API_IOD_ArReasonRpcWrite = 23 ,
  PN_API_IOD_ArReasonRpcControl = 24 , PN_API_IOD_ArReason25 = 25 , PN_API_IOD_ArReason26 = 26 , PN_API_IOD_ArReasonLinkDown = 27 ,
  PN_API_IOD_ArReasonMulticastMac = 28 , PN_API_IOD_ArReasonSync = 29 , PN_API_IOD_ArReasonTopology = 30 , PN_API_IOD_ArReasonDcpStationName = 31 ,
  PN_API_IOD_ArReasonDcpReset = 32 , PN_API_IOD_ArReason33 = 33 , PN_API_IOD_ArReasonIrData = 34 , PN_API_IOD_ArReasonPDev = 35 ,
  PN_API_IOD_ArReasonLinkMod = 36 , PN_API_IOD_ArReasonIpSuite = 37 , PN_API_IOD_ArReasonRdht = 38 , PN_API_IOD_ArReasonPDevParam = 39 ,
  PN_API_IOD_ArReasonAppReady = 40 , PN_API_IOD_ArReasonMax
}
 AR disconnection reason. More...
 
enum  PN_API_IOD_RtfOption_t {
  PN_API_IOD_RtfResetAll = 0x0000 , PN_API_IOD_RtfResetAppParam = 0x0001 , PN_API_IOD_RtfResetCommParam = 0x0002 , PN_API_IOD_RtfResetEngParam = 0x0003 ,
  PN_API_IOD_RtfResetFwUpgradeParam = 0x0004
}
 Reset To Factory option. More...
 
enum  PN_API_IOD_RealPlugState_t { PN_API_IOD_RpsNotPlugged = 0 , PN_API_IOD_RpsPlugged = 1 }
 Submodule real plug status. More...
 
enum  PN_API_IOD_RealSubmodState_t { PN_API_IOD_RssStop = 0 , PN_API_IOD_RssRun = 1 }
 Submodule real status. More...
 
enum  PN_API_IOD_ApduStatusByteMask_t {
  PN_API_IOD_ApduStatusPrimary = 0x0001 , PN_API_IOD_ApduStatusRedundancy = 0x0002 , PN_API_IOD_ApduStatusDataValid = 0x0004 , PN_API_IOD_ApduStatusRun = 0x0010 ,
  PN_API_IOD_ApduStatusStationOk = 0x0020
}
 Application Protocol Data Unit status. More...
 
enum  PN_API_IOD_DiagChannelPropDirection_t { PN_API_IOD_DiagChannelPropDirectionManuSpec = 0 , PN_API_IOD_DiagChannelPropDirectionIn = 0x01 , PN_API_IOD_DiagChannelPropDirectionOut = 0x02 , PN_API_IOD_DiagChannelPropDirectionInOut = 0x03 }
 Defines for channel properties.direction. More...
 
enum  PN_API_IOD_DiagChannelPropType_t {
  PN_API_IOD_DiagChannelPropTypeOthers = 0 , PN_API_IOD_DiagChannelPropType1Bit = 1 , PN_API_IOD_DiagChannelPropType2Bit = 2 , PN_API_IOD_DiagChannelPropType4Bit = 3 ,
  PN_API_IOD_DiagChannelPropTypeByte = 4 , PN_API_IOD_DiagChannelPropTypeWord = 5 , PN_API_IOD_DiagChannelPropTypeDWord = 6 , PN_API_IOD_DiagChannelPropTypeLWord = 7
}
 Defines for channel properties.type. More...
 
enum  PN_API_IOD_DiagChannelPropSpecErr_t { PN_API_IOD_DiagChannelPropSpecErrAppear = 1 , PN_API_IOD_DiagChannelPropSpecErrDisappear = 2 , PN_API_IOD_DiagChannelPropSpecErrDisappearMore = 3 }
 Alarm status. More...
 
enum  PN_API_IOD_IoCrType_t { PN_API_IOD_IoCrTypeIn = 1 , PN_API_IOD_IoCrTypeOut = 2 }
 IO direcition. More...
 
enum  PN_API_IOD_PlugState_t { PN_API_IOD_NotPlugged = 0 , PN_API_IOD_Plugged = 1 }
 Submodule plug state. More...
 
#define PN_API_IOD_MAX_DEV_TYPE_LEN   240
 Maximum device type name length (Must be lower than the maximum station type length allowed by DCP (255).
 
#define PN_API_IOD_IM0_ORDER_ID_LEN   20
 Length of IM0 order ID.
 
#define PN_API_IOD_IM0_SERIAL_NUM_LEN   16
 Length of IM0 serial number.
 
#define PN_API_IOD_SUPPORT_IM1234   0x1e
 IM supported, IM1...4.
 
#define PN_API_IOD_SUPPORT_IM12345   0x3e
 IM supported, IM1...5.
 
#define PN_API_IOD_SNMP_SYS_DESC_LEN   0xff
 Length of system description.
 
#define PN_API_IOD_SNMP_SYSNAME_LEN   255
 According to RFC1213 (do not change).
 
#define PN_API_IOD_SNMP_SYSLOC_LEN   255
 According to RFC1213 (do not change).
 
#define PN_API_IOD_SNMP_SYSCONT_LEN   255
 According to RFC1213 (do not change).
 
#define PN_API_IOD_DEVICE_NAME_LEN   256
 Maximum length of device name.
 
#define PN_API_IOD_ARFSU_LEN   20
 ARFSU length (4B Mode + 16B UUID).
 
#define PN_API_IOD_PDEV_LEN   1024
 PDEV record length.
 
#define PN_API_IOD_IOXS   uint8_t
 IO provider/consumer status.
 
#define PN_API_IOD_IO_PROP_ENUM   uint8_t
 Shouldn't be an ENUM, as bitwise combinations are used.
 
#define PN_API_IOD_IM0_SUPP_ENUM   uint8_t
 Shouldn't be an ENUM, as bitwise combinations are used.