X729-script

Overview

This is script installation tutorial for X729 shield, it will replace X729 Software installation tutorial, although X729 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.

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.

OS that has been tested

• Raspbian
• DietPi
• Manjaro
• Ubuntu
• myNode
• Umbrel
• Volumio
• RetroPie
• Twister

Install

Please follow the steps below:

Enable I2C

Reter to How to enable I2C

NOTE: sample/bat.py will run with error if you don't enable I2C.

Check & review I2C address:

pi@raspberrypi:~ $ sudo i2cdetect -y 1
     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
00:          -- -- -- -- -- -- -- -- -- -- -- -- -- 
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 
20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 
30: -- -- -- -- -- -- 36 -- -- -- -- -- 3c -- -- -- 
40: 40 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 
60: -- -- -- -- -- -- -- -- 68 -- -- -- -- -- -- -- 
70: -- -- -- -- -- -- -- --   

Explaination:

#36 - the address of the battery fuel gauging chip
#3c - address of oled display，This value only exists when the oled is inserted，check if the OLED is inserted in the correct direction if you don't found the above i2c port
#40 - TI INA219 12-bit current/voltage/power monitor
#68 - the address of the RTC chip

Preconfigured config.txt

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

sudo nano /boot/config.txt

Or (it's /boot/firmware/config.txt if you are using ubuntu os)

sudo nano /boot/firmware/config.txt

Save & exit.

sudo reboot

Clone the script

git clone https://github.com/geekworm-com/x729-script

cd x729-script
chmod +x *.sh

Create the x729-fan service

x729-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.

sudo cp -f ./x729-fan.sh                /usr/local/bin/
sudo cp -f ./x729-fan.service           /lib/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable x729-fan
sudo systemctl start x729-fan

Then the pwm fan starts running.

Create the x729-pwr service

x729-pwr service will be responsible for power management and hardware safe shutdown.

sudo cp -f ./x729-pwr.sh                /usr/local/bin/
sudo cp -f x729-pwr.service             /lib/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable x729-pwr
sudo systemctl start x729-pwr

Now, if you press and hold the onboard 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.

Prepair software shutdown script

sudo cp -f ./x729-softsd.sh             /usr/local/bin/

Create a alias x729off command to execute the software shutdown

echo "alias x729off='sudo /usr/local/bin/x729-softsd.sh'" >>   ~/.bashrc
source ~/.bashrc

Then you can run x729off to execute software shutdown as follows

x729off

Test safe shutdown

Software safe shutdown command:

x729off

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

Sample Files

The example programs are only suitable for advanced players, and you can construct your own usage scenarios according to the example programs.

Each example program demonstrates a different function:

read_fan_speed.py: Read the pwm fan running speed;

cd ~x729-script
sudo python3 sample/read_fan_speed.py

pld.py: AC Power supply loss dection script;

cd ~x729-script
sudo python3 sample/pld.py.py

plsd.py: Auto shutdown when AC power loss or power adapter failure script;(Added auto shuntdown function base pld.py)

cd ~x729-script
sudo python3 sample/plsd.py

buzzer.py: demonstrates how the buzzer will sound when power supply is lost, which is very important in some usage scenarios.

cd ~x729-script
sudo python3 sample/buzzer.py

PS:

1. The above sample python file maybe 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

2. The sample program is only to demonstrate how to use the advanced functions of the shield, we do not provide the development function of the sample program.

Enable OLED display

Refer to How to enable OLED display

Set and Read the RTC time

PS: We only test this step on Raspberry Pi OS;

1. To enable RTC module, first add dtoverlay=i2c-rtc,ds1307 to /boot/config.txt under [all] or the end of file and reboot:

sudo nano /boot/config.txt

Save and exit. In nano, you do that by hitting CTRL + X, answering Y and hitting Enter when prompted.

2. Run the commands to disable the "fake hwclock" which interferes with the 'real' hwclock

sudo apt-get -y remove fake-hwclock
sudo update-rc.d -f fake-hwclock remove
sudo systemctl disable fake-hwclock

3. Then run the following command to comment out 7-12 line in file /lib/udev/hwclock-set:

sudo nano /lib/udev/hwclock-set

‎

 1 #!/bin/sh
 2 # Reset the System Clock to UTC if the hardware clock from which it
 3 # was copied by the kernel was in localtime.
 4 
 5 dev=$1
 6 
 7 #if [ -e /run/systemd/system ] ; then
 8 #    exit 0
 9 #fi
10 #
11 #/sbin/hwclock --rtc=$dev --systz
12 #/sbin/hwclock --rtc=$dev --hctosys
13 ‎

PS: Inserting a `# `at the beginning of a line means to comment the line

4. Reboot the Raspberry Pi

sudo reboot

5. Run the command to verify the time is correct. Plug in Ethernet or WiFi to let the Pi sync the right time from the Internet

date

6. Run the command to write the time

 sudo hwclock -w

7. Run the command to read the time

 sudo hwclock -r

Once the time is set, make sure the batteries are inserted so that the time is saved. You only have to set the time once. That's it! Next time you boot the time will automatically be synced from the shield.

Other

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

Support

Email: 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

Other resource

• X729-Chip-Specifications：File:MAX17040-MAX17041.pdf
• I2C address: 0x36 for battery fuel gauging, 0x68 for RTC

References: *Raspberry Pi Tutorial: How to Use a Buzzer

Return to X729 or X729-hardware

Add your comment

Geekworm Wiki welcomes all comments. If you do not want to be anonymous, register or log in. It is free.

Sort by date Sort by score

Enable comment auto-refresher

You are ignoring the author of this comment

Show comment | Manage ignore list

Anonymous user #1

one day 3 hours 56 minutes ago

Score 0

There is no 'install-ssh.sh script in the Repo linked. Its 'install-sss.sh' and that script makes reference to the X728 instead of X729. I know its just a PRINT statement for user notification but it creates some confusion. Line 9 of that script is also commented out so it doesnt actually create the ALIAS to shutdown the pi and poweroff the UPS. '#echo "alias x79off='sudo /usr/local/bin/xSoft.sh 0 26'" >> ~/.bashrc'

and the Alias its supposed to create is missing the 2 from x729, so telling the user to enter 'x729off' to shutdown wouldnt work even if it did properly create the alias.

Permalink | Reply

You are ignoring the author of this comment

Show comment | Manage ignore list

Harry

4 hours 4 minutes ago

Score 0

Thank you for your detailed correction.

I just modified x728-script to x729-script, and modifed x79off to x729off also.

I did remove the command to create the alias x729off in the install-sss.sh script yesterday, because I found that this command would fail to execute in some Linux environments, and it has happened several times. Now this command needs to be executed manually. I have put it on the wiki page.

I tried to explain why the file on github is incorrect. It is really frustrating that you can't always visit github.com in China, so sometimes submissions fail. But I did test our script and it works fine.

Thank you again for your comments. The correct description of the wiki page is indeed very important, and we will work hard to do better.

Permalink

You are ignoring the author of this comment

Show comment | Manage ignore list

Anonymous user #2

one day 12 hours 17 minutes ago

Score 0

There are a LOT of errors in this documentation. Documentation does not match up with reality of whats cloned from Git, there are spelling errors in scripts, there are errors thrown by script. These install instructions simply dont work.

Permalink | Reply

You are ignoring the author of this comment

Show comment | Manage ignore list

Harry

one day 7 hours 20 minutes ago

Score 0

Thanks.

I have update 'install-ssh-v1.sh' to install-ssh.sh' on wiki, could you tell more detai.

And we did test the x729 script on pi 5 and pi 4.

Permalink

You are ignoring the author of this comment

Show comment | Manage ignore list

Anonymous user #1

3 days ago

Score 0

pi@RasPi4:~/x729-script $ sudo python3 sample/read_fan_speed.py Traceback (most recent call last): File "/home/pi/x729-script/sample/read_fan_speed.py", line 28, in <module> GPIO.add_event_detect(TACH, GPIO.FALLING, fell)

RuntimeError: Failed to add edge detection

Permalink | Reply

You are ignoring the author of this comment

Show comment | Manage ignore list

Harry

one day 7 hours 43 minutes ago

Score 0

Refer to https://gith.../issues/6037,

You can change it with other gpio liberary such as gpiod.

We just provide the sample code, so if you are new to this, ignore it.

Permalink