184 lines
11 KiB
HTML
Executable File
184 lines
11 KiB
HTML
Executable File
<!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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>CANopenNode: OD_subEntry_t Struct 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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</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">CANopenNode
|
|
</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
</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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('structOD__subEntry__t.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-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">OD_subEntry_t Struct Reference<div class="ingroups"><a class="el" href="group__CO__CANopen__301.html">CANopen_301</a> » <a class="el" href="group__CO__ODinterface.html">OD interface</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Structure describing properties of a variable, located in specific index and sub-index inside the Object Dictionary.
|
|
<a href="structOD__subEntry__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="CO__ODinterface_8h_source.html">CO_ODinterface.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a4e10db7bdf91d721ecc7d97f4dda67ff"><td class="memItemLeft" align="right" valign="top"><a id="a4e10db7bdf91d721ecc7d97f4dda67ff"></a>
|
|
<a class="el" href="group__CO__dataTypes.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOD__subEntry__t.html#a4e10db7bdf91d721ecc7d97f4dda67ff">index</a></td></tr>
|
|
<tr class="memdesc:a4e10db7bdf91d721ecc7d97f4dda67ff"><td class="mdescLeft"> </td><td class="mdescRight">Object Dictionary index. <br /></td></tr>
|
|
<tr class="separator:a4e10db7bdf91d721ecc7d97f4dda67ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c39cbf86fc3b384b017ed6261d379bd"><td class="memItemLeft" align="right" valign="top"><a id="a2c39cbf86fc3b384b017ed6261d379bd"></a>
|
|
<a class="el" href="group__CO__dataTypes.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOD__subEntry__t.html#a2c39cbf86fc3b384b017ed6261d379bd">subIndex</a></td></tr>
|
|
<tr class="memdesc:a2c39cbf86fc3b384b017ed6261d379bd"><td class="mdescLeft"> </td><td class="mdescRight">Object Dictionary sub-index. <br /></td></tr>
|
|
<tr class="separator:a2c39cbf86fc3b384b017ed6261d379bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49750c447be0b3773e8aa1814d5fa2de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CO__dataTypes.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOD__subEntry__t.html#a49750c447be0b3773e8aa1814d5fa2de">subEntriesCount</a></td></tr>
|
|
<tr class="memdesc:a49750c447be0b3773e8aa1814d5fa2de"><td class="mdescLeft"> </td><td class="mdescRight">Number of sub-entries in OD object. <a href="structOD__subEntry__t.html#a49750c447be0b3773e8aa1814d5fa2de">More...</a><br /></td></tr>
|
|
<tr class="separator:a49750c447be0b3773e8aa1814d5fa2de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7d83df4e106219f32cb28d7c510b9d2"><td class="memItemLeft" align="right" valign="top"><a id="ae7d83df4e106219f32cb28d7c510b9d2"></a>
|
|
<a class="el" href="group__CO__ODinterface.html#ga8d459f95307815637e41edc4df71a725">OD_attr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOD__subEntry__t.html#ae7d83df4e106219f32cb28d7c510b9d2">attribute</a></td></tr>
|
|
<tr class="memdesc:ae7d83df4e106219f32cb28d7c510b9d2"><td class="mdescLeft"> </td><td class="mdescRight">Attribute bit-field of the OD sub-object, see <a class="el" href="group__CO__ODinterface.html#ga47b0d204aaf1ea64b4f826aaf8f5c151">OD_attributes_t</a>. <br /></td></tr>
|
|
<tr class="separator:ae7d83df4e106219f32cb28d7c510b9d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6a4eb8da2f84f7b84164eac01115dd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CO__ODinterface.html#ga69f6e1121545e5669098f49e95ce4e47">OD_flagsPDO_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structOD__subEntry__t.html#ad6a4eb8da2f84f7b84164eac01115dd1">flagsPDO</a></td></tr>
|
|
<tr class="memdesc:ad6a4eb8da2f84f7b84164eac01115dd1"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to PDO flags bit-field. <a href="structOD__subEntry__t.html#ad6a4eb8da2f84f7b84164eac01115dd1">More...</a><br /></td></tr>
|
|
<tr class="separator:ad6a4eb8da2f84f7b84164eac01115dd1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Structure describing properties of a variable, located in specific index and sub-index inside the Object Dictionary. </p>
|
|
<p>Structure is initialized with <a class="el" href="group__CO__ODinterface.html#gaf1f736d4b4d6754d971f0c0a63655bcf">OD_getSub()</a> function. </p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a49750c447be0b3773e8aa1814d5fa2de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49750c447be0b3773e8aa1814d5fa2de">◆ </a></span>subEntriesCount</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__CO__dataTypes.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> OD_subEntry_t::subEntriesCount</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Number of sub-entries in OD object. </p>
|
|
<p>For VAR is 1, for ARRAY is maxSubIndex + 1, for RECORD maxSubIndex may be larger, if there is a gap between sub-indexes. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad6a4eb8da2f84f7b84164eac01115dd1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad6a4eb8da2f84f7b84164eac01115dd1">◆ </a></span>flagsPDO</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__CO__ODinterface.html#ga69f6e1121545e5669098f49e95ce4e47">OD_flagsPDO_t</a>* OD_subEntry_t::flagsPDO</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Pointer to PDO flags bit-field. </p>
|
|
<p>This is optional extension of OD object. If OD object has enabled this extension, then each sub-element is coupled with own flagsPDO variable of size 8 to 64 bits (size is configurable by <a class="el" href="group__CO__ODinterface.html#ga69f6e1121545e5669098f49e95ce4e47">OD_flagsPDO_t</a>). Flag is useful, when variable is mapped to RPDO or TPDO.</p>
|
|
<p>If sub-element is mapped to RPDO, then bit0 is set to 1 each time, when any RPDO writes new data into variable. Application may clear bit0.</p>
|
|
<p>If sub-element is mapped to TPDO, then TPDO will set one bit on the time, it is sent. First TPDO will set bit1, second TPDO will set bit2, etc. Up to 63 TPDOs can use flagsPDO.</p>
|
|
<p>Another functionality is with asynchronous TPDOs, to which variable may be mapped. If corresponding bit is 0, TPDO will be sent. This means, that if application sets variable pointed by flagsPDO to zero, it will trigger sending all asynchronous TPDOs (up to first 63), to which variable is mapped. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>301/<a class="el" href="CO__ODinterface_8h_source.html">CO_ODinterface.h</a></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="structOD__subEntry__t.html">OD_subEntry_t</a></li>
|
|
<li class="footer">Generated on Thu Dec 24 2020 14:30:50 for CANopenNode by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|