APM:Libraries
Public Member Functions | List of all members
AP_HAL::RCInput Class Referenceabstract

#include <RCInput.h>

Inheritance diagram for AP_HAL::RCInput:
[legend]

Public Member Functions

virtual void init ()=0
 
virtual void teardown ()
 
virtual bool new_input (void)=0
 
virtual uint8_t num_channels ()=0
 
virtual uint16_t read (uint8_t ch)=0
 
virtual uint8_t read (uint16_t *periods, uint8_t len)=0
 
virtual int16_t get_rssi (void)
 
virtual bool set_override (uint8_t channel, int16_t override)=0
 
virtual void clear_overrides ()=0
 
virtual bool rc_bind (int dsmMode)
 

Detailed Description

Definition at line 8 of file RCInput.h.

Member Function Documentation

◆ clear_overrides()

virtual void AP_HAL::RCInput::clear_overrides ( )
pure virtual

Implemented in ChibiOS::RCInput, F4Light::RCInput, Linux::RCInput, PX4::PX4RCInput, VRBRAIN::VRBRAINRCInput, HALSITL::RCInput, and Empty::RCInput.

Referenced by RC_Channels::clear_overrides(), and get_rssi().

Here is the caller graph for this function:

◆ get_rssi()

virtual int16_t AP_HAL::RCInput::get_rssi ( void  )
inlinevirtual

Reimplemented in ChibiOS::RCInput, Linux::RCInput, PX4::PX4RCInput, and VRBRAIN::VRBRAINRCInput.

Definition at line 36 of file RCInput.h.

Referenced by RC_Channels::get_receiver_rssi().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ init()

virtual void AP_HAL::RCInput::init ( )
pure virtual

Call init from the platform hal instance init, so that both the type of the RCInput implementation and init argument (e.g. ISRRegistry) are known to the programmer. (It's too difficult to describe this dependency in the C++ type system.)

Implemented in Linux::RCInput_RPI, ChibiOS::RCInput, F4Light::RCInput, Linux::RCInput_AioPRU, Linux::RCInput_SoloLink, Linux::RCInput_115200, Linux::RCInput_Multi, Linux::RCInput_SBUS, Linux::RCInput, Linux::RCInput_UART, Linux::RCInput_PRU, PX4::PX4RCInput, Linux::RCInput_UDP, VRBRAIN::VRBRAINRCInput, Linux::RCInput_ZYNQ, HALSITL::RCInput, Linux::RCInput_Navio2, and Empty::RCInput.

Referenced by AP_BoardConfig::board_setup(), AP_BoardConfig::px4_setup_peripherals(), HAL_Linux::run(), HAL_SITL::run(), and HAL_F4Light::run().

Here is the caller graph for this function:

◆ new_input()

virtual bool AP_HAL::RCInput::new_input ( void  )
pure virtual

Return true if there has been new input since the last call to new_input()

Implemented in ChibiOS::RCInput, F4Light::RCInput, Linux::RCInput, PX4::PX4RCInput, VRBRAIN::VRBRAINRCInput, HALSITL::RCInput, and Empty::RCInput.

Referenced by RC_UART::loop(), RC_Channels::read_input(), and teardown().

Here is the caller graph for this function:

◆ num_channels()

virtual uint8_t AP_HAL::RCInput::num_channels ( )
pure virtual

Return the number of valid channels in the last read

Implemented in ChibiOS::RCInput, F4Light::RCInput, Linux::RCInput, PX4::PX4RCInput, VRBRAIN::VRBRAINRCInput, HALSITL::RCInput, and Empty::RCInput.

Referenced by RC_Channels::get_valid_channel_count(), loop(), and teardown().

Here is the caller graph for this function:

◆ rc_bind()

virtual bool AP_HAL::RCInput::rc_bind ( int  dsmMode)
inlinevirtual

Reimplemented in ChibiOS::RCInput, F4Light::RCInput, PX4::PX4RCInput, and VRBRAIN::VRBRAINRCInput.

Definition at line 53 of file RCInput.h.

Referenced by RC_Channels::receiver_bind().

Here is the caller graph for this function:

◆ read() [1/2]

virtual uint16_t AP_HAL::RCInput::read ( uint8_t  ch)
pure virtual

Implemented in ChibiOS::RCInput, F4Light::RCInput, Linux::RCInput, PX4::PX4RCInput, HALSITL::RCInput, VRBRAIN::VRBRAINRCInput, and Empty::RCInput.

Referenced by RC_Channel::input(), loop(), RC_UART::loop(), RC_Channel::read(), and teardown().

Here is the caller graph for this function:

◆ read() [2/2]

virtual uint8_t AP_HAL::RCInput::read ( uint16_t *  periods,
uint8_t  len 
)
pure virtual

◆ set_override()

virtual bool AP_HAL::RCInput::set_override ( uint8_t  channel,
int16_t  override 
)
pure virtual

Overrides: these are really grody and don't belong here but we need them at the moment to make the port work. case v of: v == -1 -> no change to this channel v == 0 -> do not override this channel v > 0 -> set v as override.

Implemented in ChibiOS::RCInput, F4Light::RCInput, Linux::RCInput, PX4::PX4RCInput, VRBRAIN::VRBRAINRCInput, HALSITL::RCInput, and Empty::RCInput.

Referenced by get_rssi(), and RC_Channels::set_override().

Here is the caller graph for this function:

◆ teardown()

virtual void AP_HAL::RCInput::teardown ( )
inlinevirtual

Reimplemented in Linux::RCInput_RPI.

Definition at line 17 of file RCInput.h.

Referenced by HAL_Linux::run().

Here is the call graph for this function:
Here is the caller graph for this function:

The documentation for this class was generated from the following file: