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? deviceAddress hardwareDescription? id integroVariant? position? stackInfo? type?

Properties

Optional alias

alias?: number

EtherCAT alias number;

deviceAddress

deviceAddress: number

A unique number assigned to each device. 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.

Optional hardwareDescription

hardwareDescription?: HardwareDescription

Parsed .hardware_description file. HardwareDescription

id

id: string

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

Optional integroVariant

integroVariant?: IntegroVariant

Parsed .variant file. IntegroVariant

Optional position

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.

Optional stackInfo

stackInfo?: StackInfo

Parsed .stack_info.json file. HardwareDescription

Optional type

type?: number

The type can be one of the following:

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

Settings

Member Visibility

Theme

Generated using TypeDoc