aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlan Lord <alanslists@gmail.com>2021-02-02 19:34:56 +0000
committerGitHub <noreply@github.com>2021-02-02 14:34:56 -0500
commit7d4df659203269452c722c6e029fbc71e2488db7 (patch)
treed302a7cb6aeea9b799c978d8916e283dbfc7ab40 /docs
parent19397a0a2b5997d74b8aada1596310a3f383c626 (diff)
downloadkutter-7d4df659203269452c722c6e029fbc71e2488db7.tar.gz
kutter-7d4df659203269452c722c6e029fbc71e2488db7.tar.xz
kutter-7d4df659203269452c722c6e029fbc71e2488db7.zip
ds18b20: new module for 1-wire temperature sensor (#3462)
Initial commit of code to support 1-wire (Dallas) sensors such as the DS18B20. Requires Linux kernel drivers to create a file in /sysfs which is read by this module, and temperature typically returned to a temperature_fan. Signed-off-by: Alan Lord <alanslists@gmail.com> Signed-off-by: Josh Headapohl <joshhead@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Reference.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 19fc82a2..57fbe3df 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -2153,6 +2153,23 @@ CPU temperature from the Raspberry Pi running the host software.
sensor_type: rpi_temperature
```
+## DS18B20 temperature sensor
+
+DS18B20 is a 1-wire (w1) digital temperature sensor. Note that this sensor is not intended for use with extruders and heater beds, but rather for monitoring ambient temperature (C). 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. DS18B20 sensors are only supported on the "host mcu", e.g. the Raspberry Pi. The w1-gpio Linux kernel module must be installed.
+
+```
+sensor_type: DS18B20
+serial_no:
+# Each 1-wire device has a unique serial number used to identify the device,
+# usually in the format 28-031674b175ff. This parameter must be provided.
+# Attached 1-wire devices can be listed using the following Linux command:
+# ls /sys/bus/w1/devices/
+#ds18_report_time:
+# Interval in seconds between readings. Default is 3.0, with a minimum of 1.0
+#sensor_mcu:
+# The micro-controller to read from. Must be the host_mcu
+```
+
# Fans
## [fan]