clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/AnalogOut.h@2:91b6646ea994, 2017-02-01 (annotated)

Committer:
clementlignie
Date:
Wed Feb 01 13:42:30 2017 +0000
Revision:
2:91b6646ea994
Parent:
0:c03cffe402df 
config AX12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:c03cffe402df 1 /* mbed Microcontroller Library - AnalogOut
slowness 0:c03cffe402df 2 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 3 */
slowness 0:c03cffe402df 4
slowness 0:c03cffe402df 5 #ifndef MBED_ANALOGOUT_H
slowness 0:c03cffe402df 6 #define MBED_ANALOGOUT_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #include "device.h"
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 #if DEVICE_ANALOGOUT
slowness 0:c03cffe402df 11
slowness 0:c03cffe402df 12 #include "platform.h"
slowness 0:c03cffe402df 13 #include "PinNames.h"
slowness 0:c03cffe402df 14 #include "PeripheralNames.h"
slowness 0:c03cffe402df 15 #include "Base.h"
slowness 0:c03cffe402df 16
slowness 0:c03cffe402df 17 namespace mbed {
slowness 0:c03cffe402df 18
slowness 0:c03cffe402df 19 /* Class: AnalogOut
slowness 0:c03cffe402df 20 * An analog output, used for setting the voltage on a pin
slowness 0:c03cffe402df 21 *
slowness 0:c03cffe402df 22 * Example:
slowness 0:c03cffe402df 23 * > // Make a sawtooth output
slowness 0:c03cffe402df 24 * >
slowness 0:c03cffe402df 25 * > #include "mbed.h"
slowness 0:c03cffe402df 26 * >
slowness 0:c03cffe402df 27 * > AnalogOut tri(p18);
slowness 0:c03cffe402df 28 * > int main() {
slowness 0:c03cffe402df 29 * > while(1) {
slowness 0:c03cffe402df 30 * > tri = tri + 0.01;
slowness 0:c03cffe402df 31 * > wait_us(1);
slowness 0:c03cffe402df 32 * > if(tri == 1) {
slowness 0:c03cffe402df 33 * > tri = 0;
slowness 0:c03cffe402df 34 * > }
slowness 0:c03cffe402df 35 * > }
slowness 0:c03cffe402df 36 * > }
slowness 0:c03cffe402df 37 */
slowness 0:c03cffe402df 38 class AnalogOut : public Base {
slowness 0:c03cffe402df 39
slowness 0:c03cffe402df 40 public:
slowness 0:c03cffe402df 41
slowness 0:c03cffe402df 42 /* Constructor: AnalogOut
slowness 0:c03cffe402df 43 * Create an AnalogOut connected to the specified pin
slowness 0:c03cffe402df 44 *
slowness 0:c03cffe402df 45 * Variables:
slowness 0:c03cffe402df 46 * pin - AnalogOut pin to connect to (18)
slowness 0:c03cffe402df 47 */
slowness 0:c03cffe402df 48 AnalogOut(PinName pin, const char *name = NULL);
slowness 0:c03cffe402df 49
slowness 0:c03cffe402df 50 /* Function: write
slowness 0:c03cffe402df 51 * Set the output voltage, specified as a percentage (float)
slowness 0:c03cffe402df 52 *
slowness 0:c03cffe402df 53 * Variables:
slowness 0:c03cffe402df 54 * percent - A floating-point value representing the output voltage,
slowness 0:c03cffe402df 55 * specified as a percentage. The value should lie between
slowness 0:c03cffe402df 56 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
slowness 0:c03cffe402df 57 * Values outside this range will be saturated to 0.0f or 1.0f.
slowness 0:c03cffe402df 58 */
slowness 0:c03cffe402df 59 void write(float value);
slowness 0:c03cffe402df 60
slowness 0:c03cffe402df 61 /* Function: write_u16
slowness 0:c03cffe402df 62 * Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
slowness 0:c03cffe402df 63 *
slowness 0:c03cffe402df 64 * Variables:
slowness 0:c03cffe402df 65 * value - 16-bit unsigned short representing the output voltage,
slowness 0:c03cffe402df 66 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
slowness 0:c03cffe402df 67 */
slowness 0:c03cffe402df 68 void write_u16(unsigned short value);
slowness 0:c03cffe402df 69
slowness 0:c03cffe402df 70 /* Function: read
slowness 0:c03cffe402df 71 * Return the current output voltage setting, measured as a percentage (float)
slowness 0:c03cffe402df 72 *
slowness 0:c03cffe402df 73 * Variables:
slowness 0:c03cffe402df 74 * returns - A floating-point value representing the current voltage being output on the pin,
slowness 0:c03cffe402df 75 * measured as a percentage. The returned value will lie between
slowness 0:c03cffe402df 76 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
slowness 0:c03cffe402df 77 *
slowness 0:c03cffe402df 78 * Note:
slowness 0:c03cffe402df 79 * This value may not match exactly the value set by a previous <write>.
slowness 0:c03cffe402df 80 */
slowness 0:c03cffe402df 81 float read();
slowness 0:c03cffe402df 82
slowness 0:c03cffe402df 83
slowness 0:c03cffe402df 84 #ifdef MBED_OPERATORS
slowness 0:c03cffe402df 85 /* Function: operator=
slowness 0:c03cffe402df 86 * An operator shorthand for <write()>
slowness 0:c03cffe402df 87 */
slowness 0:c03cffe402df 88 AnalogOut& operator= (float percent);
slowness 0:c03cffe402df 89 AnalogOut& operator= (AnalogOut& rhs);
slowness 0:c03cffe402df 90
slowness 0:c03cffe402df 91 /* Function: operator float()
slowness 0:c03cffe402df 92 * An operator shorthand for <read()>
slowness 0:c03cffe402df 93 */
slowness 0:c03cffe402df 94 operator float();
slowness 0:c03cffe402df 95 #endif
slowness 0:c03cffe402df 96
slowness 0:c03cffe402df 97 #ifdef MBED_RPC
slowness 0:c03cffe402df 98 virtual const struct rpc_method *get_rpc_methods();
slowness 0:c03cffe402df 99 static struct rpc_class *get_rpc_class();
slowness 0:c03cffe402df 100 #endif
slowness 0:c03cffe402df 101
slowness 0:c03cffe402df 102 protected:
slowness 0:c03cffe402df 103
slowness 0:c03cffe402df 104 DACName _dac;
slowness 0:c03cffe402df 105
slowness 0:c03cffe402df 106 };
slowness 0:c03cffe402df 107
slowness 0:c03cffe402df 108 } // namespace mbed
slowness 0:c03cffe402df 109
slowness 0:c03cffe402df 110 #endif
slowness 0:c03cffe402df 111
slowness 0:c03cffe402df 112 #endif