Commit Graph

351 Commits

Author SHA1 Message Date
Kevin O'Connor 6f34ba59cb docs: Add an index page for the www.klipper3d.org website
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-16 22:00:35 -04:00
Kevin O'Connor 4739e28137 docs: Add a github pages html template
Add an html template so that each page has a navbar at the top and a
sidebar on the left with an auto-generated table of contents.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-16 20:55:41 -04:00
Kevin O'Connor 64e7235e48 docs: Rewrite the Overview.md - just list documents by category
Replace the Overview.md document description with a list of documents
and a brief description of their contents.  The goal is to make it
easier for users to find information.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-16 20:45:00 -04:00
Kevin O'Connor cb04e4c45d docs: Fix alignment of tmc2208.svg
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-16 11:34:45 -04:00
Kevin O'Connor c440c6b7aa docs: Start of google pages _config.yml file
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-15 11:04:23 -04:00
Kevin O'Connor e3df39245f docs: Fixup github pages
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-14 22:41:23 -04:00
KevinOConnor 8a6d415745 Update CNAME 2019-04-14 21:25:54 -04:00
KevinOConnor b90a04a5cf Create CNAME 2019-04-14 21:21:14 -04:00
KevinOConnor 63f8d8cc79 Set theme jekyll-theme-leap-day 2019-04-14 21:17:52 -04:00
Kevin O'Connor 8bc9f39c58 docs: Avoid using .. in markdown links
Using .. in the markdown link can confuse some document processors.
Use an absolute link to github instead.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-14 21:12:21 -04:00
Kevin O'Connor 04adde9a02 docs: Update Installation.md to point to list of supported ARM mcus
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-06 18:47:02 -04:00
Kevin O'Connor de124677b0 docs: Update BLTouch.md to refer to Probe_Calibrate.md for offset config
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-05 18:22:57 -04:00
Kevin O'Connor 9f9262cba8 docs: Minor wording changes to BLTouch.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-05 18:20:21 -04:00
Kevin O'Connor 54a2c5d58e BLTouch: Use G90 in the BLTouch.md homing_override example
Reported by @sgtnoodle.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-05 17:49:58 -04:00
Kevin O'Connor a5a6ae83ff docs: Wrap BLTouch.md to 80 columns.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-05 17:48:51 -04:00
Kevin O'Connor 6318bdc99b docs: Note the python software dependency update in Config_Changes.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-05 11:20:36 -04:00
Kevin O'Connor 0615ab5f89 docs: Note the use of bus enumerations in Config_Changes.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-04 18:30:04 -04:00
Kevin O'Connor be6b29fabf sx1509: Convert code to use generic i2c bus support
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-04 18:29:30 -04:00
Kevin O'Connor 9bd3e80421 docs: Note that graphstats.py can produce different types of graphs
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-01 22:24:45 -04:00
Kevin O'Connor 2980c2e12c docs: Minor wording change in MCU_Commands.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-01 22:04:56 -04:00
Kevin O'Connor c30a6f2e6b docs: Update Protocol documentation with enumerations
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-01 21:41:33 -04:00
Eugene Krashtan b35e07ca2b docs: STM32F0 benchmarks (#1462)
Signed-off-by: Eugene Krashtan <eug.krashtan@gmail.com>
2019-03-29 09:38:54 -04:00
Douglas Hammond c105adc80b temperature_fan: Fix. Temperature fan min speed should be used (#1405)
Signed-off-by: Douglas Hammond <wizhippo@gmail.com>
2019-03-28 14:07:40 -04:00
Eugene Krashtan c7330e07a4 stm32f0: Various fixes according to comment: (#1453)
* Copyright in log.c
* GPIO check completely removed
* generic/timer_irq added
* Change in doc section

Signed-off-by: Eugene Krashtan <eug.krashtan@gmail.com>
2019-03-28 10:21:51 -04:00
Kevin O'Connor 312cabc3f7 docs: Move benchmark information from Debugging.md to new Benchmarks.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-28 09:52:06 -04:00
Kevin O'Connor de7444ca69 docs: Remove spurious executable flag from documents
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-24 12:17:12 -04:00
Eugene Krashtan b79db3e3d6 docs: Documentation draft for STM32F0
Signed-off-by: Eugene Krashtan <Eugene.Krashtan@opensynergy.com>
2019-03-24 12:10:11 -04:00
Kevin O'Connor 9aadc3c7fa docs: Also note that driver_VSENSE was removed from tmc2660 driver
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-22 22:40:42 -04:00
Kevin O'Connor efab177645 docs: Note tmc2660 driver_HEND default change from 6 to 3
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-22 20:41:32 -04:00
amblidex 0980b7e4ec tmc2130: add SET_TMC_CURRENT and SET_TMC_FIELD commands (#1419)
Signed-off-by: Frank Kang <amblidex@outlook.com>
2019-03-22 20:37:03 -04:00
Frank Kang 06c0463d44 Update sensorless homing documentation to disable second home
Signed-off-by: Frank Kang <amblidex@outlook.com>
2019-03-19 10:55:59 -04:00
Kevin O'Connor b28e95ca1a command: Always pass a string to the DECL_CONSTANT() macro
Make it clear that the name of the constant being defined is a string.
When the value being defined is also a string, use a new
DECL_CONSTANT_STR() macro.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-17 19:38:18 -04:00
Kevin O'Connor 12f6513ba2 docs: Recommend OctoPi v0.16.0
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-11 22:13:04 -04:00
Kevin O'Connor 96c4e1c5a0 docs: Update atsam usb transfer benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-10 21:59:18 -04:00
Kevin O'Connor d3f6dad853 controller_fan: Allow multiple controller_fan sections to be defined
It may be necessary to define multiple fans, so allow each config
section to be named.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-10 13:57:01 -04:00
Rui Caridade 5c0a2479be screws_tilt_adjust: Add new screws_tilt_adjust tool (#1367)
Signed-off-by: Rui Caridade <rui.mcbc@gmail.com>
2019-03-08 11:47:17 -05:00
Kevin O'Connor 563bc37073 tmc2130: Rename driver_BLANK_TIME_SELECT to driver_TBL
Use the field names from the trinamic specification.  This makes the
field similar to all the other driver_XXX config options.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-08 11:25:19 -05:00
Kevin O'Connor 89935c6831 docs: Update Config_Changes.md with tmc2660 changes
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-08 11:08:24 -05:00
Florian Heilmann 789379e95b tmc2660: Add INIT_TMC and SET_TMC_FIELD gcodes
Signed-off-by: Florian Heilmann <Florian.Heilmann@gmx.net>
2019-03-08 11:04:14 -05:00
Kevin O'Connor d62a41b930 manual_stepper: Add support for moves with acceleration
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-03 13:38:10 -05:00
Arksine 69491e2dab filament_switch_sensor: update documentation
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2019-03-01 00:45:51 -05:00
Kevin O'Connor c8d7e28a35 atsamd: Add support for programming SERCOM pins
Signed-off-by: Florian Heilmann <Florian.Heilmann@gmx.net>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-01 00:40:44 -05:00
Kevin O'Connor c039b33f2a tmc2130: Add support for INIT_TMC command
Signed-off-by: Frank Kang <amblidex@outlook.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-03-01 00:24:39 -05:00
Kevin O'Connor b40a04fb8d docs: Update Installation document to emphasize the "stay connected" step
Move the OctoPrint "stay connected" during error configuration step to
its own paragraph. Hopefully this will make it less likely that users
skip this step.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-27 20:03:44 -05:00
Kevin O'Connor 88ebedcc63 docs: Update Installation document to suggest using /dev/serial/by-id/
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-27 19:58:09 -05:00
Arksine f7d8854587 bed_mesh: simplify configuration
The 'bed_shape' option has been removed.  The user will enter a 'bed_radius' if they have a round be, otherwise they should enter 'min_point' and 'max_point'.  When the bed is round the user should supply a 'round_probe_count' option, otherwise just 'probe_count'.

Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2019-02-25 13:34:14 -05:00
Kevin O'Connor 31987c7bcd docs: Add a Manual_Probe.md document
Add information on calibrating the bed on traditional printers with a
Z endstop and bed screws.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-24 00:49:47 -05:00
Kevin O'Connor 80c8bd8b4d bed_screws: Add a helper tool for leveling bed screws
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-24 00:49:47 -05:00
Kevin O'Connor 328bd89fc1 docs: Warn against using the TMC2208 in standalone mode
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-20 16:22:06 -05:00
Rui Caridade 276d5a1436 probe: Add PROBE_ACCURACY command
Implementation of "PROBE_ACCURACY" to measure the maximum, minimum,
average and standard deviation of a probe.

Signed-off-by: Rui Caridade <rui.mcbc@gmail.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-18 00:36:28 -05:00