Skip to content

Commit 1550c04

Browse files
devin-ai-integration[bot]rlauer@blues.com
andcommitted
revert: remove changes to auto-generated docs/api.md
Co-Authored-By: rlauer@blues.com <rlauer@blues.com>
1 parent 596fa3e commit 1550c04

File tree

1 file changed

+4
-51
lines changed

1 file changed

+4
-51
lines changed

docs/api.md

Lines changed: 4 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ Retrieve firmware version information from the Notecard.
9898
#### Returns
9999
string The result of the Notecard request.
100100

101-
#### `public def `[`voltage`](#namespacenotecard_1_1card_1a1f9f65c34f1bd959d7902285a7537ce6)`(card,hours,offset,vmax,vmin,usb,alert)`
101+
#### `public def `[`voltage`](#namespacenotecard_1_1card_1a1f9f65c34f1bd959d7902285a7537ce6)`(card,hours,offset,vmax,vmin)`
102102

103-
Retrieve current and historical voltage info from the Notecard, with optional USB power state monitoring.
103+
Retrieve current and historical voltage info from the Notecard.
104104

105105
#### Parameters
106106
* `card` The current Notecard object.
@@ -113,57 +113,10 @@ Retrieve current and historical voltage info from the Notecard, with optional US
113113

114114
* `vmin` min voltage level to report.
115115

116-
* `usb` Enable USB power state monitoring. When True, the Notecard will monitor USB power state changes.
117-
118-
* `alert` Enable alerts for USB power state changes. Only works when usb=True. When enabled, power state changes are recorded in the health.qo Notefile.
119-
120116
#### Returns
121117

122118
#### Returns
123-
dict The result of the Notecard request containing voltage and power state information.
124-
125-
Example request:
126-
```json
127-
{
128-
"req": "card.voltage",
129-
"usb": true,
130-
"alert": true
131-
}
132-
```
133-
134-
#### `public def `[`power`](#namespacenotecard_1_1card_1a10f5f4667d80f47674d1876df69b8e22)`(card,minutes,reset)`
135-
136-
Configure and query Mojo-based power consumption monitoring.
137-
138-
#### Parameters
139-
* `card` The current Notecard object.
140-
141-
* `minutes` (optional) How often to log power consumption in minutes. Default is 720 minutes (12 hours).
142-
143-
* `reset` (optional) Reset consumption counters if True.
144-
145-
#### Returns
146-
dict The result of the Notecard request containing power monitoring data.
147-
148-
Example request:
149-
```json
150-
{
151-
"req": "card.power",
152-
"minutes": 120,
153-
"reset": true
154-
}
155-
```
156-
157-
Example response:
158-
```json
159-
{
160-
"temperature": 26.0,
161-
"voltage": 4.2,
162-
"milliamp_hours": 2.45
163-
}
164-
```
165-
166-
Note: Requires Notecard firmware v8.1.3 or later and a connected Mojo device.
119+
string The result of the Notecard request.
167120

168121
#### `public def `[`wireless`](#namespacenotecard_1_1card_1a10f5f4667d80f47674d1876df69b8e22)`(card,mode,apn)`
169122

@@ -706,4 +659,4 @@ Initialize the [Notecard](#classnotecard_1_1notecard_1_1_notecard) before a rese
706659

707660
Ensure that the passed-in card is a Notecard.
708661

709-
Generated by [Moxygen](https://sourcey.com/moxygen)
662+
Generated by [Moxygen](https://sourcey.com/moxygen)

0 commit comments

Comments
 (0)