Skip to content

Commit

Permalink
Testing readme updates, added class diagrams to html directory
Browse files Browse the repository at this point in the history
  • Loading branch information
@mantonakakis1
mantonakakis1 committed May 14, 2020
1 parent 2b748f7 commit 23279e6
Show file tree
Hide file tree
Showing 67 changed files with 8,057 additions and 2 deletions.
1 change: 0 additions & 1 deletion MegaCAN.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

#include "Arduino.h"
const extern uint32_t baseID;
// #define BASEID 1512

typedef struct MegaCAN_message_t {
struct {
Expand Down
9 changes: 8 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# MegaCAN
Megasquirt CAN Protocol with Arduino, receives and stores broadcast data from Megasquirt, responds to requests for data from Megasquirt.
Library for interacting with Megasquirt CAN Protocol on Arduino-compatible hardware (Arduino, Teensy, Feather, etc.). Hopefully this makes it relatively easy to:
* Receive and store 11-bit broadcast data from Megasquirt.
* Receive and interpret 29-bit (extended) requests for data from a Megasquirt.
* Prepare a response to the Megasquirt's request for data.

## Installation and Adding to a Sketch
Simply download a zip of this respository, and extract it your Arduino/Libraries directory. To use, add the following to your Arduino sketch:
<#include <MegaCAN.h>>

569 changes: 569 additions & 0 deletions html/_mega_c_a_n_8h_source.html
View file

Large diffs are not rendered by default.

107 changes: 107 additions & 0 deletions html/annotated.html
View file
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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MegaCAN: Class List</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MegaCAN
</div>
<div id="projectbrief">Megasquirt CAN Protocol with Arduino</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">Class List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_mega_c_a_n.html" target="_self">MegaCAN</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_mega_c_a_n__broadcast__message__t.html" target="_self">MegaCAN_broadcast_message_t</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_mega_c_a_n__message__t.html" target="_self">MegaCAN_message_t</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>
6 changes: 6 additions & 0 deletions html/annotated_dup.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
var annotated_dup =
[
[ "MegaCAN", "class_mega_c_a_n.html", "class_mega_c_a_n" ],
[ "MegaCAN_broadcast_message_t", "struct_mega_c_a_n__broadcast__message__t.html", "struct_mega_c_a_n__broadcast__message__t" ],
[ "MegaCAN_message_t", "struct_mega_c_a_n__message__t.html", "struct_mega_c_a_n__message__t" ]
];
Binary file added html/bc_s.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/bdwn.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
107 changes: 107 additions & 0 deletions html/class_mega_c_a_n-members.html
View file
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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MegaCAN: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MegaCAN
</div>
<div id="projectbrief">Megasquirt CAN Protocol with Arduino</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_mega_c_a_n.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">MegaCAN Member List</div> </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="class_mega_c_a_n.html">MegaCAN</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getBCastData</b>(uint32_t id, const uint8_t data[8], MegaCAN_broadcast_message_t &amp;msg) (defined in <a class="el" href="class_mega_c_a_n.html">MegaCAN</a>)</td><td class="entry"><a class="el" href="class_mega_c_a_n.html">MegaCAN</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>MegaCAN</b>() (defined in <a class="el" href="class_mega_c_a_n.html">MegaCAN</a>)</td><td class="entry"><a class="el" href="class_mega_c_a_n.html">MegaCAN</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>processMSreq</b>(uint32_t msgCore, const uint8_t msgData[3], MegaCAN_message_t &amp;msg) (defined in <a class="el" href="class_mega_c_a_n.html">MegaCAN</a>)</td><td class="entry"><a class="el" href="class_mega_c_a_n.html">MegaCAN</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>setMSresp</b>(MegaCAN_message_t recMsg, MegaCAN_message_t &amp;respMsg, uint16_t var0, uint16_t var1, uint16_t var2, uint16_t var3) (defined in <a class="el" href="class_mega_c_a_n.html">MegaCAN</a>)</td><td class="entry"><a class="el" href="class_mega_c_a_n.html">MegaCAN</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>
121 changes: 121 additions & 0 deletions html/class_mega_c_a_n.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MegaCAN: MegaCAN Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MegaCAN
</div>
<div id="projectbrief">Megasquirt CAN Protocol with Arduino</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_mega_c_a_n.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_mega_c_a_n-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MegaCAN Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4143c5cce1ca2dceb452f45a94e3770e"><td class="memItemLeft" align="right" valign="top"><a id="a4143c5cce1ca2dceb452f45a94e3770e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>processMSreq</b> (uint32_t msgCore, const uint8_t msgData[3], <a class="el" href="struct_mega_c_a_n__message__t.html">MegaCAN_message_t</a> &amp;msg)</td></tr>
<tr class="separator:a4143c5cce1ca2dceb452f45a94e3770e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7eb033e98b17a142ab37467702d1f627"><td class="memItemLeft" align="right" valign="top"><a id="a7eb033e98b17a142ab37467702d1f627"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setMSresp</b> (<a class="el" href="struct_mega_c_a_n__message__t.html">MegaCAN_message_t</a> recMsg, <a class="el" href="struct_mega_c_a_n__message__t.html">MegaCAN_message_t</a> &amp;respMsg, uint16_t var0, uint16_t var1, uint16_t var2, uint16_t var3)</td></tr>
<tr class="separator:a7eb033e98b17a142ab37467702d1f627"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93a0f4768ce256e4c90a3dfeb5873c34"><td class="memItemLeft" align="right" valign="top"><a id="a93a0f4768ce256e4c90a3dfeb5873c34"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>getBCastData</b> (uint32_t id, const uint8_t data[8], <a class="el" href="struct_mega_c_a_n__broadcast__message__t.html">MegaCAN_broadcast_message_t</a> &amp;msg)</td></tr>
<tr class="separator:a93a0f4768ce256e4c90a3dfeb5873c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_mega_c_a_n_8h_source.html">MegaCAN.h</a></li>
<li>MegaCAN.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_mega_c_a_n.html">MegaCAN</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>
7 changes: 7 additions & 0 deletions html/class_mega_c_a_n.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
var class_mega_c_a_n =
[
[ "MegaCAN", "class_mega_c_a_n.html#a6b3d339d000dfc4b5a4f45778e296ce8", null ],
[ "getBCastData", "class_mega_c_a_n.html#a93a0f4768ce256e4c90a3dfeb5873c34", null ],
[ "processMSreq", "class_mega_c_a_n.html#a4143c5cce1ca2dceb452f45a94e3770e", null ],
[ "setMSresp", "class_mega_c_a_n.html#a7eb033e98b17a142ab37467702d1f627", null ]
];
Loading

0 comments on commit 23279e6

Please sign in to comment.