mirror of https://github.com/koreader/koreader
BatteryStat plugin and instruction of KoboLight plugin (#2643)
* Start battery stat plugin * BatteryStat & kobolight * Several minor improvements * Remove a useless function * flush settings * Some review feedbacks * Resolve review comments * Remaining Minutes -> Remaining Hours * Add dump_file * typo * realpath * realpath on folder * Remove useless os.time() * Resolve review comments * warning * Add BatteryStat.debugging flag * treat log as txt * Minor improvement * Charging hour should be positive * Use warn instead of info * onSuspend in Kobo * Charging events for kobo and kindle * More events * dumpOrLog * Warnings * Typo * More space * Singleton * slightly format change * BatteryStat singleton * Init * Remove debugging flag * sleeping percentage is still negative * Read settings * Do not need to change was_suspending and was_charging * Typo * Remove debugging flag * Not charging should happen before suspend * Resolve review comments * was_suspend and was_charging should be updated each time in onCallback()pull/2671/head
Hzj_jie
7 years ago
committed by
GitHub
parent
0edf1cca29
commit
0b29e73e2e
@ -0,0 +1,283 @@
|
||||
|
||||
local DataStorage = require("datastorage")
|
||||
local KeyValuePage = require("ui/widget/keyvaluepage")
|
||||
local LuaSettings = require("luasettings")
|
||||
local PowerD = require("device"):getPowerDevice()
|
||||
local UIManager = require("ui/uimanager")
|
||||
local WidgetContainer = require("ui/widget/container/widgetcontainer")
|
||||
local T = require("ffi/util").template
|
||||
local logger = require("logger")
|
||||
local util = require("ffi/util")
|
||||
local _ = require("gettext")
|
||||
|
||||
local State = {}
|
||||
|
||||
function State:new(o)
|
||||
o = o or {}
|
||||
setmetatable(o, self)
|
||||
self.__index = self
|
||||
if o.percentage == nil or o.timestamp == nil then
|
||||
o.percentage = PowerD:getCapacity()
|
||||
o.timestamp = os.time()
|
||||
end
|
||||
return o
|
||||
end
|
||||
|
||||
function State:toString()
|
||||
return string.format("{%d @ %s}", self.percentage, os.date("%c", self.timestamp))
|
||||
end
|
||||
|
||||
local Usage = {}
|
||||
|
||||
function Usage:new(o)
|
||||
o = o or {}
|
||||
setmetatable(o, self)
|
||||
self.__index = self
|
||||
if o.percentage == nil or o.time == nil then
|
||||
o.percentage = 0
|
||||
o.time = 0
|
||||
end
|
||||
return o
|
||||
end
|
||||
|
||||
function Usage:append(state)
|
||||
local curr = State:new()
|
||||
self.percentage = self.percentage + (state.percentage - curr.percentage)
|
||||
self.time = self.time + os.difftime(curr.timestamp - state.timestamp)
|
||||
end
|
||||
|
||||
function Usage:minutes()
|
||||
return self.time / 60
|
||||
end
|
||||
|
||||
function Usage:hours()
|
||||
return self:minutes() / 60
|
||||
end
|
||||
|
||||
function Usage:percentagePerHour()
|
||||
if self.time == 0 then
|
||||
return 0
|
||||
else
|
||||
return self.percentage / self:hours()
|
||||
end
|
||||
end
|
||||
|
||||
function Usage:remainingHours()
|
||||
local curr = State:new()
|
||||
return curr.percentage / self:percentagePerHour()
|
||||
end
|
||||
|
||||
function Usage:chargingHours()
|
||||
local curr = State:new()
|
||||
return (curr.percentage - 100) / self:percentagePerHour()
|
||||
end
|
||||
|
||||
local function shorten(number)
|
||||
return string.format("%.2f", number);
|
||||
end
|
||||
|
||||
function Usage:dump(kv_pairs)
|
||||
table.insert(kv_pairs, {_(" Consumed %"), shorten(self.percentage)})
|
||||
table.insert(kv_pairs, {_(" Total minutes"), shorten(self:minutes())})
|
||||
table.insert(kv_pairs, {_(" % per hour"), shorten(self:percentagePerHour())})
|
||||
end
|
||||
|
||||
function Usage:dumpRemaining(kv_pairs)
|
||||
table.insert(kv_pairs, {_(" Estimated remaining hours"), shorten(self:remainingHours())})
|
||||
end
|
||||
|
||||
function Usage:dumpCharging(kv_pairs)
|
||||
table.insert(kv_pairs, {_(" Estimated hours for charging"), shorten(self:chargingHours())})
|
||||
end
|
||||
|
||||
local BatteryStat = {
|
||||
name = "batterstat",
|
||||
settings = LuaSettings:open(DataStorage:getSettingsDir() .. "/batterstat.lua"),
|
||||
dump_file = util.realpath(DataStorage:getDataDir()) .. "/batterystat.log",
|
||||
debugging = false,
|
||||
}
|
||||
|
||||
function BatteryStat:init()
|
||||
self.charging = Usage:new(self.settings:readSetting("charging"))
|
||||
self.decharging = Usage:new(self.settings:readSetting("decharging"))
|
||||
self.awake = Usage:new(self.settings:readSetting("awake"))
|
||||
self.sleeping = Usage:new(self.settings:readSetting("sleeping"))
|
||||
|
||||
-- Note: these fields are not the "real" timestamp and battery usage, but
|
||||
-- the unaccumulated values.
|
||||
self.charging_state = State:new(self.settings:readSetting("charging_state"))
|
||||
self.awake_state = State:new(self.settings:readSetting("awake_state"))
|
||||
self:initCurrentState()
|
||||
|
||||
if self.debugging then
|
||||
self.debugOutput = self._debugOutput
|
||||
else
|
||||
self.debugOutput = function() end
|
||||
end
|
||||
end
|
||||
|
||||
function BatteryStat:initCurrentState()
|
||||
-- Whether the device was suspending before current timestamp.
|
||||
self.was_suspending = false
|
||||
-- Whether the device was charging before current timestamp.
|
||||
self.was_charging = PowerD:isCharging()
|
||||
end
|
||||
|
||||
function BatteryStat:onFlushSettings()
|
||||
self.settings:reset({
|
||||
charging = self.charging,
|
||||
decharging = self.decharging,
|
||||
awake = self.awake,
|
||||
sleeping = self.sleeping,
|
||||
charging_state = self.charging_state,
|
||||
awake_state = self.awake_state,
|
||||
})
|
||||
self.settings:flush()
|
||||
end
|
||||
|
||||
function BatteryStat:accumulate()
|
||||
if self.was_suspending then
|
||||
-- Suspending to awake.
|
||||
self.sleeping:append(self.awake_state)
|
||||
else
|
||||
-- Awake to suspending, time between self.awake_state and now should belong to awake.
|
||||
self.awake:append(self.awake_state)
|
||||
end
|
||||
if self.was_charging then
|
||||
-- Decharging to charging.
|
||||
self.charging:append(self.charging_state)
|
||||
else
|
||||
self.decharging:append(self.charging_state)
|
||||
end
|
||||
self.awake_state = State:new()
|
||||
self.charging_state = State:new()
|
||||
end
|
||||
|
||||
function BatteryStat:dumpOrLog(content)
|
||||
local file = io.open(self.dump_file, "a")
|
||||
if file then
|
||||
file:write(content .. "\n")
|
||||
file:close()
|
||||
else
|
||||
logger.warn("Failed to dump output ", content, " into ", self.dump_file )
|
||||
end
|
||||
end
|
||||
|
||||
function BatteryStat:_debugOutput(event)
|
||||
self:dumpOrLog(event .. " @ " .. State:new():toString() ..
|
||||
", awake_state " .. self.awake_state:toString() ..
|
||||
", charging_state " .. self.charging_state:toString())
|
||||
end
|
||||
|
||||
function BatteryStat:onSuspend()
|
||||
self:debugOutput("onSuspend")
|
||||
self.was_suspending = false
|
||||
self:accumulate()
|
||||
end
|
||||
|
||||
function BatteryStat:onResume()
|
||||
self:debugOutput("onResume")
|
||||
self.was_suspending = true
|
||||
self:accumulate()
|
||||
end
|
||||
|
||||
function BatteryStat:onCharging()
|
||||
self:debugOutput("onCharging")
|
||||
self.was_charging = false
|
||||
self:dumpToText()
|
||||
self.charging = Usage:new()
|
||||
self.awake = Usage:new()
|
||||
self.sleeping = Usage:new()
|
||||
self:accumulate()
|
||||
end
|
||||
|
||||
function BatteryStat:onNotCharging()
|
||||
self:debugOutput("onNotCharging")
|
||||
self.was_charging = true
|
||||
self:dumpToText()
|
||||
self.decharging = Usage:new()
|
||||
self.awake = Usage:new()
|
||||
self.sleeping = Usage:new()
|
||||
self:accumulate()
|
||||
end
|
||||
|
||||
function BatteryStat:onCallback()
|
||||
self:initCurrentState()
|
||||
self:accumulate()
|
||||
local kv_pairs = self:dump()
|
||||
table.insert(kv_pairs, "----------")
|
||||
table.insert(kv_pairs, {_("Historical records are dumped to"), ""})
|
||||
table.insert(kv_pairs, {self.dump_file, ""})
|
||||
UIManager:show(KeyValuePage:new{
|
||||
title = _("Battery statistics"),
|
||||
kv_pairs = kv_pairs,
|
||||
})
|
||||
end
|
||||
|
||||
function BatteryStat:dumpToText()
|
||||
local kv_pairs = self:dump()
|
||||
local content = T(_("Dump at %1"), os.date("%c"))
|
||||
for _, pair in ipairs(kv_pairs) do
|
||||
content = content .. "\n" .. pair[1]
|
||||
if pair[2] ~= nil and pair[2] ~= "" then
|
||||
content = content .. "\t" .. pair[2]
|
||||
end
|
||||
end
|
||||
self:dumpOrLog(content .. "\n-=-=-=-=-=-\n")
|
||||
end
|
||||
|
||||
function BatteryStat:dump()
|
||||
local kv_pairs = {}
|
||||
table.insert(kv_pairs, {_("Awake since last charge"), ""})
|
||||
self.awake:dump(kv_pairs)
|
||||
self.awake:dumpRemaining(kv_pairs)
|
||||
table.insert(kv_pairs, {_("Sleeping since last charge"), ""})
|
||||
self.sleeping:dump(kv_pairs)
|
||||
self.sleeping:dumpRemaining(kv_pairs)
|
||||
table.insert(kv_pairs, {_("During last charge"), ""})
|
||||
self.charging:dump(kv_pairs)
|
||||
self.charging:dumpCharging(kv_pairs)
|
||||
table.insert(kv_pairs, {_("Since last charge"), ""})
|
||||
self.decharging:dump(kv_pairs)
|
||||
self.decharging:dumpRemaining(kv_pairs)
|
||||
return kv_pairs
|
||||
end
|
||||
|
||||
BatteryStat:init()
|
||||
|
||||
local BatteryStatWidget = WidgetContainer:new()
|
||||
|
||||
function BatteryStatWidget:init()
|
||||
self.ui.menu:registerToMainMenu(self)
|
||||
end
|
||||
|
||||
function BatteryStatWidget:addToMainMenu(tab_item_table)
|
||||
table.insert(tab_item_table.plugins, {
|
||||
text = _("Battery statistics"),
|
||||
callback = function()
|
||||
BatteryStat:onCallback()
|
||||
end,
|
||||
})
|
||||
end
|
||||
|
||||
function BatteryStatWidget:onFlushSettings()
|
||||
BatteryStat:onFlushSettings()
|
||||
end
|
||||
|
||||
function BatteryStatWidget:onSuspend()
|
||||
BatteryStat:onSuspend()
|
||||
end
|
||||
|
||||
function BatteryStatWidget:onResume()
|
||||
BatteryStat:onResume()
|
||||
end
|
||||
|
||||
function BatteryStatWidget:onCharging()
|
||||
BatteryStat:onCharging()
|
||||
end
|
||||
|
||||
function BatteryStatWidget:onNotCharging()
|
||||
BatteryStat:onNotCharging()
|
||||
end
|
||||
|
||||
return BatteryStatWidget
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Loading…
Reference in New Issue