mirror of
https://github.com/PiSugar/PiSugar.git
synced 2026-10-26 19:01:50 -04:00
Created PiSugar Power Manager (Software) (markdown)
Jdaie
parent
b3dacedde2
commit
92cc2c7b70
1 changed files with 134 additions and 0 deletions
134
PiSugar-Power-Manager-(Software).md
Normal file
134
PiSugar-Power-Manager-(Software).md
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
PiSugar Power Manager is a software created for PiSugar 2 serises.
|
||||
|
||||
https://github.com/PiSugar/pisugar-power-manager-rs
|
||||
|
||||
## Before Install
|
||||
|
||||
This software will occupy i2c addresses 0x32(RTC) and 0x75(PowerIC). Please avoid other phats using these addresses.
|
||||
|
||||
After attaching PiSugar2 to you pi, you can use the following commands to see whether it works properly:
|
||||
|
||||
```
|
||||
# turn on i2c interface
|
||||
sudo raspi-config
|
||||
|
||||
# Interfacing Options -> I2C -> Yes
|
||||
|
||||
# detect i2c bus and devices
|
||||
i2cdetect -y 1
|
||||
i2cdump -y 1 0x32
|
||||
i2cdump -y 1 0x75
|
||||
```
|
||||
|
||||
If you cannot find any devices, or see lots of 'X.XX.X.X...' things, please try turning off PiSugar 2 and restart one minutes later.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Run the following script on your pi:
|
||||
|
||||
```
|
||||
curl http://cdn.pisugar.com/release/Pisugar-power-manager.sh | sudo bash
|
||||
```
|
||||
After finished, you can manage the battery by visiting http://\<your raspberry ip\>:8421 in your browser.
|
||||
|
||||
<p>
|
||||
<img width="600" src="http://cdn.pisugar.com/pisugar2/images/ui.png?imageView2/0/w/800">
|
||||
</p>
|
||||
|
||||
PiSugar Power Manager is develop in Rust and Vue2.0, with high performace (less than 2% pi0 cpu) and exquisite designed webUI.
|
||||
|
||||
## Commands of controlling pisugar-server systemd service
|
||||
|
||||
```
|
||||
# reload daemon
|
||||
sudo systemctl daemon-reload
|
||||
|
||||
# check status
|
||||
sudo systemctl status pisugar-server
|
||||
|
||||
# start service
|
||||
sudo systemctl start pisugar-server
|
||||
|
||||
# stop service
|
||||
sudo systemctl stop pisugar-server
|
||||
|
||||
# disable service
|
||||
sudo systemctl disable pisugar-server
|
||||
|
||||
# enable service
|
||||
sudo systemctl enable pisugar-server
|
||||
```
|
||||
|
||||
The service will start automatically after first install. If you stop it, you should restart it manually next time.
|
||||
|
||||
## Unix Domain Socket / Webscoket / TCP
|
||||
If you need to get the battery data in your own software, you can request via the following ports
|
||||
|
||||
Default ports:
|
||||
```
|
||||
uds /tmp/pisugar-server.sock
|
||||
tcp 0.0.0.0:8423
|
||||
ws 0.0.0.0:8422 # standalone websocket api
|
||||
http 0.0.0.0:8421 # web UI and websocket (/ws)
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
Examples:
|
||||
|
||||
nc -U /tmp/pisugar-server.sock
|
||||
get battery
|
||||
get model
|
||||
rtc_alarm_set 2020-06-26T16:09:34+08:00 127
|
||||
set_button_enable long 1
|
||||
set_button_enable long sudo shutdown now
|
||||
safe_shutdown_level 3
|
||||
safe_shutdown_delay 30
|
||||
<ctrl+c to break>
|
||||
|
||||
Or
|
||||
|
||||
echo "get battery" | nc -q 0 127.0.0.1 8423
|
||||
|
||||
| Command | Description | Response/Usage |
|
||||
| :- | :-: | :-: |
|
||||
| get battery | battery level % | battery: [number] |
|
||||
| get battery_i | BAT current in A | battery_i: [number] |
|
||||
| get battery_v | BAT votage in V | battery_v: [number] |
|
||||
| get battery_charging | charging status | battery_charging: [true\|false] |
|
||||
| get model | pisugar model | model: PiSugar 2 |
|
||||
| get rtc_time | rtc clock | rtc_time: [ISO8601 time string] |
|
||||
| get rtc_alarm_enabled | rtc wakeup alarm enable | rtc_alarm_enabled: [true\|false] |
|
||||
| get rtc_alarm_time | rtc wakeup alarm time | rtc_alarm_time: [ISO8601 time string] |
|
||||
| get alarm_repeat | rtc wakeup alarm repeat in weekdays (127=1111111) | alarm_repeat: [number] |
|
||||
| get button_enable | custom button enable status | button_enable: [single\|double\|long] [true\|false] |
|
||||
| get button_shell | shell script when button is clicked | button_shell: [single\|double\|long] [shell] |
|
||||
| get safe_shutdown_level | auto shutdown level | safe_shutdown_level: [number] |
|
||||
| get safe_shutdown_delay | auto shutdown delay | safe_shutdown_delay: [number] |
|
||||
| rtc_pi2rtc | sync time pi => rtc | |
|
||||
| rtc_rtc2pi | sync time rtc => pi | |
|
||||
| rtc_web | sync time web => rtc & pi | |
|
||||
| rtc_alarm_set | set rtc wakeup alarm | rtc_alarm_set [ISO8601 time string] [repeat] |
|
||||
| rtc_alarm_disable | disable rtc wakeup alarm | |
|
||||
| set_button_enable | auto shutdown level % | set_button_enable [single\|double\|long] [0\|1] |
|
||||
| set_button_shell | auto shutdown level | safe_shutdown_level [single\|double\|long] [shell] |
|
||||
| set_safe_shutdown_level | set auto shutdown level % | safe_shutdown_level [number] |
|
||||
| set_safe_shutdown_delay | set auto shutdown delay in second | safe_shutdown_delay [number]|
|
||||
|
||||
|
||||
## Uninstall
|
||||
|
||||
```
|
||||
# Uninstall/Purge
|
||||
sudo dpkg -P pisugar-server
|
||||
|
||||
```
|
||||
|
||||
## Release
|
||||
|
||||
See https://github.com/PiSugar/pisugar-power-manager-rs/releases
|
||||
|
||||
## LICENSE
|
||||
|
||||
GPL v3
|
||||
Loading…
Add table
Add a link
Reference in a new issue