Difference between revisions of "X729-script"
Line 129: | Line 129: | ||
sudo python3 sample/buzzer.py | sudo python3 sample/buzzer.py | ||
− | 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. | + | 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 | sudo apt-get install -y python3-smbus python3-rpi.gpio | ||
Or you can refer to [[How to Install RPi.GPIO Python Library]] | 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=== | ===Enable OLED display=== |
Revision as of 00:44, 23 July 2023
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@Q: How to login to myNode via SSH?
A: URL connection is IP address, and the default user name is admin, default password is boltQ: How to login to DietPi via SSH?
A: URL connection is IP address, and the default user name is root, default password is dietpiQ: Is LibreELEC supported?
A: TODOOther 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
Enable comment auto-refresher
Anonymous user #3
Permalink |
Lisa
Anonymous user #1
Permalink |
Harry
Anonymous user #2
Permalink |
Harry
Anonymous user #1
Permalink |
Harry