Skip to content
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

Jump to bottom

Add RSLK library #1

Merged
merged 17 commits into from
Aug 15, 2023
Merged

Add RSLK library #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
5198955
added RSLK library
ndroid Jul 28, 2023
55c71fc
formatting updates
ndroid Jul 28, 2023
a994754
bug fixes
ndroid Jul 28, 2023
0fe64b6
updated SimpleRSLK API
ndroid Jul 29, 2023
10fdc0d
updates to RSLK API and docs
ndroid Aug 9, 2023
0319c54
bug fix for pauseMotor method
ndroid Aug 9, 2023
9d454ee
moved library documentation to root docs directory
ndroid Aug 10, 2023
c310930
re-organized example programs for RSLK library
ndroid Aug 10, 2023
212698e
updated RSLK bump switch example
ndroid Aug 10, 2023
0436bf5
updated RSLK examples and line sensor method
ndroid Aug 10, 2023
c445eac
updates to RSLK library examples
ndroid Aug 11, 2023
359c703
updated RSLK examples to simplify alternate UART usage
ndroid Aug 12, 2023
72026b2
updated RSLK docs
ndroid Aug 12, 2023
5c99771
minor edits in documentation
ndroid Aug 12, 2023
9171097
Merge branch 'main' into rslk-devel
ndroid Aug 14, 2023
2e11b85
minor updates to RSLK library
ndroid Aug 15, 2023
18327cd
updated documentation
ndroid Aug 15, 2023
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
21 changes: 19 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ This MSP432 core includes the following libraries:
* IR remote (NEC transmit and receive)
* SPI
* Wire (I2C)
* [TI RSLK Max library](https://ndroid.github.io/msp432-core/RSLK/)
* Encoders
* Sharp GP2Y0A21 IR distance sensors
* QTR line sensor
* Romi motor driver

### Energia Resources

Expand Down Expand Up @@ -66,14 +71,26 @@ More information can be found in the Energia guide [Installing the LaunchPad dri

# Change Log

__`version 5.29.4`__
__`version 5.29.5`__

* features
* added TI RSLK Max library which uses MSP432P401R
* updated RSLK library API for simplified application
* updated RSLK library examples
* added documentation for new RSLK library API, to be extended to document all libraries

* bug fixes
* corrected pin 2.3 missing high-drive config option


__`version 5.29.4`__ (corrected missing libraries issue)

<ul> Initial release, adapted from msp432r version 5.29.1 core </ul>

* features
* added MSP432P4111 LaunchPad board
* added support for Serial2 and Serial3
* modified Servo library to use Timer32 to avoid using Timer_A which may conflict with PWM output requests(e.g. analogWrite and IRremote)
* modified Servo library to use Timer32 to avoid using Timer_A which may conflict with PWM output requests (e.g. analogWrite and IRremote)
* attempts to allocate Timer32_2 first (will attempt Timer32_1 if T32_2 is unavailable)
* added MultipleServos example in Servo library
* added TinyIRremote library to support IR NEC encoding receive and transmit applications
Expand Down
11 changes: 11 additions & 0 deletions docs/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Documentation for MSP432-core libraries

For each libarary, put documentation in docs subdirectory for library, and add
library doc reference to index page.


For generating docs, place Doxyfile in library root directory and set

OUTPUT_DIRECTORY = ../../../docs/LIBRARY_DIR/

Then run doxygen within library root directory.
107 changes: 107 additions & 0 deletions docs/RSLK/_bump___switch_8cpp_source.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TI RSLK Library: src/Bump_Switch.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">TI RSLK Library<span id="projectnumber">&#160;0.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Bump_Switch.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &quot;Bump_Switch.h&quot;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span>Bump_Switch::Bump_Switch()</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span>{</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> configured = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> num_pins = 0;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> bump_sw_pin = 0;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>}</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="class_bump___switch.html#ac5049af12039af917a1190594d07315d"> 10</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="class_bump___switch.html#ac5049af12039af917a1190594d07315d">Bump_Switch::begin</a>(uint8_t pin_num, uint8_t mode)</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> bump_sw_pin = pin_num;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> pinMode(bump_sw_pin, mode);</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>}</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="class_bump___switch.html#ae3c38668a94ddaa370393ffb600abadc"> 17</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="class_bump___switch.html#ae3c38668a94ddaa370393ffb600abadc">Bump_Switch::read</a>()</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">return</span> digitalRead(bump_sw_pin);</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>}</div>
<div class="ttc" id="aclass_bump___switch_html_ac5049af12039af917a1190594d07315d"><div class="ttname"><a href="class_bump___switch.html#ac5049af12039af917a1190594d07315d">Bump_Switch::begin</a></div><div class="ttdeci">bool begin(uint8_t pin_num, uint8_t mode=INPUT_PULLUP)</div><div class="ttdoc">Initialize the bump switch class.</div><div class="ttdef"><b>Definition</b> <a href="_bump___switch_8cpp_source.html#l00010">Bump_Switch.cpp:10</a></div></div>
<div class="ttc" id="aclass_bump___switch_html_ae3c38668a94ddaa370393ffb600abadc"><div class="ttname"><a href="class_bump___switch.html#ae3c38668a94ddaa370393ffb600abadc">Bump_Switch::read</a></div><div class="ttdeci">bool read()</div><div class="ttdoc">Read the bump switch value.</div><div class="ttdef"><b>Definition</b> <a href="_bump___switch_8cpp_source.html#l00017">Bump_Switch.cpp:17</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 15 2023 20:37:21 for TI RSLK Library by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
109 changes: 109 additions & 0 deletions docs/RSLK/_bump___switch_8h_source.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TI RSLK Library: src/Bump_Switch.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">TI RSLK Library<span id="projectnumber">&#160;0.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Bump_Switch.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef Bump_Switch_h</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define Bump_Switch_h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;Energia.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_bump___switch.html"> 12</a></span><span class="keyword">class </span><a class="code hl_class" href="class_bump___switch.html">Bump_Switch</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> uint8_t bump_sw_pin;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> uint8_t num_pins;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordtype">bool</span> configured;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="class_bump___switch.html">Bump_Switch</a>();</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_bump___switch.html#ac5049af12039af917a1190594d07315d">begin</a>(uint8_t pin_num, uint8_t mode = INPUT_PULLUP);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_bump___switch.html#ae3c38668a94ddaa370393ffb600abadc">read</a>();</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>};</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_bump___switch_html"><div class="ttname"><a href="class_bump___switch.html">Bump_Switch</a></div><div class="ttdoc">Represents a single bump switch.</div><div class="ttdef"><b>Definition</b> <a href="_bump___switch_8h_source.html#l00012">Bump_Switch.h:13</a></div></div>
<div class="ttc" id="aclass_bump___switch_html_ac5049af12039af917a1190594d07315d"><div class="ttname"><a href="class_bump___switch.html#ac5049af12039af917a1190594d07315d">Bump_Switch::begin</a></div><div class="ttdeci">bool begin(uint8_t pin_num, uint8_t mode=INPUT_PULLUP)</div><div class="ttdoc">Initialize the bump switch class.</div><div class="ttdef"><b>Definition</b> <a href="_bump___switch_8cpp_source.html#l00010">Bump_Switch.cpp:10</a></div></div>
<div class="ttc" id="aclass_bump___switch_html_ae3c38668a94ddaa370393ffb600abadc"><div class="ttname"><a href="class_bump___switch.html#ae3c38668a94ddaa370393ffb600abadc">Bump_Switch::read</a></div><div class="ttdeci">bool read()</div><div class="ttdoc">Read the bump switch value.</div><div class="ttdef"><b>Definition</b> <a href="_bump___switch_8cpp_source.html#l00017">Bump_Switch.cpp:17</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 15 2023 20:37:21 for TI RSLK Library by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
Loading