Changes

Jump to navigation Jump to search

XScript

370 bytes added, 9 April
{{GD Template Impl}}
__NOTOC__This page only provides scripts on how to install '''power management & safety switch & PWM fan''' based on different OSis script installation tutorial for [[NASPi]], [[NASPi Gemini 2. 5]], [[NASPi CM4-M2]] and [[NASPi CM4-2.5]]
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''':* This script also works on [https://www.raspberrypi.com/documentationsoftware/computersoperating-systems/getting-started.html Getting startedbookworm]* [https://wwwOS, and test it on Jan.raspberrypi9th 2024.com/documentation/computers/compute-module.html#flashing-the-compute-module-emmc Flashing the Compute Module eMMC]
==For Raspbian OS=='''Test this The original key pwm fan control script based on the following OS:'''* is from [https://downloadsgithub.raspberrypi.org/raspios_arm64com/imagespimlie/raspios_arm64geekworm-2023x-05-03c1 pimlie/2023-05-03-raspios-bullseye-arm64.img.xz 2023-05-03geekworm-raspiosx-bullseye-arm64.img.xzc1]* [https://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]* [https://retropie.org.uk/download/ retropie-buster-4.8-rpi4_400.img.gz]* [https://twisteros.com/download.html TwisterOSv2, pimlie implements the pwm fan shell script, which does not depend on third-1-2party python libraries at all.imgThanks to pimlie.xz]'''Install'''
<pre>
cd ~
sudo apt-get update
sudo apt-get -y upgrade
sudo apt-get -y install git i2c-tools wiringpi python3-smbus python3-rpi.gpio
git clone https://githubNow 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.com/geekworm-com/xscript.git
cd xscriptsudo chmod +x *.shsudo cp -f .After your system boots, then you need to open <code>Terminal</pwr.sh /etc/pwr.shsudo cp -f ./softsd.sh /usr/local/bin/softsd.shcode> prpgram, then type the following command to complete the installation of the script
sudo sed -i '$ i /etc/pwr.sh &' /etc/rc.local
echo "alias xoff='sudo /usr/local/bin/softsd.sh'" >> ~/.bashrc'[Update]'''
sudo reboot now</pre>1. NASPi series does '''not support Raspberry Pi 5 hardwared''' due to different hardware interface.
If you find the following information when executing the above command:2. Use gpiod instead of obsolete interface, and suuports ubuntu 23.04 also
3. The script now supports the Raspberry Pi OS '''BOOKWORM'''0 upgraded, 0 newly installed, 0 version. You just need to remove '''uninstall''' the original script and 0 not upgraded.'''reinstall''' 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.Please refer to the following:
OPen ternimal window, then run the following command:
<pre>
mv xscript xcript-old
git clone https://github.com/geekworm-com/xscript
cd xscript
chmod +x *.sh
./uninstall.sh
</pre>
Then just follow the installation process below.
==OS that has been tested==* Raspbian* DietPi* Manjaro* Ubuntu (Testing based on ''' PWM fan controlUbuntu 23.04''' (This is optional))* myNode* Umbrel* Volumio* RetroPie* Twister
PS'''Note: You can ignore this step if you don't '' Not tested with '''Home Assistant''', for some reason, we are not able to upgrade and use the 3-Pin PWM fan Home Assistant to test, please pay attention to cool check if there is any update in the CM4future. In fact, the [[C235]] passive cooler can provide enough cooling capacity, and (If you can also avoid the trouble of fan noisehave successfully tested Home Assistant, it is included in [[NASPi CM4-M2]] and [[NASPi CM4-2welcome to share your experience via email at: support@geekworm.5]]com)
Run the below command ==Preconfigured <code>config.txt</code>==To install pwm fan, first add <code>dtoverlay=pwm-2chan</code> to get <code>/boot/firmware/config.txt</code> or <code>/boot/config.txt</code> under [all] or the fan running.end of file and <code>reboot</code>: python3 sudo nano /homeboot/pifirmware/xscript/fan-rpiconfig.py&txtBut when you reboot Some OS's config.txt may be in the device/boot/ directory, the PWM fans won't run unless so that you need to run the above following command again, so : sudo nano /boot/config.txtUsing <code>ls /boot/firmware/config.txt</code> you need to create a crontab job to keep can check if the fans running when file is in the device reboots, Please refer to [[How to add crontab job]]./boot/firmware/ directory
Save & exit.
sudo reboot
PS: Only appending to the last line not replace.
'''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 not be shut down.</span>* press button switch `1-2` seconds to reboot==Install gpiod package===* press button switch `3` seconds to safe shutdown,* press `7sudo apt install -8` seconds to force shutdown.y gpiod
'''uninstall'''==Download the script==
<pre>
sudo sed -i 'git clone https://pwrgithub.shcom/d' /etc/rc.localsudo sed geekworm-i 'com/softsd.sh/d' ~/.bashrcxscript
sudo rm /usr/local/bin/softsd.sh -fcd xscriptsudo rm /etc/pwrchmod +x *.sh -fsudo rm ~/xscript -rf sudo reboot now
</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
==For ubuntu mate / ubuntun desktop / ubuntu serverCreate 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>
est this script based on Run the following OS:command to install fan service script;* ubuntu-22 sudo .04.1/install-preinstalledfan-desktop-arm64+raspiservice.imgshThen the pwm fan starts running.xz
'''Install'''==Create the x-c1-pwr service== sudo ./install-pwr-service.sh
<pre>cd ~==Prepair software shutdown script== sudo apt-get updatesudo apt-get -y upgradesudo apt-get -y ./install git i2c-tools wiringpi python3-smbus python3-rpisss.gpiosh
git clone https:After the installation is complete, an <code>xoff<//githubcode> command will be created to shut down the software.com/geekworm-comThen you can run <code>xoff</xscriptcode> to execute software shutdown.git
cd xscript==Uninstall==sudo chmod +x *.shsudo cp -f ./pwr.sh /etc/pwrRun the following command to uninstall all.sh sudo cp -f ./softsd.sh /usr/local/bin/softsduninstall.sh
sudo cp -f ./rc.local /etc/rc.local==Test safe shutdown=='''Software safe shutdown command''': xoffsudo sed -i <span class="tb_red">DON'T run the 'shutdown'$ i /etc/pwrlinux command to shut down, otherwise the power of shield will not be shut down.sh &' </etc/rc.localspan>
echo "alias xoff='sudo /usr/local/bin/softsd.sh'" >> ~/.bashrc'Hardware safe shutdown operation''':
sudo 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 now* press button switch <code>3</code> seconds to safe shutdown,* press <code>7-8</precode>seconds to force shutdown.
If you find ==Sample==#The code for fan speed control is now in the following information when executing the above command:<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.
'''''0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded==Support==Email: support@geekworm.'''''com
Please ignore itIf you have any problems during use, it just means that your please contact us by email and tell us the product model you are using and the OS already contains these software, nothing moreversion you are using.
If reboot fails==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, please force shutdown or power off and restart.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>
''' PWM fan control''' (This is optional)<details><summary>Q: How to login to <b>myNode</b> via SSH?</summary>
PSA: 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 capacityURL connection is IP address, and you can also avoid the trouble of fan noisedefault user name is <b>admin</b>, it default password is included in [[NASPi CM4-M2]] and [[NASPi CM4-2.5]]<b>bolt</b></details>
Run the below command <details><summary>Q: How to login to get the fan running. python3 /home/pi<b>DietPi</xscriptb> via SSH?</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]].summary>
A: URL connection is IP address, and the default user name is <b>root</b>, default password is <b>dietpi</b>
</details>
'''Test safe shutdown''' xoff<details>* Please run 'xoff' to shut down or press the on-board button switch to shut down. <span style="colorsummary>Q:red;"Is <b>DON'T run the 'shutdown' linux command to shut down, otherwise the power of device will not be shut down.LibreELEC</spanb> supported?</summary>* press button switch `1-2` seconds to reboot* press button switch `3` seconds to safe shutdown,* press `7-8` seconds to force shutdown.
'''uninstall'''A: TODO<pre/details>sudo sed -i '/pwr.sh/d' /etc/rc.localsudo sed -i '/softsd.sh/d' ~/.bashrc
#Enable rc.localsudo cp -f .</rc.local /etc/rc.localhtml>
sudo rm /usr/local/bin/softsd.sh -f
sudo rm /etc/pwr.sh -f
sudo rm ~/xscript -rf
sudo reboot now
</pre>
<!--Add review function! -->

Navigation menu