1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* Fan.h
*
* Created on: 29 Jun 2016
* Author: David
*/
#ifndef SRC_FAN_H_
#define SRC_FAN_H_
#include <RepRapFirmware.h>
#include <ObjectModel/ObjectModel.h>
#include <Hardware/IoPorts.h>
#if SUPPORT_CAN_EXPANSION
# include <CanMessageFormats.h>
#endif
class GCodeBuffer;
class Fan INHERIT_OBJECT_MODEL
{
public:
explicit Fan(unsigned int fanNum) noexcept;
Fan(const Fan&) = delete;
virtual ~Fan() noexcept { }
virtual bool Check(bool checkSensors) noexcept = 0; // update the fan PWM returning true if it is a thermostatic fan that is on
virtual GCodeResult SetPwmFrequency(PwmFrequency freq, const StringRef& reply) noexcept = 0;
virtual bool IsEnabled() const noexcept = 0;
virtual int32_t GetRPM() const noexcept = 0;
virtual float GetPwm() const noexcept = 0;
virtual PwmFrequency GetPwmFrequency() const noexcept = 0;
virtual GCodeResult ReportPortDetails(const StringRef& str) const noexcept = 0;
#if SUPPORT_CAN_EXPANSION
virtual void UpdateFromRemote(CanAddress src, const FanReport& report) noexcept = 0;
#endif
#if SUPPORT_REMOTE_COMMANDS
virtual bool IsLocal() const noexcept = 0;
// Set or report the parameters for this fan
// If errors were discovered while processing parameters, put an appropriate error message in 'reply' and set 'error' to true.
// If no relevant parameters are found, print the existing ones to 'reply' and return false.
GCodeResult Configure(const CanMessageFanParameters& msg, const StringRef& reply) noexcept;
#endif
// Set or report the parameters for this fan
// If 'mCode' is an M-code used to set parameters (which should only ever be 106 or 107)
// then search for parameters used to configure the fan. If any are found, perform appropriate actions and return true.
// If errors were discovered while processing parameters, put an appropriate error message in 'reply' and set 'error' to true.
// If no relevant parameters are found, print the existing ones to 'reply' and return false.
bool Configure(unsigned int mcode, size_t fanNum, GCodeBuffer& gb, const StringRef& reply, bool& error) THROWS(GCodeException);
float GetConfiguredPwm() const noexcept { return val; } // returns the configured PWM. Actual PWM may be different, e.g. due to blipping or for thermostatic fans.
GCodeResult SetPwm(float speed, const StringRef& reply) noexcept;
bool HasMonitoredSensors() const noexcept { return sensorsMonitored.IsNonEmpty(); }
unsigned int GetNumber() const { return fanNumber; }
const char *_ecv_array GetName() const noexcept { return name.c_str(); }
#if HAS_MASS_STORAGE || HAS_SBC_INTERFACE
bool WriteSettings(FileStore *f, size_t fanNum) const noexcept; // save the settings of this fan if it isn't thermostatic
#endif
protected:
DECLARE_OBJECT_MODEL
static constexpr uint32_t FanReportTimeout = 2000; // any reading older than this number of milliseconds is considered unreliable
virtual GCodeResult Refresh(const StringRef& reply) noexcept = 0;
virtual bool UpdateFanConfiguration(const StringRef& reply) noexcept = 0;
unsigned int fanNumber;
// Variables that control the fan
float val; // the value requested in the M106 command
float minVal;
float maxVal;
float triggerTemperatures[2];
uint32_t blipTime; // how long we blip the fan for, in milliseconds
SensorsBitmap sensorsMonitored;
String<MaxFanNameLength> name;
};
#endif /* SRC_FAN_H_ */
|
