Difference between revisions of "My Test"

Latest revision as of 21:19, 20 March 2024

Overview

This is script installation tutorial for X735 v2.5 & v3.0, it will replace X735 Software installation tutorial, although X735 Software installation tutorial is still available, but we strongly recommend that you use this script tutorial, which simplifies the installation process and reduces dependencies on third-party python libraries.

The core shell script of X735-script comes from from 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 OS. You need to perform the following operations in Terminal.

[NOTE]

If you are using an ubuntu system, DO NOT use version ubuntu 23.04, otherwise you will get an error similar to the following when you run x735off:

/usr/local/bin/x735-softsd.sh: line 5: /sys/class/gpio/export: No such file or directory
/usr/local/bin/x735-softsd.sh: line 6: /sys/class/gpio/gpio20/direction: No such file or directory
/usr/local/bin/x735-softsd.sh: line 7: /sys/class/gpio/gpio20/value: No such file or directory
Your device will shutting down in 4 seconds...
/usr/local/bin/x735-softsd.sh: line 19: /sys/class/gpio/gpio20/value: No such file or directory

Resolved! Please delete the old installation folder and re-install it by the following guide.

PS： This issure is be fiexed, please refer to https://github.com/geekworm-com/x735-script/issues/2

OS that has been tested

Raspbian
DietPi
Manjaro
Ubuntu
myNode
Umbrel
Volumio
RetroPie
Twister

Install

Preconfigured `config.txt`

To install pwm fan, first add dtoverlay=pwm-2chan,pin2=13,func2=4 to /boot/firmware/config.txt under [all] or the end of file and reboot:

sudo nano /boot/firmware/config.txt

Save & exit.

sudo reboot

Clone the script

Clone pruduct software script

git clone https://github.com/geekworm-com/x735-script
cd x735-script
chmod +x *.sh

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 x735-fan service

x735-fan service is for pwm fan, the pwm fan will automatically adjust the runing speed according to the temperature of the cpu after the service is started.

Run the following command to install fan service script;

./install-fan-service.sh

Then the pwm fan starts running.

Create the x735-pwr service

If you are using ubuntu verson 23.04 or more high version, please run the following command:

./install-pwr-service-ubuntu.sh

OR run the following command to install power management script;

./install-pwr-service.sh

Prepair software shutdown script

If you are using ubuntu verson 23.04 or more high version, please run the following command:

./install-sss-ubuntu.sh

OR, Run the following command to install software shutdown script (sss),

./install-sss.sh

After the installation is complete, an x735xoff command will be created to shut down the software.Then you can run x735xoff to execute software shutdown.

Uninstall

Run the following command to uninstall all.

./uninstall.sh

Test safe shutdown

Software safe shutdown command:

x735off

DON'T run the 'shutdown' linux command to shut down, otherwise the power of x735 shield will not be shut down.

Hardware safe shutdown operation:

You can verify the safety switch through the onboard switch, press and hold the switch for 3 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 1-2 seconds to reboot
press button switch 3 seconds to safe shutdown,
press 7-8 seconds to force shutdown.

Read fan speed

read_fan_speed.py is a sample python file on how to read the speed of the pwm fan. Run the following command to get the speed of the fan:

cd ~x735-script
sudo python3 read_fan_speed.py

This `read_fan_speed.py` python file depends on the third-party python library `Rpi.GPIO`. In the official Raspberry Pi OS and most third-party OS, this library is installed by default. If you run this file and get some errors, try to run the following command to install the Rpi.GPIOy library.

sudo apt-get install -y python3-smbus python3-rpi.gpio

Or you can refer to How to Install RPi.GPIO Python Library

Other

pwm_fan_control.py is no longer used, and are reserved here for research and use by python lovers only.

Support

If you have some questions or suggestions, please contact to support@geekworm.com

FAQ

Q: How to login volumio via SSH?

1. Enable SSH:

Visit http://volumio.local/dev/, then click ENABLE SSH button

2. URL connection is IP address, and the default user name is volumio, default password is volumio

Q: How to login to Umbrel via SSH?

A: ssh umbrel@umbrel.local (or ssh umbrel@). the default user name is umbrel, default password is moneyprintergobrrr

Q: How to login to myNode via SSH?

A: URL connection is IP address, and the default user name is admin, default password is bolt

Q: How to login to DietPi via SSH?

A: URL connection is IP address, and the default user name is root, default password is dietpi

Q: Is LibreELEC supported?

A: TODO

Return to X735

Enable comment auto-refresher

@@ Line 1: / Line 1: @@
 {{GD Template Impl}}
-__NOTOC__
+==Overview==
-This is script installation tutorial for [[NASPi]], [[NASPi Gemini 2.5]], [[NASPi CM4-M2]] and [[NASPi CM4-2.5]]
+This is script installation tutorial for [[X735]] v2.5 & v3.0, it will replace [[X735 Software | X735 Software installation tutorial]], although [[X735 Software | X735 Software installation tutorial]] is still available, but we strongly recommend that you use this script tutorial, which simplifies the installation process and reduces dependencies on third-party python libraries.
-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.
+The core shell script of [[X735-script]] comes from 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.
+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 OS. You need to perform the following operations in <code>Terminal</code>.
-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 using an '''ubuntu''' system, '''DO NOT''' use version '''ubuntu 23.04''', otherwise you will get an error similar to the following when you run '''x735off''':
+<pre>
+/usr/local/bin/x735-softsd.sh: line 5: /sys/class/gpio/export: No such file or directory
+/usr/local/bin/x735-softsd.sh: line 6: /sys/class/gpio/gpio20/direction: No such file or directory
+/usr/local/bin/x735-softsd.sh: line 7: /sys/class/gpio/gpio20/value: No such file or directory
+Your device will shutting down in 4 seconds...
+/usr/local/bin/x735-softsd.sh: line 19: /sys/class/gpio/gpio20/value: No such file or directory
+</pre>
+'''Resolved'''! Please delete the old installation folder and re-install it by the following guide.
+'''PS'''： This issure is be fiexed, please refer to https://github.com/geekworm-com/x735-script/issues/2
 ==OS that has been tested==
@@ Line 23: / Line 37: @@
 * 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)
+==Install==
+===Preconfigured <code>config.txt</code>===
-==Preconfigured <code>config.txt</code>==
+To install pwm fan, first add <code>dtoverlay=pwm-2chan,pin2=13,func2=4</code> to <code>/boot/firmware/config.txt</code> under [all] or the end of file and <code>reboot</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==
+===Clone the script===
-<pre>
+Clone pruduct software script
-git clone https://github.com/geekworm-com/xscript
+ git clone https://github.com/geekworm-com/x735-script
+ cd x735-script
-cd xscript
+ chmod +x *.sh
-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
+<!--
+. Download xGPIO tool
+ wget https://github.com/geekworm-com/xgpio/raw/main/bin/ubuntu/xgpio_pwr
+ wget https://github.com/geekworm-com/xgpio/raw/main/bin/ubuntu/xgpio_soft
+After the download is successful, there will be two files xGPIO_pwr and xGPIO_soft in the current directory.
+-->
-==Create the x-c1-fan service==
+===Create the x735-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>
+x735-fan service is for pwm fan, the pwm fan will automatically adjust the runing speed according to the temperature of the cpu after the service is started.
 Run the following command to install fan service script;
-  sudo bash install-fan-service.sh
+  ./install-fan-service.sh
 Then the pwm fan starts running.
-==Create the x-c1-pwr service==
+===Create the x735-pwr service===
-Run the following command to install power management script;
+If you are using <span class="tb_red">ubuntu verson 23.04</span> or more high version, please run the following command:
-  sudo bash install-pwr-service.sh
+ ./install-pwr-service-ubuntu.sh
+OR run the following command to install power management script;
+  ./install-pwr-service.sh
 ==Prepair software shutdown script==
-Run the following command to install software shutdown script (sss), and create a alias 'xoff' command to execute the software shutdown
+If you are using <span class="tb_red">ubuntu verson 23.04</span> or more high version, please run the following command:
-  sudo bash install-sss.sh
+ ./install-sss-ubuntu.sh
-Then you can run <code>xoff</code> to execute software shutdown.
+OR, Run the following command to install software shutdown script (sss),
+  ./install-sss.sh
+After the installation is complete, an <code>x735xoff</code> command will be created to shut down the software.Then you can run <code>x735xoff</code> to execute software shutdown.
+==Uninstall==
+Run the following command to uninstall all.
+ ./uninstall.sh
-==Test safe shutdown==
+===Test safe shutdown===
 '''Software safe shutdown command''':
-  xoff
+  x735off
-<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>
+<span class="tb_red">DON'T run the 'shutdown' linux command to shut down, otherwise the power of x735 shield will not be shut down.</span>
 '''Hardware safe shutdown operation''':
@@ Line 69: / Line 95: @@
 * press <code>7-8</code> seconds to force shutdown.
-==Sample==
+===Read fan speed===
-#The code for fan speed control is now in the <code>x-c1-fan.sh</code> file.
+<code>read_fan_speed.py</code> is a sample python file on how to read the speed of the pwm fan. Run the following command to get the speed of the fan:
-#<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.
+ cd ~x735-script
+ sudo python3 read_fan_speed.py
-==Uninstall==
+This `read_fan_speed.py` python file depends on the third-party python library `Rpi.GPIO`. In the official Raspberry Pi OS and most third-party OS, this library is installed by default. If you run this file and get some errors, try to run the following command to install the Rpi.GPIOy library.
-Uninstall <code>x-c1-fan.service</code>:
+  sudo apt-get install -y python3-smbus python3-rpi.gpio
- 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
+Or you can refer to [[How to Install RPi.GPIO Python Library]]
- sudo sed -i '/xoff/d' ~/.bashrc
- source ~/.bashrc
+===Other===
+<code>pwm_fan_control.py</code> is no longer used, and are reserved here for research and use by python lovers only.
 ==Support==
-Email: support@geekworm.com
+If you have some questions or suggestions, please contact to <span class="tb_red">support@geekworm.com</span>
-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==
@@ Line 124: / Line 144: @@
 </html>
+Return to [[X735]]
 <!--Add review function! -->

Difference between revisions of "My Test"

Latest revision as of 21:19, 20 March 2024

Contents

Overview

OS that has been tested

Install

Preconfigured `config.txt`

Clone the script

Create the x735-fan service

Create the x735-pwr service

Prepair software shutdown script

Uninstall

Test safe shutdown

Read fan speed

Other

Support

FAQ

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

In other languages

WIKI

Difference between revisions of "My Test"

Latest revision as of 21:19, 20 March 2024

Contents

Overview

OS that has been tested

Install

Preconfigured config.txt

Clone the script

Create the x735-fan service

Create the x735-pwr service

Prepair software shutdown script

Uninstall

Test safe shutdown

Read fan speed

Other

Support

FAQ

Navigation menu

Search

Preconfigured `config.txt`