MHVLib  20111011
An efficiency oriented runtime library for AVR microcontrollers
A:/eclipse/mhvlib/MHV_VoltageRegulator.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2011, Make, Hack, Void Inc
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *  * Redistributions of source code must retain the above copyright
00008  *    notice, this list of conditions and the following disclaimer.
00009  *  * Redistributions in binary form must reproduce the above copyright
00010  *    notice, this list of conditions and the following disclaimer in the
00011  *    documentation and/or other materials provided with the distribution.
00012  *  * Neither the name of the Make, Hack, Void nor the
00013  *    names of its contributors may be used to endorse or promote products
00014  *    derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00017  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00018  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019  * DISCLAIMED. IN NO EVENT SHALL MAKE, HACK, VOID BE LIABLE FOR ANY
00020  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00021  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00022  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00023  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00024  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00025  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 
00028 #ifndef MHV_VOLTAGEREGULATOR_H_
00029 #define MHV_VOLTAGEREGULATOR_H_
00030 
00031 #ifdef MHV_AD_RESOLUTION
00032 #ifdef MHV_TIMER16_1
00033 #include <MHV_Timer16.h>
00034 
00035 enum mhv_vreg_modes {
00036         MHV_VREG_MODE_BUCK,
00037         MHV_VREG_MODE_BOOST
00038 };
00039 typedef enum mhv_vreg_modes MHV_VREG_MODES;
00040 
00041 
00042 class MHV_VoltageRegulator {
00043 private:
00044         MHV_VREG_MODES  _mode;
00045         uint8_t                 _vref;
00046         float                   _vrefVoltage;
00047         uint16_t                _targetADC;
00048         MHV_Timer16             *_timer;
00049         uint8_t                 _adcChannel;
00050         uint16_t                _pwm;   // The current PWM rate
00051         bool                    _lastMoveUp;
00052         bool                    _invert;
00053         uint16_t                _lastADC;
00054         float                   _divider;
00055 
00056         void regulateBoost();
00057         void regulateBuck();
00058 
00059 public:
00060         MHV_VoltageRegulator(MHV_VREG_MODES mode, float voltage, float vrefVoltage, uint8_t vref,
00061                         float divider, MHV_Timer16 *timer, uint8_t channel);
00062         void enable();
00063         void disable();
00064         float getVoltage();
00065         void regulate();
00066 };
00067 
00068 #endif // MHV_TIMER16_1
00069 #endif // MHV_AD_RESOLUTION
00070 #endif // MHV_VOLTAGEREGULATOR_H_