Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

AnalogOut.h@5:62573be585e9, 2009-01-22 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Jan 22 18:32:40 2009 +0000
Revision:
5:62573be585e9
Parent:
4:5d1359a283bc
Child:
11:1c1ebd0324fa
* Added initial RPC release

 * Added RTC and helper functions

 * Added read_u16()/write_u16() to AnalogIn/Out

 * Ticker/Timeout timing fixed!

 * mbedinfo() helper added

 * error() and printf() added to replace DEBUG() and ERROR()

 * DigitalIn supports methods on rise/fall

 * SPI and Serial support NC

 * LED1-4 also map to 1-4

 * Timer object reset fixed

 * SPI uses single mode

 * SPI3 added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - AnalogOut
simon.ford@mbed.co.uk 5:62573be585e9 2 * Copyright (c) 2006-2009 ARM Limited. All rights reserved.
simon.ford@mbed.co.uk 5:62573be585e9 3 * sford
simon.ford@mbed.co.uk 5:62573be585e9 4 */
simon.ford@mbed.co.uk 0:82220227f4fa 5
simon.ford@mbed.co.uk 0:82220227f4fa 6 #ifndef MBED_ANALOGOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_ANALOGOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 8
simon.ford@mbed.co.uk 0:82220227f4fa 9 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 10
simon.ford@mbed.co.uk 0:82220227f4fa 11 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 12
simon.ford@mbed.co.uk 0:82220227f4fa 13 /* Class: AnalogOut
simon.ford@mbed.co.uk 0:82220227f4fa 14 * An analog output, used for setting the voltage on a pin
simon.ford@mbed.co.uk 0:82220227f4fa 15 */
simon.ford@mbed.co.uk 0:82220227f4fa 16 class AnalogOut : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 17
simon.ford@mbed.co.uk 0:82220227f4fa 18 public:
simon.ford@mbed.co.uk 0:82220227f4fa 19
simon.ford@mbed.co.uk 0:82220227f4fa 20 /* Constructor: AnalogOut
simon.ford@mbed.co.uk 0:82220227f4fa 21 * Create an AnalogOut connected to the specified pin
simon.ford@mbed.co.uk 0:82220227f4fa 22 *
simon.ford@mbed.co.uk 0:82220227f4fa 23 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 24 * pin - AnalogOut pin to connect to (18)
simon.ford@mbed.co.uk 0:82220227f4fa 25 */
simon.ford@mbed.co.uk 4:5d1359a283bc 26 AnalogOut(int pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 27
simon.ford@mbed.co.uk 0:82220227f4fa 28 /* Function: write
simon.ford@mbed.co.uk 0:82220227f4fa 29 * Set the output voltage, specified as a percentage (float)
simon.ford@mbed.co.uk 0:82220227f4fa 30 *
simon.ford@mbed.co.uk 0:82220227f4fa 31 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 32 * percent - A floating-point value representing the output voltage,
simon.ford@mbed.co.uk 0:82220227f4fa 33 * specified as a percentage. The value should lie between
simon.ford@mbed.co.uk 0:82220227f4fa 34 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
simon.ford@mbed.co.uk 0:82220227f4fa 35 * Values outside this range will be saturated to 0.0f or 1.0f.
simon.ford@mbed.co.uk 0:82220227f4fa 36 */
simon.ford@mbed.co.uk 0:82220227f4fa 37 void write(float percent);
simon.ford@mbed.co.uk 0:82220227f4fa 38
simon.ford@mbed.co.uk 5:62573be585e9 39 /* Function: write_u16
simon.ford@mbed.co.uk 5:62573be585e9 40 * Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
simon.ford@mbed.co.uk 5:62573be585e9 41 *
simon.ford@mbed.co.uk 5:62573be585e9 42 * Variables:
simon.ford@mbed.co.uk 5:62573be585e9 43 * value - 16-bit unsigned short representing the output voltage,
simon.ford@mbed.co.uk 5:62573be585e9 44 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
simon.ford@mbed.co.uk 5:62573be585e9 45 */
simon.ford@mbed.co.uk 5:62573be585e9 46 void write_u16(unsigned short value);
simon.ford@mbed.co.uk 5:62573be585e9 47
simon.ford@mbed.co.uk 0:82220227f4fa 48 void write_v(float v);
simon.ford@mbed.co.uk 0:82220227f4fa 49 void write_mv(int mv);
simon.ford@mbed.co.uk 0:82220227f4fa 50
simon.ford@mbed.co.uk 0:82220227f4fa 51 /* Function: read
simon.ford@mbed.co.uk 0:82220227f4fa 52 * Return the current output voltage setting, measured as a percentage (float)
simon.ford@mbed.co.uk 0:82220227f4fa 53 *
simon.ford@mbed.co.uk 0:82220227f4fa 54 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 55 * returns - A floating-point value representing the current voltage being output on the pin,
simon.ford@mbed.co.uk 0:82220227f4fa 56 * measured as a percentage. The returned value will lie between
simon.ford@mbed.co.uk 0:82220227f4fa 57 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
simon.ford@mbed.co.uk 0:82220227f4fa 58 *
simon.ford@mbed.co.uk 0:82220227f4fa 59 * Note:
simon.ford@mbed.co.uk 0:82220227f4fa 60 * This value may not match exactly the value set by a previous <write>.
simon.ford@mbed.co.uk 0:82220227f4fa 61 */
simon.ford@mbed.co.uk 0:82220227f4fa 62 float read();
simon.ford@mbed.co.uk 0:82220227f4fa 63
simon.ford@mbed.co.uk 0:82220227f4fa 64 /* Function: operator=
simon.ford@mbed.co.uk 5:62573be585e9 65 * An operator shorthand for <write()>
simon.ford@mbed.co.uk 0:82220227f4fa 66 */
simon.ford@mbed.co.uk 0:82220227f4fa 67 AnalogOut& operator= (float percent);
simon.ford@mbed.co.uk 0:82220227f4fa 68 AnalogOut& operator= (AnalogOut& rhs);
simon.ford@mbed.co.uk 0:82220227f4fa 69
simon.ford@mbed.co.uk 0:82220227f4fa 70 /* Function: operator float()
simon.ford@mbed.co.uk 5:62573be585e9 71 * An operator shorthand for <read()>
simon.ford@mbed.co.uk 0:82220227f4fa 72 */
simon.ford@mbed.co.uk 0:82220227f4fa 73 operator float();
simon.ford@mbed.co.uk 4:5d1359a283bc 74
simon.ford@mbed.co.uk 5:62573be585e9 75 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 76 static struct rpc_class *get_rpc_class();
simon.ford@mbed.co.uk 5:62573be585e9 77
simon.ford@mbed.co.uk 0:82220227f4fa 78 };
simon.ford@mbed.co.uk 0:82220227f4fa 79
simon.ford@mbed.co.uk 0:82220227f4fa 80 }
simon.ford@mbed.co.uk 0:82220227f4fa 81
simon.ford@mbed.co.uk 1:6b7f447ca868 82 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 83