1201 lines
88 KiB
HTML
1201 lines
88 KiB
HTML
<!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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>LibL6474-C-Library: C:/HomeGit/dhbw/EmbSys/RealtimeProg/MCU_STM32_60h/libs/LibL6474/inc/LibL6474.h File 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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="projectlogo"><img alt="Logo" src="banner.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">LibL6474-C-Library<span id="projectnumber"> 1.0</span>
|
|
</div>
|
|
<div id="projectbrief">Library Code documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('LibL6474_8h.html',''); initResizable(true); });
|
|
/* @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">
|
|
<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 class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">LibL6474.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="LibL6474Config_8h_source.html">LibL6474Config.h</a>"</code><br />
|
|
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for LibL6474.h:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="LibL6474_8h__incl.png" border="0" usemap="#aC_1_2HomeGit_2dhbw_2EmbSys_2RealtimeProg_2MCU__STM32__60h_2libs_2LibL6474_2inc_2LibL6474_8h" alt=""/></div>
|
|
<map name="aC_1_2HomeGit_2dhbw_2EmbSys_2RealtimeProg_2MCU__STM32__60h_2libs_2LibL6474_2inc_2LibL6474_8h" id="aC_1_2HomeGit_2dhbw_2EmbSys_2RealtimeProg_2MCU__STM32__60h_2libs_2LibL6474_2inc_2LibL6474_8h">
|
|
<area shape="rect" title=" " alt="" coords="5,5,223,64"/>
|
|
<area shape="rect" href="LibL6474Config_8h.html" title=" " alt="" coords="53,112,175,139"/>
|
|
<area shape="poly" title=" " alt="" coords="117,64,117,96,111,96,111,64"/>
|
|
</map>
|
|
</div>
|
|
</div><div class="textblock"><div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="LibL6474_8h__dep__incl.png" border="0" usemap="#aC_1_2HomeGit_2dhbw_2EmbSys_2RealtimeProg_2MCU__STM32__60h_2libs_2LibL6474_2inc_2LibL6474_8hdep" alt=""/></div>
|
|
<map name="aC_1_2HomeGit_2dhbw_2EmbSys_2RealtimeProg_2MCU__STM32__60h_2libs_2LibL6474_2inc_2LibL6474_8hdep" id="aC_1_2HomeGit_2dhbw_2EmbSys_2RealtimeProg_2MCU__STM32__60h_2libs_2LibL6474_2inc_2LibL6474_8hdep">
|
|
<area shape="rect" title=" " alt="" coords="9,5,227,64"/>
|
|
<area shape="rect" href="LibL6474x_8c.html" title=" " alt="" coords="5,112,231,171"/>
|
|
<area shape="poly" title=" " alt="" coords="121,80,121,112,115,112,115,80"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="LibL6474_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structL6474__Status.html">L6474_Status</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structL6474x__Platform.html">L6474x_Platform</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a53cf9b773b6772920a7ddf52a3e07bda" id="r_a53cf9b773b6772920a7ddf52a3e07bda"><td class="memItemLeft" align="right" valign="top"><a id="a53cf9b773b6772920a7ddf52a3e07bda" name="a53cf9b773b6772920a7ddf52a3e07bda"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>INC_LIBL6474_H_</b>   INC_LIBL6474_H_</td></tr>
|
|
<tr class="separator:a53cf9b773b6772920a7ddf52a3e07bda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ae918168038a867ae74023c36e0e5faad" id="r_ae918168038a867ae74023c36e0e5faad"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#ac0c141006464185b5e25e20794737205">L6474x_State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae918168038a867ae74023c36e0e5faad">L6474x_State_t</a></td></tr>
|
|
<tr class="separator:ae918168038a867ae74023c36e0e5faad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cbcefa1aa04c85bacfbe16591593661" id="r_a8cbcefa1aa04c85bacfbe16591593661"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8d">L6474x_StepMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a></td></tr>
|
|
<tr class="separator:a8cbcefa1aa04c85bacfbe16591593661"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74d57e36e55d111079c64174e961f619" id="r_a74d57e36e55d111079c64174e961f619"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#aaae3fcfa5e86dceb09b3befb997241a1">L6474x_Direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a74d57e36e55d111079c64174e961f619">L6474x_Direction_t</a></td></tr>
|
|
<tr class="separator:a74d57e36e55d111079c64174e961f619"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a309c3dbe6f05306b1a0a8201979595a8" id="r_a309c3dbe6f05306b1a0a8201979595a8"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#aafb11f316ec72214c03013555014eebb">L6474x_ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a></td></tr>
|
|
<tr class="separator:a309c3dbe6f05306b1a0a8201979595a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe6a37602588d49b9ed5d1a308977d6a" id="r_afe6a37602588d49b9ed5d1a308977d6a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structL6474__Status.html">L6474_Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afe6a37602588d49b9ed5d1a308977d6a">L6474_Status_t</a></td></tr>
|
|
<tr class="separator:afe6a37602588d49b9ed5d1a308977d6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1c87367ce432f3754d12ceb390077c8" id="r_ab1c87367ce432f3754d12ceb390077c8"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#ae9c0b900e2373b01b2ca16d49f0e8907">L6474x_OCD_TH</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab1c87367ce432f3754d12ceb390077c8">L6474x_OCD_TH_t</a></td></tr>
|
|
<tr class="separator:ab1c87367ce432f3754d12ceb390077c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31a0c627342d952d0dddf3fbe0643cac" id="r_a31a0c627342d952d0dddf3fbe0643cac"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structL6474__Handle.html">L6474_Handle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td></tr>
|
|
<tr class="separator:a31a0c627342d952d0dddf3fbe0643cac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd8789d767c61f493658bc6c964d141a" id="r_abd8789d767c61f493658bc6c964d141a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structL6474x__Platform.html">L6474x_Platform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abd8789d767c61f493658bc6c964d141a">L6474x_Platform_t</a></td></tr>
|
|
<tr class="separator:abd8789d767c61f493658bc6c964d141a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ac0c141006464185b5e25e20794737205" id="r_ac0c141006464185b5e25e20794737205"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0c141006464185b5e25e20794737205">L6474x_State</a> { <a class="el" href="#ac0c141006464185b5e25e20794737205a576e46e9b76d8638efad09499b272547">stRESET</a> = 0x00
|
|
, <a class="el" href="#ac0c141006464185b5e25e20794737205ab33bf4e863de1ff463ac63502f8c667c">stDISABLED</a> = 0x01
|
|
, <a class="el" href="#ac0c141006464185b5e25e20794737205ab8f8e4177a77cd29c2e3b89872b9d9b4">stENABLED</a> = 0x02
|
|
, <a class="el" href="#ac0c141006464185b5e25e20794737205ac61c2d407550d5c3a881f44bb5ba87c3">stINVALID</a> = 0x04
|
|
}</td></tr>
|
|
<tr class="separator:ac0c141006464185b5e25e20794737205"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb572e4b787e8746f0d5e9475b0ffb8d" id="r_aeb572e4b787e8746f0d5e9475b0ffb8d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8d">L6474x_StepMode</a> { <br />
|
|
  <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8daae0a2b7890ada0233bf18bfd01a4d858">smFULL</a> = 0x00
|
|
, <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8da1828e5c142b0310cca2dbbb40c38e50a">smHALF</a> = 0x01
|
|
, <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8da67510ff93567212cc7dc038411b6d996">smMICRO4</a> = 0x02
|
|
, <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8da08e26b297b3455c747c4000c0d7374ac">smMICRO8</a> = 0x03
|
|
, <br />
|
|
  <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8da818e6ddb4c69f3d47eb3e97b27cccf73">smMICRO16</a> = 0x04
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:aeb572e4b787e8746f0d5e9475b0ffb8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaae3fcfa5e86dceb09b3befb997241a1" id="r_aaae3fcfa5e86dceb09b3befb997241a1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaae3fcfa5e86dceb09b3befb997241a1">L6474x_Direction</a> { <a class="el" href="#aaae3fcfa5e86dceb09b3befb997241a1a9b2b3de6fba4086254d01d9c190f001c">dirFOREWARD</a> = 0x00
|
|
, <a class="el" href="#aaae3fcfa5e86dceb09b3befb997241a1a23676e3ddc39d6b66b646978c3f57ab9">dirBACKWARD</a> = 0x01
|
|
}</td></tr>
|
|
<tr class="separator:aaae3fcfa5e86dceb09b3befb997241a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafb11f316ec72214c03013555014eebb" id="r_aafb11f316ec72214c03013555014eebb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#aafb11f316ec72214c03013555014eebb">L6474x_ErrorCode</a> { <br />
|
|
  <a class="el" href="#aafb11f316ec72214c03013555014eebba65d3c9089e9c458d114a5ff65a93cdd5">errcNONE</a> = 0
|
|
, <a class="el" href="#aafb11f316ec72214c03013555014eebba6ad539de84e07698a37f5b78733715d7">errcINV_ARG</a> = -1
|
|
, <a class="el" href="#aafb11f316ec72214c03013555014eebbadd837fbbec5502b2f8c74213db4cd2c0">errcNULL_ARG</a> = -2
|
|
, <a class="el" href="#aafb11f316ec72214c03013555014eebbad6b856cca8b1bd633fe4441eebfd1220">errcINV_STATE</a> = -3
|
|
, <br />
|
|
  <a class="el" href="#aafb11f316ec72214c03013555014eebbaa2afa9f9beb6e0e57ad44b469ef60762">errcINTERNAL</a> = -4
|
|
, <a class="el" href="#aafb11f316ec72214c03013555014eebba542a8aafecef8c52d42e537e6b7dfb48">errcLOCKING</a> = -5
|
|
, <a class="el" href="#aafb11f316ec72214c03013555014eebbad22ec437f96367b7938a52c999578db7">errcDEVICE_STATE</a> = -6
|
|
, <a class="el" href="#aafb11f316ec72214c03013555014eebbac707cff173b23da9ae8ef627b177bfb3">errcPENDING</a> = -7
|
|
, <br />
|
|
  <a class="el" href="#aafb11f316ec72214c03013555014eebbae4ead3ad9188404d7cdd1c4d0c2b340d">errcFORBIDDEN</a> = -8
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:aafb11f316ec72214c03013555014eebb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9c0b900e2373b01b2ca16d49f0e8907" id="r_ae9c0b900e2373b01b2ca16d49f0e8907"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae9c0b900e2373b01b2ca16d49f0e8907">L6474x_OCD_TH</a> { <br />
|
|
  <b>ocdth375mA</b> = 0x00
|
|
, <b>ocdth750mA</b> = 0x01
|
|
, <b>ocdth1125mA</b> = 0x02
|
|
, <b>ocdth1500mA</b> = 0x03
|
|
, <br />
|
|
  <b>ocdth1875mA</b> = 0x04
|
|
, <b>ocdth2250mA</b> = 0x05
|
|
, <b>ocdth2625mA</b> = 0x06
|
|
, <b>ocdth3000mA</b> = 0x07
|
|
, <br />
|
|
  <b>ocdth3375mA</b> = 0x08
|
|
, <b>ocdth3750mA</b> = 0x09
|
|
, <b>ocdth4125mA</b> = 0x0A
|
|
, <b>ocdth4500mA</b> = 0x0B
|
|
, <br />
|
|
  <b>ocdth4875mA</b> = 0x0C
|
|
, <b>ocdth5250mA</b> = 0x0D
|
|
, <b>ocdth5625mA</b> = 0x0E
|
|
, <b>ocdth6000mA</b> = 0x0F
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ae9c0b900e2373b01b2ca16d49f0e8907"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dade050e47f1fea02eff190de585d22" id="r_a7dade050e47f1fea02eff190de585d22"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a> { <br />
|
|
  <a class="el" href="#a7dade050e47f1fea02eff190de585d22abccdf1a94c5d1a194f423948fcc35f8a">L6474_PROP_TORQUE</a> = 0x09
|
|
, <a class="el" href="#a7dade050e47f1fea02eff190de585d22afc595836a950e6620f1cb371937a35b7">L6474_PROP_TON</a> = 0x0F
|
|
, <a class="el" href="#a7dade050e47f1fea02eff190de585d22aa16add8513a7cf75c29145c4b8dcccaf">L6474_PROP_TOFF</a> = 0x10
|
|
, <a class="el" href="#a7dade050e47f1fea02eff190de585d22a31afb1f2ce5b021ffbb8bc750b7c75de">L6474_PROP_ADC_OUT</a> = 0x12
|
|
, <br />
|
|
  <a class="el" href="#a7dade050e47f1fea02eff190de585d22a898527fab1d519699d217acca881c40d">L6474_PROP_OCDTH</a> = 0x13
|
|
, <a class="el" href="#a7dade050e47f1fea02eff190de585d22aa8e33c286f409be906405a261d70b2f1">L6474_PROP_TFAST</a> = 0x0E
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a7dade050e47f1fea02eff190de585d22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a86f889135167d8b4e889c620d0bf9990" id="r_a86f889135167d8b4e889c620d0bf9990"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a86f889135167d8b4e889c620d0bf9990">L6474_CreateInstance</a> (<a class="el" href="#abd8789d767c61f493658bc6c964d141a">L6474x_Platform_t</a> *p, void *pIO, void *pGPO, void *pPWM)</td></tr>
|
|
<tr class="separator:a86f889135167d8b4e889c620d0bf9990"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50d6d2ccc49478ff0ee3f42a24a8f496" id="r_a50d6d2ccc49478ff0ee3f42a24a8f496"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a50d6d2ccc49478ff0ee3f42a24a8f496">L6474_DestroyInstance</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h)</td></tr>
|
|
<tr class="separator:a50d6d2ccc49478ff0ee3f42a24a8f496"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9104da6893519c5eb0b33d56778fee2f" id="r_a9104da6893519c5eb0b33d56778fee2f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9104da6893519c5eb0b33d56778fee2f">L6474_ResetStandBy</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h)</td></tr>
|
|
<tr class="separator:a9104da6893519c5eb0b33d56778fee2f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09a265e08fc1c8e4ec0c1c40ede3aa41" id="r_a09a265e08fc1c8e4ec0c1c40ede3aa41"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a09a265e08fc1c8e4ec0c1c40ede3aa41">L6474_SetBaseParameter</a> (<a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a> *p)</td></tr>
|
|
<tr class="separator:a09a265e08fc1c8e4ec0c1c40ede3aa41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab7a90876abaf436e55942909df4c3430" id="r_ab7a90876abaf436e55942909df4c3430"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab7a90876abaf436e55942909df4c3430">L6474_EncodePhaseCurrent</a> (float mA)</td></tr>
|
|
<tr class="separator:ab7a90876abaf436e55942909df4c3430"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa09b09b606dae725681f47cb44208df0" id="r_aa09b09b606dae725681f47cb44208df0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa09b09b606dae725681f47cb44208df0">L6474_EncodePhaseCurrentParameter</a> (<a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a> *p, float mA)</td></tr>
|
|
<tr class="separator:aa09b09b606dae725681f47cb44208df0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b7f8efa1a972e53487d5cdfc8282784" id="r_a7b7f8efa1a972e53487d5cdfc8282784"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b7f8efa1a972e53487d5cdfc8282784">L6474_Initialize</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, <a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a> *p)</td></tr>
|
|
<tr class="separator:a7b7f8efa1a972e53487d5cdfc8282784"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b9c50f6d131a6acc788725354941bf1" id="r_a9b9c50f6d131a6acc788725354941bf1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b9c50f6d131a6acc788725354941bf1">L6474_SetStepMode</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, <a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a> mode)</td></tr>
|
|
<tr class="separator:a9b9c50f6d131a6acc788725354941bf1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3570aff9f639c99f46549923cebdd511" id="r_a3570aff9f639c99f46549923cebdd511"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3570aff9f639c99f46549923cebdd511">L6474_GetStepMode</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, <a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a> *mode)</td></tr>
|
|
<tr class="separator:a3570aff9f639c99f46549923cebdd511"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18d8fb31625d8e3ee10fb37ff2054416" id="r_a18d8fb31625d8e3ee10fb37ff2054416"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a18d8fb31625d8e3ee10fb37ff2054416">L6474_SetPowerOutputs</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int ena)</td></tr>
|
|
<tr class="separator:a18d8fb31625d8e3ee10fb37ff2054416"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72614a564fe727aefceab5121943d66f" id="r_a72614a564fe727aefceab5121943d66f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a72614a564fe727aefceab5121943d66f">L6474_GetStatus</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, <a class="el" href="#afe6a37602588d49b9ed5d1a308977d6a">L6474_Status_t</a> *status)</td></tr>
|
|
<tr class="separator:a72614a564fe727aefceab5121943d66f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd4a11ba27a26c9addb848e3aa3ad5c5" id="r_abd4a11ba27a26c9addb848e3aa3ad5c5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#abd4a11ba27a26c9addb848e3aa3ad5c5">L6474_GetState</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, <a class="el" href="#ae918168038a867ae74023c36e0e5faad">L6474x_State_t</a> *state)</td></tr>
|
|
<tr class="separator:abd4a11ba27a26c9addb848e3aa3ad5c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4589feae28120554b6bdc708ee4e2e4" id="r_aa4589feae28120554b6bdc708ee4e2e4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa4589feae28120554b6bdc708ee4e2e4">L6474_StepIncremental</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int steps)</td></tr>
|
|
<tr class="separator:aa4589feae28120554b6bdc708ee4e2e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac04e97cbc212711d7fc321abd0d3f5aa" id="r_ac04e97cbc212711d7fc321abd0d3f5aa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac04e97cbc212711d7fc321abd0d3f5aa">L6474_StopMovement</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h)</td></tr>
|
|
<tr class="separator:ac04e97cbc212711d7fc321abd0d3f5aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c018c06758c809898408d249b3723b3" id="r_a0c018c06758c809898408d249b3723b3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c018c06758c809898408d249b3723b3">L6474_IsMoving</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int *moving)</td></tr>
|
|
<tr class="separator:a0c018c06758c809898408d249b3723b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae15c095b47ecccc41e7dbecc4761c14d" id="r_ae15c095b47ecccc41e7dbecc4761c14d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae15c095b47ecccc41e7dbecc4761c14d">L6474_SetProperty</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, <a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a> prop, int value)</td></tr>
|
|
<tr class="separator:ae15c095b47ecccc41e7dbecc4761c14d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a772c5810e20ed1056abaedf614f8adb3" id="r_a772c5810e20ed1056abaedf614f8adb3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a772c5810e20ed1056abaedf614f8adb3">L6474_GetProperty</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, <a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a> prop, int *value)</td></tr>
|
|
<tr class="separator:a772c5810e20ed1056abaedf614f8adb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28e38522674ae36aadb4c880eae3a1e7" id="r_a28e38522674ae36aadb4c880eae3a1e7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a28e38522674ae36aadb4c880eae3a1e7">L6474_GetAbsolutePosition</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int *position)</td></tr>
|
|
<tr class="separator:a28e38522674ae36aadb4c880eae3a1e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0edaf248fe144722aaed9a7b315651fa" id="r_a0edaf248fe144722aaed9a7b315651fa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0edaf248fe144722aaed9a7b315651fa">L6474_SetAbsolutePosition</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int position)</td></tr>
|
|
<tr class="separator:a0edaf248fe144722aaed9a7b315651fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76f2ad47b2c1b923186a3881e5cc97ba" id="r_a76f2ad47b2c1b923186a3881e5cc97ba"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a76f2ad47b2c1b923186a3881e5cc97ba">L6474_GetElectricalPosition</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int *position)</td></tr>
|
|
<tr class="separator:a76f2ad47b2c1b923186a3881e5cc97ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1aa8e3250bc70809859a71f8a0e68dfe" id="r_a1aa8e3250bc70809859a71f8a0e68dfe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1aa8e3250bc70809859a71f8a0e68dfe">L6474_SetElectricalPosition</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int position)</td></tr>
|
|
<tr class="separator:a1aa8e3250bc70809859a71f8a0e68dfe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a693afe2b1029683cbfb988b4e95dbed6" id="r_a693afe2b1029683cbfb988b4e95dbed6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a693afe2b1029683cbfb988b4e95dbed6">L6474_GetPositionMark</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int *position)</td></tr>
|
|
<tr class="separator:a693afe2b1029683cbfb988b4e95dbed6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f1c7b4f6c47bc5fe82ca9d7cde2606d" id="r_a1f1c7b4f6c47bc5fe82ca9d7cde2606d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f1c7b4f6c47bc5fe82ca9d7cde2606d">L6474_SetPositionMark</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int position)</td></tr>
|
|
<tr class="separator:a1f1c7b4f6c47bc5fe82ca9d7cde2606d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b5bfb89269e877f95fa6c003e685f71" id="r_a4b5bfb89269e877f95fa6c003e685f71"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b5bfb89269e877f95fa6c003e685f71">L6474_GetAlarmEnables</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int *bits)</td></tr>
|
|
<tr class="separator:a4b5bfb89269e877f95fa6c003e685f71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3f26a5707e354391c5a90bf3e035a27" id="r_aa3f26a5707e354391c5a90bf3e035a27"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3f26a5707e354391c5a90bf3e035a27">L6474_SetAlarmEnables</a> (<a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> h, int bits)</td></tr>
|
|
<tr class="separator:aa3f26a5707e354391c5a90bf3e035a27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="a31a0c627342d952d0dddf3fbe0643cac" name="a31a0c627342d952d0dddf3fbe0643cac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a31a0c627342d952d0dddf3fbe0643cac">◆ </a></span>L6474_Handle_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structL6474__Handle.html">L6474_Handle</a>* <a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> handle is an instance pointer of the driver library which is generated whenever the L6474_CreateInstance function returns with success. Therefore at least a <a class="el" href="#abd8789d767c61f493658bc6c964d141a">L6474x_Platform_t</a> platform description pointer is required </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afe6a37602588d49b9ed5d1a308977d6a" name="afe6a37602588d49b9ed5d1a308977d6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe6a37602588d49b9ed5d1a308977d6a">◆ </a></span>L6474_Status_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structL6474__Status.html">L6474_Status</a> <a class="el" href="#afe6a37602588d49b9ed5d1a308977d6a">L6474_Status_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#afe6a37602588d49b9ed5d1a308977d6a">L6474_Status_t</a> enum describes the status register content of the stepper driver chip. It is reinterpreted so it can be naturally used in the code to get some of the error codes or state bits of the driver. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74d57e36e55d111079c64174e961f619" name="a74d57e36e55d111079c64174e961f619"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74d57e36e55d111079c64174e961f619">◆ </a></span>L6474x_Direction_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="#aaae3fcfa5e86dceb09b3befb997241a1">L6474x_Direction</a> <a class="el" href="#a74d57e36e55d111079c64174e961f619">L6474x_Direction_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a74d57e36e55d111079c64174e961f619">L6474x_Direction_t</a> enum describes the direction of the driver and therefore the rotation of the stepper axis. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a309c3dbe6f05306b1a0a8201979595a8" name="a309c3dbe6f05306b1a0a8201979595a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a309c3dbe6f05306b1a0a8201979595a8">◆ </a></span>L6474x_ErrorCode_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="#aafb11f316ec72214c03013555014eebb">L6474x_ErrorCode</a> <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum describes the possible error codes when using the API commands. Those error codes are mostly returned as return value by the API function which has been called previously </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab1c87367ce432f3754d12ceb390077c8" name="ab1c87367ce432f3754d12ceb390077c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1c87367ce432f3754d12ceb390077c8">◆ </a></span>L6474x_OCD_TH_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="#ae9c0b900e2373b01b2ca16d49f0e8907">L6474x_OCD_TH</a> <a class="el" href="#ab1c87367ce432f3754d12ceb390077c8">L6474x_OCD_TH_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#ab1c87367ce432f3754d12ceb390077c8">L6474x_OCD_TH_t</a> enum describes the possible overcurrent threshold values which can be set in the library and which are then taken into account by the stepper driver </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd8789d767c61f493658bc6c964d141a" name="abd8789d767c61f493658bc6c964d141a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd8789d767c61f493658bc6c964d141a">◆ </a></span>L6474x_Platform_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structL6474x__Platform.html">L6474x_Platform</a> <a class="el" href="#abd8789d767c61f493658bc6c964d141a">L6474x_Platform_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#abd8789d767c61f493658bc6c964d141a">L6474x_Platform_t</a> structure is used to encapsulate platform specific parameters and to provide environment specific functions in a generalized format. Theses functions are malloc and free or some PWM and GPIO abstractions The lock guards and thread safety mechanisms are also abstracted by this structure </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae918168038a867ae74023c36e0e5faad" name="ae918168038a867ae74023c36e0e5faad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae918168038a867ae74023c36e0e5faad">◆ </a></span>L6474x_State_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="#ac0c141006464185b5e25e20794737205">L6474x_State</a> <a class="el" href="#ae918168038a867ae74023c36e0e5faad">L6474x_State_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="LibL6474Config_8h.html">LibL6474Config.h</a> must be provided by the user project. The header in conf folder is only a template!</p>
|
|
<p>The <a class="el" href="#ae918168038a867ae74023c36e0e5faad">L6474x_State_t</a> enum is used to describe the current state of the driver library which helps the user to decide the next steps to be taken or to get notified about an unexpected state which is caused by an error </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8cbcefa1aa04c85bacfbe16591593661" name="a8cbcefa1aa04c85bacfbe16591593661"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8cbcefa1aa04c85bacfbe16591593661">◆ </a></span>L6474x_StepMode_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8d">L6474x_StepMode</a> <a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a> enum is used to describe the current step mode (resolution) of the driver library and the stepper motor. This changes the internal calculations for speed and position and requires a new reference run in case it will be changed at runtime. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a7dade050e47f1fea02eff190de585d22" name="a7dade050e47f1fea02eff190de585d22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7dade050e47f1fea02eff190de585d22">◆ </a></span>L6474_Property_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a> enum is a address representation for externally changeable properties by the library via the API commands. In case the torque shall be changed, the user can call L6474_SetProperty with the L6474_PROP_TORQUE entry. Some of the properties can not be changed while the driver outputs are enabled and the library is in stENABLED state </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7dade050e47f1fea02eff190de585d22abccdf1a94c5d1a194f423948fcc35f8a" name="a7dade050e47f1fea02eff190de585d22abccdf1a94c5d1a194f423948fcc35f8a"></a>L6474_PROP_TORQUE </td><td class="fielddoc"><p>L6474_PROP_TORQUE is the current setpoint value of each phase of the stepper which follows the torque directly </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7dade050e47f1fea02eff190de585d22afc595836a950e6620f1cb371937a35b7" name="a7dade050e47f1fea02eff190de585d22afc595836a950e6620f1cb371937a35b7"></a>L6474_PROP_TON </td><td class="fielddoc"><p>L6474_PROP_TON is the minimum time for the ON-part of the current control loop </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7dade050e47f1fea02eff190de585d22aa16add8513a7cf75c29145c4b8dcccaf" name="a7dade050e47f1fea02eff190de585d22aa16add8513a7cf75c29145c4b8dcccaf"></a>L6474_PROP_TOFF </td><td class="fielddoc"><p>L6474_PROP_TOFF is the minimum time for the OFF-part of the current control loop </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7dade050e47f1fea02eff190de585d22a31afb1f2ce5b021ffbb8bc750b7c75de" name="a7dade050e47f1fea02eff190de585d22a31afb1f2ce5b021ffbb8bc750b7c75de"></a>L6474_PROP_ADC_OUT </td><td class="fielddoc"><p>L6474_PROP_ADC_OUT controls the ADC output behavior </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7dade050e47f1fea02eff190de585d22a898527fab1d519699d217acca881c40d" name="a7dade050e47f1fea02eff190de585d22a898527fab1d519699d217acca881c40d"></a>L6474_PROP_OCDTH </td><td class="fielddoc"><p>L6474_PROP_OCDTH sets the overcurrent threshold detection value </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7dade050e47f1fea02eff190de585d22aa8e33c286f409be906405a261d70b2f1" name="a7dade050e47f1fea02eff190de585d22aa8e33c286f409be906405a261d70b2f1"></a>L6474_PROP_TFAST </td><td class="fielddoc"><p>L6474_PROP_TFAST is used to change switching times </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaae3fcfa5e86dceb09b3befb997241a1" name="aaae3fcfa5e86dceb09b3befb997241a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaae3fcfa5e86dceb09b3befb997241a1">◆ </a></span>L6474x_Direction</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#aaae3fcfa5e86dceb09b3befb997241a1">L6474x_Direction</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a74d57e36e55d111079c64174e961f619">L6474x_Direction_t</a> enum describes the direction of the driver and therefore the rotation of the stepper axis. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aaae3fcfa5e86dceb09b3befb997241a1a9b2b3de6fba4086254d01d9c190f001c" name="aaae3fcfa5e86dceb09b3befb997241a1a9b2b3de6fba4086254d01d9c190f001c"></a>dirFOREWARD </td><td class="fielddoc"><p>dirFOREWARD is interpreted as clock wise rotation </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aaae3fcfa5e86dceb09b3befb997241a1a23676e3ddc39d6b66b646978c3f57ab9" name="aaae3fcfa5e86dceb09b3befb997241a1a23676e3ddc39d6b66b646978c3f57ab9"></a>dirBACKWARD </td><td class="fielddoc"><p>dirFOREWARD is interpreted as counter clock wise rotation </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aafb11f316ec72214c03013555014eebb" name="aafb11f316ec72214c03013555014eebb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aafb11f316ec72214c03013555014eebb">◆ </a></span>L6474x_ErrorCode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#aafb11f316ec72214c03013555014eebb">L6474x_ErrorCode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum describes the possible error codes when using the API commands. Those error codes are mostly returned as return value by the API function which has been called previously </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebba65d3c9089e9c458d114a5ff65a93cdd5" name="aafb11f316ec72214c03013555014eebba65d3c9089e9c458d114a5ff65a93cdd5"></a>errcNONE </td><td class="fielddoc"><p>errcNONE means no error and the operation was successful </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebba6ad539de84e07698a37f5b78733715d7" name="aafb11f316ec72214c03013555014eebba6ad539de84e07698a37f5b78733715d7"></a>errcINV_ARG </td><td class="fielddoc"><p>errcINV_ARG means that at least one argument was invalid or out of range </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebbadd837fbbec5502b2f8c74213db4cd2c0" name="aafb11f316ec72214c03013555014eebbadd837fbbec5502b2f8c74213db4cd2c0"></a>errcNULL_ARG </td><td class="fielddoc"><p>errcNULL_ARG means that at least one argument was a null pointer where it was not expected </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebbad6b856cca8b1bd633fe4441eebfd1220" name="aafb11f316ec72214c03013555014eebbad6b856cca8b1bd633fe4441eebfd1220"></a>errcINV_STATE </td><td class="fielddoc"><p>errcINV_STATE means that the stepper driver or the library is not in the state of type <a class="el" href="#ae918168038a867ae74023c36e0e5faad">L6474x_State_t</a> and therefore the operation can not be executed </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebbaa2afa9f9beb6e0e57ad44b469ef60762" name="aafb11f316ec72214c03013555014eebbaa2afa9f9beb6e0e57ad44b469ef60762"></a>errcINTERNAL </td><td class="fielddoc"><p>errcINTERNAL means an error which happens when calling abstraction functions which then return an error code </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebba542a8aafecef8c52d42e537e6b7dfb48" name="aafb11f316ec72214c03013555014eebba542a8aafecef8c52d42e537e6b7dfb48"></a>errcLOCKING </td><td class="fielddoc"><p>errcLOCKING in case the library is used multi-threaded, it might happen, that a function can not be locked because another caller is still using the library (lock guard principle). In mutex case this should not be returned by the API </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebbad22ec437f96367b7938a52c999578db7" name="aafb11f316ec72214c03013555014eebbad22ec437f96367b7938a52c999578db7"></a>errcDEVICE_STATE </td><td class="fielddoc"><p>errcDEVICE_STATE means that the state of the driver chip permits the operation </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebbac707cff173b23da9ae8ef627b177bfb3" name="aafb11f316ec72214c03013555014eebbac707cff173b23da9ae8ef627b177bfb3"></a>errcPENDING </td><td class="fielddoc"><p>errcPENDING means that another operation is still pending and therefore the operation can not be executed while there is still a pending one </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aafb11f316ec72214c03013555014eebbae4ead3ad9188404d7cdd1c4d0c2b340d" name="aafb11f316ec72214c03013555014eebbae4ead3ad9188404d7cdd1c4d0c2b340d"></a>errcFORBIDDEN </td><td class="fielddoc"><p>errcFORBIDDEN means that operation is not possible with the given arguments or this library </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9c0b900e2373b01b2ca16d49f0e8907" name="ae9c0b900e2373b01b2ca16d49f0e8907"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9c0b900e2373b01b2ca16d49f0e8907">◆ </a></span>L6474x_OCD_TH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#ae9c0b900e2373b01b2ca16d49f0e8907">L6474x_OCD_TH</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#ab1c87367ce432f3754d12ceb390077c8">L6474x_OCD_TH_t</a> enum describes the possible overcurrent threshold values which can be set in the library and which are then taken into account by the stepper driver </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac0c141006464185b5e25e20794737205" name="ac0c141006464185b5e25e20794737205"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac0c141006464185b5e25e20794737205">◆ </a></span>L6474x_State</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#ac0c141006464185b5e25e20794737205">L6474x_State</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="LibL6474Config_8h.html">LibL6474Config.h</a> must be provided by the user project. The header in conf folder is only a template!</p>
|
|
<p>The <a class="el" href="#ae918168038a867ae74023c36e0e5faad">L6474x_State_t</a> enum is used to describe the current state of the driver library which helps the user to decide the next steps to be taken or to get notified about an unexpected state which is caused by an error </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac0c141006464185b5e25e20794737205a576e46e9b76d8638efad09499b272547" name="ac0c141006464185b5e25e20794737205a576e46e9b76d8638efad09499b272547"></a>stRESET </td><td class="fielddoc"><p>stRESET is used to signal the initial power up state or a full device reset state in which the chip is kept until the user releases a reset state </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ac0c141006464185b5e25e20794737205ab33bf4e863de1ff463ac63502f8c667c" name="ac0c141006464185b5e25e20794737205ab33bf4e863de1ff463ac63502f8c667c"></a>stDISABLED </td><td class="fielddoc"><p>stDISABLED is used to signal the ready but disabled state of the chip. It is kept in this step until the user enables the power output stages </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ac0c141006464185b5e25e20794737205ab8f8e4177a77cd29c2e3b89872b9d9b4" name="ac0c141006464185b5e25e20794737205ab8f8e4177a77cd29c2e3b89872b9d9b4"></a>stENABLED </td><td class="fielddoc"><p>stENABLED is used to signal the ready and enabled state of the chip. It is kept in this step until the user disables the power output stages or an error happens </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ac0c141006464185b5e25e20794737205ac61c2d407550d5c3a881f44bb5ba87c3" name="ac0c141006464185b5e25e20794737205ac61c2d407550d5c3a881f44bb5ba87c3"></a>stINVALID </td><td class="fielddoc"><p>stINVALID is used to signal a state which requires user interaction because something is completely wrong in regular cases, this state can not be present. This is an indicator of memory corruption or misleading usage of the library </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb572e4b787e8746f0d5e9475b0ffb8d" name="aeb572e4b787e8746f0d5e9475b0ffb8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb572e4b787e8746f0d5e9475b0ffb8d">◆ </a></span>L6474x_StepMode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#aeb572e4b787e8746f0d5e9475b0ffb8d">L6474x_StepMode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The <a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a> enum is used to describe the current step mode (resolution) of the driver library and the stepper motor. This changes the internal calculations for speed and position and requires a new reference run in case it will be changed at runtime. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aeb572e4b787e8746f0d5e9475b0ffb8daae0a2b7890ada0233bf18bfd01a4d858" name="aeb572e4b787e8746f0d5e9475b0ffb8daae0a2b7890ada0233bf18bfd01a4d858"></a>smFULL </td><td class="fielddoc"><p>smFULL requires minimum of 4 steps for a full turn of the motor axis. This mode results in the highest torque but in the most noisy operation and the lowest resolution </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aeb572e4b787e8746f0d5e9475b0ffb8da1828e5c142b0310cca2dbbb40c38e50a" name="aeb572e4b787e8746f0d5e9475b0ffb8da1828e5c142b0310cca2dbbb40c38e50a"></a>smHALF </td><td class="fielddoc"><p>smHALF requires minimum of 8 steps for a full turn of the motor axis. better resolution but less torque </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aeb572e4b787e8746f0d5e9475b0ffb8da67510ff93567212cc7dc038411b6d996" name="aeb572e4b787e8746f0d5e9475b0ffb8da67510ff93567212cc7dc038411b6d996"></a>smMICRO4 </td><td class="fielddoc"><p>smMICRO4 requires minimum of 16 steps for a full turn of the motor axis. better resolution but less torque </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aeb572e4b787e8746f0d5e9475b0ffb8da08e26b297b3455c747c4000c0d7374ac" name="aeb572e4b787e8746f0d5e9475b0ffb8da08e26b297b3455c747c4000c0d7374ac"></a>smMICRO8 </td><td class="fielddoc"><p>smMICRO8 requires minimum of 32 steps for a full turn of the motor axis. better resolution but less torque </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aeb572e4b787e8746f0d5e9475b0ffb8da818e6ddb4c69f3d47eb3e97b27cccf73" name="aeb572e4b787e8746f0d5e9475b0ffb8da818e6ddb4c69f3d47eb3e97b27cccf73"></a>smMICRO16 </td><td class="fielddoc"><p>smMICRO16 requires minimum of 64 steps for a full turn of the motor axis. better resolution but less torque </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a86f889135167d8b4e889c620d0bf9990" name="a86f889135167d8b4e889c620d0bf9990"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86f889135167d8b4e889c620d0bf9990">◆ </a></span>L6474_CreateInstance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a> L6474_CreateInstance </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#abd8789d767c61f493658bc6c964d141a">L6474x_Platform_t</a> *</td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>pIO</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>pGPO</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>pPWM</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>L6474_CreateInstance is used once to create a library instance which encapsulates the handling for one stepper driver chip It needs a <a class="el" href="#abd8789d767c61f493658bc6c964d141a">L6474x_Platform_t</a> abstraction pointer and optionally some context pointers which are platform specific. The context pointers are passed to the abstraction functions which are provided by the platform structure.</p>
|
|
<p>In case it fails, a null pointer is returned. In case it was successful, a handle pointer is returned which is always required for all other API calls </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50d6d2ccc49478ff0ee3f42a24a8f496" name="a50d6d2ccc49478ff0ee3f42a24a8f496"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50d6d2ccc49478ff0ee3f42a24a8f496">◆ </a></span>L6474_DestroyInstance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_DestroyInstance </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>L6474_DestroyInstance is used to destroy a library instance which has been previously created by a call to L6474_CreateInstance</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab7a90876abaf436e55942909df4c3430" name="ab7a90876abaf436e55942909df4c3430"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab7a90876abaf436e55942909df4c3430">◆ </a></span>L6474_EncodePhaseCurrent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char L6474_EncodePhaseCurrent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>mA</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Calling L6474_EncodePhaseCurrent converts the requested phase current into the register value which is required in the base parameter structure. The member for this value is named TorqueVal</p>
|
|
<p>The function returns a register value which represents the given current value </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa09b09b606dae725681f47cb44208df0" name="aa09b09b606dae725681f47cb44208df0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa09b09b606dae725681f47cb44208df0">◆ </a></span>L6474_EncodePhaseCurrentParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_EncodePhaseCurrentParameter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a> *</td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>mA</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Calling L6474_EncodePhaseCurrentParameter converts the requested phase current into the register value which is required in the base parameter structure. The member for this value is named TorqueVal. This function directly inserts the converted value into the given base parameter structure.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28e38522674ae36aadb4c880eae3a1e7" name="a28e38522674ae36aadb4c880eae3a1e7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28e38522674ae36aadb4c880eae3a1e7">◆ </a></span>L6474_GetAbsolutePosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetAbsolutePosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>position</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_GetAbsolutePosition is used to read the current stepper position. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param position is required. It returns the position </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b5bfb89269e877f95fa6c003e685f71" name="a4b5bfb89269e877f95fa6c003e685f71"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b5bfb89269e877f95fa6c003e685f71">◆ </a></span>L6474_GetAlarmEnables()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetAlarmEnables </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>bits</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_GetAlarmEnables is used to read the current enable bits for the ERROR ALARM and FLAG Pin. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param bits is required. The bitmask can be found in the datasheet </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a76f2ad47b2c1b923186a3881e5cc97ba" name="a76f2ad47b2c1b923186a3881e5cc97ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a76f2ad47b2c1b923186a3881e5cc97ba">◆ </a></span>L6474_GetElectricalPosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetElectricalPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>position</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_GetElectricalPosition is used to read the current stepper electrical position. The library must not be in stRESET state to perform this operation. The electrical Position returns the step state and micro step component of the driver.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param position is required. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a693afe2b1029683cbfb988b4e95dbed6" name="a693afe2b1029683cbfb988b4e95dbed6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a693afe2b1029683cbfb988b4e95dbed6">◆ </a></span>L6474_GetPositionMark()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetPositionMark </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>position</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_GetPositionMark is used to read the current stepper position mark. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param position is required. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a772c5810e20ed1056abaedf614f8adb3" name="a772c5810e20ed1056abaedf614f8adb3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a772c5810e20ed1056abaedf614f8adb3">◆ </a></span>L6474_GetProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a></td> <td class="paramname"><span class="paramname"><em>prop</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetProperty is used to read a property of the type of <a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a>. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param prop is required.</p>
|
|
<p>param value is required. The value formats can be found in the datasheet </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd4a11ba27a26c9addb848e3aa3ad5c5" name="abd4a11ba27a26c9addb848e3aa3ad5c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd4a11ba27a26c9addb848e3aa3ad5c5">◆ </a></span>L6474_GetState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#ae918168038a867ae74023c36e0e5faad">L6474x_State_t</a> *</td> <td class="paramname"><span class="paramname"><em>state</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_GetState is used to read back the current libraries state. The library can be in state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param state is required. And must not be null </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a72614a564fe727aefceab5121943d66f" name="a72614a564fe727aefceab5121943d66f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72614a564fe727aefceab5121943d66f">◆ </a></span>L6474_GetStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#afe6a37602588d49b9ed5d1a308977d6a">L6474_Status_t</a> *</td> <td class="paramname"><span class="paramname"><em>status</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_GetStatus is used to read back the current libraries and devices status. The library must not be in stRESET to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param status is required. And must not be null </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3570aff9f639c99f46549923cebdd511" name="a3570aff9f639c99f46549923cebdd511"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3570aff9f639c99f46549923cebdd511">◆ </a></span>L6474_GetStepMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_GetStepMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a> *</td> <td class="paramname"><span class="paramname"><em>mode</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetStepMode is used to read back the step mode and therefore the resolution. The library must not be in stRESET to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param mode is required and is one out of <a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7b7f8efa1a972e53487d5cdfc8282784" name="a7b7f8efa1a972e53487d5cdfc8282784"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b7f8efa1a972e53487d5cdfc8282784">◆ </a></span>L6474_Initialize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a> *</td> <td class="paramname"><span class="paramname"><em>p</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_Initialize is used to set all basic parameters and take the required steps to bring up the driver into an idle state. It sets the library to stDISABLED in case no error happens.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param p is required and can not be null. the struct can be filled by calling L6474_SetBaseParameter before. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c018c06758c809898408d249b3723b3" name="a0c018c06758c809898408d249b3723b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c018c06758c809898408d249b3723b3">◆ </a></span>L6474_IsMoving()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_IsMoving </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>moving</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_IsMoving is used to read the state of movement. In case the stepper moves, it returns true. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param moving is required. It returns 0 when no movement is pending or 1 when there is a movement. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9104da6893519c5eb0b33d56778fee2f" name="a9104da6893519c5eb0b33d56778fee2f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9104da6893519c5eb0b33d56778fee2f">◆ </a></span>L6474_ResetStandBy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_ResetStandBy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Calling L6474_ResetStandBy sets the driver in deep power down or reset state and the library will be set to default startup state again. All initialization steps must be done again by at least calling L6474_Initialize. The library is set to stRESET from any other state before.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error</p>
|
|
<p>note that in case the stepper is enabled an moving, the operation will be safely disabled but depending on the speed, the position can not be tracked properly anymore. So a new reference run after re-initialization is required!</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0edaf248fe144722aaed9a7b315651fa" name="a0edaf248fe144722aaed9a7b315651fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0edaf248fe144722aaed9a7b315651fa">◆ </a></span>L6474_SetAbsolutePosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetAbsolutePosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>position</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetAbsolutePosition is used to write the current stepper position. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param position is required. It sets the position </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa3f26a5707e354391c5a90bf3e035a27" name="aa3f26a5707e354391c5a90bf3e035a27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3f26a5707e354391c5a90bf3e035a27">◆ </a></span>L6474_SetAlarmEnables()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetAlarmEnables </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>bits</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetAlarmEnables is used to write the current enable bits for the ERROR ALARM and FLAG Pin. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param bits is required. The bitmask can be found in the datasheet </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a09a265e08fc1c8e4ec0c1c40ede3aa41" name="a09a265e08fc1c8e4ec0c1c40ede3aa41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09a265e08fc1c8e4ec0c1c40ede3aa41">◆ </a></span>L6474_SetBaseParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetBaseParameter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a> *</td> <td class="paramname"><span class="paramname"><em>p</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Calling L6474_SetBaseParameter sets the basic global default parameters for all properties in the <a class="el" href="structL6474__BaseParameter__t.html">L6474_BaseParameter_t</a> structure. These parameters are required when calling L6474_Initialize</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1aa8e3250bc70809859a71f8a0e68dfe" name="a1aa8e3250bc70809859a71f8a0e68dfe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1aa8e3250bc70809859a71f8a0e68dfe">◆ </a></span>L6474_SetElectricalPosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetElectricalPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>position</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetElectricalPosition is used to write the current stepper electrical position. The library must not be in stRESET state to perform this operation. The electrical Position consists of the step state and micro step component of the driver.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param position is required. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f1c7b4f6c47bc5fe82ca9d7cde2606d" name="a1f1c7b4f6c47bc5fe82ca9d7cde2606d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f1c7b4f6c47bc5fe82ca9d7cde2606d">◆ </a></span>L6474_SetPositionMark()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetPositionMark </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>position</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetPositionMark is used to write the current stepper position mark. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param position is required. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a18d8fb31625d8e3ee10fb37ff2054416" name="a18d8fb31625d8e3ee10fb37ff2054416"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18d8fb31625d8e3ee10fb37ff2054416">◆ </a></span>L6474_SetPowerOutputs()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetPowerOutputs </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>ena</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetPowerOutputs is used to enable or disable the driver output stages. The library must not be in stRESET to perform this operation. The libraries state will be changed to stENABLED or stDISABLED depending on the ena parameter.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param ena is required and is either 0 when disabling or 1 when enabling is requested </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae15c095b47ecccc41e7dbecc4761c14d" name="ae15c095b47ecccc41e7dbecc4761c14d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae15c095b47ecccc41e7dbecc4761c14d">◆ </a></span>L6474_SetProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a></td> <td class="paramname"><span class="paramname"><em>prop</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetProperty is used to write a property of the type of <a class="el" href="#a7dade050e47f1fea02eff190de585d22">L6474_Property_t</a>. The library must not be in stRESET state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param prop is required.</p>
|
|
<p>param value is required. The value formats can be found in the datasheet </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b9c50f6d131a6acc788725354941bf1" name="a9b9c50f6d131a6acc788725354941bf1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b9c50f6d131a6acc788725354941bf1">◆ </a></span>L6474_SetStepMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_SetStepMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a></td> <td class="paramname"><span class="paramname"><em>mode</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_SetStepMode is used to change the step mode and therefore the resolution. It is required to execute a new reference run because the position value of the lib does not match the stepping mode anymore. The library must not be in stRESET to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param mode is required and is one out of <a class="el" href="#a8cbcefa1aa04c85bacfbe16591593661">L6474x_StepMode_t</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa4589feae28120554b6bdc708ee4e2e4" name="aa4589feae28120554b6bdc708ee4e2e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4589feae28120554b6bdc708ee4e2e4">◆ </a></span>L6474_StepIncremental()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_StepIncremental </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>steps</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_StepIncremental is used to issue a movement with the given amount of steps. The library has to be in stENABLED state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before.</p>
|
|
<p>param steps is required. negative values lead to a counter clock wise movement, 0 does not lead to any movement but returns errcNONE in case no other issue is present. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac04e97cbc212711d7fc321abd0d3f5aa" name="ac04e97cbc212711d7fc321abd0d3f5aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac04e97cbc212711d7fc321abd0d3f5aa">◆ </a></span>L6474_StopMovement()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L6474_StopMovement </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a31a0c627342d952d0dddf3fbe0643cac">L6474_Handle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>func L6474_StopMovement is used to stop a pending movement in case it has been configured as async. If not, it always return errcNONE in case no other issue is present. The library has to be in stENABLED state to perform this operation.</p>
|
|
<p>The function returns errcNONE in case no error happens or any other error code from <a class="el" href="#a309c3dbe6f05306b1a0a8201979595a8">L6474x_ErrorCode_t</a> enum in case of an error.</p>
|
|
<p>param h is required and can not be null. the handle can be created by calling L6474_CreateInstance before. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</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_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="LibL6474_8h.html">LibL6474.h</a></li>
|
|
<li class="footer">Generated on Fri Oct 24 2025 14:30:57 for LibL6474-C-Library by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|