update

README.md

@@ -46,7 +46,7 @@ Replace model in `/etc/default/pisugar-server`
     sed -e "s|--model '.*' |--model '<model>' |"
         -i /etc/default/pisugar-server
 
-**NOTE** UPS mode would prevent PiSugar falling into sleep, it could be useful in some cases. (since v1.4.8, `/etc/pisugar-server/config.json`)
+**NOTE** `auto_power_on` mode would prevent PiSugar falling into sleep, it could be useful in some cases. (since v1.4.8, `/etc/pisugar-server/config.json`)
 
 ## Prerequisites
 

pisugar-core/src/battery.rs

@@ -5,7 +5,7 @@ use std::time::Instant;
 /// Battery chip controller
 pub trait Battery {
     /// Init battery chip
-    fn init(&mut self, ups: bool) -> Result<()>;
+    fn init(&mut self, auto_power_on: bool) -> Result<()>;
 
     /// Model
     fn model(&self) -> String;

pisugar-core/src/ip5209.rs

@@ -81,7 +81,7 @@ impl IP5209 {
     }
 
     /// Shutdown under light load (144mA and 8s)
-    pub fn enable_auto_shutdown(&self) -> Result<()> {
+    pub fn enable_light_load_auto_shutdown(&self) -> Result<()> {
         let threshold = PI_ZERO_IDLE_INTENSITY * 1000.0;
         let threshold = (threshold / 12.0) as u64;
         let threshold = if threshold > 0b0001_1111 {
@@ -228,7 +228,7 @@ impl IP5209 {
     /// Force shutdown
     pub fn force_shutdown(&self) -> Result<()> {
         // enable auto shutdown
-        self.enable_auto_shutdown()?;
+        self.enable_light_load_auto_shutdown()?;
 
         // force shutdown
         let mut t = self.i2c.smbus_read_byte(0x01)?;
@@ -263,16 +263,16 @@ impl IP5209Battery {
 }
 
 impl Battery for IP5209Battery {
-    fn init(&mut self, ups: bool) -> Result<()> {
+    fn init(&mut self, auto_power_on: bool) -> Result<()> {
         if self.model.led_amount() == 2 {
             self.ip5209.init_gpio_2led()?;
             self.ip5209.toggle_allow_charging_2led(true)?;
         } else {
             self.ip5209.init_gpio()?;
         }
         // NOTE: Disable auto shutdown in UPS
-        self.ip5209.enable_auto_shutdown()?;
-        if ups {
+        self.ip5209.enable_light_load_auto_shutdown()?;
+        if auto_power_on {
             self.ip5209.disable_light_load_shutdown()?;
         }
 

pisugar-core/src/ip5312.rs

@@ -78,7 +78,7 @@ impl IP5312 {
     }
 
     /// Shutdown under light load (126mA and 8s)
-    pub fn enable_auto_shutdown(&self) -> Result<()> {
+    pub fn enable_light_load_auto_shutdown(&self) -> Result<()> {
         let threshold = PI_PRO_IDLE_INTENSITY * 1000.0;
         let threshold = (threshold / 4.3) as u64;
         let threshold = if threshold > 0b0011_1111 {
@@ -231,7 +231,7 @@ impl IP5312 {
     /// Force shutdown
     pub fn force_shutdown(&self) -> Result<()> {
         // enable auto shutdown
-        self.enable_auto_shutdown()?;
+        self.enable_light_load_auto_shutdown()?;
 
         // enable force shutdown
         let mut t = self.i2c.smbus_read_byte(0x01)?;
@@ -266,7 +266,7 @@ impl IP5312Battery {
 }
 
 impl Battery for IP5312Battery {
-    fn init(&mut self, ups: bool) -> Result<()> {
+    fn init(&mut self, auto_power_on: bool) -> Result<()> {
         if self.model.led_amount() == 2 {
             self.ip5312.init_gpio_2led()?;
             self.ip5312.toggle_allow_charging_2led(true)?;
@@ -275,8 +275,8 @@ impl Battery for IP5312Battery {
         }
         self.ip5312.init_boost_intensity()?;
         // NOTE: Disable auto shutdown in UPS
-        self.ip5312.enable_auto_shutdown()?;
-        if ups {
+        self.ip5312.enable_light_load_auto_shutdown()?;
+        if auto_power_on {
             self.ip5312.disable_light_load_shutdown()?;
         }
 

pisugar-core/src/lib.rs

@@ -157,7 +157,7 @@ pub struct PiSugarConfig {
     pub full_charge_duration: Option<u64>,
 
     #[serde(default)]
-    pub ups: Option<bool>,
+    pub auto_power_on: Option<bool>,
 }
 
 impl PiSugarConfig {
@@ -289,7 +289,7 @@ impl PiSugarCore {
     fn init_battery(&mut self) -> Result<()> {
         if self.battery.is_none() {
             let mut battery = self.model.bind(I2C_ADDR_BAT)?;
-            battery.init(self.config.ups.unwrap_or(false))?;
+            battery.init(self.config.auto_power_on.unwrap_or(false))?;
             self.battery = Some(battery);
         }
         Ok(())
@@ -298,7 +298,7 @@ impl PiSugarCore {
     fn init_rtc(&mut self) -> Result<()> {
         if self.rtc.is_none() {
             let rtc = SD3078::new(I2C_ADDR_RTC)?;
-            rtc.init(self.config.ups.unwrap_or(false))?;
+            rtc.init(self.config.auto_power_on.unwrap_or(false))?;
             self.rtc = Some(rtc);
         }
         Ok(())
@@ -450,7 +450,7 @@ impl PiSugarCore {
     }
 
     pub fn set_alarm(&self, t: SD3078Time, weekday_repeat: u8) -> Result<()> {
-        if self.config.ups == Some(true) {
+        if self.config.auto_power_on == Some(true) {
             return Err(Error::Other("UPS is in conflict with alarm function".to_string()));
         }
         call_rtc!(&self.rtc, set_alarm, t, weekday_repeat)

pisugar-core/src/sd3078.rs

@@ -147,11 +147,11 @@ impl SD3078 {
     }
 
     /// Init
-    pub fn init(&self, ups: bool) -> Result<()> {
+    pub fn init(&self, auto_power_on: bool) -> Result<()> {
         self.clear_alarm_flag()?;
 
-        // NOTE enable UPS frequency alarm
-        if ups {
+        // NOTE enable frequency alarm
+        if auto_power_on {
             self.set_frequency_alarm()?;
         }
 

pisugar-module/.gitignore

@@ -0,0 +1 @@
+build/

pisugar-module/Makefile

@@ -0,0 +1,18 @@
+obj-m := rtc-sd3078.o
+CURRENT_PATH := $(shell pwd)
+LINUX_KERNEL := $(shell uname -r)
+LINUX_KERNEL_PATH := /usr/src/linux-headers-$(LINUX_KERNEL)
+BUILD_DIR := $(shell pwd)/build
+BUILD_DIR_MAKEFILE := $(PWD)/build/Makefile
+
+all: $(BUILD_DIR_MAKEFILE)
+	$(MAKE) -C $(LINUX_KERNEL_PATH) M=$(BUILD_DIR) src=$(PWD) modules
+
+$(BUILD_DIR):
+	mkdir -p "$@"
+
+$(BUILD_DIR_MAKEFILE): $(BUILD_DIR)
+	touch "$@"
+
+clean:
+	$(MAKE) -C $(LINUX_KERNEL_PATH) M=$(BUILD_DIR) src=$(PWD) clean

pisugar-module/README.md

@@ -0,0 +1,9 @@
+# Linux kernel modules
+
+Make kernel modules:
+
+    make
+
+## RTC
+
+rtc-sd3078.c https://github.com/torvalds/linux/blob/master/drivers/rtc/rtc-sd3078.c