<big>Although this tutorial is still available, but we strongly recommend that you use [[XScript]] new tutorial, and we no longer maintain this page</big>
'''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) <hr/> [Update] Support [https://getumbrel.com/ Umbrel] now. The script is '''not tested''' VMware ESXI ARM operating system. To make the 3pin PWM cooling fan running, please remove/pull out the yellow cable if you use X-C1 V1.3 version.Remove the jumper cap on "Fan FS" PIN of X-C1 V2.0 to let the fan running at full speed. NOTE: In general, two important libraries are needed to run this script: 1. pigpiod, refer to http://abyz.me.uk/rpi/pigpio/download.html 2. Python, try to run 'python --version' to check it. ==For Raspbian or / RetroPie / Twister OSv2.0.2 ==Test this script based on RetroPie 4the following OS:* Tested '2022-04-04-raspios-buster-armhf.7img" on Apr.1 and 13, 2022;* Raspbian 2021-05-07-raspios-buster-armhf, 2021-10-30-raspios-bullseye-armhf.img, 2021-10-30-raspios-bullseye-armhf-lite.img* RetroPie 4.7.1* Twister OS v2.0.2 / Twister OS 2.1.2
If reboot fails, please force shutdown or power off and restart
''' PWM fan control'''
'''Test safe shutdown'''
<pre> xoff* Please run 'xoff is safe ' to shut down or press the on-board button switch to shut down. <span style="color:red;">DON'T run the 'shutdown ' linux commandto shut down, otherwise the power of X-C1 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 shutdown.</pre>
'''uninstall'''
</pre>
==For ubuntu mate OS and / ubuntun desktop / ubuntu server==Test this script based on the following OS:* ubuntu-mate-20.04.1-desktop and * ubuntu server 21.04* ubuntu-21.04-preinstalled-desktop-arm64+raspi
'''install'''
<pre>
cd ~
sudo apt -get updatesudo apt -get upgrade #DON'T forget this step, or 'sudo pigpiod' is failed. sudo apt -get install -y unzip make gcc python git wiringpi python3-pigpio python-setuptoolspython3-rpi.gpiosudo apt-get install -y python3-distutils
#install pigpio library, also refer to http://abyz.me.uk/rpi/pigpio/download.html
sudo reboot
</pre>
'''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 X-C1 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 shutdown.
'''uninstall'''
<pre>
</pre>
== For myNode OS and Umbrel ==
About myNode, please refer to http://www.mynodebtc.com/
About Umbrel, please refer to https://getumbrel.com/
'''Install'''
login Login to mynode teminal via Putty or Xsheel tool, the default user name is `admin`, default password is `bolt`, then run the following command: Login to Umbrel teminal via Putty or Xsheel tool, the default user name is `umbrel`, default password is `moneyprintergobrrr`, then run the following command: '''FAQ''' Q: What are the credentials to SSH into my Umbrel? A: ssh umbrel@umbrel.local (or ssh umbrel@<IP address of your Umbrel>). The password is the same as your Umbrel's password. If you haven't set a password yet, the default password is: moneyprintergobrrr.
<pre>
sudo apt-get update
'''Test safe shutdown'''
<pre> xoff* Please run 'xoff is safe ' to shut down or press the on-board button switch to shut down. <span style="color:red;">DON'T run the 'shutdown ' linux commandto shut down, otherwise the power of X-C1 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 shutdown.
</pre>
'''uninstall'''
== For DietPi==
About DietPi, please refer to [https://dietpi.com/ URL]
Test 'DietPi_RPi-ARMv6-Bullseye.image' on May 5th, 2022.
'''Install'''
Test it base DietPi_RPi-ARMv8-Buster.img login to mynode via teminal via Putty or Xsheel toolwindow, the default user name is `root`, password is `dietpi`, then run the following command:
The script is installed successfully and the fan starts to run
'''Test safe shutdown'''
xoff
* Please run 'xoff is safe ' to shut down or press the on-board button switch to shut down. <span style="color:red;">DON'T run the 'shutdown ' linux commandto shut down, otherwise the power of X-C1 will not be shut down.</span>* press button switch `1-2` seconds to reboot* press button switch `3` seconds to safe shutdown,
The script is installed successfully and the fan starts to run
'''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 X-C1 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 shutdown.
'''uninstall'''
<pre>
</pre>
==For LibreELEC==
With LibreELEC it is not possible to change the system for security and stability reasons so even 'apt-get' would not be able to do this, so we cannot install some third-party libraries like pigpiod, Therefore, safe shutdown and dynamic adjustment of fan speed cannot be supported on liberelec.
'''Please pull out the yellow wire of the fan to make the fan run immediately'''
The script is installed successfully and the fan starts to run
'''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 X-C1 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 shutdown.
'''uninstall'''
<pre>
sudo ./uninstall.sh
</pre>
'''Note'''
<pre>
Enable SSH:
http://volumio.local/dev/
Name: volumio
Password: volumio
</pre>
we use the default password to run the volumio.sh, please replace default password 'volumio' with your new password in volumio.sh file .(Line 72)
==FAQ==
Q1: Can't connect to pigpio at localhost(8888)
<pre>
Can't connect to pigpio at localhost(8888)
Did you start the pigpio daemon? E.g. sudo pigpiod
Did you specify the correct Pi host/port in the environment
variables PIGPIO_ADDR/PIGPIO_PORT?
E.g. export PIGPIO_ADDR=soft, export PIGPIO_PORT=8888
Did you specify the correct Pi host/port in the
pigpio.pi() function? E.g. pigpio.pi('soft', 8888)
File "/usr/lib/python2.7/dist-packages/pigpio.py", line 1025, in _pigpio_command
sl.s.send(struct.pack('IIII', cmd, p1, p2, 0))
AttributeError: 'NoneType' object has no attribute 'send'
</pre>
A: If you find an error similar to the above, it is because pigpiod library is not started, we need to run pigpiod first,
sudo pigpiod
python 'your directory'/x-c1/fan.py &
If 'sudo' command request a password, you can use the following command:
echo 'your password' | sudo -S pigpiod
python 'your directory'/x-c1/fan.py &
You can put these two lines in the /etc/rc.local file so that it will run automatically after booting.
[[File:Volumio-rc-local.jpg|800px]]
Q2:How to get the current fan speed value? As I remember old x735 software where with such read_fan_speed.py script example, but not found such in X-C1.
A: The X-C1's PWM fan is a 3Pin FAN, and does not support reading speed. The Fan of X735 is a 4Pin PWM fan.