summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Hundebøll <martin@geanix.com>2019-07-19 14:39:57 +0200
committerDenis Kenzior <denkenz@gmail.com>2019-07-22 02:39:55 -0500
commitb57fff4843a9174143e0a3cedb27635aabc4399c (patch)
tree7f82c9f61f98fbe7945ddb01050314194fa13eba /doc
parent133233845e9d0ce0904944a57670511f22445633 (diff)
downloadofono-b57fff4843a9174143e0a3cedb27635aabc4399c.tar.gz
doc: document power-event signals for quectel Hardware API
Diffstat (limited to 'doc')
-rw-r--r--doc/quectel-hardware-api.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/quectel-hardware-api.txt b/doc/quectel-hardware-api.txt
index c6cce4e8..139a0dc1 100644
--- a/doc/quectel-hardware-api.txt
+++ b/doc/quectel-hardware-api.txt
@@ -10,6 +10,25 @@ Methods array{string,variant} GetProperties
Returns hardware properties for the modem object. See
the properties section for available properties.
+Signals PowerDown(string reason)
+
+ This signal is emitted on gracefull shutdowns initiated
+ by the modem.
+
+ Possible reasons:
+ "VoltageLow" The supply voltage is too low
+ "Normal" The PWRKEY pin was asserted
+ "VoltageHigh" The supply voltage is too high
+
+ PowerWarning(string reason)
+
+ This signal is emitted when the modem detects its supply
+ voltage is close to its supported limits.
+
+ Possible reasons:
+ "VoltageLow" The supply voltage is low
+ "VoltageHigh" The supply voltage is high
+
Properties int32 Voltage [readonly]
Integer with the modem supply voltage in mV.