I want to find...

Search

Shares

Table of Content

EthercatDevice_DmpStepper.configMachineHomingPriority()

[EthercatDevice_DmpStepper_Generic]

Description

Configure the homing priority of the specified machine axis on the EtherCAT slave device in G-code Controller mode. This parameter is written to the EEPROM of the EtherCAT slave device and loaded during startup, so users do not need to configure this parameter each time before running the program.

Derived Class:

Class NameVendor IDProduct Code
EthercatDevice_QECR11MP3S0x00000bc30x0086d0d6
EthercatDevice_QECR00MP3S0x00000bc30x0086d0d9

Syntax

int configMachineHomingPriority(int machine_axis, uint8_t priority);

Parameters

  • [in] int machine_axis
    The specified machine axis number on the EtherCAT slave device:
DefinitionValueDescription
ECAT_MACHINE_X_AXIS0X-axis, which mapping is determined by the configMachineAxisMapping().
ECAT_MACHINE_Y_AXIS1Y-axis, which mapping is determined by the configMachineAxisMapping().
ECAT_MACHINE_Z_AXIS2Z-axis, which mapping is determined by the configMachineAxisMapping().
  • [in] uint8_t priority
    The homing priority to be configured. The value range is 0 to 255, and the lower the value, the higher the priority. If the values are equal, the priority order is not guaranteed.

Return Value

Return an error code. If the returned value is zero, it indicates a successful execution of this function.

Comment

This function must be called after a successful execution of EthercatMaster::begin(). This function is blocking and cannot be called within the Cyclic Callback.

Example

#include "Ethercat.h"

EthercatMaster master;
EthercatDevice_QECR11MP3S slave;

void setup() {
  master.begin();
  slave.attach(0, master);

  slave.configMachineHomingPriority(ECAT_MACHINE_X_AXIS, 1);
  slave.configMachineHomingPriority(ECAT_MACHINE_Y_AXIS, 2);
  slave.configMachineHomingPriority(ECAT_MACHINE_Z_AXIS, 3);
  // ...
}

void loop() {
  // ...
}

Please see EthercatDevice_DmpStepper_Generic Class for more QEC Stepper Drivers instructions and API usage.

Leave a Comment

Scroll to Top