Interface Device

Represents a single device with extended metadata beyond what the Motion Master API provides.

Some properties—such as the serial number, hardware description, and variant—must be retrieved through additional file requests from Motion Master.

Hierarchy

  • Device

Properties

alias? deviceAddress deviceProductId? fwid? hardwareDescription? id imageId? integroVariant? position? productId? serialNumber? stackInfo? type? uiFeaturesConfig? versionedDeviceProductId? versionedProductId?

Properties

Optional alias

alias?: number

The EtherCAT alias of the device, if configured.

deviceAddress

deviceAddress: number

The device address assigned by the EtherCAT master.

Used when sending commands to Motion Master. Since the address changes after each power cycle, the client library uses DeviceRef as a stable reference.

Optional deviceProductId

deviceProductId?: string

The product ID of the device. Example: 8506

Optional fwid

fwid?: string

Firmware ID used to identify and resolve the firmware package for the device.

Optional hardwareDescription

hardwareDescription?: HardwareDescription

Parsed .hardware_description file containing hardware details.

id

id: string

Unique identifier of the device, typically its serial number.

Optional imageId

imageId?: string

Identifier of the image associated with this device. Retrieved from the assembly or device entries of the hardware description file.

Optional integroVariant

integroVariant?: IntegroVariant

Parsed .variant file describing variant-specific information.

Optional position

position?: number

Device position in the EtherCAT topology.

  • SOEM: positions start at 1 (0 is broadcast)
  • IgH EtherCAT Master: positions start at 0

Optional productId

productId?: string

Product ID of the device or its assembly. Example: 6000

Optional serialNumber

serialNumber?: string

Serial number read from the hardware description file.

Optional stackInfo

stackInfo?: StackInfo

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

Optional type

type?: number

Device type:

  • 0: UNSPECIFIED
  • 1: SOMANET_CIA401_ETHERCAT
  • 2: SOMANET_CIA402_ETHERCAT

Optional uiFeaturesConfig

uiFeaturesConfig?: UIFeaturesConfig

UI configuration for device-specific features.

Optional versionedDeviceProductId

versionedDeviceProductId?: string

Product ID and revision combined. Example: 8506-01

Optional versionedProductId

versionedProductId?: string

Product or assembly ID and revision combined. Example: 6000-01

Settings

Member Visibility

Theme

Generated using TypeDoc