Admin: Replace with

2026-05-27T02:13:53Z

Replace <comments/> with <comment-streams />

← Older revision		Revision as of 10:13, 27 May 2026
Line 128:		Line 128:

	<!--Add review function! -->		<!--Add review function! -->
	<comment-streams />		<comment-streams id="main" />

	<!--Please choose the -->		<!--Please choose the -->

Admin: Replace with

2026-05-26T12:08:01Z

Replace <comments/> with <comment-streams />

← Older revision		Revision as of 20:08, 26 May 2026
Line 128:		Line 128:

	<!--Add review function! -->		<!--Add review function! -->
	<~~comments~~ />		<comment-streams />

	<!--Please choose the -->		<!--Please choose the -->

Cindy at 10:22, 24 April 2026

2026-04-24T10:22:52Z

← Older revision		Revision as of 18:22, 24 April 2026
Line 1:		Line 1:
	{{GD Template Impl}}		{{GD Template Impl}}
			{{Deprecated\|Please refer to [[X728-script]].}}

	<big>Although this installation tutorial is still available, but we strongly recommend that you use [[X728-script]] new tutorial, and we no longer maintain this page.</big>		<big>Although this installation tutorial is still available, but we strongly recommend that you use [[X728-script]] new tutorial, and we no longer maintain this page.</big>

Harry at 17:09, 22 July 2023

2023-07-22T17:09:49Z

New page

{{GD Template Impl}}
<big>Although this installation tutorial is still available, but we strongly recommend that you use [[X728-script]] new tutorial, and we no longer maintain this page.</big>

<hr/>

The following test is base on [https://www.raspberrypi.com/software/operating-systems/ 2022-01-28-raspios-bullseye-armhf.zip]

Python version is 3;

1. Enable I2C funcion on Raspbian:
reter to [[How to enable I2C]]

2. Login via teminal window, then update & upgrade & install necessary software (python and i2c tool library)
sudo apt-get update
sudo apt-get upgrade
sudo apt-get -y install i2c-tools python3-smbus python-smbus

2.1 Once you have logged into your Raspberry Pi from the command line, run the command to see all the connected devices
sudo i2cdetect -y 1
[[File:X728x-i2c.png]]
#36 - the address of the battery fuel gauging chip
#68 - the address of the RTC chip
#Different x728 versions may have different values

3. Download x728 setup scripts:
cd ~
git clone https://github.com/geekworm-com/x728

4. Install script&reboot:

Firstly please select your x728 version, please use x728-v2.1.sh for x728 v2.1 and v2.2 and '''v2.3'''
sudo bash x728-v2.1.sh
#New add buzzer support
or
sudo bash x728-v2.0.sh
or
sudo bash x728-v1.0.sh
then
sudo reboot

You can get the following python file in /home/pi/ fold:

x728bat.py # Reading battery voltage
x728pld.py # Testing AC power off/loss or power adapter failure detection, added buzzer function on v2.1
x728plsd.py # Testing Auto shutdown when AC power loss or power adapter failure

5. Set and Read the RTC time
#If you need to set the system time for any reason you can use the following command :
date -s "5 MAR 2019 13:00:00"

#Write the system date and time to the RTC module after your correct the system date and time :
sudo hwclock -w

#Read the date and time back from the RTC module:
sudo hwclock -r

6. How to reading battery voltage and percentage, this is the sample code, you can modify it by your request.
sudo python /home/pi/x728bat.py
[[File:X728-bat-2.jpg]]

User Guide: https://github.com/geekworm-com/x728 to know more details;

But we hope that the script can be executed automatically when the Raspberry Pi board boots, we can use crontab system command to achieve it. Refer to [[How to add crontab job]] or refer to the following:
sudo crontab -e
[[File:Crontab-step1.png]]

Choose "`1`" then press Enter

Add a line at the end of the file that reads like this:
@reboot python /home/pi/x728bat.py
[[File:X728-crontab.png|800px]]

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

7. Power off command on Raspbian from software
x728off
* x728off is safe shutdown command
* press on-board blue button 1-2 seconds to reboot
* press on-board blue button 3 seconds to safe shutdown,
* press on-board blue button 7-8 seconds to force shutdown.

8. Testing AC power off/loss or power adapter failure detection (need to short the 'PLD' pin on v1.x), also test the buzzer function on v2.1
cd ~
sudo python3 x728pld.py
or
sudo python x728pld.py

[[File:X728-pld-2.jpg]]

PS:

1. X728pld.py is '''ONLY''' a sample code file, you can modify it according to your own needs

2. The buzzer is controlled by software. It is found that some customers do not know how to turn off the buzzer's warning sound. Here is a reminder.

[[File:X728-buzzer.png|800px]]

9. '''Testing Auto shutdown when AC power loss''' or power adapter failure
cd ~
sudo python3 x728pld.py
or
sudo python x728plsd.py

==uninstall x728 script==
uninsatll x728 shell script, run the following command:
sudo ./uninstall_x728.sh

For the x728 old shell script, you also run this command to remove it, then re-install the x728 script.

==FAQ==
Q: We want to automatically shut down when the battery voltage is lower than a certain specified value, is it possible?

A: Please run the followng command to achieve this function.(Note: 3V is default shut down voltage value )
python3 /home/pi/x728/x728v2-asd.py &

X728-Chip-Specifications：
* [[File:MAX17040-MAX17041.pdf]]

*[https://www.sparkfun.com/datasheets/Components/DS1307.pdf I2C address: 0x36 for battery fuel gauging, 0x68 for RTC]

References:
*[https://www.instructables.com/Raspberry-Pi-Tutorial-How-to-Use-a-Buzzer/ Raspberry Pi Tutorial: How to Use a Buzzer]
*[https://github.com/arbowl/cyberdeck-battery-indicator/ Battery Indicator Script Share by Drew]

Return to [[X728]]


<comments />




[[Category:Product Manual]]
[[Category:Raspberry pi]]
[[Category:Knowledge]]

X728-Software - Revision history

Admin: Replace with

Admin: Replace with

Cindy at 10:22, 24 April 2026

Harry at 17:09, 22 July 2023