From 731c042968f47223dca8079c5f78029308bcc424 Mon Sep 17 00:00:00 2001 From: rusefi Date: Sat, 18 Apr 2020 21:23:35 -0400 Subject: [PATCH] debug mode progress and etc --- Debug_Mode.md | 6 ++++++ ...ocumentation_Strategy.md => Documentation_Strategy.md | 0 ...ocumentation_Workflow.md => Documentation_Workflow.md | 9 ++++++--- FAQ/HOWTO_electronic_throttle_body_configuration.md | 2 +- FAQ/HOWTO_quick_start.md => HOWTO_quick_start.md | 0 5 files changed, 13 insertions(+), 4 deletions(-) create mode 100644 Debug_Mode.md rename Special/Documentation_Strategy.md => Documentation_Strategy.md (100%) rename Special/Documentation_Workflow.md => Documentation_Workflow.md (87%) rename FAQ/HOWTO_quick_start.md => HOWTO_quick_start.md (100%) diff --git a/Debug_Mode.md b/Debug_Mode.md new file mode 100644 index 0000000..14e98dd --- /dev/null +++ b/Debug_Mode.md @@ -0,0 +1,6 @@ +Debug fields is an advanced troubleshooting feature allowing one to monitor internal state of some rusEfi subsystems. + +In TunerStudio, select "Base Engine Settings -> Debug Mode" and use gauges from "Debug" category. + + +See https://rusefi.com/wiki/index.php?title=Manual:Debug_fields \ No newline at end of file diff --git a/Special/Documentation_Strategy.md b/Documentation_Strategy.md similarity index 100% rename from Special/Documentation_Strategy.md rename to Documentation_Strategy.md diff --git a/Special/Documentation_Workflow.md b/Documentation_Workflow.md similarity index 87% rename from Special/Documentation_Workflow.md rename to Documentation_Workflow.md index 0e35aa0..d1f015a 100644 --- a/Special/Documentation_Workflow.md +++ b/Documentation_Workflow.md @@ -8,9 +8,9 @@ Jenkins automation merges all changes from technical git into https://github.com For example, in order for user abelom to edit this page: -1) abelom would start editing at https://github.com/rusefi/rusefi_documentation/blob/master/Special/Documentation_Workflow.md which would automatically create a branch in https://github.com/abelom/rusefi_documentation fork +1) abelom would start editing at https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md which would automatically create a branch in https://github.com/abelom/rusefi_documentation fork 1) once changed are made, abelom would create a Pull Request -3) once that PR is merged into primary rusEfi modified content would appear as https://github.com/rusefi/rusefi_documentation/blob/master/Special/Documentation_Workflow.md +3) once that PR is merged into primary rusEfi modified content would appear as https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md 4) within the next 5 minutes automation would sync this page into wiki git and it would be available with nicer layout as https://github.com/rusefi/rusefi/wiki/Documentation_Workflow Same but in different terms: @@ -28,7 +28,10 @@ A: We have images in the same repository! Just add your images while editing pag For example https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/images/TunerStudio_new_project.png is visible on /wiki/ as https://raw.githubusercontent.com/wiki/rusefi/rusefi/FAQ/images/TunerStudio_new_project.png +Long story short, for images to work good both in technical git and user-facing wiki, we place all .md files into the same root folder. + +(More deteils: Please note that all .md files like https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/HOWTO_quick_start.md are displayed without folder name like https://github.com/rusefi/rusefi/wiki/HOWTO_quick_start which also means that you need full image path like ``FAQ/images/rusEfi_console/rusEfi_console_start_screen.png`` for image to be rendered properly. This is one of github wiki features which are a bit counter-intuitive to me. -This also means that .md file names have to be unique for the whole. \ No newline at end of file +This also means that .md file names have to be unique for the whole.) \ No newline at end of file diff --git a/FAQ/HOWTO_electronic_throttle_body_configuration.md b/FAQ/HOWTO_electronic_throttle_body_configuration.md index 9ec581e..680c3b6 100644 --- a/FAQ/HOWTO_electronic_throttle_body_configuration.md +++ b/FAQ/HOWTO_electronic_throttle_body_configuration.md @@ -43,7 +43,7 @@ rusEfi has auto-tuning software that can help generate a starting point for your ### _Ensure the engine is off! Do not attempt to start the engine during this process!_ 1. Ensure your electronic throttle roughly tracks the target position. It doesn't have to be perfect or super fast, but it should at least work. Confirm this by checking that the gauge "ETB position error" displays small values while moving the throttle around gently (a few percent is fine, so long as it trends towards zero if you stop moving). -2. Set debug mode to ETB autotune and add gauges Ku, Tu, Kp, Ki, Kd (in debug menu) (todo: add screenshot) +2. Set [debug mode](Debug_Mode) to ETB autotune and add gauges Ku, Tu, Kp, Ki, Kd (in debug menu) (todo: add screenshot) 3. Using the accelerator pedal, hold the throttle at approximately 50% open. 4. Press `ETB PID Autotune` button. The throttle will begin oscillating around the target: this is normal. 5. Observe the estimated PID parameters on gauges Kp, Ki, Kd diff --git a/FAQ/HOWTO_quick_start.md b/HOWTO_quick_start.md similarity index 100% rename from FAQ/HOWTO_quick_start.md rename to HOWTO_quick_start.md