RemoteOutputInterface Class Reference

RemoteOutputInterface class is used as an interface for remote HVAC devices over which we don't have explicit control. More...

#include <remote_output_interface.h>

Inheritance diagram for RemoteOutputInterface:

Collaboration diagram for RemoteOutputInterface:

Public Member Functions
	RemoteOutputInterface (bool onOffOnly)
	Contructor.
void	setOutputValueFromRemote (int value)
	Set output value from a remote device.
int	getOutputValue () const override
	Returns current output value.
void	setOutputValue (int value) override
	Override base class method in order to disable setting output value by HvacBase.
bool	isOnOffOnly () const override
	Returns if output is on/off only or 0-100%.
bool	isControlledInternally () const override
	Returns false - output is not controlled internally.

Detailed Description

RemoteOutputInterface class is used as an interface for remote HVAC devices over which we don't have explicit control.

When used, HvacBase will not set output value to the device. It allows to set output value from remote device via setOutputValueFromRemote method and it's state will be shared to Supla.

Constructor & Destructor Documentation

RemoteOutputInterface()

RemoteOutputInterface::RemoteOutputInterface ( bool onOffOnly )

explicit

Contructor.

Parameters

onOffOnly

if true, output value will be 0 or 1. If false, output value will be 0-100 %

Member Function Documentation

getOutputValue()

int RemoteOutputInterface::getOutputValue ( ) const

overridevirtual

Returns current output value.

Returns

0 - off, 1 - on (for on/off only), or 1-100 %

Implements Supla::Control::OutputInterface.

isControlledInternally()

bool RemoteOutputInterface::isControlledInternally ( ) const

overridevirtual

Returns false - output is not controlled internally.

Returns

false

Reimplemented from Supla::Control::OutputInterface.

isOnOffOnly()

bool RemoteOutputInterface::isOnOffOnly ( ) const

overridevirtual

Returns if output is on/off only or 0-100%.

Returns

true if output is on/off only

Implements Supla::Control::OutputInterface.

setOutputValue()

void RemoteOutputInterface::setOutputValue ( int value )

overridevirtual

Override base class method in order to disable setting output value by HvacBase.

Parameters

value

Implements Supla::Control::OutputInterface.

setOutputValueFromRemote()

void RemoteOutputInterface::setOutputValueFromRemote

(

int

value

)

Set output value from a remote device.

Use this method to set output value received from a remote device.

Parameters

value

0 - off, 1 - on (for on/off only), or 1-100 %

---

The documentation for this class was generated from the following files:

• src/supla/control/remote_output_interface.h
• src/supla/control/remote_output_interface.cpp