FanController.h

Go to the documentation of this file.

/*
   Copyright 2019 Leon Kiefer
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
 
       http://www.apache.org/licenses/LICENSE-2.0
 
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
#pragma once
 
#include "Arduino.h"
#include "IFanController.h"
 
#define FAN_NUM 6
 
enum class FanMask : byte {
    Disconnected = 0x00,
    ThreePin = 0x01,
    FourPin = 0x02
};
 
bool isValidFanMask(const FanMask fanMask);
 
enum class FanDetectionType : byte {
    Auto = 0x00,
    ThreePin = 0x01,
    FourPin = 0x02,
    Disconnected = 0x03
};
 
bool isValidFanDetectionType(const FanDetectionType type);
 
#define FAN_FORCE_THREE_PIN_MODE_ON 0x01
#define FAN_FORCE_THREE_PIN_MODE_OFF 0x00
 
#define FAN_CURVE_POINTS_NUM 6
 
#define FAN_CURVE_TEMP_GROUP_EXTERNAL 255
 
struct FanCurve {
    uint16_t temperatures[FAN_CURVE_POINTS_NUM];
    uint16_t rpms[FAN_CURVE_POINTS_NUM];
};
 
class FanController : public IFanController {
public:
    virtual void handleFanControl(const Command& command, const CorsairLightingProtocolResponse* response) override;
 
protected:
    virtual uint16_t getFanSpeed(uint8_t fan) = 0;
    virtual void setFanSpeed(uint8_t fan, uint16_t speed) = 0;
    virtual uint8_t getFanPower(uint8_t fan) = 0;
    virtual void setFanPower(uint8_t fan, uint8_t percentage) = 0;
    virtual void setFanCurve(uint8_t fan, uint8_t group, FanCurve& fanCurve) = 0;
    virtual void setFanExternalTemperature(uint8_t fan, uint16_t temp) = 0;
    virtual void setFanForce3PinMode(bool flag) = 0;
    virtual FanDetectionType getFanDetectionType(uint8_t fan) = 0;
    virtual void setFanDetectionType(uint8_t fan, FanDetectionType type) = 0;
};