Changes

Jump to navigation Jump to search

XScript

9,278 bytes removed, 11:33, 13 July 2023
no edit summary
{{GD Template Impl}}
==Overview==
This page only provides scripts and tutorial on how to install '''power management & safety switch & PWM fan''' based on different OS.
If you need to know how to flash raspberry pi OS image into micro sd card or nvme ssd, please refer to the following '''official document''':* [https://www.raspberrypi.com/documentation/computers/getting-started.html Getting started]* [https://www.raspberrypi.com/documentation/computers/compute-module.html#flashing-the-compute-module-emmc Flashing the Compute Module eMMC]__NOTOC__
==For Raspbian OS=='''Test this This is script based on the following OS:'''* installation tutorial for [[NASPi]], [[https://downloadsNASPi Gemini 2.raspberrypi.org/raspios_arm64/images/raspios_arm645]], [[NASPi CM4-2023M2]] and [[NASPi CM4-05-03/2023-05-03-raspios-bullseye-arm642.img.xz 2023-05-03-raspios-bullseye-arm64.img.xz5]]* [https:<hr//downloads.raspberrypi.org/raspios_lite_arm64/images/raspios_lite_arm64-2023-05-03/2023-05-03-raspios-bullseye-arm64-lite.img.xz 2023-05-03-raspios-bullseye-arm64-lite.img.xz]>* The original code is from [https://retropiegithub.org.ukcom/downloadpimlie/ retropie-bustergeekworm-4.8x-rpi4_400.img.gz]* [https:/c1 pimlie/twisteros.com/download.html TwisterOSv2geekworm-1x-2.img.xzc1]===Install===<pre>cd ~sudo apt, pimlie implements the pwm fan shell script, which does not depend on third-get updatesudo apt-get -y upgradesudo apt-get -y install git i2c-tools python3-smbus python3-rpiparty python libraries at all. Thanks to pimlie.gpio
git clone https://github.com/geekworm-com/xscript.git==OS that has been tested==* Raspbian* DietPi* Manjaro* Ubuntu* myNode* Umbrel* Volumio
cd xscriptsudo chmod +x *==Preconfigured <code>config.shtxt</code>==sudo cp To install pwm fan, first add <code>dtoverlay=pwm-f .2chan</code> to <code>/boot/pwrconfig.sh txt</etccode> under [all] or the end of file and <code>reboot</pwr.shcode>: sudo cp -f ./softsd.sh /usr/localnano /binboot/softsdconfig.shtxt
sudo sed -i '$ i ''Or''' (it's <code>/boot/etcfirmware/pwrconfig.sh &' txt</code> if you are using <code>ubuntu</code>) sudo nano /boot/etcfirmware/rcconfig.txtSave & exit.local sudo reboot
echo "alias xoff='sudo =Clone the script==<pre>git clone https:/usr/localgithub.com/bingeekworm-com/softsd.sh'" >> ~/.bashrcscript-test
sudo reboot nowcd script-testchmod +x *.sh
</pre>
==Create the x-c1-fan service==
<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.
If you find the following information when executing the above command: '''''0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.''''' Please ignore it, it just means that PS: If your OS already contains these software, nothing more. If reboot fails, please force shutdown or power off and restart.  ===Test safe shutdown=== xoff* Please run 'xoff' to shut down or press the on-board button switch to shut down. <span style="color:red;">DON'T run the 'shutdown' linux command to shut down, otherwise the power of device will does not be shut down.</span>* press button switch `1-2` seconds to reboot* press button switch `3` seconds to safe shutdown,* press `7-8` seconds to force shutdown. ===How to enable OLED display===Please refer to [[How to enable OLED display]] === PWM fan control''' (This is optional)=== PS: You can ignore this step if you don't use the 3-Pin PWM fan to cool the CM4. In fact, the [[C235]] passive cooler can provide enough cooling capacity, and you can also avoid the trouble of fan noise, it is included in [[NASPi CM4-M2]] and [[NASPi CM4-2.5]] Run the below command to get the fan running. python3 /home/pi/xscript/fan-rpi.py &But when you reboot the device, the PWM support pwm fans won't run unless or you run the above command again, There are serveral methods to enable fan run after the device reboots, recommend the first method: 1. Create a crontab job, place the command 'python3 /home/geekworm/xscript/fan-rpi.py&' into the crontab, refer to [[How to add crontab job]]. 2. Place the running command into the /etc/rc.local filenot using pwm, you can run the following command: sudo sed -i '$ i python3 /home/pi/xscript/fan-rpi.py &' /etc/rc.localNOTE: Please make sure the fan-rpi.py file path is correct;  ===Uninstall=== sudo ./uninstall.sh sudo reboot now ==For ubuntu mate / ubuntun desktop / ubuntu server== Test skip this script based on the following OS:* ubuntu-22.04.1-preinstalled-desktop-arm64+raspi.img.xz '''Installstep'''
==Create the x-c1-pwr service==
<pre>
cd ~sudo aptcp -get updatesudo apt-get upgrade -ysudo apt-get install -y git i2c-tools wiringpi python3-setuptools python3-distutils python3-rpif .gpio python3-smbus git clone https://github.com/geekwormx-com/xscript.git cd xscriptsudo chmod +x *.sh rc.localsudo cp c1-f ./pwr.sh /etc/pwr.shsudo cp -f ./softsd.sh /usr/local/bin/softsd.sh #Enable rc.localsudo cp -f x-c1-pwr.service /rc.local lib/etcsystemd/rc.localsystemsudo systemctl daemon-reloadsudo sed systemctl enable x-c1-i '$ i /etc/pwr.sh &' /etc/rc.local echo "alias xoff='sudo /usr/local/bin/softsd.sh'" >> ~/.bashrc sudo reboot nowsystemctl start x-c1-pwr
</pre>
If you find Then the following information when executing the above command: '''''0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.''''' Please ignore it, it just means that your OS already contains these software, nothing more. If reboot fails, please force shutdown or power off and restart.  ''' PWM pwm fan control''' (This is optional)starts running
PS: You can ignore this step if you don't use the 3-Pin PWM fan to cool the CM4. In fact, the [[C235]] passive cooler can provide enough cooling capacity, and you can also avoid the trouble of fan noise, it is included in [[NASPi CM4-M2]] and [[NASPi CM4-2.5]] Run the below command to get the fan running.==Prepair software shutdown== python3 /home/geekworm/xscript/fansudo cp -rpi.py&NOTE: You need change the 'geekworm' to your username; But when you reboot the device, the PWM fans won't run unless you run the above command again,  There are '''serveral methods''' to enable fan run after the device reboots: 1f . Create a crontab job, place the command 'python3 /home/geekworm/xscript/fanx-c1-rpisoftsd.py&' into the crontab, refer to [[How to add crontab job]]. 2. Place the running command into the sh /etcusr/rc.local file, you can run the following command: sudo sed -i '$ i python3 /home/geekworm/xscript/fan-rpi.py&' /etcbin/rc.local NOTE: You need change the 'geekworm' to your username; '''Test safe shutdown''' Create a alias <code>xoff* Please run 'xoff' to shut down or press the on-board button switch to shut down. <span style="color:red;"/code>DON'T run the 'shutdown' linux command to shut down, otherwise execute the power of device will not be shut down.</span>* press button switch `1-2` seconds to reboot* press button switch `3` seconds to safe shutdown,* press `7-8` seconds to force software shutdown. '''uninstall''' sudo ./uninstall.sh sudo reboot now == For DietPi==* [https://dietpi.com/#download DietPi_RPi-ARMv8-Bullseye.7z] '''Install''' login via teminal window, the default user name is `root`, password is `dietpi`, then run the following command:
<pre>
cd ~sudo apt-get updatesudo apt-get -y upgradesudo apt-get -y install git i2c-tools python3 python3-smbus python3-rpi.gpio git clone https://github.com/geekworm-com/xscript.git cd xscriptsudo chmod +x *.sh rc.localsudo cp -f ./pwr.sh /etc/pwr.shsudo cp -f ./softsd.sh /usr/local/bin/softsd.sh sudo cp -f ./rc.local /etc/rc.local sudo sed -i '$ i /etc/pwr.sh &' /etc/rc.localecho "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc sudo reboot nowsource ~/.bashrc
</pre>
Then you can run <code>xoff</code> to execute software shutdown.
''' PWM fan control''' (This is optional) PS: You can ignore this step if you don't use the 3-Pin PWM fan to cool the CM4. In fact, the [[C235]] passive cooler can provide enough cooling capacity, and you can also avoid the trouble of fan noise, it is included in [[NASPi CM4-M2]] and [[NASPi CM4-2.5]] Run the below command to get the fan running. python3 /root/xscript/fan-rpi.py&But when you reboot the device, the PWM fans won't run unless you run the above command again, so you need to create a crontab job to keep the fans running when the device reboots, Please refer to [[How to add crontab job]]. ==Test safe shutdown=='''Test Software safe shutdowncommand''':
xoff
* Please run 'xoff' to shut down or 'Hardware safe shutdown operation''':* press the on-board button switch to shut down. <span style="color:red;"code>DON'T run the 'shutdown' linux command to shut down, otherwise the power of device will not be shut down.1-2</spancode>* press button switch `1-2` seconds to reboot* press button switch `<code>3` </code> seconds to safe shutdown,* press `<code>7-8` </code> seconds to force shutdown. '''uninstall''' sudo ./uninstall.sh sudo reboot now ==For Manjaro==Test this script base on the following OS:* [https://manjaro.org Manjaro-ARM-gnome-rpi4-23.02.img.xz] ===1. Install=== '''Update system & install dependent packages''' cd ~ sudo pacman -Syyu sudo pacman -S python python-setuptools '''Install RPi.GPIO Python Library''' The script that the fan runs depends on the RPi.GPIO Python library. Since this OS does not include this package by default, we need to install it manually. Refer to [[How to Install RPi.GPIO Python Library]], and you need use the ''''Method 2 – Manual Installation'''' '''Download script''' cd ~ git clone https://github.com/geekworm-com/xscript.git If the current OS does not include the git tool, then you need to use the following command to install it firstly sudo pacman -S git '''Install script''' cd ~/xscript sudo chmod +x *.sh rc.local sudo cp -f ./pwr.sh /etc/pwr.sh sudo cp -f ./softsd.sh /usr/local/bin/softsd.sh '''Enable rc.local service''' sudo cp -f ./rc.local /etc/rc.local sudo cp rc.local.service /lib/systemd/system sudo systemctl enable rc.local  sudo sed -i '$ i /etc/pwr.sh &' /etc/rc.local sudo sed -i '$ i sudo python3 ~/xscript/fan-rpi.py &' /etc/rc.local
==FAQ==Q: How to login '''Create a alias xoffvolumio''' echo "alias xoff='sudo /usr/local/bin/softsd.sh'" >> ~/.bashrcThen reboot the device sudo reboot nowvia SSH?
===2. Test safe shutdown=== xoff* Please run 'xoff' to shut down or press the on-board button switch to shut down. DON'T run the 'shutdown' linux command to shut down, otherwise the power of device will not be shut down.* press button switch `1-2` seconds to reboot* press button switch `3` seconds to safe shutdown,* press `7-8` seconds to force shutdown.A:
===31. PWM fan control (Optional)===Enable SSH:
PSVisit http: You can ignore this step if you don't use the 3-Pin PWM fan to cool the CM4//volumio. In factlocal/dev/, the C235 passive cooler can provide enough cooling capacity, and you can also avoid the trouble of fan noise, it is included in [[NASPi CM4-M2]] and [[NASPi CM4-2.5]]then click 'ENABLE SSH' button
Run the below command to get the fan running. sudo python3 ~/xscript/fan-rpi2.py &But when you reboot the deviceURL connection is IP address, and the PWM fans wondefault user name is '''volumio'''t run unless you run the above command again,default password is '''volumio'''
ON Manjaro OS, Place the running command into the '/etc/rc.local file', then this command will be execute after the device reboot, you can run the following command:
sudo sed -i '$ i echo "your password" | sudo -S python3 ~/xscript/fan-rpi.py &' /etc/rc.local
NOTE: Please make sure the fan-rpi.py file path is correct;
===4. Uninstall=== cd ~/xscript sudo ./uninstall.sh sudo reboot nowQ: How to login to '''Umbrel''' via SSH?
==For myNode OS and Umbrel==* [httpsA://mynodebtc.com/ mynode_raspi4_arm64_0-3-18.img.gz], the default user name is `'''admin'''`, default password is `'''bolt'''`* [https://ssh umbrel@umbrel.com/ local (or ssh umbrel-os-v0.5.3@<IP address of your Umbrel>).zip],the default user name is `'''umbrel'''`, default password is `'''moneyprintergobrrr'''`
===1. Install===
sudo apt-get update sudo apt-get install pigpio python-pigpio python-smbus wiringpi -y cd ~ git clone httpsQ://github.com/geekworm-com/xscript.git sudo chmod +x *.sh rc.local sudo cp -f ./pwr.sh /etc/pwr.sh sudo cp -f ./softsd.sh /usr/local/bin/softsd.sh sudo sed -i How to login to '$ i /etc/pwr.sh &' /etc/rc.local'myNode''' via SSH?
echo "alias xoff=A: URL connection is IP address, and the default user name is '''admin''', default password is '''bolt''sudo /usr/local/bin/softsd.sh'" >> ~/.bashrc
Then reboot the device
sudo reboot now
===2. Test safe shutdown=== xoff* Please run Q: How to login to 'xoff' to shut down or press the on-board button switch to shut down. DON'T run the DietPi''shutdown' linux command to shut down, otherwise the power of device will not be shut down.* press button switch `1-2` seconds to reboot* press button switch `3` seconds to safe shutdown,* press `7-8` seconds to force shutdown.via SSH?
===3. PWM fan control (Optional)===A: URL connection is IP address, and the default user name is '''root''', default password is '''dietpi'''
PS: You can ignore this step if you don't use the 3-Pin PWM fan to cool the CM4. In fact, the C235 passive cooler can provide enough cooling capacity, and you can also avoid the trouble of fan noise, it is included in [[NASPi CM4-M2]] and [[NASPi CM4-2.5]]
Run the below command to get the fan running. sudo systemctl enable pigpiod sudo sed -i '$ i sudo pigpiod' /etc/rc.local sudo python ~/xscript/fan.py &But when you reboot the device, the PWM fans won't run unless you run the above command again,Q: Is LibreELEC supported?
ON myNode OS, create a crontab,place the following command into the crontab file, then this command will be execute after the device reboot, refer to [[How to add crontab job]]. * * * * * python ~/xscript/fan.py &A: TODO
NOTE: Please make sure the fan.py file path is correct;
<!--Add review function! -->

Navigation menu