Skip to content

Update docs for v1.1.0 #4

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 1 commit into from
Mar 28, 2022
Merged

Update docs for v1.1.0 #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 20 additions & 12 deletions docs/_spark_fun___swarm___satellite___arduino___library_8h.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,16 +186,23 @@
<tr class="separator:a0052bf9ad87bb3962b65afc0520939d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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 />
&#160;&#160;<b>SWARM_M138_GPIO1_ANALOG</b> = 0
, <b>SWARM_M138_GPIO1_ADC</b>
, <b>SWARM_M138_GPIO1_INPUT</b>
, <b>SWARM_M138_GPIO1_EXIT_SLEEP_LOW_HIGH</b>
, <b>SWARM_M138_GPIO1_EXIT_SLEEP_HIGH_LOW</b>
, <br />
&#160;&#160;<b>SWARM_M138_GPIO1_EXIT_SLEEP_HIGH_LOW</b>
, <b>SWARM_M138_GPIO1_OUTPUT_LOW</b>
, <b>SWARM_M138_GPIO1_OUTPUT_HIGH</b>
, <b>SWARM_M138_GPIO1_MESSAGES_UNREAD_LOW</b>
, <br />
&#160;&#160;<b>SWARM_M138_GPIO1_OUTPUT_HIGH</b>
, <b>SWARM_M138_GPIO1_MESSAGES_PENDING_LOW</b>
, <b>SWARM_M138_GPIO1_MESSAGES_PENDING_HIGH</b>
, <b>SWARM_M138_GPIO1_SLEEP_MODE_LOW</b>
&#160;&#160;<b>SWARM_M138_GPIO1_MESSAGES_UNREAD_HIGH</b>
, <b>SWARM_M138_GPIO1_MESSAGES_UNSENT_LOW</b>
, <b>SWARM_M138_GPIO1_MESSAGES_UNSENT_HIGH</b>
, <b>SWARM_M138_GPIO1_MESSAGES_UNREAD_UNSENT_LOW</b>
, <br />
&#160;&#160;<b>SWARM_M138_GPIO1_SLEEP_MODE_HIGH</b>
&#160;&#160;<b>SWARM_M138_GPIO1_MESSAGES_UNREAD_UNSENT_HIGH</b>
, <b>SWARM_M138_GPIO1_SLEEP_MODE_LOW</b>
, <b>SWARM_M138_GPIO1_SLEEP_MODE_HIGH</b>
, <b>SWARM_M138_GPIO1_INVALID</b>
<br />
}</td></tr>
Expand Down Expand Up @@ -223,21 +230,22 @@
<tr class="separator:aaa4043b63ec1d3d591d0c0296303b884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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 />
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_BOOT_ABORT</b> = 0
, <b>SWARM_M138_MODEM_STATUS_BOOT_DEVICEID</b>
, <b>SWARM_M138_MODEM_STATUS_BOOT_POWERON</b>
, <b>SWARM_M138_MODEM_STATUS_BOOT_RUNNING</b>
, <b>SWARM_M138_MODEM_STATUS_BOOT_UPDATED</b>
, <br />
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_BOOT_VERSION</b>
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_BOOT_UPDATED</b>
, <b>SWARM_M138_MODEM_STATUS_BOOT_VERSION</b>
, <b>SWARM_M138_MODEM_STATUS_BOOT_RESTART</b>
, <b>SWARM_M138_MODEM_STATUS_BOOT_SHUTDOWN</b>
, <b>SWARM_M138_MODEM_STATUS_DATETIME</b>
, <br />
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_POSITION</b>
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_DATETIME</b>
, <b>SWARM_M138_MODEM_STATUS_POSITION</b>
, <b>SWARM_M138_MODEM_STATUS_DEBUG</b>
, <b>SWARM_M138_MODEM_STATUS_ERROR</b>
, <b>SWARM_M138_MODEM_STATUS_UNKNOWN</b>
, <br />
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_INVALID</b>
&#160;&#160;<b>SWARM_M138_MODEM_STATUS_UNKNOWN</b>
, <b>SWARM_M138_MODEM_STATUS_INVALID</b>
<br />
}</td></tr>
<tr class="separator:a50e4b1bf4dda91ee2eecd756f84726e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down
704 changes: 360 additions & 344 deletions docs/_spark_fun___swarm___satellite___arduino___library_8h_source.html
View file
Open in desktop

Large diffs are not rendered by default.

56 changes: 29 additions & 27 deletions docs/class_s_w_a_r_m___m138-members.html
View file
Open in desktop

Large diffs are not rendered by default.

173 changes: 143 additions & 30 deletions docs/class_s_w_a_r_m___m138.html
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 10 additions & 4 deletions docs/functions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
<li>getConfigurationSettings()
: <a class="el" href="class_s_w_a_r_m___m138.html#a292b81e6e750a6b065621d239dd3b603">SWARM_M138</a>
</li>
<li>getCPUvoltage()
: <a class="el" href="class_s_w_a_r_m___m138.html#a562937e17c39872418516fa40bfa9152">SWARM_M138</a>
</li>
<li>getDateTime()
: <a class="el" href="class_s_w_a_r_m___m138.html#a632fe232be4229626ac0f888ce653d63">SWARM_M138</a>
</li>
Expand Down Expand Up @@ -178,12 +181,12 @@ <h3><a id="index_i"></a>- i -</h3><ul>


<h3><a id="index_l"></a>- l -</h3><ul>
<li>listMessage()
: <a class="el" href="class_s_w_a_r_m___m138.html#a33c0cf77a4894bbca339260b497abd0e">SWARM_M138</a>
</li>
<li>listTxMessage()
: <a class="el" href="class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da">SWARM_M138</a>
</li>
<li>listTxMessagesIDs()
: <a class="el" href="class_s_w_a_r_m___m138.html#a01a4f4dd4f35bfc518cf995ea3f10a21">SWARM_M138</a>
</li>
</ul>


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


<h3><a id="index_r"></a>- r -</h3><ul>
<li>readGPIO1voltage()
: <a class="el" href="class_s_w_a_r_m___m138.html#addc6746679553eb8c4ff3e5c58f21620">SWARM_M138</a>
</li>
<li>readMessage()
: <a class="el" href="class_s_w_a_r_m___m138.html#ab609a57c23ac5a6b44130a5855428873">SWARM_M138</a>
</li>
Expand All @@ -221,7 +227,7 @@ <h3><a id="index_r"></a>- r -</h3><ul>
: <a class="el" href="class_s_w_a_r_m___m138.html#a481ec005c4e7234292842fea347bb21d">SWARM_M138</a>
</li>
<li>restartDevice()
: <a class="el" href="class_s_w_a_r_m___m138.html#ae2031153a334147e94205bcac2e03f34">SWARM_M138</a>
: <a class="el" href="class_s_w_a_r_m___m138.html#af154d7474f55d35fd9823280d42302b5">SWARM_M138</a>
</li>
</ul>

Expand Down
14 changes: 10 additions & 4 deletions docs/functions_func.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
<li>getConfigurationSettings()
: <a class="el" href="class_s_w_a_r_m___m138.html#a292b81e6e750a6b065621d239dd3b603">SWARM_M138</a>
</li>
<li>getCPUvoltage()
: <a class="el" href="class_s_w_a_r_m___m138.html#a562937e17c39872418516fa40bfa9152">SWARM_M138</a>
</li>
<li>getDateTime()
: <a class="el" href="class_s_w_a_r_m___m138.html#a632fe232be4229626ac0f888ce653d63">SWARM_M138</a>
</li>
Expand Down Expand Up @@ -178,12 +181,12 @@ <h3><a id="index_i"></a>- i -</h3><ul>


<h3><a id="index_l"></a>- l -</h3><ul>
<li>listMessage()
: <a class="el" href="class_s_w_a_r_m___m138.html#a33c0cf77a4894bbca339260b497abd0e">SWARM_M138</a>
</li>
<li>listTxMessage()
: <a class="el" href="class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da">SWARM_M138</a>
</li>
<li>listTxMessagesIDs()
: <a class="el" href="class_s_w_a_r_m___m138.html#a01a4f4dd4f35bfc518cf995ea3f10a21">SWARM_M138</a>
</li>
</ul>


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


<h3><a id="index_r"></a>- r -</h3><ul>
<li>readGPIO1voltage()
: <a class="el" href="class_s_w_a_r_m___m138.html#addc6746679553eb8c4ff3e5c58f21620">SWARM_M138</a>
</li>
<li>readMessage()
: <a class="el" href="class_s_w_a_r_m___m138.html#ab609a57c23ac5a6b44130a5855428873">SWARM_M138</a>
</li>
Expand All @@ -221,7 +227,7 @@ <h3><a id="index_r"></a>- r -</h3><ul>
: <a class="el" href="class_s_w_a_r_m___m138.html#a481ec005c4e7234292842fea347bb21d">SWARM_M138</a>
</li>
<li>restartDevice()
: <a class="el" href="class_s_w_a_r_m___m138.html#ae2031153a334147e94205bcac2e03f34">SWARM_M138</a>
: <a class="el" href="class_s_w_a_r_m___m138.html#af154d7474f55d35fd9823280d42302b5">SWARM_M138</a>
</li>
</ul>

Expand Down
39 changes: 20 additions & 19 deletions docs/search/all_4.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/search/all_5.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['isconnected_29',['isConnected',['../class_s_w_a_r_m___m138.html#a4f3c6d458cf601015c82d6b9c8908ffa',1,'SWARM_M138']]]
['isconnected_30',['isConnected',['../class_s_w_a_r_m___m138.html#a4f3c6d458cf601015c82d6b9c8908ffa',1,'SWARM_M138']]]
];
4 changes: 2 additions & 2 deletions docs/search/all_6.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
var searchData=
[
['listtxmessage_30',['listTxMessage',['../class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da',1,'SWARM_M138']]],
['listtxmessagesids_31',['listTxMessagesIDs',['../class_s_w_a_r_m___m138.html#a01a4f4dd4f35bfc518cf995ea3f10a21',1,'SWARM_M138']]]
['listmessage_31',['listMessage',['../class_s_w_a_r_m___m138.html#a33c0cf77a4894bbca339260b497abd0e',1,'SWARM_M138']]],
['listtxmessage_32',['listTxMessage',['../class_s_w_a_r_m___m138.html#add4b3b463c40e9eb724ad8dcf98a26da',1,'SWARM_M138']]]
];
8 changes: 4 additions & 4 deletions docs/search/all_7.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
var searchData=
[
['markallrxmessages_32',['markAllRxMessages',['../class_s_w_a_r_m___m138.html#aa796aba166b6d4ae207d7544b5a1d135',1,'SWARM_M138']]],
['markrxmessage_33',['markRxMessage',['../class_s_w_a_r_m___m138.html#a4df09dcb143201413dd7dd8047229a2d',1,'SWARM_M138']]],
['modemerrorstring_34',['modemErrorString',['../class_s_w_a_r_m___m138.html#ad2aaca84f17dca3e217ac60a4553a557',1,'SWARM_M138']]],
['modemstatusstring_35',['modemStatusString',['../class_s_w_a_r_m___m138.html#a7ad89ffb6e960e38aa541c41122f43a6',1,'SWARM_M138']]]
['markallrxmessages_33',['markAllRxMessages',['../class_s_w_a_r_m___m138.html#aa796aba166b6d4ae207d7544b5a1d135',1,'SWARM_M138']]],
['markrxmessage_34',['markRxMessage',['../class_s_w_a_r_m___m138.html#a4df09dcb143201413dd7dd8047229a2d',1,'SWARM_M138']]],
['modemerrorstring_35',['modemErrorString',['../class_s_w_a_r_m___m138.html#ad2aaca84f17dca3e217ac60a4553a557',1,'SWARM_M138']]],
['modemstatusstring_36',['modemStatusString',['../class_s_w_a_r_m___m138.html#a7ad89ffb6e960e38aa541c41122f43a6',1,'SWARM_M138']]]
];
2 changes: 1 addition & 1 deletion docs/search/all_8.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['poweroff_36',['powerOff',['../class_s_w_a_r_m___m138.html#a667d06996e109bbe2bdb96c2a2665767',1,'SWARM_M138']]]
['poweroff_37',['powerOff',['../class_s_w_a_r_m___m138.html#a667d06996e109bbe2bdb96c2a2665767',1,'SWARM_M138']]]
];
9 changes: 5 additions & 4 deletions docs/search/all_9.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
var searchData=
[
['readmessage_37',['readMessage',['../class_s_w_a_r_m___m138.html#ab609a57c23ac5a6b44130a5855428873',1,'SWARM_M138']]],
['readnewestmessage_38',['readNewestMessage',['../class_s_w_a_r_m___m138.html#afbd3e7d880ad5e8c38d5ae1455410add',1,'SWARM_M138']]],
['readoldestmessage_39',['readOldestMessage',['../class_s_w_a_r_m___m138.html#a481ec005c4e7234292842fea347bb21d',1,'SWARM_M138']]],
['restartdevice_40',['restartDevice',['../class_s_w_a_r_m___m138.html#ae2031153a334147e94205bcac2e03f34',1,'SWARM_M138']]]
['readgpio1voltage_38',['readGPIO1voltage',['../class_s_w_a_r_m___m138.html#addc6746679553eb8c4ff3e5c58f21620',1,'SWARM_M138']]],
['readmessage_39',['readMessage',['../class_s_w_a_r_m___m138.html#ab609a57c23ac5a6b44130a5855428873',1,'SWARM_M138']]],
['readnewestmessage_40',['readNewestMessage',['../class_s_w_a_r_m___m138.html#afbd3e7d880ad5e8c38d5ae1455410add',1,'SWARM_M138']]],
['readoldestmessage_41',['readOldestMessage',['../class_s_w_a_r_m___m138.html#a481ec005c4e7234292842fea347bb21d',1,'SWARM_M138']]],
['restartdevice_42',['restartDevice',['../class_s_w_a_r_m___m138.html#af154d7474f55d35fd9823280d42302b5',1,'SWARM_M138']]]
];
Loading