Get-EcMaster

SYNOPSIS

Gets actually loaded EtherCAT Master devices on the target system.

SYNTAX

NetIdPortList (Default)

Get-EcMaster [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

NetIdPort

Get-EcMaster [-NetId <AmsNetId>] [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

AddressStr

Get-EcMaster [-Address] <String> [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Session

Get-EcMaster -Session <ISession> [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

This command lists the loaded EtherCAT master devices on the specified target system.

The devices must be already loaded and being active on the EtherCAT Network.

EXAMPLES

EXAMPLE 1

PS> Get-EcMaster -NetId 5.91.172.198.1.1

 ID   Name                 Type                 DeviceNetId      Port   Slaves     Slaves     State PortCrcError
                                                                        (Online)   (Config)
 --   ----                 ----                 -----------      ----   ---------- ---------- ----- ------------
 1    Device 1 (EtherCAT)  P06b80001 R00000000  5.91.172.198.2.1 65535  9          9          Op    A:0,B:0,C:0,D:0
 
 PS> Get-EcBoxes -InputObject $m

Pos Name                 Type                 Port  State CrcError         FW   HW   Production
--- ----                 ----                 ----  ----- --------         --   --   ----------
2   Term 2 (EL1808)      EL1808-0000-0018     1001  Op    A:0,B:0          7    0    2021-5-29
3   Term 3 (EL2088)      EL2088-0000-0018     1002  Op    A:0,B:0          9    0    2021-6-04
4   Term 4 (EL2624)      EL2624-0000-0018     1003  Op    A:0,B:0          12   1    2021-5-25
5   Term 5 (EL3064)      EL3064-0000-0020     1004  Op    A:0,B:0          15   9    2021-6-01
6   Term 6 (EL4004)      EL4004-0000-0020     1005  Op    A:0,B:0          19   4    2021-5-31
7   Term 7 (EL6021)      EL6021-0000-0021     1006  Op    A:0,B:0          13   9    2021-6-01
8   Term 8 (EL9110)      EL9110-0000-0018     1007  Op    A:0,B:0          14   0    2021-5-17
9   Term 9 (EL1004)      EL1004-0000-0016     1008  Op    A:0,B:0          0    0    2000-1-02
10  Term 10 (EL2008)     EL2008-0000-0016     1009  Op    A:0,B:0          0    0    2000-1-02

Getting EtherCAT master and connected boxes from target system.

PARAMETERS

-NetId

Gets or sets the NetId of the target system.

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) of the target system(s) where to get the EtherCAT Master devices.

This can be the RouteName, NetId, the HostName or the IPAddress.

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

-Id

Specifies the DeviceId to scan by the Cmdlet.

If not specified, all Devices will be scanned.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: -1
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

-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.

INPUTS

TwinCAT.ISession

The Session to use for the Cmdlet, must be connected to port 300, R0_IO

OUTPUTS

NOTES