Relay Class Reference

#include <Relay.h>

Inheritance diagram for Relay:

List of all members.

Public Types
enum	Value { kOff, kOn, kForward, kReverse }
enum	Direction { kBothDirections, kForwardOnly, kReverseOnly }
Public Member Functions
	Relay (UINT32 channel, Direction direction=kBothDirections)
	Relay (UINT8 moduleNumber, UINT32 channel, Direction direction=kBothDirections)
virtual	~Relay ()
void	Set (Value value)

---

Detailed Description

Class for Spike style relay outputs. Relays are intended to be connected to spikes or similar relays. The relay channels controls a pair of pins that are either both off, one on, the other on, or both on. This translates into two spike outputs at 0v, one at 12v and one at 0v, one at 0v and the other at 12v, or two spike outputs at 12V. This allows off, full forward, or full reverse control of motors without variable speed. It also allows the two channels (forward and reverse) to be used independently for something that does not care about voltage polatiry (like a solenoid).

---

Constructor & Destructor Documentation

Relay::Relay	(	UINT32	channel,
		Relay::Direction	direction = kBothDirections
	)

Relay constructor given a channel only where the default digital module is used.

Parameters:

channel	The channel number within the default module for this relay.
direction	The direction that the Relay object will control.

Relay::Relay	(	UINT8	moduleNumber,
		UINT32	channel,
		Relay::Direction	direction = kBothDirections
	)

Relay constructor given the module and the channel.

Parameters:

moduleNumber	The digital module this relay is connected to (1 or 2).
channel	The channel number within the module for this relay.
direction	The direction that the Relay object will control.

Relay::~Relay

(

)

[virtual]

Free the resource associated with a relay. The relay channels are set to free and the relay output is turned off.

---

Member Function Documentation

void Relay::Set

(

Relay::Value

value

)

Set the relay state.

Valid values depend on which directions of the relay are controlled by the object.

When set to kBothDirections, the relay can be any of the four states: 0v-0v, 0v-12v, 12v-0v, 12v-12v

When set to kForwardOnly or kReverseOnly, you can specify the constant for the direction or you can simply specify kOff and kOn. Using only kOff and kOn is recommended.

Parameters:

value

The state to set the relay.

---

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

• Relay.h
• Relay.cpp