X715-script

Overview

This is script installation tutorial for X715 only, it will replace X715 Software installation tutorial, although X715 Software installation tutorial is still available, but we strongly recommend that you use this script tutorial, which simplifies the installation process and reduces dependencies on third-party python libraries.

The core shell script of X715-script comes from from pimlie/geekworm-x-c1, pimlie implements the pwm fan shell script, which does not depend on third-party python libraries at all. Thanks to pimlie.

Now we think you have successfully flashed the OS Image into Micro SD and and power on the device, and you have also completed the operations such as creating new user required in some OS. You need to perform the following operations in Terminal.

[update]

1. Use gpiod instead of obsolete interface, and suuports ubuntu 23.04 also

2. Fix fan not working on Raspberry Pi 5 hardware issue

If you are using it on a Raspberry Pi 5, make the following changes:

Be sure to update the kernel to version 6.6.22.

sudo apt update
sudo apt full-upgrade
sudo rpi-update

Change the PWM_CHIP_PATH to /sys/class/pwm/pwmchip2 on line 7 of X715fan.sh

OS that has been tested

Raspbian
DietPi
Manjaro
Ubuntu
myNode
Umbrel
Volumio
RetroPie
Twister

Install

Preconfigured `config.txt`

To install pwm fan, first add dtoverlay=pwm-2chan,pin=12,func=4,pin2=13,func2=4 to /boot/firmware/config.txt under [all] or the end of file and reboot:

sudo nano /boot/firmware/config.txt

Save & exit.

sudo reboot

Install gpiod package

sudo apt install -y gpiod

Clone the script

Clone pruduct software script

git clone https://github.com/geekworm-com/X715-script
cd X715-script
chmod +x *.sh

PS: For some OS such as Raspberry Pi OS Lite, the git tool is not installed by default, if you get an error like error: -bash: git: command not found, please run the following command to install the git tool.

sudo apt install -y git

Configuring Different GPIO Chip for Raspberry Pi 5 hardware

If you are not using Raspberry 5 hardware, skip this step,or run the following command to set differnt chip and pwm number.

sed -i 's/xSoft.sh 0 20/xSoft.sh 4 20/g' install-sss.sh
sed -i 's/xPWR.sh 0 5 12/xPWR.sh 4 5 12/g' X715-pwr.service
sed -i 's/pwmchip0/pwmchip2/g' X715-fan.sh

PS： Because Raspberry Pi 5 uses a different GPIO chip.

Create the X715-fan service

X715-fan service is for pwm fan, the pwm fan will automatically adjust the runing speed according to the temperature of the cpu after the service is started.

Run the following command to install fan service script;

sudo ./install-fan-service.sh

Then the pwm fan starts running.

PS: If fan don't works, be sure to update the kernel to version 6.6.22, don't work on 6.6.20, it's a kernel issue.

sudo apt update
sudo apt full-upgrade
sudo rpi-update

Run the command uname -r to check kernel verson

Create the X715-pwr service

sudo ./install-pwr-service.sh

Prepair software shutdown script

Run the following command to install software shutdown script (sss)

sudo ./install-sss.sh

After the installation is complete, an X715xoff command will be created to shut down.Then you can run X715xoff to execute software shutdown.

Uninstall

Run the following command to uninstall all.

sudo ./uninstall.sh

Test

Test safe shutdown

Software safe shutdown command:

X715off

DON'T run the 'shutdown' linux command to shut down, otherwise the power of X715 shield will not be shut down.

Hardware safe shutdown operation:

You can verify the safety switch through the onboard switch, press and hold the switch for 3 seconds, then the blue LED will flash slowly and the shutdown is going then all LEDs will be off until the device is completely powered off.

press on-board button switch 1-2 seconds to reboot
press button switch 3 seconds to safe shutdown,
press 7-8 seconds to force shutdown.

Read fan speed

read_fan_speed.py is a sample python file on how to read the speed of the pwm fan. Run the following command to get the speed of the fan:

cd ~X715-script
sudo python3 read_fan_speed.py

This `read_fan_speed.py` python file depends on the third-party python library `Rpi.GPIO`. In the official Raspberry Pi OS and most third-party OS, this library is installed by default. If you run this file and get some errors, try to run the following command to install the Rpi.GPIOy library.

sudo apt-get install -y python3-smbus python3-rpi.gpio

Or you can refer to How to Install RPi.GPIO Python Library

Other

pwm_fan_control.py is no longer used, and are reserved here for research and use by python lovers only.

Support

If you have some questions or suggestions, please contact to support@geekworm.com

FAQ

Q: How to login volumio via SSH?

1. Enable SSH:

Visit http://volumio.local/dev/, then click ENABLE SSH button

2. URL connection is IP address, and the default user name is volumio, default password is volumio

Q: How to login to Umbrel via SSH?

A: ssh umbrel@umbrel.local (or ssh umbrel@). the default user name is umbrel, default password is moneyprintergobrrr

Q: How to login to myNode via SSH?

A: URL connection is IP address, and the default user name is admin, default password is bolt

Q: How to login to DietPi via SSH?

A: URL connection is IP address, and the default user name is root, default password is dietpi

Q: Is LibreELEC supported?

A: TODO

Return to X715

Enable comment auto-refresher