Difference between revisions of "X735-script"
Line 1: | Line 1: | ||
{{GD Template Impl}} | {{GD Template Impl}} | ||
− | + | ==Overview== | |
This is script installation tutorial for [[X735]] v2.5 & v3.0, it will replace [[X735 Software | X735 Software installation tutorial]], although [[X735 Software | X735 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. | This is script installation tutorial for [[X735]] v2.5 & v3.0, it will replace [[X735 Software | X735 Software installation tutorial]], although [[X735 Software | X735 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. | ||
Line 21: | Line 21: | ||
* Twister | * Twister | ||
− | ==Preconfigured <code>config.txt</code>== | + | ==Install== |
+ | ===Preconfigured <code>config.txt</code>=== | ||
To install pwm fan, first add <code>dtoverlay=pwm-2chan,pin2=13,func2=4</code> to <code>/boot/config.txt</code> under [all] or the end of file and <code>reboot</code>: | To install pwm fan, first add <code>dtoverlay=pwm-2chan,pin2=13,func2=4</code> to <code>/boot/config.txt</code> under [all] or the end of file and <code>reboot</code>: | ||
sudo nano /boot/config.txt | sudo nano /boot/config.txt | ||
Line 30: | Line 31: | ||
sudo reboot | sudo reboot | ||
− | ==Clone the script== | + | ===Clone the script=== |
<pre> | <pre> | ||
git clone https://github.com/geekworm-com/x735-script | git clone https://github.com/geekworm-com/x735-script | ||
Line 38: | Line 39: | ||
</pre> | </pre> | ||
− | ==Create the x735-fan service== | + | ===Create the x735-fan service=== |
x735-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. | x735-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. | ||
<pre> | <pre> | ||
Line 49: | Line 50: | ||
Then the pwm fan starts running. | Then the pwm fan starts running. | ||
− | ==Create the x735-pwr service== | + | ===Create the x735-pwr service=== |
x735-pwr service will be responsible for power management and hardware safe shutdown. | x735-pwr service will be responsible for power management and hardware safe shutdown. | ||
<pre> | <pre> | ||
Line 59: | Line 60: | ||
</pre> | </pre> | ||
− | ==Prepair software shutdown script== | + | ===Prepair software shutdown script=== |
sudo cp -f ./x735-softsd.sh /usr/local/bin/ | sudo cp -f ./x735-softsd.sh /usr/local/bin/ | ||
Create a alias <code>x735off</code> command to execute the software shutdown | Create a alias <code>x735off</code> command to execute the software shutdown | ||
Line 68: | Line 69: | ||
Then you can run <code>x735off</code> to execute software shutdown. | Then you can run <code>x735off</code> to execute software shutdown. | ||
− | ==Test safe shutdown== | + | ===Test safe shutdown=== |
'''Software safe shutdown command''': | '''Software safe shutdown command''': | ||
x735off | x735off | ||
Line 80: | Line 81: | ||
* press <code>7-8</code> seconds to force shutdown. | * press <code>7-8</code> seconds to force shutdown. | ||
− | ==Read fan speed== | + | ===Read fan speed=== |
<code>read_fan_speed.py</code> 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: | <code>read_fan_speed.py</code> 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 ~x735-script | cd ~x735-script | ||
Line 90: | Line 91: | ||
Or you can refer to [[How to Install RPi.GPIO Python Library]] | Or you can refer to [[How to Install RPi.GPIO Python Library]] | ||
− | ==Other== | + | ===Other=== |
<code>pwm_fan_control.py</code> is no longer used, and are reserved here for research and use by python lovers only. | <code>pwm_fan_control.py</code> is no longer used, and are reserved here for research and use by python lovers only. | ||
==Support== | ==Support== |
Revision as of 19:38, 22 July 2023
Contents
Overview
This is script installation tutorial for X735 v2.5 & v3.0, it will replace X735 Software installation tutorial, although X735 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.
This guideline is similar to XScript only because the hardware uses a different GPIO.
The core shell script of X735-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
.
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,pin2=13,func2=4
to /boot/config.txt
under [all] or the end of file and reboot
:
sudo nano /boot/config.txt
Or (it's /boot/firmware/config.txt
if you are using ubuntu os
)
sudo nano /boot/firmware/config.txt
Save & exit.
sudo reboot
Clone the script
git clone https://github.com/geekworm-com/x735-script cd x735-script chmod +x *.sh
Create the x735-fan service
x735-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.
sudo cp -f ./x735-fan.sh /usr/local/bin/ sudo cp -f ./x735-fan.service /lib/systemd/system sudo systemctl daemon-reload sudo systemctl enable x735-fan sudo systemctl start x735-fan
Then the pwm fan starts running.
Create the x735-pwr service
x735-pwr service will be responsible for power management and hardware safe shutdown.
sudo cp -f ./x735-pwr.sh /usr/local/bin/ sudo cp -f x735-pwr.service /lib/systemd/system sudo systemctl daemon-reload sudo systemctl enable x735-pwr sudo systemctl start x735-pwr
Prepair software shutdown script
sudo cp -f ./x735-softsd.sh /usr/local/bin/
Create a alias x735off
command to execute the software shutdown
echo "alias x735off='sudo /usr/local/bin/x735-softsd.sh'" >> ~/.bashrc source ~/.bashrc
Then you can run x735off
to execute software shutdown.
Test safe shutdown
Software safe shutdown command:
x735off
DON'T run the 'shutdown' linux command to shut down, otherwise the power of x735 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 ~x735-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
Email: 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@Q: How to login to myNode via SSH?
A: URL connection is IP address, and the default user name is admin, default password is boltQ: How to login to DietPi via SSH?
A: URL connection is IP address, and the default user name is root, default password is dietpiQ: Is LibreELEC supported?
A: TODOReturn to X735
Enable comment auto-refresher
Anonymous user #15
Permalink |
Anonymous user #16
Anonymous user #14
Permalink |
Harry
Anonymous user #10
Permalink |
Anonymous user #11
Harry
Anonymous user #12
Anonymous user #13
Anonymous user #9
Permalink |
Walker
Anonymous user #8
Permalink |
Walker
Anonymous user #7
Permalink |
Walker
Anonymous user #6
Permalink |
Walker
Anonymous user #5
Permalink |
Anonymous user #4
Permalink |
Walker
Anonymous user #3
Permalink |
Walker
Anonymous user #1
Permalink |
Anonymous user #2