SysEthernetLEDBlink (FUN) ¶ FUNCTION SysEthernetLEDBlink : SysTypes.RTS_IEC_RESULT Triggering the mechanism to blink a LED of an adapter specified by the MAC address for the specified duration. The operating system and hardware must support this feature. The function call doesn’t wait the given duration and returns as fast as possible. However the real-time capability of this call is not guranteed. InOut: Scope Name Type Comment Return SysEthernetLEDBlink SysTypes.RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input macAddress ARRAY [0..5] OF BYTE MAC address of the adapter that should blink. durationInSec UDINT Duration to blink the adapter in seconds
SysEthernetSetAutoNegAdvertisedCap (FUN) ¶ FUNCTION SysEthernetSetAutoNegAdvertisedCap : SysTypes.RTS_IEC_RESULT Set advertised auto-negotiation capabilities for an adapter identified by its MAC address. InOut: Scope Name Type Comment Return SysEthernetSetAutoNegAdvertisedCap SysTypes.RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input macAddress ARRAY [0..5] OF BYTE MAC address of the adapter uliAutoNegAdvertisedCap ULINT Advertised auto-negotiation capabilities of MAU, see AutoNegCaps constants SYSETH_AUTONEGCAP_ …
SysEthernetSetAutoNegMode (FUN) ¶ FUNCTION SysEthernetSetAutoNegMode : SysTypes.RTS_IEC_RESULT Set auto-negotiation mode for an adapter identified by its MAC address. InOut: Scope Name Type Comment Return SysEthernetSetAutoNegMode SysTypes.RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input macAddress ARRAY [0..5] OF BYTE MAC address of the adapter usiAutoNegMode USINT Auto-negotiation mode of MAU, see AutoNegMode constants SYSETH_AUTONEGMODE_ …
SysEthernetSetMauType (FUN) ¶ FUNCTION SysEthernetSetMauType : SysTypes.RTS_IEC_RESULT Set Media Access Unit (MAU) type for an adapter identified by its MAC address. InOut: Scope Name Type Comment Return SysEthernetSetMauType SysTypes.RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input macAddress ARRAY [0..5] OF BYTE MAC address of the adapter udiMauType UDINT Media Access Unit (MAU) type, see MauType constants SYSETH_MAUTYPE_ …
Structs ¶ SysEthernetCapabilities (Struct) SysEthernetFrame (Struct) SysEthernetInterfaceCounters (Struct) SysEthernetMediaCounters (Struct) SysEthernetPortConfigAndStatus (Struct)
SysEthernetCapabilities (STRUCT) ¶ TYPE SysEthernetCapabilities : STRUCT The “Capability Bits” of EIP plus a quality flag for each value and a struct version. Quality Flags used in the runtime interface for reading the Ethernet interface settings. These quality flags are not from the EIP specification, but were added by CODESYS. The idea behind this is to be able to say for each individual value of the respective STRUCT whether it has been filled correctly by the platform implementation. Possible quality flags are: - ERR_OK: Value could be determined without errors - ERR_NOTIMPLEMENTED: Not implemented by this platform implementation - ERR_NOT_SUPPORTED: Not supported by this platform implementation - ERR_FAILED: Error: Value could not be determined InOut: Name Type Initial Comment structVersion DWORD 1 Version number of this struct. This is version 1. To be increased on changes. manualSettingRequiresReset BOOL Indicates whether or not the device requires a reset to apply changes made to the Interface Control attribute (#6). 0 = Indicates that the device automatically applies changes made to the Interface Control attribute (#6) and, therefore, does not require a reset in order for changes to take effect. This is the value this bit shall have when the Interface Control attribute (#6) is not implemented. 1 = Indicates that the device does not automatically apply changes made to the Interface Control attribute (#6) and, therefore, will require a reset in order for changes to take effect. Note: this bit shall also be replicated in the Interface Flags attribute (#2) in order to retain backwards compatibility with previous object revisions. autoNegotiate BOOL 0 = Indicates that the interface does not support link auto-negotiation 1 = Indicates that the interface supports link auto-negotiation autoMdix BOOL 0 = Indicates that the interface does not support auto MDIX operation 1 = Indicates that the interface supports auto MDIX operation manualSpeedDuplex BOOL 0 = Indicates that the interface does not support manual setting of speed/duplex. The Interface Control attribute (#6) shall not be supported. 1 = Indicates that the interface supports manual setting of speed/duplex via the Interface Control attribute (#6) manualSettingRequiresResetQuality SysTypes.RTS_IEC_RESULT autoNegotiateQuality SysTypes.RTS_IEC_RESULT autoMdixQuality SysTypes.RTS_IEC_RESULT manualSpeedDuplexQuality SysTypes.RTS_IEC_RESULT
MvtIdRange_CreateSingle (FUN) ¶ FUNCTION MvtIdRange_CreateSingle InOut: Scope Name Type Inout mvtIds MvtIdRange Input id ULINT
SysEthernetFrame (STRUCT) ¶ TYPE SysEthernetFrame : STRUCT InOut: Name Type udFrameLen UDINT ethData ARRAY [0..1521] OF BYTE
SysEthernetInterfaceCounters (STRUCT) ¶ TYPE SysEthernetInterfaceCounters : STRUCT The “HC Interface Counters” and the “Interface Counters” of EIP plus a quality flag for each value and a struct version. Quality Flags used in the runtime interface for reading the Ethernet interface settings. These quality flags are not from the EIP specification, but were added by CODESYS. The idea behind this is to be able to say for each individual value of the respective STRUCT whether it has been filled correctly by the platform implementation. Possible quality flags are: - ERR_OK: Value could be determined without errors - ERR_NOTIMPLEMENTED: Not implemented by this platform implementation - ERR_NOT_SUPPORTED: Not supported by this platform implementation - ERR_FAILED: Error: Value could not be determined InOut: Name Type Initial Comment structVersion DWORD 1 Version number of this struct. This is version 1. To be increased on changes. ifInNUcastPkts DWORD RFC 2863 InNUcastPackets: The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast or broadcast address at this sub-layer. ifInDiscards DWORD RFC 2863 InDiscards: The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. ifInErrors DWORD RFC 2863 InErrors: For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character- oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. ifInUnknownProtos DWORD RFC 2863 InUnknownProtos: For packet-oriented interfaces, the number of packets received via the interface which were discarded because of an unknown or unsupported protocol. For character-oriented or fixed-length interfaces that support protocol multiplexing the number of transmission units received via the interface which were discarded because of an unknown or unsupported protocol. For any interface that does not support protocol multiplexing, this counter will always be 0. ifOutNUcastPkts DWORD RFC 2863 OutNUcastPkts: The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent. ifOutDiscards DWORD RFC 2863 OutDiscards: The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. ifOutErrors DWORD RFC 2863 OutErrors: For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. hcInOctets LWORD The total number of octets received on the interface. This counter is a 64-bit version of In Octets. hcInUcastPkts LWORD Unicast packets received on the interface. This counter is a 64-bit version of In Ucast Packets. hcInMulticastPkts LWORD Multicast packets received on the interface. hcInBroadcastPkts LWORD Broadcast packets received on the interface. hcOutOctets LWORD Octets sent on the interface. This counter is a 64-bit version of Out Octets. hcOutUcastPkts LWORD Unicast packets sent on the interface. This counter is a 64-bit version of Out Ucast Packets. hcOutMulticastPkts LWORD Multicast packets sent on the interface. hcOutBroadcastPkts LWORD Broadcast packets sent on the interface. ifInNUcastPktsQuality SysTypes.RTS_IEC_RESULT ifInDiscardsQuality SysTypes.RTS_IEC_RESULT ifInErrorsQuality SysTypes.RTS_IEC_RESULT ifInUnknownProtosQuality SysTypes.RTS_IEC_RESULT ifOutNUcastPktsQuality SysTypes.RTS_IEC_RESULT ifOutDiscardsQuality SysTypes.RTS_IEC_RESULT ifOutErrorsQuality SysTypes.RTS_IEC_RESULT hcInOctetsQuality SysTypes.RTS_IEC_RESULT hcInUcastPktsQuality SysTypes.RTS_IEC_RESULT hcInMulticastPktsQuality SysTypes.RTS_IEC_RESULT hcInBroadcastPktsQuality SysTypes.RTS_IEC_RESULT hcOutOctetsQuality SysTypes.RTS_IEC_RESULT hcOutUcastPktsQuality SysTypes.RTS_IEC_RESULT hcOutMulticastPktsQuality SysTypes.RTS_IEC_RESULT hcOutBroadcastPktsQuality SysTypes.RTS_IEC_RESULT
SysEthernetMediaCounters (STRUCT) ¶ TYPE SysEthernetMediaCounters : STRUCT The “HC Media Counters” and the “Media Counters” of EIP plus a quality flag for each value and a struct version. Quality Flags used in the runtime interface for reading the Ethernet interface settings. These quality flags are not from the EIP specification, but were added by CODESYS. The idea behind this is to be able to say for each individual value of the respective STRUCT whether it has been filled correctly by the platform implementation. Possible quality flags are: - ERR_OK: Value could be determined without errors - ERR_NOTIMPLEMENTED: Not implemented by this platform implementation - ERR_NOT_SUPPORTED: Not supported by this platform implementation - ERR_FAILED: Error: Value could not be determined InOut: Name Type Initial Comment structVersion DWORD 1 Version number of this struct. This is version 1. To be increased on changes. dot3StatsSingleCollisionFrames DWORD RFC 3635 Single Collisions: A count of frames that are involved in a single collision, and are subsequently transmitted successfully. A frame that is counted by an instance of this object is also counted by the corresponding instance of either the ifOutUcastPkts, ifOutMulticastPkts, or ifOutBroadcastPkts, and is not counted by the corresponding instance of the dot3StatsMultipleCollisionFrames object. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsMultipleCollisionFrames DWORD RFC 3635 Multiple Collisions: A count of frames that are involved in more than one collision and are subsequently transmitted successfully. A frame that is counted by an instance of this object is also counted by the corresponding instance of either the ifOutUcastPkts, ifOutMulticastPkts, or ifOutBroadcastPkts, and is not counted by the corresponding instance of the dot3StatsSingleCollisionFrames object. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsSQETestErrors DWORD RFC 3635 SQE Test Errors: A count of times that the SQE TEST ERROR is received on a particular interface. The SQE TEST ERROR is set in accordance with the rules for verification of the SQE detection mechanism in the PLS Carrier Sense Function as described in IEEE Std. 802.3, 2000 Edition, section 7.2.4.6. This counter does not increment on interfaces operating at speeds greater than 10 Mb/s, or on interfaces operating in full-duplex mode. dot3StatsDeferredTransmissions DWORD RFC 3635 Deferred Transmissions: A count of frames for which the first transmission attempt on a particular interface is delayed because the medium is busy. The count represented by an instance of this object does not include frames involved in collisions. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsLateCollisions DWORD RFC 3635 Late Collisions: The number of times that a collision is detected on a particular interface later than one slotTime into the transmission of a packet. A (late) collision included in a count represented by an instance of this object is also considered as a (generic) collision for purposes of other collision-related statistics. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsExcessiveCollisions DWORD RFC 3635 Excessive Collisions: A count of frames for which transmission on a particular interface fails due to excessive collisions. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsCarrierSenseErrors DWORD RFC 3635 Carrier Sense Errors: The number of times that the carrier sense condition was lost or never asserted when attempting to transmit a frame on a particular interface. The count represented by an instance of this object is incremented at most once per transmission attempt, even if the carrier sense condition fluctuates during a transmission attempt. This counter does not increment when the interface is operating in full-duplex mode. hcStatsAlignmentErrors LWORD Frames received that are not an integral number of octets in length and do not pass the FCS check. This counter is a 64-bit version of Alignment Errors. hcStatsFCSErrors LWORD Frames received that are an integral number of octets in length but do not pass the FCS check. This counter is a 64-bit version of FCS Errors. hcStatsInternalMacTransmitErrors LWORD Frames for which transmission fails due to an internal MAC sublayer transmit error. This counter is a 64-bit version of MAC Transmit Errors. hcStatsFrameTooLongs LWORD Frames received that exceed the maximum permitted frame size. This counter is a 64-bit version of Frame Too Long Errors. hcStatsInternalMacReceiveErrors LWORD Frames for which reception on an interface fails due to an internal MAC sublayer receive error. This counter is a 64-bit version of MAC Receive Errors. hcStatsSymbolErrors LWORD Number of times there was an invalid data symbol on the media when a valid carrier was present. dot3StatsAlignmentErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsFCSErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsSingleCollisionFramesQuality SysTypes.RTS_IEC_RESULT dot3StatsMultipleCollisionFramesQuality SysTypes.RTS_IEC_RESULT dot3StatsSQETestErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsDeferredTransmissionsQuality SysTypes.RTS_IEC_RESULT dot3StatsLateCollisionsQuality SysTypes.RTS_IEC_RESULT dot3StatsExcessiveCollisionsQuality SysTypes.RTS_IEC_RESULT dot3StatsInternalMacTransmitErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsCarrierSenseErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsFrameTooLongsQuality SysTypes.RTS_IEC_RESULT dot3StatsInternalMacReceiveErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsAlignmentErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsFCSErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsInternalMacTransmitErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsFrameTooLongsQuality SysTypes.RTS_IEC_RESULT hcStatsInternalMacReceiveErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsSymbolErrorsQuality SysTypes.RTS_IEC_RESULT