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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* Heater.h
*
* Created on: 24 Jul 2019
* Author: David
*/
#ifndef SRC_HEATING_HEATER_H_
#define SRC_HEATING_HEATER_H_
#include "RepRapFirmware.h"
#include "FOPDT.h"
#include "GCodes/GCodeResult.h"
#if SUPPORT_CAN_EXPANSION
# include "CanId.h"
#endif
class HeaterProtection;
struct CanHeaterReport;
// Enumeration to describe the status of a heater. Note that the web interface returns the numerical values, so don't change them.
enum class HeaterStatus { off = 0, standby = 1, active = 2, fault = 3, tuning = 4, offline = 5 };
class Heater
{
public:
Heater(unsigned int num);
virtual ~Heater();
// Configuration methods
virtual GCodeResult ConfigurePortAndSensor(const char *portName, PwmFrequency freq, unsigned int sensorNumber, const StringRef& reply) = 0;
virtual GCodeResult SetPwmFrequency(PwmFrequency freq, const StringRef& reply) = 0;
virtual GCodeResult ReportDetails(const StringRef& reply) const = 0;
virtual float GetTemperature() const = 0; // Get the current temperature
virtual float GetAveragePWM() const = 0; // Return the running average PWM to the heater. Answer is a fraction in [0, 1].
virtual GCodeResult ResetFault(const StringRef& reply) = 0; // Reset a fault condition - only call this if you know what you are doing
virtual void SwitchOff() = 0;
virtual void Spin() = 0;
virtual void StartAutoTune(float targetTemp, float maxPwm, const StringRef& reply) = 0; // Start an auto tune cycle for this PID
virtual void GetAutoTuneStatus(const StringRef& reply) const = 0; // Get the auto tune status or last result
virtual void Suspend(bool sus) = 0; // Suspend the heater to conserve power or while doing Z probing
virtual float GetAccumulator() const = 0; // Get the inertial term accumulator
#if SUPPORT_CAN_EXPANSION
virtual void UpdateRemoteStatus(CanAddress src, const CanHeaterReport& report) = 0;
#endif
HeaterStatus GetStatus() const; // Get the status of the heater
unsigned int GetHeaterNumber() const { return heaterNumber; }
const char *GetSensorName() const; // Get the name of the sensor for this heater, or nullptr if it hasn't been named
void SetActiveTemperature(float t);
float GetActiveTemperature() const { return activeTemperature; }
void SetStandbyTemperature(float t);
float GetStandbyTemperature() const { return standbyTemperature; }
GCodeResult Activate(const StringRef& reply); // Switch from idle to active
void Standby(); // Switch from active to idle
void GetFaultDetectionParameters(float& pMaxTempExcursion, float& pMaxFaultTime) const
{ pMaxTempExcursion = maxTempExcursion; pMaxFaultTime = maxHeatingFaultTime; }
GCodeResult SetFaultDetectionParameters(float pMaxTempExcursion, float pMaxFaultTime, const StringRef& reply);
float GetHighestTemperatureLimit() const; // Get the highest temperature limit
float GetLowestTemperatureLimit() const; // Get the lowest temperature limit
void SetHeaterProtection(HeaterProtection *h);
const FopDt& GetModel() const { return model; } // Get the process model
GCodeResult SetModel(float gain, float tc, float td, float maxPwm, float voltage, bool usePid, bool inverted, const StringRef& reply); // Set the process model
void SetModelDefaults();
bool IsHeaterEnabled() const // Is this heater enabled?
{ return model.IsEnabled(); }
void SetM301PidParameters(const M301PidParameters& params)
{ model.SetM301PidParameters(params); }
bool CheckGood() const;
protected:
enum class HeaterMode : uint8_t
{
// The order of these is important because we test "mode > HeatingMode::suspended" to determine whether the heater is active
// and "mode >= HeatingMode::off" to determine whether the heater is either active or suspended
fault,
offline,
off,
suspended,
heating,
cooling,
stable,
// All states from here onwards must be PID tuning states because function IsTuning assumes that
tuning0,
tuning1,
tuning2,
tuning3,
lastTuningMode = tuning3
};
virtual void ResetHeater() = 0;
virtual HeaterMode GetMode() const = 0;
virtual GCodeResult SwitchOn(const StringRef& reply) = 0;
virtual GCodeResult UpdateModel(const StringRef& reply) = 0;
virtual GCodeResult UpdateFaultDetectionParameters(const StringRef& reply) = 0;
int GetSensorNumber() const { return sensorNumber; }
void SetSensorNumber(int sn) { sensorNumber = sn; }
float GetMaxTemperatureExcursion() const { return maxTempExcursion; }
float GetMaxHeatingFaultTime() const { return maxHeatingFaultTime; }
float GetTargetTemperature() const { return (active) ? activeTemperature : standbyTemperature; }
HeaterProtection *GetHeaterProtections() const { return heaterProtection; }
FopDt model;
private:
bool CheckProtection() const; // Check heater protection elements and return true if everything is good
unsigned int heaterNumber;
int sensorNumber; // the sensor number used by this heater
float activeTemperature; // The required active temperature
float standbyTemperature; // The required standby temperature
float maxTempExcursion; // The maximum temperature excursion permitted while maintaining the setpoint
float maxHeatingFaultTime; // How long a heater fault is permitted to persist before a heater fault is raised
HeaterProtection *heaterProtection; // The first element of assigned heater protection items
bool active; // Are we active or standby?
};
#endif /* SRC_HEATING_HEATER_H_ */
|
