ITemperatureController Interface

Defines a temperature controller plugin.

Namespace: CompreDriveSDK.Plugins
Assembly: CompreDriveSDK (in CompreDriveSDK.dll) Version: 1.17.16

Syntax

public interface ITemperatureController : ICommandAcceptor

Public Interface ITemperatureController
	Inherits ICommandAcceptor

The ITemperatureController type exposes the following members.

Properties

	Name	Description
	Identifier	Gets an identifier string, usually read from the controller or constructed with connection information.
	IsConnected	Gets a value indicating if the controller is currently connected.
	IsEnabled	Gets a value indicating if the controller is currently active and accepts setpoints.
	Name	Gets or sets the name of the temperature controller plugin. Should be unique.

Methods

	Name	Description
	AcceptApiInstance	Is called during plugin initialization on CompreDriveControl start and allows the plugin to receive an API interface of the CompreDriveControl instance it is loaded into. (Inherited from ICommandAcceptor)
	DisableRegulation	Disable the temperature controller, so that it no longer regulates the temperature process value.
	Disconnect	Disconnect from the controller.
	EnableRegulation	Enable the temperature controller, so that it actively regulates the temperature process value.
	ExecuteCommand	Execute the given command. (Inherited from ICommandAcceptor)
	GetAvailableCommands	Get the commands available to run. (Inherited from ICommandAcceptor)
	GetConfigInterface	Should return a configuration interface that returns configuration information used in the TryConnect(DictionaryString, String) function.
	TryAutoConnect	Try to automatically establish a connection with the controller without user input.
	TryConnect	Connect to the controller using the supplied options.
	TryGetMaxTempSetpoint	Try to read the maximum acceptable temperature setpoint.
	TryGetMinTempSetpoint	Try to read the minimum acceptable temperature setpoint.
	TryGetTemperature	Try to read the current temperature process value.
	TryGetTempSetpoint	Try to read the current temperature setpoint value.
	TrySetTempSetpoint	Try to set the given temperature setpoint.