Changes

Jump to navigation Jump to search

XScript

3,175 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 into micro sd card or nvme ssd, please refer to the This script also works on [https://www.raspberrypi.com/documentationsoftware/computersoperating-systems/getting-startedbookworm] OS, and test it on Jan. 9th 2024.html official document]
==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_arm64-2023geekworm-05x-03c1 pimlie/2023geekworm-05x-03-raspios-bullseye-arm64.img.xz 2023-05c1], pimlie implements the pwm fan shell script, which does not depend on third-03-raspios-bullseye-arm64party python libraries at all.imgThanks to pimlie.xz]'''Install'''
 
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.
 
2. Use gpiod instead of obsolete interface, and suuports ubuntu 23.04 also
 
3. The script now supports the Raspberry Pi OS '''BOOKWORM''' version. You just need to '''uninstall''' the original script and '''reinstall''' it. Please refer to the following:
 
OPen ternimal window, then run the following command:
<pre>
mv xscript xcript-oldgit clone https://github.com/geekworm-com/xscriptcd ~xscriptchmod +x *.sh./uninstall.sh</pre>Then just follow the installation process below. ==OS that has been tested==* Raspbiansudo apt-get update* DietPisudo apt-get -y upgrade* Manjarosudo apt-get -y install i2c-tools python3-smbus python3-rpi* Ubuntu (Testing based on '''Ubuntu 23.gpio04''')* myNode* Umbrel* Volumio* RetroPiesudo apt-get install -y git* 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.txtUsing <code>ls /boot/firmware/config.txt</code> you can check if the file is in the /boot/firmware/ directory Save & exit. sudo rebootPS: Only appending to the last line not replace. ===Install gpiod package=== sudo apt install -y gpiod ==Download the script==<pre>git clone https://github.com/geekworm-com/xscript.git
cd xscript
sudo 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 cp apt install -f 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> Run the following command to install fan service script; sudo ./install-fan-service.shThen the pwm fan starts running. ==Create the x-c1-pwrservice== sudo .sh /etc/install-pwr-service.sh ==Prepair software shutdown script== sudo cp -f ./softsdinstall-sss.sh  After the installation is complete, an <code>xoff</usrcode> command will be created to shut down the software.Then you can run <code>xoff</local/bin/softsdcode> to execute software shutdown. ==Uninstall==Run the following command to uninstall all.sh sudo sed -i '$ i ./etc/pwruninstall.sh & ==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.</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
sudo rm </usr/local/bin/softsd.sh -fsudo rm /etc/pwr.sh -fsudo rm ~/xscript -rfhtml>
sudo reboot now
</pre>

Navigation menu