Commit Graph

48 Commits

Author SHA1 Message Date
Thijs Triemstra 848a78d1a5
docs: Fix typos (#6032)
Signed-off-by: Thijs Triemstra <info@collab.nl>
2023-02-20 11:06:25 -05:00
Dmitry Butyugin 40702bf9db docs: Updated simulavr building instructions
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2022-01-26 18:02:24 -05:00
Kevin O'Connor fea30f8771 docs: Add a note on how to view the raw motan logs in Debugging.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-12-01 20:09:25 -05:00
Kevin O'Connor 44e2c630b3 docs: Update documentation with new klipper github URL
The main code repository moved from
https://github.com/KevinOConnor/klipper.git to
https://github.com/Klipper3d/klipper.git .

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-09-23 19:37:27 -04:00
Kevin O'Connor 59bd51d207 avrsim: Change default speed to 16Mhz and default baud to 250K
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-09-16 20:11:42 -04:00
Kevin O'Connor 1e4041a96b motan: Pass dataset parameters in parenthesis
Replace names like "trapq:toolhead:x" with "trapq(toolhead,x)".

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-30 12:12:01 -04:00
Kevin O'Connor 8e1929649f docs: Fix typo in Debugging.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-24 10:17:49 -04:00
Kevin O'Connor 7f704c4749 docs: Add information on motan scripts to Debugging.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-22 12:22:11 -04:00
Kevin O'Connor c3ab8fee90 docs: Reorder sections of Debugging.md
Reorder the sections to put most useful information at the top.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 12:49:48 -04:00
Damien cff61605fb docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top.

Signed-off-by: Damien Martin <damlobster@gmail.com>

Update CNAME
2021-07-27 13:15:25 -04:00
Kevin O'Connor 3c6eb376ac console: Make baud an optional parameter
Make the baud rate an optional parameter to the console.py tool.  When
not present, it will default to 250000.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-02 11:38:50 -05:00
Kevin O'Connor 7ad36a2164 github: Run continuous integration tests using "github actions"
Use "github actions" instead of "travis ci" for the automatic build
regression tests.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-10-30 15:23:42 -04:00
Kevin O'Connor 982567a69a config: Rename avrsim.cfg to generic-simulavr.cfg
Rename the file to be more similar to the naming of other files.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-11-24 20:21:13 -05:00
Kevin O'Connor d9bddc35a1 docs: Add information on running the regression suite locally
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-06-23 17:59:23 -04:00
Kevin O'Connor 8cce3cc8e7 graphstats: Add support for interactive graphs
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-06-19 21:12:26 -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 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
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 805e56008f docs: Note command dispatch benchmark needs desktop class machine
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-11 16:35:03 -05:00
Florian Heilmann 607461f7b6 docs: Update duet2 benchmarks
Signed-off-by: Florian Heilmann <Florian.Heilmann@gmx.net>
2019-02-10 17:59:40 -05:00
Kevin O'Connor 32e0d4d3ac docs: Update atsam benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-07 13:24:03 -05:00
Kevin O'Connor 1f9208dc66 docs: Update benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-06 22:08:39 -05:00
Kevin O'Connor c3e889a67c docs: Add performance results for SAMD51
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-28 20:05:50 -05:00
Kevin O'Connor 8c5a94f49f docs: Sort command dispatch table by transfer rate
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-20 14:17:08 -05:00
Kevin O'Connor f0ac5c378f docs: Update Debugging document with SAM3X8E usb transfer benchmark
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-20 00:57:48 -05:00
Kevin O'Connor 549e682069 docs: Add sam4s8c benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-07 19:43:56 -05:00
Kevin O'Connor cd1e669306 docs: Fix typo in command dispatch benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-11-16 20:38:30 -05:00
Kevin O'Connor 64a1837fec docs: Round pru command parsing benchmark
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-11-16 20:31:41 -05:00
Kevin O'Connor c349863988 docs: Add information on command parsing benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-11-16 20:21:05 -05:00
Kevin O'Connor 52fa91fb9a docs: Update benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-11-16 18:59:55 -05:00
Kevin O'Connor ca04caa42c docs: Fix SAM4E8E benchmark test revision
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-10-22 11:21:43 -04:00
Kevin O'Connor 2b81b2935c docs: Update SAM4E8E benchmarks
New benchmark numbers reported by @FHeilmann.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-10-22 11:18:55 -04:00
Kevin O'Connor 530a37196c docs: Update LPC176x benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-10-18 09:55:02 -04:00
Kevin O'Connor f5c99c1dec docs: Update benchmarks for Arduino Due
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-10-13 11:57:13 -04:00
Kevin O'Connor aa693fbdc1 docs: Updates to stm32f103 benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-10-11 10:57:24 -04:00
Florian Heilmann a8a912fbb5 docs: Update sam4e8e docs and benchmarks (#562)
Signed-off-by: Florian Heilmann <Florian.Heilmann@gmx.net>
2018-08-22 19:17:43 -04:00
Kevin O'Connor 71063fe500 docs: Warn about possible pin conflicts in benchmarks
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-08-08 13:52:08 -04:00
Kevin O'Connor cbf019a468 docs: It's difficult to estimate real-world usage from the benchmarks
Remove the prediction on real-world usage as it's not really practical
to make a prediction.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-08-08 13:39:29 -04:00
Kevin O'Connor fbec3ebb63 docs: Add benchmarking details to docs/Debugging.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-08-08 13:28:08 -04:00
Kevin O'Connor f1222565b8 docs: Update Debugging.md with information on logextract
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-01-11 13:48:40 -05:00
Kevin O'Connor 3af87e1c42 avr: Add SIMULAVR build option; don't show WATCHDOG or SERIAL_BAUD_U2X
Add a CONFIG_SIMULAVR option to the Kbuild menus and don't directly
prompt users for CONFIG_WATCHDOG or CONFIG_SERIAL_BAUD_U2X.  The only
reason to disable these options would be if one were running on
simulavr.  This simplifies the user visible menu options.

Also, only show CONFIG_CLEAR_PRESCALER for at90usb1286 chips.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-05-28 11:04:59 -04:00
Kevin O'Connor c1c0b2dd38 docs: Avoid using "firmware" in the documentation
The term "firmware" is ambiguous - it could refer to the entire
project (host and micro-controller software) or to just the
micro-controller software.  Avoid the term in the documentation.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-27 15:59:33 -04:00
Kevin O'Connor a7b4d70cc6 docs: Add documentation on how to run the graphstats.py script
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-11 13:41:11 -04:00
Kevin O'Connor 050008f3c8 docs: Update Debugging.md file with python virtual env setup
Direct readers to the main Installation file to setup the python
virtual environment and remove the outdated instructions in the
Debugging file.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-11 12:49:12 -04:00
Kevin O'Connor 06dbc40f53 docs: Describe running Klippy in batch mode for debugging
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2016-09-10 20:49:25 -04:00
Kevin O'Connor bb3b881e21 docs: Change the debugging docs to recommend a serial baud rate of 250000
A baud of 250000 is a better choice for production use.  It's better
to test with that rate also.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2016-06-13 15:34:23 -04:00
Kevin O'Connor f582a36e4d Initial commit of source code.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2016-05-25 11:37:40 -04:00