DEV Community: WallClocks

Enable Buzzer in Klipper For Creality Boards 4.2.2 4.2.7

WallClocks — Tue, 28 Dec 2021 02:44:59 +0000

I have an Ender 3 with a 4.2.7 Board running Klipper firmware and wanted to enable the Buzzer. After some looking around I found the sample-macros.cfg and PDF schematics for both 4.2.2 and 4.2.7. Using these two things I was able to make the M300 gcode command trigger the Buzzer in the LCD panel.



######################################################################
# Beeper
######################################################################
# M300 : Play tone. Beeper support, as commonly found on usual LCD
# displays (i.e. RepRapDiscount 2004 Smart Controller, RepRapDiscount
# 12864 Full Graphic). This defines a custom I/O pin and a custom
# GCODE macro.  Usage:
#   M300 [P<ms>] [S<Hz>]
#   P is the tone duration, S the tone frequency.
# The frequency won't be pitch perfect.
[output_pin BEEPER_pin]
pin: PC6
#   Beeper pin. This parameter must be provided.
#   ar37 is the default RAMPS/MKS pin.
pwm: True
#   A piezo beeper needs a PWM signal, a DC buzzer doesn't.
value: 0
#   Silent at power on, set to 1 if active low.
shutdown_value: 0
#   Disable at emergency shutdown (no PWM would be available anyway).
cycle_time: 0.001
#   Default PWM frequency : 0.001 = 1ms will give a tone of 1kHz
#   Although not pitch perfect.
[gcode_macro M300]
gcode:
    # Use a default 1kHz tone if S is omitted.
    {% set S = params.S|default(1000)|int %}
    # Use a 10ms duration is P is omitted.
    {% set P = params.P|default(100)|int %}
    SET_PIN PIN=BEEPER_pin VALUE=0.5 CYCLE_TIME={ 1.0/S if S > 0 else 1 }
    G4 P{P}
    SET_PIN PIN=BEEPER_pin VALUE=0

To check that it is working, send M300 S440 P200 to your printer and it should beep. You can learn more here.

The only thing you need to change from the sample-macros.cfg section is the pin. Under [output_pin BEEPER_pin] you set pin:PC6. That is it.
Seems simple but I couldn't find anything online about it so I thought I would share. Hope this helps someone or me in the future at least.

Run Klipper/OctoPrint In Void Linux

WallClocks — Wed, 24 Nov 2021 01:42:52 +0000

This is a guide for installing Klipper and Octoprint on Void Linux

It is broken into 3 sections,

Installing Klipper
Installing Octoprint
Installing Webcam

Each Section is broken into numbered steps. It is a lot but very dueable, it is mostly copy+paste. That said you should always try and understand what you paste into your console.

Klipper

I am assuming you have a printer.cfg file in your home directory, your printer is connted via USB and you know kinda how to use a terminal.

I have made a new user pi, to keep things as close to the raspberry-pi setup as I can. I recommend you do this as well.

To make a new user

### Login as root
su
# create the new user
useradd -m -G dialout,tty -s /bin/bash pi

make sure the user pi is part of the dialout and tty groups
Add this user to sudoers with visudo command, google if you need help with vi or install nano and run EDITOR=nano visudo from root.

You will need python2 for this to run and python3 to set it up. As of writing this python2 in Void Linux is called python in xbps and python3 is python3. I think they are working on making everything python3 and there is a python3 branch that I have tested and works without Python2 but I am not sure how complete that is.

Now that the user is set up and you are logged in as pi, do the following....

Install system dependencies

sudo xbps-install -S python python3 python3-pip python3-devel python3-setuptools git base-devel libffi-devel libyaml-devel avrdude avr-gcc avr-binutils avr-libc

Clone Klipper Repo from github

cd ~/
git clone https://github.com/Klipper3d/klipper.git klipper
cd klipper

Setup python-venv

python3 -m venv venv
source venv/bin/activate

Install Dependencies

./venv/bin/python -m pip install --upgrade pip
./venv/bin/pip install -r scripts/klippy-requirements.txt

Create runsv service(runit) direcotry and file

sudo mkdir /etc/sv/klipper
sudo touch /etc/sv/klipper/run
sudo chmod +x /etc/sv/klipper/run

Edit the file /etc/sv/klipper/run

#!/bin/bash
export USER=pi
export HOME=/home/pi
groups="$(id -Gn "$USER" | tr ' ' ':')"

exec chpst -u "$USER:$groups" "$HOME"/klipper/venv/bin/python "$HOME"/klipper/klippy/klippy.py "$HOME"/printer.cfg -l /tmp/klippy.log

Enable klipper

sudo ln -srv /etc/sv/klipper /var/service

It be a good idea to reboot too.

After this plug in your printer if is not already, make sure you have your printer.cfg in your home dir, sudo sv restart klipper and you should be connected. I have an ender 3 with LCD enabled so I could confirm at this point that the LCD menu works. On to OctoPrint.

OctoPrint

All of the dependencies got installed in the Klipper install, so this is pretty simple.

make the directory

cd ~
mkdir OctoPrint && cd OctoPrint

Setup Python3 venv

python3 -m venv venv
source venv/bin/activate

Install Octoprint

./venv/bin/pip install pip --upgrade
./venv/bin/pip install octoprint

Create runsv service(runit) direcotry and file

sudo mkdir /etc/sv/octoprint
sudo touch /etc/sv/octoprint/run
sudo chmod +x /etc/sv/octoprint/run

Edit the file /etc/sv/octoprint/run

#!/bin/bash
export USER=pi
export HOME=/home/pi
groups="$(id -Gn "$USER" | tr ' ' ':')"

exec chpst -u "$USER:$groups" "$HOME"/OctoPrint/venv/bin/octoprint serve

Enable Octoprint

sudo ln -srv /etc/sv/octoprint /var/service

Another restart might be good.

Once you open Octoprint in the browser you should install the OctoKlipper plugin.

By default the octoprint instance runs on port 5000. So something like localhost:5000 should get you there, or the ip of the machine with void.

Webcam

Install some things

sudo xbps-install subversion libjpeg-turbo-devel ffmpeg 
cmake

Get the repo and build it

git clone https://github.com/jacksonliam/mjpg-streamer.git
cd mjpg-streamer/mjpg-streamer-experimental
export LD_LIBRARY_PATH=.
make

Test it

./mjpg_streamer -i "./input_uvc.so" -o "./output_http.so -w ./www"

Press Control-C to exit
You may have to add a device. in my case my laptop has a built in camera but I want to use the USB one, so I use(example)

./mjpg_streamer -i "./input_uvc.so -d /dev/video2" -o "./output_http.so -w ./www"

The `-d /dev/video2` part is different.
You can this will give you a video feed on port `8080`.

Setup Octoprint

In octoprint goto settings and webcam & timelapse section. In the "Stream URL" section put the http://ip:port/?action=stream, example http://192.168.0.24:8080/?action=stream.
If you want Timelapse enter the same http://ip:port part but with /?action=snapshot at the end, example http://192.168.0.24:8080/?action=snapshot
You should know have a video feed.
Setting it up to autostart. first make the files

sudo mkdir /etc/sv/octocam
sudo touch /etc/sv/octocam/run
sudo chmod +x /etc/sv/octocam/run

Create a executable file that has the start command I had trouble getting this to work any other way I tried, you need to make a file, /home/pi/bin/octocam_run, like so

mkdir ~/bin
touch ~/bin/octocam_run
chmod +x ~/bin/octocam_run

Next, put the following into the /home/pi/bin/octocam_run file

#!/bin/bash

MJPGSTREAMER_HOME=/home/pi/mjpg-streamer/mjpg-streamer-experimental
camera_options="-r 640x480 -f 10"

pushd $MJPGSTREAMER_HOME
LD_LIBRARY_PATH=. ./mjpg_streamer -o "output_http.so -w ./www" -i "input_uvc.so $camera_options -d /dev/video2"
popd

Add content to the /etc/sv/octocam/run file

#!/bin/bash
export USER=pi
export HOME=/home/pi
groups="$(id -Gn "$USER" | tr ' ' ':')"

exec chpst -u "$USER:$groups" /home/pi/bin/octocam_run

last add it to your services

sudo ln -sv /etc/sv/octocam /var/service

If you have not, maybe do a reboot.

Please let me know if I have messed anything up if there is a better way to do this. And any errors your eyes sea please.

Sources

- Klipper Install
    - https://www.klipper3d.org/Installation.html
- Void Docs
    -https://docs.voidlinux.org/config/services/index.html
    - https://docs.voidlinux.org/config/services/user-services.html
- OcotPrint Help
    - https://community.octoprint.org/t/setting-up-octoprint-on-a-raspberry-pi-running-raspbian-or-raspberry-pi-os/2337
- And the install scripts from klipper, a few man pages here and there.

X11 Special Keyboard Keys for Window Managers

WallClocks — Sat, 15 May 2021 01:48:33 +0000

Keyboard Media Keys for Unix X11

AKA XF86keysym

Not knowing what the name of a key is, is a pain, so here is a list of them and some useful ways to implement them. Original sources listed at bottom and wherever they show up.

You can also control volume, brightness and maybe some others with acpi event handlers.

For a list of all available X11 media key names, look here. This file comes with x11 development files. In Ubuntu it is obtained in the xorg-dev package and lives in /usr/include/X11/XF86keysym.h.
For i3wm and awesome you remove the "XK_" part. so instead of XF86XK_MonBrightnessUp, it would be XF86MonBrightnessUp.

Control Volume

Using Pulseaudio

i3wm

# Pulse Audio controls
bindsym XF86AudioRaiseVolume exec --no-startup-id pactl set-sink-volume 0 +5% #increase sound volume
bindsym XF86AudioLowerVolume exec --no-startup-id pactl set-sink-volume 0 -5% #decrease sound volume
bindsym XF86AudioMute exec --no-startup-id pactl set-sink-mute 0 toggle # mute sound

awesome wm

    awful.key({            }, "XF86AudioRaiseVolume" , function () awful.spawn("pactl set-sink-volume 0 +5%") end,
              {description = "Volume Up",      group = "awesome"}),
    awful.key({            }, "XF86AudioLowerVolume" , function () awful.spawn("pactl set-sink-volume 0 -5%") end,
              {description = "Volume Down", group = "awesome"}),
    awful.key({            }, "XF86AudioMute" , function () awful.spawn("pactl set-sink-mute 0 toggle") end,
              {description = "Volume Mute",  group = "awesome"}),

dwm

#include <X11/XF86keysym.h>

/* Add somewhere in your constants definition section */

static const char *upvol[]   = { "/usr/bin/pactl", "set-sink-volume", "0", "+5%",     NULL };
static const char *downvol[] = { "/usr/bin/pactl", "set-sink-volume", "0", "-5%",     NULL };
static const char *mutevol[] = { "/usr/bin/pactl", "set-sink-mute",   "0", "toggle",  NULL };

/* Add to keys[] array. With 0 as modifier, you are able to use the keys directly. */
static Key keys[] = {
    { 0,                       XF86XK_AudioLowerVolume, spawn, {.v = downvol } },
    { 0,                       XF86XK_AudioMute, spawn, {.v = mutevol } },
    { 0,                       XF86XK_AudioRaiseVolume, spawn, {.v = upvol   } },
};

/* If you have a small laptop keyboard or don't want to spring your fingers too far away. */

static Key keys[] = {
    { MODKEY,                       XK_F11, spawn, {.v = downvol } },
    { MODKEY,                       XK_F9,  spawn, {.v = mutevol } },
    { MODKEY,                       XK_F12, spawn, {.v = upvol   } },
};

ALSA

If you want to use alsa instead of pulse audio, you can use the amixer command. Here are the commands for volume up, down and mute toggle. Make sure to get the alsa-tools and alsa-utils packages.

amixer sset Master 5%+
amixer sset Master 5%-
amixer sset Master toggle

ACPI

Brightness and Volume

This is from here. If you use acpid and would rather use it then your window manager to control your volume and brightness, you can like this.

/etc/acpi/handler.sh

#!/bin/bash
# Default acpi script that takes an entry for all actions
#jack/headphone HEADPHONE unplug
#jack/headphone HEADPHONE plug

case "$1" in
    jack/headphone)
        case $3 in
            plug)
                echo "in" > /var/tmp/headphones.log
            ;;
            unplug)
                echo "out" > /var/tmp/headphones.log
            ;;
        esac
        ;;
    button/mute)
        /usr/local/bin/volume mute 
    ;;
button/volumedown)
        /usr/local/bin/volume vdown
    ;;
button/volumeup)
    /usr/local/bin/volume vup
    ;;
video/brightnessup)
    /usr/local/bin/brightness_push up
    ;;
video/brightnessdown)
    /usr/local/bin/brightness_push down
    ;;

In the above file I use the event handlers to call custom scripts in my $PATH. The first case is watching the headphone jack, when headphones get plugged in, a log file is made, if the files contents is in, headphones are plugged in, out means unplugged. My volume script them looks at that file when I press the volume keys, it will choose to control the headphone volume instead of master. This was to resolve an issue on my hp stream when running alpine as a full blown desktop.
Anyway, here are the scripts in $PATH(like /usr/local/bin/) that get called.

 #!/bin/bash

refresh_i3status="killall -SIGUSR1 py3status"
headphone=$(cat /var/tmp/headphones.log)

case "$1" in
    up)
        #sudo -g audio pactl set-sink-volume @DEFAULT_SINK@ +10%;
        amixer sset Master 5%+
        $refresh_i3status

    ;;
    down)
        #sudo -g audio pactl set-sink-volume @DEFAULT_SINK@ -10%; 
        amixer sset Master 5%-
        $refresh_i3status
    ;;
    mute)
        #sudo -g audio pactl set-sink-mute @DEFAULT_SINK@ toggle; 
        amixer sset Master toggle
        if [[ $headphone == "in" ]]; then
            amixer sset Headphone unmute
        else
            amixer sset Speaker unmute
        fi
        $refresh_i3status
    ;;
    esac

 #!/bin/bash

# Variables

brightness_dir=/sys/class/backlight/intel_backlight
brightness_file=$brightness_dir/brightness
brightness=$(cat $brightness_file)
actual_brightness=$(cat $brightness_dir/actual_brightness)
max_brightness=$(cat $brightness_dir/max_brightness)
min_brightness=50
n=50


if [[ "$1" == "up" ]]; then
    if (( $actual_brightness < $max_brightness )); then
        echo  $(dc -e "$actual_brightness $n + p") >> $brightness_file;
    fi
else
    if (( $actual_brightness > $min_brightness )); then
        echo  $(dc -e "$actual_brightness $n - p") >> $brightness_file;
    fi

fi

Brightness Control

With xbacklight

Controling Brightness is a lot like contorling volume.

i3wm

 # Screen Brightness controls
bindsym XF86MonBrightnessUp exec xbacklight -inc 20 # increase screen brightness
bindsym XF86MonBrightnessDown exec xbacklight -dec 20 # decrease screen brightness

awesome wm

    awful.key({            }, "XF86MonBrightnessUp" , function () awful.spawn("xbacklight inc 5%") end,
              {description = "Brighness Up",      group = "awesome"}),
    awful.key({            }, "XF86MonBrightnessDown" , function () awful.spawn("xbacklight dec 5%") end,
              {description = "Brighness Down",      group = "awesome"}),

dwm

 #include <X11/XF86keysym.h>

/* Add somewhere in your constants definition section */

static const char *upbrightness[]      = { "xbacklight", "inc", "5%",     NULL };
static const char *downbrightness[] = { "xbacklight", "dec", "5%",     NULL };

/* Add to keys[] array. With 0 as modifier, you are able to use the keys directly. */
static Key keys[] = {
    { 0,                       XF86XK_MonBrightnessDown, spawn, {.v = downbrightness } },
    { 0,                       XF86XK_MonBrightnessUp, spawn, {.v = upbrightness   } },
};

xbacklight Alternative

This is from here
If you have trouble with xbacklight or just don't like it, you can use a simple script, it goes into /sys/class/backlight/{your screen}, gets the current brightness and changes it a set amount.
You have to change the intel_backlight part if you do not use intel. You can find out, ls /sys/class/backlight. Replace intel_backlight with what ever you have.

#!/bin/bash

## Very simple way to change brightness without a utility.
## I made this to use with acpi event handlers and my laptop keyboard
## GNU General Public License
## dosborn at vivaldi dot net

# Variables

# brightness_dir= Direcotry containing the backlight file
brightness_dir=/sys/class/backlight/intel_backlight
# brightness_file= the file named brightness in that dir
brightness_file=$brightness_dir/brightness
# brightness= The contents of that file
brightness=$(cat $brightness_file)
# actual_brightness= the actual_brightness file
actual_brightness=$(cat $brightness_dir/actual_brightness)
# max_brightness= the contents of max_brightness
max_brightness=$(cat $brightness_dir/max_brightness)
# min_brightness= how low you want it to get
min_brightness=50
# n= the change, how fast it goes up and down
n=50

## If `brightness_push.sh up` is called then it will go up "n". and 'down' for down.

if [[ "$1" == "up" ]]; then
    if (( $actual_brightness < $max_brightness )); then
        echo  $(dc -e "$actual_brightness $n + p") >> $brightness_file;
    fi
else
    if (( $actual_brightness > $min_brightness )); then
        echo  $(dc -e "$actual_brightness $n - p") >> $brightness_file;
    fi

fi

## Trackpad
Also form here
I am leaving out the dwm from here, it is just like before but different keys.
### i3wm

--------
 # Touchpad controls
bindsym XF86TouchpadToggle exec /some/path/toggletouchpad.sh # toggle touchpad

### awesome wm

     awful.key({            }, " XF86TouchpadToggle" , function () awful.spawn("/some/path/toggletouchpad.sh") end,
              {description = "Prev Track", group = "awesome"}),

The script toggletouchpad.sh for toggling your touchpad should have following content:

#!/bin/bash
if synclient -l | grep "TouchpadOff .*=.*0" ; then
    synclient TouchpadOff=1 ;
else
    synclient TouchpadOff=0 ;
fi

Media player controls

i3wm

bindsym XF86AudioPlay exec playerctl play
bindsym XF86AudioPause exec playerctl pause
#bindsym XF86AudioPlay exec playctl play-pause  # To toggle with a single key
bindsym XF86AudioNext exec playerctl next
bindsym XF86AudioPrev exec playerctl previous

awesome wm

    awful.key({            }, "XF86AudioPlay" , function () awful.spawn("playerctl play-pause") end,
              {description = "Play Pause", group = "awesome"}),
    awful.key({            }, "XF86AudioNext" , function () awful.spawn("playerctl next") end,
              {description = "Next Track", group = "awesome"}),
    awful.key({            }, "XF86AudioPrev" , function () awful.spawn("playerctl previous") end,
              {description = "Prev Track", group = "awesome"}),

Sources

Thank you everyone who has helped me learn a random thing here and there.