Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@fontaromain
fontaromain committed Nov 15, 2017
1 parent 9cee027 commit 3e12fb8
Show file tree
Hide file tree
Showing 113 changed files with 1,271 additions and 1,366 deletions.
8 changes: 4 additions & 4 deletions Documentation/_a_c_a_n_frame_8h_source.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions Documentation/_c_c_a_n_defines_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@
<div class="title">CCANDefines.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Standard CAN</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#define CAN_FRAME_LENGHT 8 // CAN frame length in bytes</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define CAN_NO_DATA 0x0 // No data</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#define CAN_TIMEOUT 500 // In ms</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// ISO 15765-2</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Frame types</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define CAN_SINGLE_FRAME_ID 0x0 // Single frame ID</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define CAN_FIRST_FRAME_ID 0x1 // First frame ID</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define CAN_CONSECUTIVE_FRAME_ID 0x2 // Consecutive frame ID</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define CAN_FLOW_FRAME_ID 0x3 // Flow frame ID</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// Useful defines</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define CAN_MULTI_FRAME_MAX_LENGHT 128 // CAN multiframe max length in bytes (4096 is the max length defined by the ISO, use your own according to your applications)</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define CAN_FLOW_CONTROL_ADDRESS_VALUE 0x08 // CAN flow control address to substract from the first frame message address</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keywordtype">bool</span> CANIsSingleFrame(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>&amp; pValue)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">return</span> ((pValue &amp; 0xF0) &gt;&gt; 4) == CAN_SINGLE_FRAME_ID ;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;}</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keywordtype">bool</span> CANIsFirstFrame(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>&amp; pValue)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">return</span> ((pValue &amp; 0xF0) &gt;&gt; 4) == CAN_FIRST_FRAME_ID ;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keywordtype">bool</span> CANIsConsecutiveFrame(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>&amp; pValue)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;{</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span> ((pValue &amp; 0xF0) &gt;&gt; 4) == CAN_CONSECUTIVE_FRAME_ID ;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div></div><!-- fragment --></div><!-- contents -->
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright (c) FONTA romain. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Licensed under the MIT license. See LICENSE file in the project root for details.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Standard CAN</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define CAN_FRAME_LENGHT 8 // CAN frame length in bytes</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define CAN_NO_DATA 0x0 // No data</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define CAN_TIMEOUT 500 // In ms</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// ISO 15765-2</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// Frame types</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define CAN_SINGLE_FRAME_ID 0x0 // Single frame ID</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define CAN_FIRST_FRAME_ID 0x1 // First frame ID</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define CAN_CONSECUTIVE_FRAME_ID 0x2 // Consecutive frame ID</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define CAN_FLOW_FRAME_ID 0x3 // Flow frame ID</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// Useful defines</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define CAN_MULTI_FRAME_MAX_LENGHT 128 // CAN multiframe max length in bytes (4096 is the max length defined by the ISO, use your own according to your applications)</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define CAN_FLOW_CONTROL_ADDRESS_VALUE 0x08 // CAN flow control address to substract from the first frame message address</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keywordtype">bool</span> CANIsSingleFrame(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>&amp; pValue)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">return</span> ((pValue &amp; 0xF0) &gt;&gt; 4) == CAN_SINGLE_FRAME_ID ;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keywordtype">bool</span> CANIsFirstFrame(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>&amp; pValue)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> ((pValue &amp; 0xF0) &gt;&gt; 4) == CAN_FIRST_FRAME_ID ;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keywordtype">bool</span> CANIsConsecutiveFrame(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>&amp; pValue)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;{</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> ((pValue &amp; 0xF0) &gt;&gt; 4) == CAN_CONSECUTIVE_FRAME_ID ;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div></div><!-- fragment --></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="dir_a5a5e51f6a22cc0419cf5fb74bc184e6.html">CANHelperLibrary</a></li><li class="navelem"><a class="el" href="dir_0f818255192842ce3d8ba02ec8998a89.html">Frame</a></li><li class="navelem"><a class="el" href="dir_7070abba8ba302f1b9a2b9a9b16e1384.html">CAN</a></li><li class="navelem"><b>CCANDefines.h</b></li>
<li class="footer">Generated on Thu Nov 9 2017 19:41:31 for CANLibrary by
<li class="footer">Generated on Wed Nov 15 2017 22:19:15 for CANLibrary by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
Expand Down
44 changes: 17 additions & 27 deletions Documentation/_c_close_doors_8h_source.html
View file

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions Documentation/_c_debug_connector_8h_source.html
View file

Large diffs are not rendered by default.

0 comments on commit 3e12fb8

Please sign in to comment.