Table of Contents

IEthercatMaster

Namespace
ZCore
Extends
Inherited Properties
Inherited Methods
INTERFACE IEthercatMaster EXTENDS ZCore.IObject, ZCore.IBootable, ZCore.IError

This interfaces holds the general methods that the Zeugwerk Framework expects from an ethercat master. Implementations may be provided in a platform dependent library, i.e. (The beckhoff platform-library).

By extending from the IObject this interface may be used in Await() methods of sequences.

Methods

EthercatStateFlags 

METHOD EthercatStateFlags () : EthercatMasterStateFlags

Returns

EthercatMasterStateFlags

MasterStatistic 

METHOD MasterStatistic (
 [inout] statistic : EthercatMasterStatistic)

This method returns some statistical data about the ethercat master device that is linked to this object. The information is polled automatically when the object is in its Idle state with the period that can be set with SetSynchronizationPeriod.

InOuts

statistic EthercatMasterStatistic

Name 

METHOD FINAL Name () : ZString

This method returns the name of the ethercat master that has been set with SetName. This is somehow usefull if there are more than one ethercat master instances present.

Returns

ZString

RequestStateAsync 

METHOD RequestStateAsync (
 [input] startToken : IStartToken,
 [input] state : EthercatMasterState)

Use this method to switch the ethercat master device into any possible state. If the object is busy while the method is called, the startToken that is passed will inform about this and the actual request will not be performed.

Inputs

startToken IStartToken
state EthercatMasterState
METHOD SetLink (
 [input] linkPtr : ZPointer)

Set the platform specific data pointer to ethercat slave communication. This method is highly platform dependent, refer to ZPlatform.EthercatMasterImpl.

Inputs

linkPtr ZPointer

SlaveCount 

METHOD SlaveCount () : INT

This method returns the count of slaves that have been configured on the ethercat master device that is linked to this object. The value that is returned here can be used together with SlaveDescription to externally poll informations about ethercat slave devices that are connected to the busmaster.

The information is polled automatically when the object is in its Idle state with the period that can be set with SetSynchronizationPeriod.

Returns

INT

SlaveDescription 

METHOD SlaveDescription (
 [input] slaveNo : INT,
 [inout] slaveDescription : EthercatSlaveDesc)

This method returns information about slaves that have been configured to the ethercat master device that is linked to this object. The method should be used together with SlaveCount to externally poll informations about ethercat slave devices that are connected to the busmaster.

The information is polled automatically when the object is in its Idle state with the period that can be set with SetSynchronizationPeriod.

Inputs

slaveNo INT

InOuts

slaveDescription EthercatSlaveDesc