Open main menu

Changes

X728-Software

2,048 bytes added, 01:09, 23 July 2023
no edit summary
{{GD Template Impl}}
The following test <big>Although this installation tutorial is base on '2020still available, but we strongly recommend that you use [[X728-02-13-raspbian-busterscript]] new tutorial, and we no longer maintain this page.img'</big>
Python version: V2.7<hr/>
1. Enable I2C funcion The following test is base on Raspbian [https: sudo raspi//www.raspberrypi.com/software/operating-systems/ 2022-01-28-raspios-bullseye-configarmhf.zip]
Select 5 Interfacing Options and then P5 I2C - Enable/Disable automatic loading. A prompt will appear asking Would you like the ARM I2C interface to be enabled?, select "Yes" Python version is 3;
[[File:Rpi-config-1.jpg|none]] [[FileEnable I2C funcion on Raspbian:Rpi-config-5.jpg|none]]  reter to [[File:Rpi-config-6.jpg|noneHow to enable I2C]] Select "OK"
Select "Finish" to return to the command line 2. Login via teminal window, then update & upgrade & install necessary software (python and reboot your raspberry pi.i2c tool library) sudo apt-get update sudo apt-get upgrade sudo rebootapt-get -y install i2c-tools python3-smbus python-smbus
2. Install necessary software (python and i2c tool library)1 Once you have logged into your Raspberry Pi from the command line, run the command to see all the connected devices sudo apti2cdetect -get install pythony 1 [[File:X728x-smbus i2c.png]] sudo apt#36 -get install i2cthe address of the battery fuel gauging chip #68 -tools 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.git cd x728 chmod +x *.sh
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 supportor sudo bash x728-v2.0.shor
sudo bash x728-v1.0.sh
or
sudo bash x728-v2.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
6. How to reading battery voltage and percentage, this is the sample code, you can modify it by your request.
sudo python x728bat_v1.2.pyor sudo pyton /home/pi/x728bat_v1.2x728bat.py You can get the following python file in /home/pi/ fold[[File x728bat.py # Reading battery voltage  x728pldX728-bat-2.py # Testing AC power off/loss or power adapter failure detectionjpg]]
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. please Refer to [[How to add crontab job]] or refer to the following:  pi@raspberrypi ~ $ `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]]
`@reboot python /home/pi/x728batSave and exit. In nano, you do that by hitting CTRL + X, answering Y and hitting Enter when prompted.py`
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 shor short the 'PLD' pinon 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==
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]]