Get Flexible Encoder Source Info

Recovers the specified information from the named absolute or companion source.

Block ID

Get Source Info

Library

motohawk_flexenc_lib

Description

Overview

Recovers the specified information from the named absolute or companion source. A drop down menu is used to specify what information is to be read. Multiple instances of the block can be used within a model, each of which can select the same or different data.

Is Created

Allows the application to query whether the named source was created.

The most common cause behind a source not creating occurs because the calibration has specified that the source not create. The Absolute Create Source attribute or the Companion Create Source attribute control this configuration depending upon whether the source is an absolute or companion source.

Another reason for a source to fail to create occurs if the absolute source references a halfcycle or sync companion that has not been created.

Number of revolutions per cycle

Returns the Number of Revs Per Cycle configuration for the named source. This value represents the value in use by the source, even if the calibrated value of this attribute has been altered.

Number of teeth in pattern

The physical number of teeth of the pattern in use by the named source. Thus this attribute does not consider something like missing teeth.

This Source ID

This value identifies the named source. This attribute could be used to determine at runtime whether a particular Encoder System setup was in use. For example, a system using flexible connectivity could use this attribute and the Connected Sync Companion ID to determine whether a particular source had been selected as the Sync Companion.

Source ID is calculated using the a source's order attribute. The Source ID will match the value used for the order attribute if a zero based ordering is used. For example the Source ID of each source would match the order if the sources were ordered 0, 1, 2 etc.

Connected Halfcycle Companion ID

This attribute returns the source ID of the halfcycle companion connected to the named source. A value of -1 is returned if the connected source has not been created. A value of -2 is returned if a halfcycle companion has not been connected. Connection can be controlled via flexible connectivity or via the Use Halfcycle Companion attribute of the named source.

Connected Sync Companion ID

This attribute returns the source ID of the Sync companion connected to the named source. A value of -1 is returned if the connected source has not been created. A value of -2 is returned if a sync companion has not been connected. Connection can be controlled via flexible connectivity or via the Use Sync Companion attribute of the named source.

Number of RPM Samples

The number of RPM Samples in use by the encoder system. This attribute can be used to provide the active dimensions of the vector output from the Get RPM Samples block.

Default Key Tolerance

This attribute returns the current value of the Key Tolerance being used by the encoder pattern in use by the referenced source. The high and low tolerance are returned when this attribute is requested, irrespective of whether the pattern is using a symmetrical or asymmetrical key definition. The values are fixed point integers where 16 represents a tolerance of 1.0.

If the pattern is using asymmetrical keys then the values map to the <DefaultKeyToleranceHigh> and <DefaultKeyToleranceLow> values of the XML pattern definition or the high key tolerance and low key tolerance attributes of a runtime pattern definition. If symmetrical keys are in use then the high and low value will return the same value, which is the equivalent of the <DefaultKeyTolerance> attribute of an XML pattern definition or the key tolerance attribute of a runtime pattern definition.

The returned values represent the values currently in use, which may differ from the calibrated values since these values are typically only applied on key on.

Ignore Halfcycle Companion

Reports whether the referenced absolute source is currently ignoring its halfcycle companion's state reporting.

See here for more detail.

Block Parameters

Parameter Field Values Comments/Description
Reference Source Name Alpha-numeric text, quote enclosed The name of the absolute or companion source that is to be queried.
Data Dropdown Data selected from:
Is Created
Number of revolutions per cycle
Number of teeth in pattern
This Source ID
Connected Halfcycle Companion ID
Connected Sync Companion ID
Number of RPM Samples
Default Key Tolerance
Ignore Halfcycle Companion