/***************************************************//**
 * @file    ThermoElectricProtocolInterface.h
 * @date    February 2009
 * @author  Ocean Optics, Inc.
 *
 * This is a generic interface into thermoelectric functionality
 * at the protocol level, agnostic to any particular protocol.
 * Each Protocol offering this functionality should implement
 * this interface.
 *
 * LICENSE:
 *
 * SeaBreeze Copyright (C) 2014, Ocean Optics Inc
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject
 * to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *******************************************************/

#ifndef THERMOELECTRICPROTOCOLINTERFACE_H
#define THERMOELECTRICPROTOCOLINTERFACE_H

#include "common/buses/Bus.h"
#include "common/exceptions/ProtocolException.h"
#include "common/protocols/ProtocolHelper.h"

namespace seabreeze {

    class ThermoElectricProtocolInterface : public ProtocolHelper {
    public:
        ThermoElectricProtocolInterface(Protocol *protocol);
        virtual ~ThermoElectricProtocolInterface();

        /**
         * Get the temperature of the thermoelectric device.
         */
        virtual double readThermoElectricTemperatureCelsius(const Bus &bus)
            throw (ProtocolException) = 0;

        /**
         * Enable the thermoelectric unit on the device.
         */
        virtual void writeThermoElectricEnable(const Bus &bus, bool enable)
            throw (ProtocolException) = 0;

        /**
         * Set the target temperature for the thermoelectric in degrees
         * Celsius.  The actual temperature that the device
         * can reach may be a function of ambient temperature.
         */
        virtual void writeThermoElectricSetPointCelsius(const Bus &bus, double degreesC)
            throw (ProtocolException) = 0;

    };

}

#endif /* THERMOELECTRICPROTOCOLINTERFACE_H */
