rc.h

////////////////////////////////////////////////////////////////////////////////
/// @file
/// @brief Radio Control (RC) module.
////////////////////////////////////////////////////////////////////////////////

#ifndef RC_H_
#define RC_H_

// *****************************************************************************
// ************************** System Include Files *****************************
// *****************************************************************************

// *****************************************************************************
// ************************** User Include Files *******************************
// *****************************************************************************

#include <xc.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

// *****************************************************************************
// ************************** Macros *******************************************
// *****************************************************************************

// *****************************************************************************
// ************************** Defines ******************************************
// *****************************************************************************

// *****************************************************************************
// ************************** Declarations *************************************
// *****************************************************************************

// *****************************************************************************
// ************************** Function Prototypes ******************************
// *****************************************************************************

////////////////////////////////////////////////////////////////////////////////
/// @brief  Perform the RC continuous task.
///
/// This function calls module sub-functions to perform decoding of S.Bus
/// data into channel specific values, and periodic transmission of RC data
/// over Ethernet.
////////////////////////////////////////////////////////////////////////////////
void RCTask( void );

////////////////////////////////////////////////////////////////////////////////
/// @brief  Get value of RC control.
///
/// @return Value of RC control variable. (true=RC,false=Normal)
///
/// This function returns the value of RC control being commanded.
////////////////////////////////////////////////////////////////////////////////
bool RCCtrlGet( void );

////////////////////////////////////////////////////////////////////////////////
/// @brief  Get commanded servo values.
///
/// @param  servo_val
///             Buffer to store the commanded servo values.
///
/// This function copies the commanded servo values from module data into
/// supplied buffer \p servo_val.
////////////////////////////////////////////////////////////////////////////////
void RCServoGet( uint16_t servo_val[ 10 ] );

#endif // RC_H_