Open main menu
Geekworm Wiki

Changes

XScript

1,895 bytes added, 9 April
{{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
 
 
'''[Update]'''
 
1. NASPi series does '''not support Raspberry Pi 5 hardwared''' due to different hardware interface.
__NOTOC__2. Use gpiod instead of obsolete interface, and suuports ubuntu 23.04 also
This is 3. The script installation tutorial for [[NASPi]], [[NASPi Gemini 2now supports the Raspberry Pi OS '''BOOKWORM''' version.5]], [[NASPi CM4-M2]] You just need to '''uninstall''' the original script and [[NASPi CM4-2'''reinstall''' it.5]]<hr/>Please refer to the following:
The original pwm fan control script is from [OPen ternimal window, then run the following command:<pre>mv xscript xcript-oldgit clone https://github.com/pimlie/geekworm-com/xscriptcd xscriptchmod +x-c1 pimlie*.sh./uninstall.sh</geekworm-x-c1], pimlie implements pre>Then just follow the pwm fan shell script, which does not depend on third-party python libraries at all. Thanks to pimlieinstallation process below.
==OS that has been tested==
* DietPi
* Manjaro
* Ubuntu(Testing based on '''Ubuntu 23.04''')
* myNode
* Umbrel
* 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> or <code>/boot/config.txt</code> under [all] or the end of file and <code>reboot</code>: sudo nano /boot/firmware/config.txtSome OS's config.txt may be in the /boot/ directory, so that you need to run the following command:
sudo nano /boot/config.txt
Using <code>ls /boot/firmware/config.txt</code> you can check if the file is in the /boot/firmware/ directory
'''Or''' (it's <code>/boot/firmware/config.txt</code> if you are using <code>ubuntu os</code>)
sudo nano /boot/firmware/config.txt
Save & exit.
sudo reboot
PS: Only appending to the last line not replace.
 
===Install gpiod package===
sudo apt install -y gpiod
==Clone Download the script==
<pre>
git clone https://github.com/geekworm-com/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-Run the following command to install fan.sh /usr/local/bin/service script; sudo cp -f ./xinstall-c1fan-fanservice.service /lib/systemd/systemsudo systemctl daemon-reloadsudo systemctl enable x-c1-fansudo systemctl start x-c1-fan</pre>sh
Then the pwm fan starts running.
==Create the x-c1-pwr service==
<pre> sudo cp -f ./xinstall-c1pwr-pwrservice.sh /usr/local/bin/ ==Prepair software shutdown script== sudo cp -f x-c1-pwr.service /lib/systemd/systemsudo systemctl daemoninstall-reloadsss.shsudo systemctl enable x-c1-pwrsudo systemctl start x-c1-pwrAfter the installation is complete, an <code>xoff</code> command will be created to shut down the software.Then you can run <code>xoff</precode>to execute software shutdown.
==Prepair software shutdownUninstall== sudo cp -f ./x-c1-softsd.sh /usr/local/bin/Create a alias <code>xoff</code> Run the following command to execute the software shutdownuninstall all.<pre>echo "alias xoff=' sudo ./usr/local/bin/x-c1-softsduninstall.sh'" >> ~/.bashrcsource ~/.bashrc</pre>Then you can run <code>xoff</code> to execute software shutdown.
==Test safe shutdown==
* press <code>7-8</code> seconds to force shutdown.
==OthersSample==#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. ==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==
Retrieved from "https://wiki.geekworm.com/Special:MobileDiff/16712...19735"