Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: cc3000_ping_demo_try_2
Fork of mbed by
AnalogOut.h
- Committer:
- simon.ford@mbed.co.uk
- Date:
- 2009-01-22
- Revision:
- 5:62573be585e9
- Parent:
- 4:5d1359a283bc
- Child:
- 11:1c1ebd0324fa
File content as of revision 5:62573be585e9:
/* mbed Microcontroller Library - AnalogOut
* Copyright (c) 2006-2009 ARM Limited. All rights reserved.
* sford
*/
#ifndef MBED_ANALOGOUT_H
#define MBED_ANALOGOUT_H
#include "Base.h"
namespace mbed {
/* Class: AnalogOut
* An analog output, used for setting the voltage on a pin
*/
class AnalogOut : public Base {
public:
/* Constructor: AnalogOut
* Create an AnalogOut connected to the specified pin
*
* Variables:
* pin - AnalogOut pin to connect to (18)
*/
AnalogOut(int pin, const char *name = NULL);
/* Function: write
* Set the output voltage, specified as a percentage (float)
*
* Variables:
* percent - A floating-point value representing the output voltage,
* specified as a percentage. The value should lie between
* 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
* Values outside this range will be saturated to 0.0f or 1.0f.
*/
void write(float percent);
/* Function: write_u16
* Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
*
* Variables:
* value - 16-bit unsigned short representing the output voltage,
* normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
*/
void write_u16(unsigned short value);
void write_v(float v);
void write_mv(int mv);
/* Function: read
* Return the current output voltage setting, measured as a percentage (float)
*
* Variables:
* returns - A floating-point value representing the current voltage being output on the pin,
* measured as a percentage. The returned value will lie between
* 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
*
* Note:
* This value may not match exactly the value set by a previous <write>.
*/
float read();
/* Function: operator=
* An operator shorthand for <write()>
*/
AnalogOut& operator= (float percent);
AnalogOut& operator= (AnalogOut& rhs);
/* Function: operator float()
* An operator shorthand for <read()>
*/
operator float();
virtual const struct rpc_method *get_rpc_methods();
static struct rpc_class *get_rpc_class();
};
}
#endif
