Skip to content

add accumulated energy monitor feature (AT+GEMON) #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 21, 2021
Merged

add accumulated energy monitor feature (AT+GEMON) #16

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df45012
add accumulated energy monitor feature (AT+GEMON)
zunkworks Jan 12, 2021
09e67f5
correct spelling error in documentation
zunkworks Jan 12, 2021
60bc085
update documentation comment with correct version of modem that does …
zunkworks Jan 13, 2021
cfe2818
update doc string per review
zunkworks Jan 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions adafruit_rockblock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,3 +420,43 @@ def system_time(self):
time_now_unix = iridium_epoch_unix + int(secs_since_epoch)
return time.localtime(time_now_unix)
return None

@property
def energy_monitor(self):
"""The current accumulated energy usage estimate in microamp hours.

Returns an estimate of the charge taken from the +5V supply to the modem,
in microamp hours (uAh). This is represented internally as a 26-bit unsigned number,
so in principle will rollover to zero after approx. 67Ah (in practice this is usually
greater than battery life, if battery-powered).

The accumulator value is set to zero on a power-cycle or on a watchdog reset.
Note that while +5V power is supplied to the Data Module but the module is powered off
by its ON/OFF control line, it will still be consuming up to a few tens of microamps,
and this current drain will not be estimated in the +GEMON report.

The setter will preset the energy monitor accumulator to value n (typically, <n> would
be specified as 0, to clear the accumulator).

Note: Call Processor/BOOT Version: TA16005 is known to not support the AT+GEMON energy
monitor command. It is however known to work on TA19002 (newer) and TA12003 (older).
You may use the revision function to determine which version you have. Function will
return None if modem cannot retrieve the accumulated energy usage estimate.

Returns
int
"""

resp = self._uart_xfer("+GEMON")
if resp[-1].strip().decode() == "OK":
return int(resp[1].strip().decode().split(":")[1])
return None

@energy_monitor.setter
def energy_monitor(self, value):
if 0 <= value <= 67108863: # 0 to 2^26 - 1
resp = self._uart_xfer("+GEMON=" + str(value))
if resp[-1].strip().decode() == "OK":
return True
raise RuntimeError("Error setting energy monitor accumulator.")
raise ValueError("Value must be between 0 and 67108863 (2^26 - 1).")