From 7b115ec81bca10ea029082597806aafb31253b3f Mon Sep 17 00:00:00 2001
From: Mathis Mensing <matmen@dreadful.tech>
Date: Fri, 18 Mar 2022 22:45:13 +0100
Subject: [PATCH] feat: adjustable toolhead move distances (#590)

Signed-off-by: Mathis Mensing <matmen@dreadful.tech>
Co-authored-by: Pedro Lamas <pedrolamas@gmail.com>
---
 src/components/settings/ToolheadSettings.vue  | 46 +++++++++++++-
 .../widgets/toolhead/ToolheadMoves.vue        | 61 +++++--------------
 src/locales/de.yaml                           |  1 +
 src/locales/en.yaml                           |  1 +
 src/store/config/index.ts                     |  1 +
 src/store/config/mutations.ts                 |  4 ++
 src/store/config/types.ts                     |  1 +
 7 files changed, 65 insertions(+), 50 deletions(-)

diff --git a/src/components/settings/ToolheadSettings.vue b/src/components/settings/ToolheadSettings.vue
index 723737b7e6..296a5e7d0a 100644
--- a/src/components/settings/ToolheadSettings.vue
+++ b/src/components/settings/ToolheadSettings.vue
@@ -85,8 +85,8 @@
       <app-setting :title="$t('app.setting.label.default_toolhead_move_length')">
         <v-select
           :value="defaultToolheadMoveLength"
-          :items="[0.1, 1.0, 10, 25, 50, 100]"
-          :rules="[rules.numRequired, rules.numMin]"
+          :items="toolheadMoveDistances"
+          :rules="[rules.numRequired]"
           filled
           dense
           single-line
@@ -128,6 +128,28 @@
 
       <v-divider />
 
+      <app-setting :title="$t('app.setting.label.toolhead_move_distances')">
+        <v-combobox
+          ref="toolheadMoveDistances"
+          v-model="toolheadMoveDistances"
+          filled
+          dense
+          hide-selected
+          hide-details="auto"
+          multiple
+          small-chips
+          append-icon=""
+          deletable-chips
+          :rules="[
+            v => v.length > 0 || $t('app.general.simple_form.error.min', { min: 1 }),
+            v => v.length <= 6 || $t('app.general.simple_form.error.max', { max: 6 }),
+            v => !v.some(isNaN) || $t('app.general.simple_form.error.arrayofnums')
+          ]"
+        />
+      </app-setting>
+
+      <v-divider />
+
       <app-setting :title="$t('app.setting.label.z_adjust_values')">
         <v-combobox
           v-model="zAdjustValues"
@@ -164,13 +186,15 @@
 </template>
 
 <script lang="ts">
-import { Component, Vue } from 'vue-property-decorator'
+import { Component, Ref, Vue } from 'vue-property-decorator'
 import { defaultState } from '@/store/config/index'
 
 @Component({
   components: {}
 })
 export default class ToolHeadSettings extends Vue {
+  @Ref('toolheadMoveDistances') readonly toolheadMoveDistancesElement!: any;
+
   rules = {
     numRequired: (v: number | string) => v !== '' || 'Required',
     numMin: (v: number) => v >= 1 || 'Min 1'
@@ -248,6 +272,22 @@ export default class ToolHeadSettings extends Vue {
     })
   }
 
+  get toolheadMoveDistances () {
+    return this.$store.state.config.uiSettings.general.toolheadMoveDistances
+  }
+
+  set toolheadMoveDistances (value: (number | string)[]) {
+    if (!this.toolheadMoveDistancesElement.validate(true)) {
+      return
+    }
+
+    this.$store.dispatch('config/saveByPath', {
+      path: 'uiSettings.general.toolheadMoveDistances',
+      value: [...new Set(value.map(Number))].sort((a, b) => a - b),
+      server: true
+    })
+  }
+
   get useGcodeCoords () {
     return this.$store.state.config.uiSettings.general.useGcodeCoords
   }
diff --git a/src/components/widgets/toolhead/ToolheadMoves.vue b/src/components/widgets/toolhead/ToolheadMoves.vue
index 02dbcd6ab0..792302f4fd 100644
--- a/src/components/widgets/toolhead/ToolheadMoves.vue
+++ b/src/components/widgets/toolhead/ToolheadMoves.vue
@@ -166,57 +166,14 @@
           dense
         >
           <app-btn
+            v-for="(distance, index) of toolheadMoveDistances"
+            :key="index"
             small
             :min-width="40"
-            :value="0.1"
+            :value="distance"
             :disabled="!klippyReady"
           >
-            0.1
-          </app-btn>
-          <app-btn
-            small
-            :min-width="40"
-            class="pa-0"
-            :value="1.0"
-            :disabled="!klippyReady"
-          >
-            1.0
-          </app-btn>
-          <app-btn
-            small
-            :min-width="40"
-            class="pa-0"
-            :value="10"
-            :disabled="!klippyReady"
-          >
-            10
-          </app-btn>
-          <app-btn
-            small
-            :min-width="40"
-            class="pa-0"
-            :value="25"
-            :disabled="!klippyReady"
-          >
-            25
-          </app-btn>
-          <app-btn
-            small
-            :min-width="40"
-            class="pa-0"
-            :value="50"
-            :disabled="!klippyReady"
-          >
-            50
-          </app-btn>
-          <app-btn
-            small
-            :min-width="40"
-            class="pa-0"
-            :value="100"
-            :disabled="!klippyReady"
-          >
-            100
+            {{ distance }}
           </app-btn>
         </v-btn-toggle>
       </v-col>
@@ -244,6 +201,16 @@ export default class ToolheadMoves extends Mixins(StateMixin, ToolheadMixin) {
     return this.kinematics !== 'delta'
   }
 
+  get toolheadMoveDistances () {
+    const distances = this.$store.state.config.uiSettings.general.toolheadMoveDistances
+    if (distances.includes(this.toolheadMoveLength)) {
+      return distances
+    }
+
+    // safety for when no valid move length is present
+    return [this.toolheadMoveLength, ...distances].sort((a, b) => a - b)
+  }
+
   get toolheadMoveLength () {
     return (this.moveLength === '')
       ? this.$store.state.config.uiSettings.general.defaultToolheadMoveLength
diff --git a/src/locales/de.yaml b/src/locales/de.yaml
index 4e47ab9b46..f4f69749a4 100644
--- a/src/locales/de.yaml
+++ b/src/locales/de.yaml
@@ -423,6 +423,7 @@ app:
       theme_preset: Community-Voreinstellung
       thermal_preset_gcode: GCode
       thermal_preset_name: Name des Voreinstellungsprofils
+      toolhead_move_distances: Bewegungsdistanzen des Druckkopfes
       type: Art
       z_adjust_values: Z-Werte anpassen
     timer_options:
diff --git a/src/locales/en.yaml b/src/locales/en.yaml
index f0e358df5e..2b69572bac 100644
--- a/src/locales/en.yaml
+++ b/src/locales/en.yaml
@@ -416,6 +416,7 @@ app:
       theme_preset: Community preset
       thermal_preset_gcode: GCode
       thermal_preset_name: Preset Name
+      toolhead_move_distances: Toolhead distance values
       type: Type
       z_adjust_values: Z Adjust values
       date_time_format: Date and Time format
diff --git a/src/store/config/index.ts b/src/store/config/index.ts
index 00d9aab011..41aaed4711 100644
--- a/src/store/config/index.ts
+++ b/src/store/config/index.ts
@@ -51,6 +51,7 @@ export const defaultState = (): ConfigState => {
         defaultToolheadMoveLength: 1.0,
         defaultToolheadXYSpeed: 130,
         defaultToolheadZSpeed: 10,
+        toolheadMoveDistances: [0.1, 1, 10, 25, 50, 100],
         useGcodeCoords: false,
         zAdjustDistances: [0.005, 0.01, 0.025, 0.050],
         enableVersionNotifications: true,
diff --git a/src/store/config/mutations.ts b/src/store/config/mutations.ts
index fe430e8291..bd653ac3eb 100644
--- a/src/store/config/mutations.ts
+++ b/src/store/config/mutations.ts
@@ -29,6 +29,10 @@ export const mutations: MutationTree<ConfigState> = {
         Vue.set(processed.general, 'zAdjustDistances', payload.general.zAdjustDistances)
       }
 
+      if (payload.general && payload.general.toolheadMoveDistances) {
+        Vue.set(processed.general, 'toolheadMoveDistances', payload.general.toolheadMoveDistances)
+      }
+
       if (payload.editor && payload.editor.autoEditExtensions) {
         Vue.set(processed.editor, 'autoEditExtensions', payload.editor.autoEditExtensions)
       }
diff --git a/src/store/config/types.ts b/src/store/config/types.ts
index 00dbf47fe9..8f8c026a91 100644
--- a/src/store/config/types.ts
+++ b/src/store/config/types.ts
@@ -44,6 +44,7 @@ export interface GeneralConfig {
   defaultToolheadMoveLength: number;
   defaultToolheadXYSpeed: number;
   defaultToolheadZSpeed: number;
+  toolheadMoveDistances: number[];
   useGcodeCoords: boolean;
   zAdjustDistances: number[];
   enableVersionNotifications: boolean;