Get-RTimeLatency
SYNOPSIS
Get the latency of TwinCAT Realtime Cores of the specified TwinCAT target system.
SYNTAX
NetIdPort (Default)
Get-RTimeLatency [-NetId <AmsNetId>] [-Core <Int32>] [-ScanTimeout <Int32>] [-Timeout <Int32>] [-Count <Int32>]
[-Delay <Int32>] [-NoReset] [-ProgressAction <ActionPreference>] [<CommonParameters>]
AddressStr
Get-RTimeLatency [-Address] <String> [-Core <Int32>] [-ScanTimeout <Int32>] [-Timeout <Int32>] [-Count <Int32>]
[-Delay <Int32>] [-NoReset] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Session
Get-RTimeLatency -Session <ISession> [-Core <Int32>] [-ScanTimeout <Int32>] [-Timeout <Int32>] [-Count <Int32>]
[-Delay <Int32>] [-NoReset] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
This commands lists the Realtime Cores of specified TwinCAT target systems.
The values can be repeated by count parameter and a repeat delay can be set.
EXAMPLES
EXAMPLE 1
PS> Get-RTimeLatency
NetId CoreId Latency MaxLatency Limit
(us) (us)
---------------- ------ ---------- ---------- -----
5.91.172.198.1.1 1 0 20 0
Getting the Realtime latency of all Realtime cores on the local system.
EXAMPLE 2
PS> Get-RTimeLatency -NetId 5.91.172.198.1.1 -core 1 -count 5 -Delay 0
NetId CoreId Latency MaxLatency Limit
(us) (us)
---------------- ------ ---------- ---------- -----
5.91.172.198.1.1 1 0 20 0
5.91.172.198.1.1 1 0 20 0
5.91.172.198.1.1 1 0 20 0
5.91.172.198.1.1 1 0 20 0
5.91.172.198.1.1 1 0 20 0
Get the Realtime Latency of the System witt NetId 5.91.172.198.1.1 and CoreId 1 5 times without delay between values.
PARAMETERS
-NetId
The AmsNetId of the target system.
The Default is the local system (if left out).
Type: AmsNetId
Parameter Sets: NetIdPort
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Address
The address(es) where to get the Realtime latency.
This can be the RouteName, NetId, the HostName or the IPAddress.
Multiple Addresses and Wildcards are permitted.
Type: String
Parameter Sets: AddressStr
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Session
The Session to use for the Cmdlet, must be connected to port 300, R0_IO
Type: ISession
Parameter Sets: Session
Aliases: InputObject
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Core
Specifies the CoreID of the Realtime Core.
If not specified, this Cmdlet returns all Realtime Cores.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-ScanTimeout
Scannning timeout in milliseconds (Default 5000 ms) This is the timeout for each single ADS roundtrip used by this Cmdlet.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Timeout
The communication ADS timeout in milliseconds.
A value of 0 disables the timeout.
A value \<= 0 sets the Default (5000 ms).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-Count
Specifies the number request repeatations (Default is 1).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False
-Delay
Delay in Milliseconds between requests (Default is 1000ms)
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: False
-NoReset
By default, the Maximum Latency of the data is reset in each polling cycle.
Switching to -NoReset remains the maximum Latency between calls.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.