/elec/quadcopter

To get this branch, use:
bzr branch http://bzr.ed.am/elec/quadcopter

« back to all changes in this revision

Viewing changes to src/rc-interface/receiver.h

  • Committer: Tim Marston
  • Date: 2013-11-21 00:05:58 UTC
  • Revision ID: tim@ed.am-20131121000558-06xtcb4fue72td7q
updated 8-channel pulse width reading test program's comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/rc-interface/receiver.h
1
 
//
2
 
// receiver.h
3
 
//
4
 
 
5
 
#ifndef RECEIVER_H_
6
 
#define RECEIVER_H_
7
 
 
8
 
 
9
 
namespace Receiver
10
 
{
11
 
        /**
12
 
         * Setup the Arduino as required.
13
 
         */
14
 
        void setup();
15
 
        
16
 
        /**
17
 
         * Attempt to read channels.  The call is non-blocking and reutrns true if a
18
 
         * full frame of NUM_CHANNELS has been read.  When this is the case, and not
19
 
         * otherwise, the channel_values array will contain NUM_CHANNELS number of
20
 
         * channel values in the range 0 to MAX_CHANNEL_VALUE.  At other times the
21
 
         * array is used to store values read so far and should not be relied upon.
22
 
         * 
23
 
         * @param channel_values array to store channel values in
24
 
         * @returns true if a frame has been read
25
 
         */
26
 
        bool read_channels( int channel_values[] );
27
 
}
28
 
 
29
 
 
30
 
#endif //RECEIVER_H_