Interface Device

Represents a single device with extended properties beyond those provided by the Motion Master API. Certain properties, such as the ID (serial number), hardware description, and integro variant, require additional file requests from Motion Master.

Hierarchy

  • Device

Properties

alias?: number

The EtherCAT alias number of the device.

deviceAddress: number

The unique address assigned to the device in the network. This number is included in messages to Motion Master to reference the device. Since the device address changes with each power cycle, the client library uses DeviceRef for consistent device referencing.

deviceProductId?: string

The product ID of the device. Example: 8506

fwid?: string

The firmware ID for the device, used to identify and resolve the corresponding firmware package.

hardwareDescription?: HardwareDescription

Parsed .hardware_description file containing hardware details.

id: string

A unique identifier for the device. The device serial number is a strong candidate for this identifier.

imageId?: string

Identifier for the image file associated with the device. Retrieved from the assembly or device entries in the hardware description file.

integroVariant?: IntegroVariant

Parsed .variant file containing variant-specific information.

position?: number

Device position in the network stack. Note: In SOEM, the position starts at 1, as 0 is reserved for broadcasting. In the IgH EtherCAT Master, the position starts at 0.

productId?: string

The product ID of the device or assembly. Example: 6000

serialNumber?: string

The serial number of the device as read from the hardware description file.

stackInfo?: StackInfo

Parsed .stack_info.json file containing stack-related metadata.

type?: number

The type of the device, which can be one of the following:

  • 0: UNSPECIFIED
  • 1: SOMANET_CIA401_ETHERCAT
  • 2: SOMANET_CIA402_ETHERCAT
uiFeaturesConfig?: UIFeaturesConfig

User interface configuration for device-specific features.

versionedDeviceProductId?: string

This is a combination of the product ID and revision for a device. Example: 8506-01

versionedProductId?: string

This is a combination of the product ID and revision for a device or assembly. Example: 6000-01

Generated using TypeDoc