From b57fff4843a9174143e0a3cedb27635aabc4399c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Hundeb=C3=B8ll?= Date: Fri, 19 Jul 2019 14:39:57 +0200 Subject: doc: document power-event signals for quectel Hardware API --- doc/quectel-hardware-api.txt | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc') 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. -- cgit v1.2.1