AP_ServoRelayEvents Class Reference

#include <AP_ServoRelayEvents.h>

Collaboration diagram for AP_ServoRelayEvents:

Public Member Functions
	AP_ServoRelayEvents (AP_Relay &_relay)
	AP_ServoRelayEvents (const AP_ServoRelayEvents &other)=delete
AP_ServoRelayEvents &	operator= (const AP_ServoRelayEvents &)=delete
void	set_channel_mask (uint16_t _mask)
bool	do_set_servo (uint8_t channel, uint16_t pwm)
bool	do_set_relay (uint8_t relay_num, uint8_t state)
bool	do_repeat_servo (uint8_t channel, uint16_t servo_value, int16_t repeat, uint16_t delay_time_ms)
bool	do_repeat_relay (uint8_t relay_num, int16_t count, uint32_t period_ms)
void	update_events (void)

Static Public Member Functions
static AP_ServoRelayEvents *	get_singleton ()

Private Types
enum	event_type { EVENT_TYPE_RELAY =0, EVENT_TYPE_SERVO =1 }

Private Attributes
AP_Relay &	relay
uint16_t	mask
enum event_type	type
uint32_t	start_time_ms
uint16_t	delay_ms
int16_t	repeat
uint8_t	channel
uint16_t	servo_value

Static Private Attributes
static AP_ServoRelayEvents *	_singleton

Detailed Description

Definition at line 12 of file AP_ServoRelayEvents.h.

Member Enumeration Documentation

event_type

enum AP_ServoRelayEvents::event_type

private

Enumerator
EVENT_TYPE_RELAY
EVENT_TYPE_SERVO

Definition at line 47 of file AP_ServoRelayEvents.h.

Constructor & Destructor Documentation

AP_ServoRelayEvents() [1/2]

AP_ServoRelayEvents::AP_ServoRelayEvents ( AP_Relay &  _relay )

inline

Definition at line 14 of file AP_ServoRelayEvents.h.

Here is the call graph for this function:

AP_ServoRelayEvents() [2/2]

AP_ServoRelayEvents::AP_ServoRelayEvents ( const AP_ServoRelayEvents &  other )

delete

Member Function Documentation

do_repeat_relay()

bool AP_ServoRelayEvents::do_repeat_relay	(	uint8_t	relay_num,
		int16_t	count,
		uint32_t	period_ms
	)

Definition at line 85 of file AP_ServoRelayEvents.cpp.

Referenced by GCS_MAVLINK::handle_servorelay_message(), and set_channel_mask().

Here is the call graph for this function:

Here is the caller graph for this function:

do_repeat_servo()

bool AP_ServoRelayEvents::do_repeat_servo	(	uint8_t	channel,
		uint16_t	servo_value,
		int16_t	repeat,
		uint16_t	delay_time_ms
	)

Definition at line 67 of file AP_ServoRelayEvents.cpp.

Referenced by GCS_MAVLINK::handle_servorelay_message(), and set_channel_mask().

Here is the call graph for this function:

Here is the caller graph for this function:

do_set_relay()

bool AP_ServoRelayEvents::do_set_relay	(	uint8_t	relay_num,
		uint8_t	state
	)

Definition at line 47 of file AP_ServoRelayEvents.cpp.

Referenced by GCS_MAVLINK::handle_servorelay_message(), and set_channel_mask().

Here is the call graph for this function:

Here is the caller graph for this function:

do_set_servo()

bool AP_ServoRelayEvents::do_set_servo	(	uint8_t	channel,
		uint16_t	pwm
	)

Definition at line 28 of file AP_ServoRelayEvents.cpp.

Referenced by GCS_MAVLINK::handle_servorelay_message(), and set_channel_mask().

Here is the call graph for this function:

Here is the caller graph for this function:

get_singleton()

static AP_ServoRelayEvents* AP_ServoRelayEvents::get_singleton ( void  )

inlinestatic

Definition at line 26 of file AP_ServoRelayEvents.h.

Referenced by AP::servorelayevents().

Here is the caller graph for this function:

operator=()

AP_ServoRelayEvents& AP_ServoRelayEvents::operator= ( const AP_ServoRelayEvents &  )

delete

Referenced by AP_ServoRelayEvents().

Here is the caller graph for this function:

set_channel_mask()

void AP_ServoRelayEvents::set_channel_mask ( uint16_t  _mask )

inline

Definition at line 31 of file AP_ServoRelayEvents.h.

Here is the call graph for this function:

update_events()

void AP_ServoRelayEvents::update_events

(

void

)

Definition at line 103 of file AP_ServoRelayEvents.cpp.

Referenced by do_repeat_relay(), do_repeat_servo(), and set_channel_mask().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_singleton

AP_ServoRelayEvents * AP_ServoRelayEvents::_singleton

staticprivate

Definition at line 41 of file AP_ServoRelayEvents.h.

Referenced by AP_ServoRelayEvents(), get_singleton(), and update_events().

channel

uint8_t AP_ServoRelayEvents::channel

private

Definition at line 64 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_relay(), do_repeat_servo(), do_set_relay(), do_set_servo(), set_channel_mask(), and update_events().

delay_ms

uint16_t AP_ServoRelayEvents::delay_ms

private

Definition at line 58 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_relay(), do_repeat_servo(), and update_events().

mask

uint16_t AP_ServoRelayEvents::mask

private

Definition at line 44 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_servo(), do_set_servo(), and set_channel_mask().

relay

AP_Relay& AP_ServoRelayEvents::relay

private

Definition at line 43 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_relay(), do_set_relay(), and update_events().

repeat

int16_t AP_ServoRelayEvents::repeat

private

Definition at line 61 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_relay(), do_repeat_servo(), do_set_relay(), do_set_servo(), set_channel_mask(), and update_events().

servo_value

uint16_t AP_ServoRelayEvents::servo_value

private

Definition at line 67 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_servo(), set_channel_mask(), and update_events().

start_time_ms

uint32_t AP_ServoRelayEvents::start_time_ms

private

Definition at line 55 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_relay(), do_repeat_servo(), and update_events().

type

enum event_type AP_ServoRelayEvents::type

private

Definition at line 52 of file AP_ServoRelayEvents.h.

Referenced by do_repeat_relay(), do_repeat_servo(), do_set_relay(), do_set_servo(), and update_events().

---

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

• libraries/AP_ServoRelayEvents/AP_ServoRelayEvents.h
• libraries/AP_ServoRelayEvents/AP_ServoRelayEvents.cpp