EtherCAT Arduino Shield by Esmacat and Motor Shield Tutorial

/** @file
 *  @brief This file contains the template for the main program for the Esmacat slave
 *  project */
/*****************************************************************************************
 * INCLUDES
 ****************************************************************************************/
#include <iostream>
#include "my_app.h"

/*****************************************************************************************
 * FUNCTIONS
 ****************************************************************************************/
/**
 * @brief Initializes the execution of the Ethercat communication and
 *        primary real-time loop for your application for the desired
 *        slave
 * @return
 */

int main()
{
    //this is defined in my_app.cpp and my_app.h
    my_app app;

    // if you already know the ethernet adapter name for EtherCAT, uncomment and use the line below
    //    app.set_ethercat_adapter_name(" WRITE YOUR ETHERNET ADAPTER NAME");

    // If the name is not known, select through the terminal an ethernet adapter (the slave)
    // you'd like to communicate with over EtherCAT
    app.set_ethercat_adapter_name_through_terminal();

    // start the esmacat application customized for your slave
    app.start();

    //the application runs as long as the esmacat master and slave are in communication
    while (app.is_esmacat_master_closed() == FALSE );
    return 0;
}

/** @file
 * @brief This file contains the definition of the functions associated with the user-defined
 * application for the Esmacat slave project */
 /*****************************************************************************************
 * INCLUDES
 ****************************************************************************************/
#include "my_app.h"

/*****************************************************************************************
 * FUNCTIONS
 ****************************************************************************************/
/**
 * @brief Identifies the actual Esmacat slave sequence in the EtherCAT communication chain.
 */
void my_app::assign_slave_sequence(){
    assign_esmacat_slave_index(&ease_motor_shield, 0);   //<-- The Motor Shield is connected in number 0
}

/**
 * @brief Configure your Esmacat slave.
 * Link Esmacat slave object with the actual Esmacat slave in the EtherCAT communication chain.
 * Functions beginning with 'configure_slave' must only be executed in this function
 */
void my_app::configure_slaves(){
    // add initialization code here
    // Functions starting with "configure_slave" work only in configure_slaves() function
}

/** @brief Initialization that needs to happen on the first iteration of the loop
 */
void my_app::init()
{
    // Motor Shield Initialization
    ease_motor_shield.set_output_variable_0_OUT_GEN_INT0(0);
    ease_motor_shield.set_output_variable_1_OUT_GEN_INT1(0);
    ease_motor_shield.set_output_variable_2_OUT_GEN_INT2(0);
    ease_motor_shield.set_output_variable_3_OUT_GEN_INT3(0);

    // Variable Initialization
    servo_position = 0;
    dc_pwm = 60;
    stepper_speed = 0;
    motor_select = -1;    

    cout << "Motor Party Program" << endl;
    counter = 0;
}

/*
   EASE Motor Shield Register Mapping
   |--------------------------------------------------|
   |   Register Number   |           Mapping          |
   |--------------------------------------------------|
   |         0           |         Motor Select       |
   |         1           |         Servo Angle        |
   |         2           |       DC Motor Speed       |
   |         3           |     Stepper motor Speed    |
   |--------------------------------------------------|
/*

/**
 * @brief Executes functions at the defined loop rate
 */
void my_app::loop(){

    // add functions below that are to be executed at the loop rate
    ease_motor_shield.set_output_variable_0_OUT_GEN_INT0(motor_select);

    if (counter == 0)
    {
        motor_select = (motor_select + 1) % 3;
        if (motor_select == 0)
        {
            cout << "Controlling Servo Motor now" << endl;
            dc_pwm = 60;
            stepper_speed = 0;
        }
        else if (motor_select == 1)
        {
            cout << "Controlling DC Motor now" << endl;
            servo_position = 0;
            stepper_speed = 0;
        }
        else if (motor_select == 2)
        {
            cout << "Controlling Stepper Motor now" << endl;
            servo_position = 0;
            dc_pwm = 60;
        }
    }

    if (motor_select == 0)
    {
        cout << "Servo at " << servo_position << "degrees \n";
        if (counter > 90)
        {
            servo_position -= 1;
            ease_motor_shield.set_output_variable_1_OUT_GEN_INT1(servo_position % 180);
        }
        else if (counter < 90)
        {
            servo_position += 1;
            ease_motor_shield.set_output_variable_1_OUT_GEN_INT1(servo_position % 180);
        }
    }
    
    if (motor_select == 1)
    {
        cout << "DC Motor pwm value at " << dc_pwm << endl;
        if (counter > 90)
        {
            dc_pwm -= 1;
            ease_motor_shield.set_output_variable_2_OUT_GEN_INT2(dc_pwm % 255);
        }
        else if (counter < 90)
        {
            dc_pwm += 1;
            ease_motor_shield.set_output_variable_2_OUT_GEN_INT2(dc_pwm % 255);
        }
    }

    if (motor_select == 2)
    {
        cout << "Stepper motor running at " << stepper_speed << "rpm \n";
        if (counter > 90)
        {
            stepper_speed -= 1;
            ease_motor_shield.set_output_variable_3_OUT_GEN_INT3(stepper_speed % 255);
        }
        else if (counter < 90)
        {
            stepper_speed += 1;
            ease_motor_shield.set_output_variable_3_OUT_GEN_INT3(stepper_speed % 255);
        }
    }
    counter = (counter + 1 ) % 180;
}

/** @file
 * @brief This file contains the declaration of the class associated with the user-defined
 * application for the Esmacat slave project */

#ifndef MY_APP_H
#define MY_APP_H

/*****************************************************************************************
 * INCLUDES
 ****************************************************************************************/
#include <iostream>
#include "application.h"
//Include the header file for the Esmacat slave you plan to use for e.g. Analog Input slave
#include "ethercat_arduino_shield_by_esmacat.h"
using namespace std;


/*****************************************************************************************
 * CLASSES
 ****************************************************************************************/
/**
 * @brief Description of your custom application class
 *
 * Your custom application class my_app inherits the class 'esmacat_application'
 * Write functions to override the parent functions of 'esmacat_application'
 * Declare an object of your slave class (e.g. ecat_ai)
 * Declare any other variables you might want to add
 * Define the constructor for initialization
 */
class my_app : public esmacat_application
{
private:
    void assign_slave_sequence(); /** identify sequence of slaves and their types*/
    void configure_slaves(); /** setup the slave*/
    void init(); /** code to be executed in the first iteration of the loop */
    void loop(); /** control loop*/

    esmacat_ethercat_arduino_shield_by_esmacat ease_motor_shield;   /**< create your Esmacat slave object */
    uint32_t servo_position;
    uint32_t dc_pwm;
    uint32_t stepper_speed;
    uint32_t motor_select;
    uint32_t counter;

public:
    /** A constructor- sets initial values for class members */
    my_app()
    {

    }
};

#endif // MY_APP_H

file(GLOB MY_PROJECT_HEADERS *.h)
file(GLOB MY_PROJECT_SOURCES *.cpp *.c)

add_executable(ease_master_motor_control ${MY_PROJECT_SOURCES} ${MY_PROJECT_HEADERS})
target_link_libraries(ease_master_motor_control ethercat_driver esmacat)
install(TARGETS ease_master_motor_control DESTINATION ./bin)