rotor.cpp

///
/// @file       rotor.cpp
/// @copyright  Christian Obersteiner, Andreas Müller - CC-BY-SA 4.0
///
/// @brief  Contains all kind of rotor functions
///

#include "rotor.h"

///
/// @brief  Constructor
///

CRotor::CRotor()
{
    initRotor();
}

///
/// @brief  Initialize all ADC Values and set Arduino Pins to a defined value.
///

void CRotor::initRotor()
{
    if(AZIM)
    {
        //Pin Settings
        pinMode(AZIM_RE_CW, OUTPUT);
        pinMode(AZIM_RE_CCW, OUTPUT);
        pinMode(AZIM_RE_BREAK, OUTPUT);
        //All Relais Off
        digitalWrite(AZIM_RE_CW, HIGH); 
        digitalWrite(AZIM_RE_CCW, HIGH); 
        digitalWrite(AZIM_RE_BREAK, HIGH);
        //Initial Values
        m_bAzimuthBreakReleased = 0;
    }
    if(ELEV)
    {
        //Pin Settings
        pinMode(ELEV_RE_UP, OUTPUT);
        pinMode(ELEV_RE_DWN, OUTPUT);
        pinMode(ELEV_RE_BREAK, OUTPUT);
        //All Relais Off
        digitalWrite(ELEV_RE_UP, HIGH);
        digitalWrite(ELEV_RE_DWN, HIGH);
        digitalWrite(ELEV_RE_BREAK, HIGH);
        //Initial Values
        m_bElevationBreakReleased = 0;
    }
}

///
/// @brief  Does all the rotor movement stuff
///

void CRotor::doRotor()
{
    //Do all the Rotor Stuff here
    readRotSensors();
    if(AZIM)
    {
        //Do all the Azimuth Stuff here
    }
    if(ELEV)
    {
        //Do all the Elevation Stuff here
    }

}

///
/// @brief  Serial Debug output Function
///

void CRotor::debugOut()
{
    //debug Out
    readRotSensors();
    Serial.println("-----------------");
    Serial.write("Azim Value: ");
    Serial.write(m_uActualAzimuth);
    Serial.println("");
    Serial.write("Elev Value: ");
    Serial.write(m_uActualElevation);
    Serial.println("");
}

///
/// @brief Returns the actual Azimuth value in degree
///
/// @return uint16 actual Azimuth value in degree
///

uint16 CRotor::getActualAzimuth() const
{
    return m_uActualAzimuth;
}

///
/// @brief Returns the actual Elevation value in degree
///
/// @return actual Elevation value in degree
///

uint16 CRotor::getActualElevation() const
{
    return m_uActualElevation;
}

///
/// @brief Sets the actual Azimuth value in degree and checks valid range
///
/// @param pAzimuth Azimuth value to be set
///
/// @return Error Code
///

CRotor::rotorError CRotor::setAzimuth(uint16 pAzimuth)
{
    if(pAzimuth >= AZIM_MIN && pAzimuth <= AZIM_MAX)
    {
        m_uSetAzimuth = pAzimuth;
        return CRotor::ROT_OK;
    }
    else
    {
        return CRotor::ROT_VAL_OUT_OF_RANGE;
    }
}

///
/// @brief Sets the actual Elevation value in degree and checks valid range
///
/// @param pElevation Elevation value to be set
///
/// @return Error Code
///

CRotor::rotorError CRotor::setElevation(uint16 pElevation)
{
    if(pElevation >= ELEV_MIN && pElevation <= ELEV_MAX)
    {
        m_uSetElevation = pElevation;
        return CRotor::ROT_OK;
    }
    else
    {
        return CRotor::ROT_VAL_OUT_OF_RANGE;
    }
}

///
/// @brief Reads out the Sensor values and stores them
///
/// @return Error Code
///

CRotor::rotorError CRotor::readRotSensors()
{
    m_uActualAzimuth = (uint16)(readADC(AZIM_POT)/AZIM_DEG);
    m_uActualElevation = (uint16)(readADC(ELEV_POT)/ELEV_DEG);
    
    return CRotor::ROT_OK;
}

///
/// @brief Reads out an ADC Pin 4 times and returns the average
///
/// @param AdcPin ADC Pin to read
///
/// @return average ADC value
///

uint16 CRotor::readADC(int AdcPin)
{
    //Read ADC 4 times and calculate average
    uint16 adcValue = 0;
    for(int i = 0; i < 4; i++)
        adcValue += analogRead(AdcPin);
    adcValue = adcValue/4;
}