X-C1 Software

This tutorial is deprecated, please use the new tutorial: XScript

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)

[Update]

Support 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 / RetroPie / Twister OS v2.0.2

Test this script based on the following OS:

Tested '2022-04-04-raspios-buster-armhf.img" on Apr. 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

install

cd ~
sudo apt-get update
sudo apt-get -y upgrade
sudo apt-get -y install i2c-tools python3-smbus python3-rpi.gpio
sudo apt-get install -y git
sudo apt-get install -y pigpio python3-pigpio
git clone https://github.com/geekworm-com/x-c1.git
cd x-c1
sudo chmod +x *.sh
sudo bash install.sh
echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc
sudo reboot

If reboot fails, please force shutdown or power off and restart

PWM fan control

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. DON'T run the 'shutdown' linux command to shut down, otherwise the power of X-C1 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.

uninstall

sudo ./uninstall.sh

For ubuntu mate / ubuntun desktop / ubuntu server

Test this script based on the following OS：

ubuntu-mate-20.04.1-desktop
ubuntu server 21.04
ubuntu-21.04-preinstalled-desktop-arm64+raspi

install

cd ~
sudo apt-get update
sudo apt-get upgrade

sudo apt-get install -y unzip make gcc python git wiringpi python3-pigpio python-setuptools python3-rpi.gpio
sudo apt-get install -y python3-distutils

#install pigpio library, also refer to http://abyz.me.uk/rpi/pigpio/download.html
wget https://github.com/joan2937/pigpio/archive/master.zip
unzip master.zip
cd pigpio-master
sudo make
sudo make install

cd ~
git clone https://github.com/geekworm-com/x-c1
cd x-c1
sudo chmod +x *.sh
sudo bash install-ubuntu.sh

echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc
sudo reboot

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 X-C1 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.

uninstall

sudo ./uninstall-ubuntu.sh

For myNode OS and Umbrel

About myNode, please refer to http://www.mynodebtc.com/

About Umbrel, please refer to https://getumbrel.com/

Install

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.

 sudo apt-get update
 sudo apt-get install pigpio python-pigpio python-smbus wiringpi -y
 git clone https://github.com/geekworm-com/x-c1
 cd x-c1
 chmod +x *.sh
 sudo bash install-mynode.sh
 echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc

 sudo reboot

PWM fan control

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. DON'T run the 'shutdown' linux command to shut down, otherwise the power of X-C1 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.

uninstall

./uninstall-mynode.sh

For DietPi

About DietPi, please refer to URL

Test 'DietPi_RPi-ARMv6-Bullseye.image' on May 5th, 2022.

Install

Test it base DietPi_RPi-ARMv8-Buster.img

login via teminal window, the default user name is `root`, password is `dietpi`, then run the following command:

 sudo apt-get update
 sudo apt-get install git pigpiod python3-pigpio python3-smbus python3-rpi.gpio -y
 git clone https://github.com/geekworm-com/x-c1
 cd x-c1
 chmod +x *.sh

 sudo bash install-dietPi.sh

 echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc
 sudo reboot

PWM fan control

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. DON'T run the 'shutdown' linux command to shut down, otherwise the power of X-C1 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.

uninstall

sudo ./uninstall-dietPi.sh

For Manjaro

About Manjaro, please refer to https://manjaro.org/

Test this script based on Manjaro-ARM-kde-plasma-rpi4-21.07.img

install

cd ~
sudo pacman -Syyu
sudo pacman -S unzip make gcc python python-setuptools git

#install pigpio library, also refer to http://abyz.me.uk/rpi/pigpio/download.html
wget https://github.com/joan2937/pigpio/archive/master.zip
unzip master.zip
cd pigpio-master
sudo make
sudo make install
sudo cp /usr/local/lib/libpigpio* /usr/lib/

#install wiringpi
git clone https://github.com/WiringPi/WiringPi.git
cd WiringPi
./build

cd ~
git clone https://github.com/geekworm-com/x-c1
cd x-c1
sudo chmod +x *.sh
sudo bash install-manjaro.sh

#create a alias xoff
echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc
sudo reboot

PWM fan control

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. DON'T run the 'shutdown' linux command to shut down, otherwise the power of X-C1 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.

uninstall

sudo ./uninstall-ubuntu.sh

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

return to NASPi

For Volumio

Test this script based on the following OS:

Volumio-3.175-2021-12-13-pi.img

install

cd ~
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install -y git pigpio 
sudo apt-get install -y python-pigpio python3-pigpio
sudo apt-get install -y python-smbus python3-smbus
git clone https://github.com/geekworm-com/x-c1.git
cd x-c1
sudo chmod +x *.sh
sudo bash volumio.sh
echo "alias xoff='sudo /usr/local/bin/x-c1-softsd.sh'" >> ~/.bashrc
sudo reboot

PWM fan control

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. DON'T run the 'shutdown' linux command to shut down, otherwise the power of X-C1 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.

uninstall

sudo ./uninstall.sh

Note

Enable SSH:
http://volumio.local/dev/
Name: volumio
Password: volumio

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)

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)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Traceback (most recent call last):
  File "/home/volumio/x-c1/fan.py", line 8, in <module>
    pwm.set_mode(servo, pigpio.OUTPUT)
  File "/usr/lib/python2.7/dist-packages/pigpio.py", line 1376, in set_mode
    return _u2i(_pigpio_command(self.sl, _PI_CMD_MODES, gpio, mode))
  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'

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.

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.

Enable comment auto-refresher

Anonymous user #74

3 months ago

Score 0

For anyone for whom the install.sh breaks the boot sequence with an infinite loop of error messages (complaining that the file or directory wasn't found for /sys/class/gpio/gpio17/ or something):

1. Go to the install.sh file 2. Replace the first echo block with:

``` echo '#!/bin/bash

SHUTDOWN=4 REBOOTPULSEMINIMUM=200 REBOOTPULSEMAXIMUM=600

echo "$SHUTDOWN" > /sys/class/gpio/export
echo "in" > /sys/class/gpio/gpio$SHUTDOWN/direction

BOOT=17

echo "$BOOT" > /sys/class/gpio/export
echo "out" > /sys/class/gpio/gpio$BOOT/direction
echo "1" > /sys/class/gpio/gpio$BOOT/value

gpioset --mode=wait gpiochip0 $BOOT=1

echo "Your device are shutting down..."

while [ 1 ]; do

shutdownSignal=$(cat /sys/class/gpio/gpio$SHUTDOWN/value)

shutdownSignal=$(gpioget gpiochip0 $SHUTDOWN)

if [ $shutdownSignal = 0 ]; then /bin/sleep 0.2 else pulseStart=$(date +%s%N | cut -b1-13) while [ $shutdownSignal = 1 ]; do /bin/sleep 0.02 if [ $(($(date +%s%N | cut -b1-13)-$pulseStart)) -gt $REBOOTPULSEMAXIMUM ]; then echo "Your device are shutting down", SHUTDOWN, ", halting Rpi ..." sudo poweroff exit fi

shutdownSignal=$(cat /sys/class/gpio/gpio$SHUTDOWN/value)

shutdownSignal=$(gpioget gpiochip0 $SHUTDOWN) done if [ $(($(date +%s%N | cut -b1-13)-$pulseStart)) -gt $REBOOTPULSEMINIMUM ]; then echo "Your device are rebooting", SHUTDOWN, ", recycling Rpi ..." sudo reboot exit fi fi done' > /etc/x-c1-pwr.sh ```

3. Replace the shutdown echo block with:

``` echo '#!/bin/bash

BUTTON=27

echo "$BUTTON" > /sys/class/gpio/export;
echo "out" > /sys/class/gpio/gpio$BUTTON/direction
echo "1" > /sys/class/gpio/gpio$BUTTON/value

gpioset --mode=wait gpiochip0 $BUTTON=1

SLEEP=${1:-4}

re='^[0-9\.]+$' if ! $SLEEP =~ $re ; then echo "error: sleep time not a number" >&2; exit 1 fi

echo "Your device will shutting down in 4 seconds..." /bin/sleep $SLEEP

gpioset --mode=wait gpiochip0 $BUTTON=0

echo "0" > /sys/class/gpio/gpio$BUTTON/value

' > /usr/local/bin/x-c1-softsd.sh ```

Now it should be safe to run `sudo bash install.sh`. Worked for me at least.

The echo > sys/classes/gpio method is no longer supported on newer releases of raspberry pi's os. The commented out lines are the original ones, below them is usually my correction.

Permalink | Reply

Anonymous user #73

8 months ago

Score 0

howto on esxi fling raspberry?

does the script work on it?

Permalink | Reply

Lisa

8 months ago

Score 0

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.

X-C1 Software

Contents

For Raspbian / RetroPie / Twister OS v2.0.2

For ubuntu mate / ubuntun desktop / ubuntu server

For myNode OS and Umbrel

For DietPi

For Manjaro

For LibreELEC

For Volumio

FAQ