rework macro BEEP description

Author: torte71

armbian-mkspi-mainline-setup-v25-2.md

@@ -272,17 +272,7 @@ cd
 wget https://torte71.github.io/tmteststuff/files/makerbase-beep-service.deb
 dpkg -i makerbase-beep-service.deb
 ```
-      * Fix access rights to gpio82:
-        * Execute `nano /etc/rc.local`
-        * Add following lines (before the `exit 0` line)
-```
-if [ ! -d "/sys/class/gpio/gpioi82" ]; then
-  echo 82 > /sys/class/gpio/export
-fi
-chgrp mks /sys/class/gpio/gpio82/value
-chmod g+w /sys/class/gpio/gpio82/value
-```
-        * Save and exit the editor
+    * (Modifying `/etc/rc.local`, as stated in prior versions, is not required)
     * To uninstall:
       * Execute `sudo dpkg -r makerbase-beep-service`
 

armbian-mkspi-setup-v24-2.md

@@ -150,11 +150,7 @@ Modifications from Sovol useful for this image:
       * Log into the device (ssh/putty/serial)
       * `sudo dpkg -i printer_data/gcodes/makerbase-beep-service.deb`
       * (change the path, if you've uploaded to a different location)
-      * fix access rights to gpio82:
-        * `sudo nano /etc/rc.local`
-        * add following lines (before the `exit 0` line)
-        * `chgrp mks /sys/class/gpio/gpio82/value`
-        * `chmod g+w /sys/class/gpio/gpio82/value`
+      * (Modifying `/etc/rc.local`, as stated in prior versions, is not required)
     * To uninstall:
       * `sudo dpkg -r makerbase-beep-service`
 

beeper.md

@@ -12,22 +12,37 @@ nav_order: 2
 {:toc}
 ----
 
-  * Beeper script:
-    * Based on solution by "Bastian" on <https://forum.sovol3d.com>
-    * <https://forum.sovol3d.com/t/use-beeper-from-mks-sbc-which-pin/3606/5>
+## Description
+The "BEEP" macro allows Klipper to emit beeps, e.g. to signal filament change, cancelled prints and similar.
 
-  * Requires udev rule to change rights for gpio access
-    * Based on solution by "MikeDK" on <https://forums.raspberrypi.com>
-    * <https://forums.raspberrypi.com/viewtopic.php?t=9667>
+It is based on the solution by "Bastian" at <https://forum.sovol3d.com/t/use-beeper-from-mks-sbc-which-pin/3606/5>.
+
+There are two slightly different approaches:
+  * a) Klipper directly accesses the GPIO
+  * b) GPIO is handled by shell script, which is called from Klipper via gcode-shell-command
+  
+Option a) does not depend on "gcode-shell-command", but it does not work together with "makerbase-beep-service", so touching the screen will not beep any longer. (The makerbase service requires the GPIO pin to be exported, but Klipper requires it to be unexported.)
 
-  * /etc/udev/rules.d/90-gpio.rules
+In order to not break the touchscreen beeps, I prefer option b) using the external shell script.
 
+## System setup (set access rights, export gpio pin)
+  * Requires udev rule to change rights for gpio access
+    * Based on solution by "MikeDK" on <https://forums.raspberrypi.com/viewtopic.php?t=9667>
+    * Create `/etc/udev/rules.d/90-gpio.rules`:
 ```
 SUBSYSTEM=="gpio", KERNEL=="gpiochip*", ACTION=="add", PROGRAM="/bin/sh -c 'chown root:dialout /sys/class/gpio/export /sys/class/gpio/unexport ; chmod 220 /sys/class/gpio/export /sys/class/gpio/unexport'"
 SUBSYSTEM=="gpio", KERNEL=="gpio*", ACTION=="add", PROGRAM="/bin/sh -c 'chown root:dialout /sys%p/active_low /sys%p/direction /sys%p/edge /sys%p/value ; chmod 660 /sys%p/active_low /sys%p/direction /sys%p/edge /sys%p/value'"
+```
+    * If you are **not** installing [makerbase-beep-service](makerbase-beep-files.html), then you need to set up gpio82 at boot time.
+      Insert following code to `/etc/rc.local` (after the lines starting with '#', but before the 'exit 0' line):
+```
+echo 82 > /sys/class/gpio/export
+echo out > /sys/class/gpio/gpio82/direction
 ```
 
-  * /home/mks/printer_data/config/printer.cfg:
+## Klipper setup (add macro "BEEP")
+  * Requires [gcode-shell-command](https://github.com/dw-0/kiauh/blob/master/docs/gcode_shell_command.md)
+  * Add BEEP macro to `/home/mks/printer_data/config/printer.cfg`:
 
 {% raw  %}
 ```
@@ -39,14 +54,16 @@ gcode:
   RUN_SHELL_COMMAND CMD=beep PARAMS='{beep_count} {beep_duration} {pause_duration}'
 
 [gcode_shell_command beep]
-command: bash /home/mks/printer_data/config/macro/macro-beep.sh
+command: bash /home/mks/printer_data/config/macros/macro-beep.sh
 timeout: 10
 verbose: False
 ```
 {% endraw  %}
 
-  * /home/mks/printer_data/config/macros/macro-beep.sh:
+## Add shell script ("macro-beep.sh")
+  * Create `/home/mks/printer_data/config/macros/macro-beep.sh`:
 
+{% raw  %}
 ```
 #!/bin/bash
 # usage: beep.sh [BEEPCOUNT] [BEEPDURATION] [PAUSEDURATION]
@@ -76,6 +93,9 @@ for (( i=0; i<BEEPCOUNT; i++ )); do
     sleep $PAUSEDURATION
 done
 ```
+{% endraw  %}
+  * Make the shell script executable:
+    * Execute `chmod +x /home/mks/printer_data/config/macros/macro-beep.sh`
 
 ----
 Back to [start](index.html)