Skip to content

Commit d47e132

Browse files
PaulZCPaulZC
authored
Merge pull request #4 from sparkfun/release_candidate
Update docs for v1.1.0
2 parents ab24a3a + b102b9f commit d47e132

35 files changed

+817
-662
lines changed

‎docs/_spark_fun___swarm___satellite___arduino___library_8h.html

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -186,16 +186,23 @@
186186
<tr class="separator:a0052bf9ad87bb3962b65afc0520939d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
187187
<tr class="memitem:a55f5073f3321a30d536fdbff7da3c266"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_spark_fun___swarm___satellite___arduino___library_8h.html#a55f5073f3321a30d536fdbff7da3c266">Swarm_M138_GPIO1_Mode_e</a> { <br />
188188
&#160;&#160;<b>SWARM_M138_GPIO1_ANALOG</b> = 0
189+
, <b>SWARM_M138_GPIO1_ADC</b>
190+
, <b>SWARM_M138_GPIO1_INPUT</b>
189191
, <b>SWARM_M138_GPIO1_EXIT_SLEEP_LOW_HIGH</b>
190-
, <b>SWARM_M138_GPIO1_EXIT_SLEEP_HIGH_LOW</b>
192+
, <br />
193+
&#160;&#160;<b>SWARM_M138_GPIO1_EXIT_SLEEP_HIGH_LOW</b>
191194
, <b>SWARM_M138_GPIO1_OUTPUT_LOW</b>
195+
, <b>SWARM_M138_GPIO1_OUTPUT_HIGH</b>
196+
, <b>SWARM_M138_GPIO1_MESSAGES_UNREAD_LOW</b>
192197
, <br />
193-
&#160;&#160;<b>SWARM_M138_GPIO1_OUTPUT_HIGH</b>
194-
, <b>SWARM_M138_GPIO1_MESSAGES_PENDING_LOW</b>
195-
, <b>SWARM_M138_GPIO1_MESSAGES_PENDING_HIGH</b>
196-
, <b>SWARM_M138_GPIO1_SLEEP_MODE_LOW</b>
198+
&#160;&#160;<b>SWARM_M138_GPIO1_MESSAGES_UNREAD_HIGH</b>
199+
, <b>SWARM_M138_GPIO1_MESSAGES_UNSENT_LOW</b>
200+
, <b>SWARM_M138_GPIO1_MESSAGES_UNSENT_HIGH</b>
201+
, <b>SWARM_M138_GPIO1_MESSAGES_UNREAD_UNSENT_LOW</b>
197202
, <br />
198-
&#160;&#160;<b>SWARM_M138_GPIO1_SLEEP_MODE_HIGH</b>
203+
&#160;&#160;<b>SWARM_M138_GPIO1_MESSAGES_UNREAD_UNSENT_HIGH</b>
204+
, <b>SWARM_M138_GPIO1_SLEEP_MODE_LOW</b>
205+
, <b>SWARM_M138_GPIO1_SLEEP_MODE_HIGH</b>
199206
, <b>SWARM_M138_GPIO1_INVALID</b>
200207
<br />
201208
}</td></tr>
@@ -223,21 +230,22 @@
223230
<tr class="separator:aaa4043b63ec1d3d591d0c0296303b884"><td class="memSeparator" colspan="2">&#160;</td></tr>
224231
<tr class="memitem:a50e4b1bf4dda91ee2eecd756f84726e8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_spark_fun___swarm___satellite___arduino___library_8h.html#a50e4b1bf4dda91ee2eecd756f84726e8">Swarm_M138_Modem_Status_e</a> { <br />
225232
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_BOOT_ABORT</b> = 0
233+
, <b>SWARM_M138_MODEM_STATUS_BOOT_DEVICEID</b>
226234
, <b>SWARM_M138_MODEM_STATUS_BOOT_POWERON</b>
227235
, <b>SWARM_M138_MODEM_STATUS_BOOT_RUNNING</b>
228-
, <b>SWARM_M138_MODEM_STATUS_BOOT_UPDATED</b>
229236
, <br />
230-
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_BOOT_VERSION</b>
237+
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_BOOT_UPDATED</b>
238+
, <b>SWARM_M138_MODEM_STATUS_BOOT_VERSION</b>
231239
, <b>SWARM_M138_MODEM_STATUS_BOOT_RESTART</b>
232240
, <b>SWARM_M138_MODEM_STATUS_BOOT_SHUTDOWN</b>
233-
, <b>SWARM_M138_MODEM_STATUS_DATETIME</b>
234241
, <br />
235-
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_POSITION</b>
242+
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_DATETIME</b>
243+
, <b>SWARM_M138_MODEM_STATUS_POSITION</b>
236244
, <b>SWARM_M138_MODEM_STATUS_DEBUG</b>
237245
, <b>SWARM_M138_MODEM_STATUS_ERROR</b>
238-
, <b>SWARM_M138_MODEM_STATUS_UNKNOWN</b>
239246
, <br />
240-
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_INVALID</b>
247+
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_UNKNOWN</b>
248+
, <b>SWARM_M138_MODEM_STATUS_INVALID</b>
241249
<br />
242250
}</td></tr>
243251
<tr class="separator:a50e4b1bf4dda91ee2eecd756f84726e8"><td class="memSeparator" colspan="2">&#160;</td></tr>

‎docs/_spark_fun___swarm___satellite___arduino___library_8h_source.html

Lines changed: 360 additions & 344 deletions
Large diffs are not rendered by default.

‎docs/class_s_w_a_r_m___m138-members.html

Lines changed: 29 additions & 27 deletions
Large diffs are not rendered by default.

‎docs/class_s_w_a_r_m___m138.html

Lines changed: 143 additions & 30 deletions
Large diffs are not rendered by default.

‎docs/functions.html

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
110110
<li>getConfigurationSettings()
111111
: <a class="el" href="class_s_w_a_r_m___m138.html#a292b81e6e750a6b065621d239dd3b603">SWARM_M138</a>
112112
</li>
113+
<li>getCPUvoltage()
114+
: <a class="el" href="class_s_w_a_r_m___m138.html#a562937e17c39872418516fa40bfa9152">SWARM_M138</a>
115+
</li>
113116
<li>getDateTime()
114117
: <a class="el" href="class_s_w_a_r_m___m138.html#a632fe232be4229626ac0f888ce653d63">SWARM_M138</a>
115118
</li>
@@ -178,12 +181,12 @@ <h3><a id="index_i"></a>- i -</h3><ul>
178181

179182

180183
<h3><a id="index_l"></a>- l -</h3><ul>
184+
<li>listMessage()
185+
: <a class="el" href="class_s_w_a_r_m___m138.html#a33c0cf77a4894bbca339260b497abd0e">SWARM_M138</a>
186+
</li>
181187
<li>listTxMessage()
182188
: <a class="el" href="class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da">SWARM_M138</a>
183189
</li>
184-
<li>listTxMessagesIDs()
185-
: <a class="el" href="class_s_w_a_r_m___m138.html#a01a4f4dd4f35bfc518cf995ea3f10a21">SWARM_M138</a>
186-
</li>
187190
</ul>
188191

189192

@@ -211,6 +214,9 @@ <h3><a id="index_p"></a>- p -</h3><ul>
211214

212215

213216
<h3><a id="index_r"></a>- r -</h3><ul>
217+
<li>readGPIO1voltage()
218+
: <a class="el" href="class_s_w_a_r_m___m138.html#addc6746679553eb8c4ff3e5c58f21620">SWARM_M138</a>
219+
</li>
214220
<li>readMessage()
215221
: <a class="el" href="class_s_w_a_r_m___m138.html#ab609a57c23ac5a6b44130a5855428873">SWARM_M138</a>
216222
</li>
@@ -221,7 +227,7 @@ <h3><a id="index_r"></a>- r -</h3><ul>
221227
: <a class="el" href="class_s_w_a_r_m___m138.html#a481ec005c4e7234292842fea347bb21d">SWARM_M138</a>
222228
</li>
223229
<li>restartDevice()
224-
: <a class="el" href="class_s_w_a_r_m___m138.html#ae2031153a334147e94205bcac2e03f34">SWARM_M138</a>
230+
: <a class="el" href="class_s_w_a_r_m___m138.html#af154d7474f55d35fd9823280d42302b5">SWARM_M138</a>
225231
</li>
226232
</ul>
227233

‎docs/functions_func.html

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
110110
<li>getConfigurationSettings()
111111
: <a class="el" href="class_s_w_a_r_m___m138.html#a292b81e6e750a6b065621d239dd3b603">SWARM_M138</a>
112112
</li>
113+
<li>getCPUvoltage()
114+
: <a class="el" href="class_s_w_a_r_m___m138.html#a562937e17c39872418516fa40bfa9152">SWARM_M138</a>
115+
</li>
113116
<li>getDateTime()
114117
: <a class="el" href="class_s_w_a_r_m___m138.html#a632fe232be4229626ac0f888ce653d63">SWARM_M138</a>
115118
</li>
@@ -178,12 +181,12 @@ <h3><a id="index_i"></a>- i -</h3><ul>
178181

179182

180183
<h3><a id="index_l"></a>- l -</h3><ul>
184+
<li>listMessage()
185+
: <a class="el" href="class_s_w_a_r_m___m138.html#a33c0cf77a4894bbca339260b497abd0e">SWARM_M138</a>
186+
</li>
181187
<li>listTxMessage()
182188
: <a class="el" href="class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da">SWARM_M138</a>
183189
</li>
184-
<li>listTxMessagesIDs()
185-
: <a class="el" href="class_s_w_a_r_m___m138.html#a01a4f4dd4f35bfc518cf995ea3f10a21">SWARM_M138</a>
186-
</li>
187190
</ul>
188191

189192

@@ -211,6 +214,9 @@ <h3><a id="index_p"></a>- p -</h3><ul>
211214

212215

213216
<h3><a id="index_r"></a>- r -</h3><ul>
217+
<li>readGPIO1voltage()
218+
: <a class="el" href="class_s_w_a_r_m___m138.html#addc6746679553eb8c4ff3e5c58f21620">SWARM_M138</a>
219+
</li>
214220
<li>readMessage()
215221
: <a class="el" href="class_s_w_a_r_m___m138.html#ab609a57c23ac5a6b44130a5855428873">SWARM_M138</a>
216222
</li>
@@ -221,7 +227,7 @@ <h3><a id="index_r"></a>- r -</h3><ul>
221227
: <a class="el" href="class_s_w_a_r_m___m138.html#a481ec005c4e7234292842fea347bb21d">SWARM_M138</a>
222228
</li>
223229
<li>restartDevice()
224-
: <a class="el" href="class_s_w_a_r_m___m138.html#ae2031153a334147e94205bcac2e03f34">SWARM_M138</a>
230+
: <a class="el" href="class_s_w_a_r_m___m138.html#af154d7474f55d35fd9823280d42302b5">SWARM_M138</a>
225231
</li>
226232
</ul>
227233

‎docs/search/all_4.js

Lines changed: 20 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/search/all_5.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
var searchData=
22
[
3-
['isconnected_29',['isConnected',['../class_s_w_a_r_m___m138.html#a4f3c6d458cf601015c82d6b9c8908ffa',1,'SWARM_M138']]]
3+
['isconnected_30',['isConnected',['../class_s_w_a_r_m___m138.html#a4f3c6d458cf601015c82d6b9c8908ffa',1,'SWARM_M138']]]
44
];

‎docs/search/all_6.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var searchData=
22
[
3-
['listtxmessage_30',['listTxMessage',['../class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da',1,'SWARM_M138']]],
4-
['listtxmessagesids_31',['listTxMessagesIDs',['../class_s_w_a_r_m___m138.html#a01a4f4dd4f35bfc518cf995ea3f10a21',1,'SWARM_M138']]]
3+
['listmessage_31',['listMessage',['../class_s_w_a_r_m___m138.html#a33c0cf77a4894bbca339260b497abd0e',1,'SWARM_M138']]],
4+
['listtxmessage_32',['listTxMessage',['../class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da',1,'SWARM_M138']]]
55
];

‎docs/search/all_7.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
var searchData=
22
[
3-
['markallrxmessages_32',['markAllRxMessages',['../class_s_w_a_r_m___m138.html#aa796aba166b6d4ae207d7544b5a1d135',1,'SWARM_M138']]],
4-
['markrxmessage_33',['markRxMessage',['../class_s_w_a_r_m___m138.html#a4df09dcb143201413dd7dd8047229a2d',1,'SWARM_M138']]],
5-
['modemerrorstring_34',['modemErrorString',['../class_s_w_a_r_m___m138.html#ad2aaca84f17dca3e217ac60a4553a557',1,'SWARM_M138']]],
6-
['modemstatusstring_35',['modemStatusString',['../class_s_w_a_r_m___m138.html#a7ad89ffb6e960e38aa541c41122f43a6',1,'SWARM_M138']]]
3+
['markallrxmessages_33',['markAllRxMessages',['../class_s_w_a_r_m___m138.html#aa796aba166b6d4ae207d7544b5a1d135',1,'SWARM_M138']]],
4+
['markrxmessage_34',['markRxMessage',['../class_s_w_a_r_m___m138.html#a4df09dcb143201413dd7dd8047229a2d',1,'SWARM_M138']]],
5+
['modemerrorstring_35',['modemErrorString',['../class_s_w_a_r_m___m138.html#ad2aaca84f17dca3e217ac60a4553a557',1,'SWARM_M138']]],
6+
['modemstatusstring_36',['modemStatusString',['../class_s_w_a_r_m___m138.html#a7ad89ffb6e960e38aa541c41122f43a6',1,'SWARM_M138']]]
77
];

0 commit comments

Comments
 (0)