docs: Group temperature sensors together in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor
parent
fc8ac8fe25
commit
654cbeb286
|
|
@ -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,124 +1857,6 @@ section.
|
|||
# least two measurements must be provided.
|
||||
```
|
||||
|
||||
## bme280 temperature sensor
|
||||
|
||||
BME280 two wire interface (I2C) environmental sensor. Note that this
|
||||
sensor is not intended for use with extruders and heater beds, but
|
||||
rather for monitoring ambient temperature (C), pressure (hPa), and
|
||||
relative humidity. See
|
||||
[sample-macros.cfg](../config/sample-macros.cfg) for a gcode_macro
|
||||
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"
|
||||
#i2c_address:
|
||||
# Default is 118 (0x76). Some BME280 sensors have an address of 119
|
||||
# (0x77).
|
||||
#i2c_mcu:
|
||||
# MCU the sensor is connected to. Default is the primary mcu.
|
||||
#i2c_bus:
|
||||
# The I2C bus the sensor is connected to. On some MCU platforms the
|
||||
# default is bus 0. On platforms without bus 0 this parameter is
|
||||
# required.
|
||||
#i2c_speed:
|
||||
# The I2C speed (in Hz) to use when communicating with the sensor.
|
||||
# Default is 100000. On some MCUs changing this value has no effect.
|
||||
```
|
||||
|
||||
## HTU21D sensor
|
||||
|
||||
HTU21D family two wire interface (I2C) environmental sensor. Note that
|
||||
this sensor is not intended for use with extruders and heater beds,
|
||||
but rather for monitoring ambient temperature (C) and relative
|
||||
humidity. See [sample-macros.cfg](../config/sample-macros.cfg) for a
|
||||
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:
|
||||
# Must be "HTU21D" , "SI7013", "SI7020", "SI7021" or "SHT21"
|
||||
#i2c_address:
|
||||
# Default is 64 (0x40).
|
||||
#i2c_mcu:
|
||||
# MCU the sensor is connected to. Default is the primary mcu.
|
||||
#i2c_bus:
|
||||
# The I2C bus the sensor is connected to. On some MCU platforms the
|
||||
# default is bus 0. On platforms without bus 0 this parameter is
|
||||
# required.
|
||||
#i2c_speed:
|
||||
# The I2C speed (in Hz) to use when communicating with the sensor.
|
||||
# Default is 100000. On some MCUs changing this value has no effect.
|
||||
#htu21d_hold_master:
|
||||
# If the sensor can hold the I2C buf while reading. If True no other
|
||||
# bus communication can be performed while reading is in progress.
|
||||
# Default is False.
|
||||
#htu21d_resolution:
|
||||
# The resolution of temperature and humidity reading.
|
||||
# Valid values are:
|
||||
# 'TEMP14_HUM12' -> 14bit for Temp and 12bit for humidity
|
||||
# 'TEMP13_HUM10' -> 13bit for Temp and 10bit for humidity
|
||||
# 'TEMP12_HUM08' -> 12bit for Temp and 08bit for humidity
|
||||
# 'TEMP11_HUM11' -> 11bit for Temp and 11bit for humidity
|
||||
# Default is: "TEMP11_HUM11"
|
||||
#htu21d_report_time:
|
||||
# Interval in seconds between readings. Default is 30
|
||||
```
|
||||
|
||||
## LM75 temperature sensor
|
||||
|
||||
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.
|
||||
|
||||
```
|
||||
#[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".
|
||||
#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
|
||||
# (usually with jumpers or hard wired).
|
||||
#i2c_mcu:
|
||||
# MCU the sensor is connected to. Default is the primary mcu.
|
||||
#i2c_bus:
|
||||
# The I2C bus the sensor is connected to. On some MCU platforms the
|
||||
# default is bus 0. On platforms without bus 0 this parameter is
|
||||
# required.
|
||||
#i2c_speed:
|
||||
# The I2C speed (in Hz) to use when communicating with the sensor.
|
||||
# Default is 100000. On some MCUs changing this value has no effect.
|
||||
#lm75_report_time:
|
||||
# Interval in seconds between readings. Default is 0.8, with minimum
|
||||
# 0.5.
|
||||
```
|
||||
|
||||
## RPi temperature sensor
|
||||
|
||||
CPU temperature from Raspberry Pi.
|
||||
|
||||
```
|
||||
#[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
|
||||
|
|
@ -2107,6 +1905,203 @@ temperature sensors that are reported via the M105 command.
|
|||
# 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
|
||||
sensor is not intended for use with extruders and heater beds, but
|
||||
rather for monitoring ambient temperature (C), pressure (hPa), and
|
||||
relative humidity. See
|
||||
[sample-macros.cfg](../config/sample-macros.cfg) for a gcode_macro
|
||||
that may be used to report pressure and humidity in addition to
|
||||
temperature.
|
||||
|
||||
```
|
||||
sensor_type: bme280
|
||||
#i2c_address:
|
||||
# Default is 118 (0x76). Some BME280 sensors have an address of 119
|
||||
# (0x77).
|
||||
#i2c_mcu:
|
||||
# MCU the sensor is connected to. Default is the primary mcu.
|
||||
#i2c_bus:
|
||||
# The I2C bus the sensor is connected to. On some MCU platforms the
|
||||
# default is bus 0. On platforms without bus 0 this parameter is
|
||||
# required.
|
||||
#i2c_speed:
|
||||
# The I2C speed (in Hz) to use when communicating with the sensor.
|
||||
# Default is 100000. On some MCUs changing this value has no effect.
|
||||
```
|
||||
|
||||
## HTU21D sensor
|
||||
|
||||
HTU21D family two wire interface (I2C) environmental sensor. Note that
|
||||
this sensor is not intended for use with extruders and heater beds,
|
||||
but rather for monitoring ambient temperature (C) and relative
|
||||
humidity. See [sample-macros.cfg](../config/sample-macros.cfg) for a
|
||||
gcode_macro that may be used to report humidity in addition to
|
||||
temperature.
|
||||
|
||||
```
|
||||
sensor_type:
|
||||
# Must be "HTU21D" , "SI7013", "SI7020", "SI7021" or "SHT21"
|
||||
#i2c_address:
|
||||
# Default is 64 (0x40).
|
||||
#i2c_mcu:
|
||||
# MCU the sensor is connected to. Default is the primary mcu.
|
||||
#i2c_bus:
|
||||
# The I2C bus the sensor is connected to. On some MCU platforms the
|
||||
# default is bus 0. On platforms without bus 0 this parameter is
|
||||
# required.
|
||||
#i2c_speed:
|
||||
# The I2C speed (in Hz) to use when communicating with the sensor.
|
||||
# Default is 100000. On some MCUs changing this value has no effect.
|
||||
#htu21d_hold_master:
|
||||
# If the sensor can hold the I2C buf while reading. If True no other
|
||||
# bus communication can be performed while reading is in progress.
|
||||
# Default is False.
|
||||
#htu21d_resolution:
|
||||
# The resolution of temperature and humidity reading.
|
||||
# Valid values are:
|
||||
# 'TEMP14_HUM12' -> 14bit for Temp and 12bit for humidity
|
||||
# 'TEMP13_HUM10' -> 13bit for Temp and 10bit for humidity
|
||||
# 'TEMP12_HUM08' -> 12bit for Temp and 08bit for humidity
|
||||
# 'TEMP11_HUM11' -> 11bit for Temp and 11bit for humidity
|
||||
# Default is: "TEMP11_HUM11"
|
||||
#htu21d_report_time:
|
||||
# Interval in seconds between readings. Default is 30
|
||||
```
|
||||
|
||||
## LM75 temperature sensor
|
||||
|
||||
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.
|
||||
|
||||
```
|
||||
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
|
||||
# (usually with jumpers or hard wired).
|
||||
#i2c_mcu:
|
||||
# MCU the sensor is connected to. Default is the primary mcu.
|
||||
#i2c_bus:
|
||||
# The I2C bus the sensor is connected to. On some MCU platforms the
|
||||
# default is bus 0. On platforms without bus 0 this parameter is
|
||||
# required.
|
||||
#i2c_speed:
|
||||
# The I2C speed (in Hz) to use when communicating with the sensor.
|
||||
# Default is 100000. On some MCUs changing this value has no effect.
|
||||
#lm75_report_time:
|
||||
# Interval in seconds between readings. Default is 0.8, with minimum
|
||||
# 0.5.
|
||||
```
|
||||
|
||||
## RPi temperature sensor
|
||||
|
||||
CPU temperature from the Raspberry Pi running the host software.
|
||||
|
||||
```
|
||||
sensor_type: rpi_temperature
|
||||
```
|
||||
|
||||
# Fans
|
||||
|
||||
## [fan]
|
||||
|
|
|
|||
Loading…
Reference in New Issue