mbed-dev | Mbed

Users » mbed_official » Code » mbed-dev

Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

api/AnalogOut.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:: bogdanm
Date:: Thu Oct 01 15:25:22 2015 +0300
Revision:: 0:9b334a45a8ff
Child:: 144:ef7eb2e8f9f7

Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

User	Revision	Line number	New contents of line
bogdanm	0:9b334a45a8ff	1	/* mbed Microcontroller Library
bogdanm	0:9b334a45a8ff	2	* Copyright (c) 2006-2013 ARM Limited
bogdanm	0:9b334a45a8ff	3	*
bogdanm	0:9b334a45a8ff	4	* Licensed under the Apache License, Version 2.0 (the "License");
bogdanm	0:9b334a45a8ff	5	* you may not use this file except in compliance with the License.
bogdanm	0:9b334a45a8ff	6	* You may obtain a copy of the License at
bogdanm	0:9b334a45a8ff	7	*
bogdanm	0:9b334a45a8ff	8	* http://www.apache.org/licenses/LICENSE-2.0
bogdanm	0:9b334a45a8ff	9	*
bogdanm	0:9b334a45a8ff	10	* Unless required by applicable law or agreed to in writing, software
bogdanm	0:9b334a45a8ff	11	* distributed under the License is distributed on an "AS IS" BASIS,
bogdanm	0:9b334a45a8ff	12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm	0:9b334a45a8ff	13	* See the License for the specific language governing permissions and
bogdanm	0:9b334a45a8ff	14	* limitations under the License.
bogdanm	0:9b334a45a8ff	15	*/
bogdanm	0:9b334a45a8ff	16	#ifndef MBED_ANALOGOUT_H
bogdanm	0:9b334a45a8ff	17	#define MBED_ANALOGOUT_H
bogdanm	0:9b334a45a8ff	18
bogdanm	0:9b334a45a8ff	19	#include "platform.h"
bogdanm	0:9b334a45a8ff	20
bogdanm	0:9b334a45a8ff	21	#if DEVICE_ANALOGOUT
bogdanm	0:9b334a45a8ff	22
bogdanm	0:9b334a45a8ff	23	#include "analogout_api.h"
bogdanm	0:9b334a45a8ff	24
bogdanm	0:9b334a45a8ff	25	namespace mbed {
bogdanm	0:9b334a45a8ff	26
bogdanm	0:9b334a45a8ff	27	/** An analog output, used for setting the voltage on a pin
bogdanm	0:9b334a45a8ff	28	*
bogdanm	0:9b334a45a8ff	29	* Example:
bogdanm	0:9b334a45a8ff	30	* @code
bogdanm	0:9b334a45a8ff	31	* // Make a sawtooth output
bogdanm	0:9b334a45a8ff	32	*
bogdanm	0:9b334a45a8ff	33	* #include "mbed.h"
bogdanm	0:9b334a45a8ff	34	*
bogdanm	0:9b334a45a8ff	35	* AnalogOut tri(p18);
bogdanm	0:9b334a45a8ff	36	* int main() {
bogdanm	0:9b334a45a8ff	37	* while(1) {
bogdanm	0:9b334a45a8ff	38	* tri = tri + 0.01;
bogdanm	0:9b334a45a8ff	39	* wait_us(1);
bogdanm	0:9b334a45a8ff	40	* if(tri == 1) {
bogdanm	0:9b334a45a8ff	41	* tri = 0;
bogdanm	0:9b334a45a8ff	42	* }
bogdanm	0:9b334a45a8ff	43	* }
bogdanm	0:9b334a45a8ff	44	* }
bogdanm	0:9b334a45a8ff	45	* @endcode
bogdanm	0:9b334a45a8ff	46	*/
bogdanm	0:9b334a45a8ff	47	class AnalogOut {
bogdanm	0:9b334a45a8ff	48
bogdanm	0:9b334a45a8ff	49	public:
bogdanm	0:9b334a45a8ff	50
bogdanm	0:9b334a45a8ff	51	/** Create an AnalogOut connected to the specified pin
bogdanm	0:9b334a45a8ff	52	*
bogdanm	0:9b334a45a8ff	53	* @param AnalogOut pin to connect to (18)
bogdanm	0:9b334a45a8ff	54	*/
bogdanm	0:9b334a45a8ff	55	AnalogOut(PinName pin) {
bogdanm	0:9b334a45a8ff	56	analogout_init(&_dac, pin);
bogdanm	0:9b334a45a8ff	57	}
bogdanm	0:9b334a45a8ff	58
bogdanm	0:9b334a45a8ff	59	/** Set the output voltage, specified as a percentage (float)
bogdanm	0:9b334a45a8ff	60	*
bogdanm	0:9b334a45a8ff	61	* @param value A floating-point value representing the output voltage,
bogdanm	0:9b334a45a8ff	62	* specified as a percentage. The value should lie between
bogdanm	0:9b334a45a8ff	63	* 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
bogdanm	0:9b334a45a8ff	64	* Values outside this range will be saturated to 0.0f or 1.0f.
bogdanm	0:9b334a45a8ff	65	*/
bogdanm	0:9b334a45a8ff	66	void write(float value) {
bogdanm	0:9b334a45a8ff	67	analogout_write(&_dac, value);
bogdanm	0:9b334a45a8ff	68	}
bogdanm	0:9b334a45a8ff	69
bogdanm	0:9b334a45a8ff	70	/** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
bogdanm	0:9b334a45a8ff	71	*
bogdanm	0:9b334a45a8ff	72	* @param value 16-bit unsigned short representing the output voltage,
bogdanm	0:9b334a45a8ff	73	* normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
bogdanm	0:9b334a45a8ff	74	*/
bogdanm	0:9b334a45a8ff	75	void write_u16(unsigned short value) {
bogdanm	0:9b334a45a8ff	76	analogout_write_u16(&_dac, value);
bogdanm	0:9b334a45a8ff	77	}
bogdanm	0:9b334a45a8ff	78
bogdanm	0:9b334a45a8ff	79	/** Return the current output voltage setting, measured as a percentage (float)
bogdanm	0:9b334a45a8ff	80	*
bogdanm	0:9b334a45a8ff	81	* @returns
bogdanm	0:9b334a45a8ff	82	* A floating-point value representing the current voltage being output on the pin,
bogdanm	0:9b334a45a8ff	83	* measured as a percentage. The returned value will lie between
bogdanm	0:9b334a45a8ff	84	* 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
bogdanm	0:9b334a45a8ff	85	*
bogdanm	0:9b334a45a8ff	86	* @note
bogdanm	0:9b334a45a8ff	87	* This value may not match exactly the value set by a previous write().
bogdanm	0:9b334a45a8ff	88	*/
bogdanm	0:9b334a45a8ff	89	float read() {
bogdanm	0:9b334a45a8ff	90	return analogout_read(&_dac);
bogdanm	0:9b334a45a8ff	91	}
bogdanm	0:9b334a45a8ff	92
bogdanm	0:9b334a45a8ff	93	#ifdef MBED_OPERATORS
bogdanm	0:9b334a45a8ff	94	/** An operator shorthand for write()
bogdanm	0:9b334a45a8ff	95	*/
bogdanm	0:9b334a45a8ff	96	AnalogOut& operator= (float percent) {
bogdanm	0:9b334a45a8ff	97	write(percent);
bogdanm	0:9b334a45a8ff	98	return *this;
bogdanm	0:9b334a45a8ff	99	}
bogdanm	0:9b334a45a8ff	100
bogdanm	0:9b334a45a8ff	101	AnalogOut& operator= (AnalogOut& rhs) {
bogdanm	0:9b334a45a8ff	102	write(rhs.read());
bogdanm	0:9b334a45a8ff	103	return *this;
bogdanm	0:9b334a45a8ff	104	}
bogdanm	0:9b334a45a8ff	105
bogdanm	0:9b334a45a8ff	106	/** An operator shorthand for read()
bogdanm	0:9b334a45a8ff	107	*/
bogdanm	0:9b334a45a8ff	108	operator float() {
bogdanm	0:9b334a45a8ff	109	return read();
bogdanm	0:9b334a45a8ff	110	}
bogdanm	0:9b334a45a8ff	111	#endif
bogdanm	0:9b334a45a8ff	112
bogdanm	0:9b334a45a8ff	113	protected:
bogdanm	0:9b334a45a8ff	114	dac_t _dac;
bogdanm	0:9b334a45a8ff	115	};
bogdanm	0:9b334a45a8ff	116
bogdanm	0:9b334a45a8ff	117	} // namespace mbed
bogdanm	0:9b334a45a8ff	118
bogdanm	0:9b334a45a8ff	119	#endif
bogdanm	0:9b334a45a8ff	120
bogdanm	0:9b334a45a8ff	121	#endif