Optional
aliasThe EtherCAT alias number of the device.
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.
Optional
deviceThe product ID of the device.
Example: 8506
Optional
fwidThe firmware ID for the device, used to identify and resolve the corresponding firmware package.
Optional
hardwareParsed .hardware_description
file containing hardware details.
A unique identifier for the device. The device serial number is a strong candidate for this identifier.
Optional
imageIdentifier for the image file associated with the device. Retrieved from the assembly or device entries in the hardware description file.
Optional
integroParsed .variant
file containing variant-specific information.
Optional
positionDevice 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
productThe product ID of the device or assembly.
Example: 6000
Optional
serialThe serial number of the device as read from the hardware description file.
Optional
stackParsed .stack_info.json
file containing stack-related metadata.
Optional
typeThe type of the device, which can be one of the following:
0
: UNSPECIFIED1
: SOMANET_CIA401_ETHERCAT2
: SOMANET_CIA402_ETHERCATOptional
uiUser interface configuration for device-specific features.
Optional
versionedThis is a combination of the product ID and revision for a device.
Example: 8506-01
Optional
versionedThis is a combination of the product ID and revision for a device or assembly.
Example: 6000-01
Generated using TypeDoc
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.