diff options
author | Kevin O'Connor <kevin@koconnor.net> | 2020-12-05 18:14:01 -0500 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2020-12-05 18:16:20 -0500 |
commit | 654cbeb286fdb954cd07304de025aa6470ce68f2 (patch) | |
tree | c4d4eea076ed778d3d10089d93c936175f7951b4 /docs/Config_Reference.md | |
parent | fc8ac8fe25aa9c2094c56a6a89b7c01b8dbe7afe (diff) | |
download | kutter-654cbeb286fdb954cd07304de025aa6470ce68f2.tar.gz kutter-654cbeb286fdb954cd07304de025aa6470ce68f2.tar.xz kutter-654cbeb286fdb954cd07304de025aa6470ce68f2.zip |
docs: Group temperature sensors together in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r-- | docs/Config_Reference.md | 315 |
1 files changed, 155 insertions, 160 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index 49b1915f..7017df32 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -600,9 +600,8 @@ sensor_type: # Type of sensor - common thermistors are "EPCOS 100K B57560G104F", # "ATC Semitec 104GT-2", "NTC 100K beta 3950", "Honeywell 100K # 135-104LAG-J01", "NTC 100K MGB18-104F39050L32", "SliceEngineering -# 450", and "TDK NTCG104LH104JT1". See the "Heaters and temperature -# sensors" section for other sensors. This parameter must be -# provided. +# 450", and "TDK NTCG104LH104JT1". See the "Temperature sensors" +# section for other sensors. This parameter must be provided. sensor_pin: # Analog input pin connected to the sensor. This parameter must be # provided. @@ -610,11 +609,6 @@ sensor_pin: # The resistance (in ohms) of the pullup attached to the thermistor. # This parameter is only valid when the sensor is a thermistor. The # default is 4700 ohms. -#inline_resistor: 0 -# The resistance (in ohms) of an extra (not heat varying) resistor -# that is placed inline with the thermistor. It is rare to set this. -# This parameter is only valid when the sensor is a thermistor. The -# default is 0 ohms. #smooth_time: 2.0 # A time value (in seconds) over which temperature measurements will # be smoothed to reduce the impact of measurement noise. The default @@ -1738,7 +1732,7 @@ normal printer kinematics. # MANUAL_STEPPER movement commands. ``` -# Heaters and temperature sensors +# Custom heaters and sensors ## [verify_heater] @@ -1795,84 +1789,6 @@ Tool to disable heaters when homing or probing an axis. # Typical example: extruder, heater_bed ``` -## MAXxxxxx temperature sensors - -MAXxxxxx serial peripheral interface (SPI) temperature based -sensors. The following parameters are available in heater sections -that use one of these sensor types. - -``` -#[extruder] -# See the "extruder" section for a description of heater parameters. -# The parameters below describe sensor parameters. -#sensor_type: -# One of "MAX6675", "MAX31855", "MAX31856", or "MAX31865". -#spi_speed: 4000000 -# The SPI speed (in hz) to use when communicating with the chip. -# The default is 4000000. -#spi_bus: -#spi_software_sclk_pin: -#spi_software_mosi_pin: -#spi_software_miso_pin: -# These optional parameters allow one to customize the SPI settings -# used to communicate with the chip. -#sensor_pin: -# The chip select line for the sensor chip. This parameter must be -# provided. -#tc_type: K -#tc_use_50Hz_filter: False -#tc_averaging_count: 1 -# The above parameters control the sensor parameters of MAX31856 -# chips. The defaults for each parameter are next to the parameter -# name in the above list. -#rtd_nominal_r: 100 -#rtd_reference_r: 430 -#rtd_num_of_wires: 2 -#rtd_use_50Hz_filter: False -# The above parameters control the sensor parameters of MAX31865 -# chips. The defaults for each parameter are next to the parameter -# name in the above list. -``` - -## Common temperature amplifiers - -Common temperature amplifiers. The following parameters are available -in heater sections that use one of these sensors. - -``` -#[extruder] -# See the "extruder" section for a description of heater parameters. -# The parameters below describe sensor parameters. -#sensor_type: -# One of "PT100 INA826", "AD595", "AD597", "AD8494", "AD8495", -# "AD8496", or "AD8497". -#sensor_pin: -# Analog input pin connected to the sensor. This parameter must be -# provided. -#adc_voltage: 5.0 -# The ADC comparison voltage (in Volts). The default is 5 volts. -#voltage_offset: 0 -# The ADC voltage offset (in Volts). The default is 0. -``` - -## Directly connected PT1000 sensor - -Directly connected PT1000 sensor. The following parameters are -available in heater sections that use one of these sensors. - -``` -#[extruder] -# See the "extruder" section for a description of heater parameters. -# The parameters below describe sensor parameters. -#sensor_type: PT1000 -#sensor_pin: -# Analog input pin connected to the sensor. This parameter must be -# provided. -#pullup_resistor: 4700 -# The resistance (in ohms) of the pullup attached to the sensor. The -# default is 4700 ohms. -``` - ## [thermistor] Custom thermistors (one may define any number of sections with a @@ -1941,6 +1857,152 @@ section. # least two measurements must be provided. ``` +## [heater_generic] + +Generic heaters (one may define any number of sections with a +"heater_generic" prefix). These heaters behave similarly to standard +heaters (extruders, heated beds). Use the SET_HEATER_TEMPERATURE +command (see [G-Codes](G-Codes.md) for details) to set the target +temperature. + +``` +[heater_generic my_generic_heater] +#gcode_id: +# The id to use when reporting the temperature in the M105 command. +# This parameter must be provided. +#heater_pin: +#max_power: +#sensor_type: +#sensor_pin: +#smooth_time: +#control: +#pid_Kp: +#pid_Ki: +#pid_Kd: +#pid_integral_max: +#pwm_cycle_time: +#min_temp: +#max_temp: +# See the "extruder" section for the definition of the above +# parameters. +``` + +## [temperature_sensor] + +Generic temperature sensors. One can define any number of additional +temperature sensors that are reported via the M105 command. + +``` +[temperature_sensor my_sensor] +#sensor_type: +#sensor_pin: +#min_temp: +#max_temp: +# See the "extruder" section for the definition of the above +# parameters. +#gcode_id: +# See the "heater_generic" section for the definition of this +# parameter. +``` + +# Temperature sensors + +Klipper includes definitions for many types of temperature sensors. +These sensors may be used in any config section that requires a +temperature sensor (such as an `[extruder]` or `[heated_bed]` +section). + +## Common thermistors + +``` +sensor_type: +# One of "EPCOS 100K B57560G104F", "ATC Semitec 104GT-2", +# "NTC 100K beta 3950", "Honeywell 100K 135-104LAG-J01", +# "NTC 100K MGB18-104F39050L32", "SliceEngineering 450", or +# "TDK NTCG104LH104JT1" +sensor_pin: +# Analog input pin connected to the sensor. This parameter must be +# provided. +#pullup_resistor: 4700 +# The resistance (in ohms) of the pullup attached to the thermistor. +# This parameter is only valid when the sensor is a thermistor. The +# default is 4700 ohms. +#inline_resistor: 0 +# The resistance (in ohms) of an extra (not heat varying) resistor +# that is placed inline with the thermistor. It is rare to set this. +# This parameter is only valid when the sensor is a thermistor. The +# default is 0 ohms. +``` + +## Common temperature amplifiers + +Common temperature amplifiers. The following parameters are available +in heater sections that use one of these sensors. + +``` +sensor_type: +# One of "PT100 INA826", "AD595", "AD597", "AD8494", "AD8495", +# "AD8496", or "AD8497". +sensor_pin: +# Analog input pin connected to the sensor. This parameter must be +# provided. +#adc_voltage: 5.0 +# The ADC comparison voltage (in Volts). The default is 5 volts. +#voltage_offset: 0 +# The ADC voltage offset (in Volts). The default is 0. +``` + +## Directly connected PT1000 sensor + +Directly connected PT1000 sensor. The following parameters are +available in heater sections that use one of these sensors. + +``` +sensor_type: PT1000 +sensor_pin: +# Analog input pin connected to the sensor. This parameter must be +# provided. +#pullup_resistor: 4700 +# The resistance (in ohms) of the pullup attached to the sensor. The +# default is 4700 ohms. +``` + +## MAXxxxxx temperature sensors + +MAXxxxxx serial peripheral interface (SPI) temperature based +sensors. The following parameters are available in heater sections +that use one of these sensor types. + +``` +sensor_type: +# One of "MAX6675", "MAX31855", "MAX31856", or "MAX31865". +sensor_pin: +# The chip select line for the sensor chip. This parameter must be +# provided. +#spi_speed: 4000000 +# The SPI speed (in hz) to use when communicating with the chip. +# The default is 4000000. +#spi_bus: +#spi_software_sclk_pin: +#spi_software_mosi_pin: +#spi_software_miso_pin: +# These optional parameters allow one to customize the SPI settings +# used to communicate with the chip. +#tc_type: K +#tc_use_50Hz_filter: False +#tc_averaging_count: 1 +# The above parameters control the sensor parameters of MAX31856 +# chips. The defaults for each parameter are next to the parameter +# name in the above list. +#rtd_nominal_r: 100 +#rtd_reference_r: 430 +#rtd_num_of_wires: 2 +#rtd_use_50Hz_filter: False +# The above parameters control the sensor parameters of MAX31865 +# chips. The defaults for each parameter are next to the parameter +# name in the above list. +``` + ## bme280 temperature sensor BME280 two wire interface (I2C) environmental sensor. Note that this @@ -1952,11 +2014,7 @@ that may be used to report pressure and humidity in addition to temperature. ``` -#[temperature_sensor my_sensor] -# See the "temperature_sensor" section for a description of its -# parameters. The parameters below describe BME280 sensor parameters. -#sensor_type: -# Must be "BME280" +sensor_type: bme280 #i2c_address: # Default is 118 (0x76). Some BME280 sensors have an address of 119 # (0x77). @@ -1981,11 +2039,7 @@ gcode_macro that may be used to report humidity in addition to temperature. ``` -#[temperature_sensor my_sensor] -# See the "temperature_sensor" section for a description of its -# parameters. The parameters below describe HTU21D family sensor -# parameters. -#sensor_type: +sensor_type: # Must be "HTU21D" , "SI7013", "SI7020", "SI7021" or "SHT21" #i2c_address: # Default is 64 (0x40). @@ -2018,16 +2072,10 @@ temperature. LM75/LM75A two wire (I2C) connected temperature sensors. These sensors have range up to 125 C, so are usable for e.g. chamber temperature -monitoring. They can also function as simple fan/heater controllers -but this mode is not used here. +monitoring. They can also function as simple fan/heater controllers. ``` -#[temperature_sensor my_sensor] -# See the "temperature_sensor" section for a description of its -# parameters. The parameters below describe LM75 family sensor -# parameters. -#sensor_type: -# Must be "LM75". +sensor_type: lm75 #i2c_address: # Default is 72 (0x48). Normal range is 72-79 (0x48-0x4F) and the 3 # low bits of the address are configured via pins on the chip @@ -2048,63 +2096,10 @@ but this mode is not used here. ## RPi temperature sensor -CPU temperature from Raspberry Pi. +CPU temperature from the Raspberry Pi running the host software. ``` -#[temperature_sensor my_sensor] -# See the "temperature_sensor" section for a description of its -# parameters. The parameters below describe the Raspberry Pi sensor -# parameters. -#sensor_type: -# Must be "rpi_temperature". -``` - -## [heater_generic] - -Generic heaters (one may define any number of sections with a -"heater_generic" prefix). These heaters behave similarly to standard -heaters (extruders, heated beds). Use the SET_HEATER_TEMPERATURE -command (see [G-Codes](G-Codes.md) for details) to set the target -temperature. - -``` -[heater_generic my_generic_heater] -#gcode_id: -# The id to use when reporting the temperature in the M105 command. -# This parameter must be provided. -#heater_pin: -#max_power: -#sensor_type: -#sensor_pin: -#smooth_time: -#control: -#pid_Kp: -#pid_Ki: -#pid_Kd: -#pid_integral_max: -#pwm_cycle_time: -#min_temp: -#max_temp: -# See the "extruder" section for the definition of the above -# parameters. -``` - -## [temperature_sensor] - -Generic temperature sensors. One can define any number of additional -temperature sensors that are reported via the M105 command. - -``` -[temperature_sensor my_sensor] -#sensor_type: -#sensor_pin: -#min_temp: -#max_temp: -# See the "extruder" section for the definition of the above -# parameters. -#gcode_id: -# See the "heater_generic" section for the definition of this -# parameter. +sensor_type: rpi_temperature ``` # Fans |