Corsair Lighting Protocol  0.15.0
Control LEDs connected to an Arduino with iCUE
TemperatureController Class Referenceabstract

#include <TemperatureController.h>

+ Inheritance diagram for TemperatureController:
+ Collaboration diagram for TemperatureController:

Public Member Functions

virtual void handleTemperatureControl (const Command &command, const CorsairLightingProtocolResponse *response) override
 
virtual uint16_t getTemperature (uint8_t temperatureSensor)
 

Protected Member Functions

virtual uint16_t getTemperatureValue (uint8_t temperatureSensor)=0
 
virtual bool isTemperatureSensorConnected (uint8_t temperatureSensor)=0
 
virtual uint16_t getVoltageRail12V ()=0
 
virtual uint16_t getVoltageRail5V ()=0
 
virtual uint16_t getVoltageRail3V3 ()=0
 

Detailed Description

The abstract implementation of the ITemperatureController. This implementation handles the commands parsing and processing.

Member Function Documentation

◆ getTemperature()

uint16_t TemperatureController::getTemperature ( uint8_t  temperatureSensor)
virtual

Get the temperature of a sensor.

Parameters
temperatureSensorthe index of the temperature sensor
Returns
the temperature in hundredths of a degree Celsius.

◆ getTemperatureValue()

virtual uint16_t TemperatureController::getTemperatureValue ( uint8_t  temperatureSensor)
protectedpure virtual

Get the temperature of a sensor.

Parameters
temperatureSensorthe index of the temperature sensor
Returns
the temperature in hundredths of a degree Celsius.

Implemented in ThermistorTemperatureController.

◆ getVoltageRail12V()

virtual uint16_t TemperatureController::getVoltageRail12V ( )
protectedpure virtual

Get the voltage of the 12V rail.

Returns
the voltage in mV

Implemented in ThermistorTemperatureController.

◆ getVoltageRail3V3()

virtual uint16_t TemperatureController::getVoltageRail3V3 ( )
protectedpure virtual

Get the voltage of the 3.3V rail.

Returns
the voltage in mV

Implemented in ThermistorTemperatureController.

◆ getVoltageRail5V()

virtual uint16_t TemperatureController::getVoltageRail5V ( )
protectedpure virtual

Get the voltage of the 5V rail.

Returns
the voltage in mV

Implemented in ThermistorTemperatureController.

◆ handleTemperatureControl()

void TemperatureController::handleTemperatureControl ( const Command command,
const CorsairLightingProtocolResponse response 
)
overridevirtual

Handle a temperature command and send a response.

Parameters
commandthe command which should be handled
responsethe callback for the response

Implements ITemperatureController.

◆ isTemperatureSensorConnected()

virtual bool TemperatureController::isTemperatureSensorConnected ( uint8_t  temperatureSensor)
protectedpure virtual

Check if a temperature sensor is connected.

Parameters
temperatureSensorthe index of the temperature sensor
Returns
true if a temperature sensor is connected

Implemented in ThermistorTemperatureController.


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