5,374
edits
Changes
Jump to navigation
Jump to search
Created page with "{{GD Template Impl}} __NOTOC__ This is script installation tutorial for NASPi, NASPi Gemini 2.5, NASPi CM4-M2 and NASPi CM4-2.5 This script also works on [htt..."
{{GD Template Impl}}
__NOTOC__
This is script installation tutorial for [[NASPi]], [[NASPi Gemini 2.5]], [[NASPi CM4-M2]] and [[NASPi CM4-2.5]]
This script also works on [https://www.raspberrypi.com/software/operating-systems/ bookworm] OS, and test it on Jan. 9th 2024.
The original key pwm fan control script is from [https://github.com/pimlie/geekworm-x-c1 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 Raspberry Pi OS.
After your system boots, then you need to open <code>Terminal</code> prpgram, then type the following command to complete the installation of the script
'''[NOTE]'''
If you are a new user, please ignore this '''NOTE'''
If you are using the latest Raspberry Pi OS bookworm version or have updated the OS kernel to the latest version 6.6, then you get the following error after running the <code>xoff</code> command:
<pre>
/usr/local/bin/x-c1-softsd.sh: line 5: echo: writing error: Invalid argument
/usr/local/bin/x-c1-softsd.sh: line 6: /sys/class/gpio/gpio27/direction: No such file or directory
/usr/local/bin/x-c1-softsd.sh: line 7: /sys/class/gpio/gpio27/value: No such file or directory
Your device will shutting down in 4 seconds...
/usr/local/bin/x-c1-softsd.sh: line 19: /sys/class/gpio/gpio27/value: No such file or directory
</pre>
The cause of this error is due to a kernel update, please perform the following update to solve the issue;
1. First go back to the directory where you installed xscript and you will see the ''xscript'' folder.
2. Then run the following command:
<pre>
cd xscript
rm x-c1-softsd.sh x-c1-pwr.sh -f
git pull origin
chmod +x *.sh
sudo cp -f . /x-c1-softsd.sh /usr/local/bin/
sudo cp -f . /x-c1-pwr.sh /usr/local/bin/
sudo reboot
</pre>
==OS that has been tested==
* Raspbian
* DietPi
* Manjaro
* Ubuntu
* myNode
* Umbrel
* Volumio
* RetroPie
* Twister
'''Note:''' Not tested with '''Home Assistant''', for some reason, we are not able to upgrade and use the Home Assistant to test, please pay attention to check if there is any update in the future.(If you have successfully tested Home Assistant, welcome to share your experience via email at: support@geekworm.com)
==Preconfigured <code>config.txt</code>==
To install pwm fan, first add <code>dtoverlay=pwm-2chan</code> to <code>/boot/firmware/config.txt</code> under [all] or the end of file and <code>reboot</code>:
sudo nano /boot/firmware/config.txt
Save & exit.
sudo reboot
==Clone the script==
<pre>
git clone https://github.com/geekworm-com/xscript
cd xscript
chmod +x *.sh
</pre>
'''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
==Create the x-c1-fan service==
<span class="tb_red_bold"> Note: If your device does not support pwm fans or you are not using pwm, you can skip this step</span>
<pre>
sudo cp -f ./x-c1-fan.sh /usr/local/bin/
sudo cp -f ./x-c1-fan.service /lib/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable x-c1-fan
sudo systemctl start x-c1-fan
</pre>
Then the pwm fan starts running.
==Create the x-c1-pwr service==
<pre>
sudo cp -f ./x-c1-pwr.sh /usr/local/bin/
sudo cp -f x-c1-pwr.service /lib/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable x-c1-pwr
sudo systemctl start x-c1-pwr
</pre>
==Prepair software shutdown script==
sudo cp -f ./x-c1-softsd.sh /usr/local/bin/
Create a alias <code>xoff</code> command to execute the software shutdown
<pre>
echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc
source ~/.bashrc
</pre>
Then you can run <code>xoff</code> to execute software shutdown.
==Test safe shutdown==
'''Software safe shutdown command''':
xoff
<span class="tb_red">DON'T run the 'shutdown' linux command to shut down, otherwise the power of shield will not be shut down.</span>
'''Hardware safe shutdown operation''':
You can verify the safety switch through the onboard switch, press and hold the switch for <code>3</code> 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 <code>1-2</code> seconds to reboot
* press button switch <code>3</code> seconds to safe shutdown,
* press <code>7-8</code> seconds to force shutdown.
==Sample==
#The code for fan speed control is now in the <code>x-c1-fan.sh</code> file.
#<code>fan-rpi.py</code> and <code>fan-pigpio.py</code> are no longer used, and are reserved here for research and use by python lovers only.
==Uninstall==
Uninstall <code>x-c1-fan.service</code>:
sudo systemctl stop x-c1-fan
sudo systemctl disable x-c1-fan
Uninstall <code>x-c1-pwr.service</code>:
sudo systemctl stop x-c1-pwr
sudo systemctl disable x-c1-pwr
Remove the <code>xoff</code> allias on .bashrc file
sudo sed -i '/xoff/d' ~/.bashrc
source ~/.bashrc
==Support==
Email: support@geekworm.com
If you have any problems during use, please contact us by email and tell us the product model you are using and the OS version you are using.
==FAQ==
<html>
<details>
<summary>Q: How to login <b>volumio</b> via SSH?</summary>
<p>1. Enable SSH:</p>
<p>Visit http://volumio.local/dev/, then click <b>ENABLE SSH</b> button</p>
<p>2. URL connection is IP address, and the default user name is <b>volumio</b>, default password is <b>volumio</b></p>
</details>
<details>
<summary>Q: How to login to <b>Umbrel</b> via SSH?</summary>
A: ssh umbrel@umbrel.local (or ssh umbrel@<IP address of your Umbrel>). the default user name is <b>umbrel</b>, default password is <b>moneyprintergobrrr</b>
</details>
<details>
<summary>Q: How to login to <b>myNode</b> via SSH?</summary>
A: URL connection is IP address, and the default user name is <b>admin</b>, default password is <b>bolt</b>
</details>
<details>
<summary>Q: How to login to <b>DietPi</b> via SSH?</summary>
A: URL connection is IP address, and the default user name is <b>root</b>, default password is <b>dietpi</b>
</details>
<details>
<summary>Q: Is <b>LibreELEC</b> supported?</summary>
A: TODO
</details>
</html>
<!--Add review function! -->
<comments />
<!--Please choose the -->
<!--Remove other categories, just keep the appropriate categories -->
[[Category:Product Manual]]
[[Category:Raspberry pi]]
[[Category:Knowledge]]
__NOTOC__
This is script installation tutorial for [[NASPi]], [[NASPi Gemini 2.5]], [[NASPi CM4-M2]] and [[NASPi CM4-2.5]]
This script also works on [https://www.raspberrypi.com/software/operating-systems/ bookworm] OS, and test it on Jan. 9th 2024.
The original key pwm fan control script is from [https://github.com/pimlie/geekworm-x-c1 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 Raspberry Pi OS.
After your system boots, then you need to open <code>Terminal</code> prpgram, then type the following command to complete the installation of the script
'''[NOTE]'''
If you are a new user, please ignore this '''NOTE'''
If you are using the latest Raspberry Pi OS bookworm version or have updated the OS kernel to the latest version 6.6, then you get the following error after running the <code>xoff</code> command:
<pre>
/usr/local/bin/x-c1-softsd.sh: line 5: echo: writing error: Invalid argument
/usr/local/bin/x-c1-softsd.sh: line 6: /sys/class/gpio/gpio27/direction: No such file or directory
/usr/local/bin/x-c1-softsd.sh: line 7: /sys/class/gpio/gpio27/value: No such file or directory
Your device will shutting down in 4 seconds...
/usr/local/bin/x-c1-softsd.sh: line 19: /sys/class/gpio/gpio27/value: No such file or directory
</pre>
The cause of this error is due to a kernel update, please perform the following update to solve the issue;
1. First go back to the directory where you installed xscript and you will see the ''xscript'' folder.
2. Then run the following command:
<pre>
cd xscript
rm x-c1-softsd.sh x-c1-pwr.sh -f
git pull origin
chmod +x *.sh
sudo cp -f . /x-c1-softsd.sh /usr/local/bin/
sudo cp -f . /x-c1-pwr.sh /usr/local/bin/
sudo reboot
</pre>
==OS that has been tested==
* Raspbian
* DietPi
* Manjaro
* Ubuntu
* myNode
* Umbrel
* Volumio
* RetroPie
* Twister
'''Note:''' Not tested with '''Home Assistant''', for some reason, we are not able to upgrade and use the Home Assistant to test, please pay attention to check if there is any update in the future.(If you have successfully tested Home Assistant, welcome to share your experience via email at: support@geekworm.com)
==Preconfigured <code>config.txt</code>==
To install pwm fan, first add <code>dtoverlay=pwm-2chan</code> to <code>/boot/firmware/config.txt</code> under [all] or the end of file and <code>reboot</code>:
sudo nano /boot/firmware/config.txt
Save & exit.
sudo reboot
==Clone the script==
<pre>
git clone https://github.com/geekworm-com/xscript
cd xscript
chmod +x *.sh
</pre>
'''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
==Create the x-c1-fan service==
<span class="tb_red_bold"> Note: If your device does not support pwm fans or you are not using pwm, you can skip this step</span>
<pre>
sudo cp -f ./x-c1-fan.sh /usr/local/bin/
sudo cp -f ./x-c1-fan.service /lib/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable x-c1-fan
sudo systemctl start x-c1-fan
</pre>
Then the pwm fan starts running.
==Create the x-c1-pwr service==
<pre>
sudo cp -f ./x-c1-pwr.sh /usr/local/bin/
sudo cp -f x-c1-pwr.service /lib/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable x-c1-pwr
sudo systemctl start x-c1-pwr
</pre>
==Prepair software shutdown script==
sudo cp -f ./x-c1-softsd.sh /usr/local/bin/
Create a alias <code>xoff</code> command to execute the software shutdown
<pre>
echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc
source ~/.bashrc
</pre>
Then you can run <code>xoff</code> to execute software shutdown.
==Test safe shutdown==
'''Software safe shutdown command''':
xoff
<span class="tb_red">DON'T run the 'shutdown' linux command to shut down, otherwise the power of shield will not be shut down.</span>
'''Hardware safe shutdown operation''':
You can verify the safety switch through the onboard switch, press and hold the switch for <code>3</code> 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 <code>1-2</code> seconds to reboot
* press button switch <code>3</code> seconds to safe shutdown,
* press <code>7-8</code> seconds to force shutdown.
==Sample==
#The code for fan speed control is now in the <code>x-c1-fan.sh</code> file.
#<code>fan-rpi.py</code> and <code>fan-pigpio.py</code> are no longer used, and are reserved here for research and use by python lovers only.
==Uninstall==
Uninstall <code>x-c1-fan.service</code>:
sudo systemctl stop x-c1-fan
sudo systemctl disable x-c1-fan
Uninstall <code>x-c1-pwr.service</code>:
sudo systemctl stop x-c1-pwr
sudo systemctl disable x-c1-pwr
Remove the <code>xoff</code> allias on .bashrc file
sudo sed -i '/xoff/d' ~/.bashrc
source ~/.bashrc
==Support==
Email: support@geekworm.com
If you have any problems during use, please contact us by email and tell us the product model you are using and the OS version you are using.
==FAQ==
<html>
<details>
<summary>Q: How to login <b>volumio</b> via SSH?</summary>
<p>1. Enable SSH:</p>
<p>Visit http://volumio.local/dev/, then click <b>ENABLE SSH</b> button</p>
<p>2. URL connection is IP address, and the default user name is <b>volumio</b>, default password is <b>volumio</b></p>
</details>
<details>
<summary>Q: How to login to <b>Umbrel</b> via SSH?</summary>
A: ssh umbrel@umbrel.local (or ssh umbrel@<IP address of your Umbrel>). the default user name is <b>umbrel</b>, default password is <b>moneyprintergobrrr</b>
</details>
<details>
<summary>Q: How to login to <b>myNode</b> via SSH?</summary>
A: URL connection is IP address, and the default user name is <b>admin</b>, default password is <b>bolt</b>
</details>
<details>
<summary>Q: How to login to <b>DietPi</b> via SSH?</summary>
A: URL connection is IP address, and the default user name is <b>root</b>, default password is <b>dietpi</b>
</details>
<details>
<summary>Q: Is <b>LibreELEC</b> supported?</summary>
A: TODO
</details>
</html>
<!--Add review function! -->
<comments />
<!--Please choose the -->
<!--Remove other categories, just keep the appropriate categories -->
[[Category:Product Manual]]
[[Category:Raspberry pi]]
[[Category:Knowledge]]