STM32_General/Doc/html/index.html
2025-11-07 20:43:07 +03:00

145 lines
7.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>STM32_General: Инструкция по подключению релиза библиотеки STM32_General</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="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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">STM32_General<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Библиотеки для периферии STM32</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</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">
$(function(){initNavTree('index.html','',''); });
</script>
<div id="container">
<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><div class="header">
<div class="headertitle"><div class="title">Инструкция по подключению релиза библиотеки <span class="tt">STM32_General</span> </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md__e_1_2_8_w_o_r_k_2_s_t_m32_2_s_t_m___libs_2_s_t_m32___general_2_r_e_a_d_m_e"></a></p>
<p>STM32_General - это набор библиотек для удобной работы с периферией STM32. Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы МК, в частности STM32 и SEGGER RTT.</p>
<h1 class="doxsection"><a class="anchor" id="структура-библиотеки"></a>
Структура библиотеки</h1>
<p>*Note: STM32_General требует наличия библиотеки (MyLibs)[<a href="https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs">https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs</a>] для работы*** </p><div class="fragment"><div class="line">ProjectRoot/</div>
<div class="line">└── STM32_General # Работа с периферией STM32</div>
<div class="line"> ├── inc/</div>
<div class="line"> │ ├── general_gpio.h # Работа с GPIO</div>
<div class="line"> │ ├── general_spi.h # Работа с SPI</div>
<div class="line"> │ ├── general_tim.h # Работа с таймерами</div>
<div class="line"> │ └── general_uart.h # Работа с UART</div>
<div class="line"> └── src/</div>
<div class="line"> ├── general_gpio.c # Реализация GPIO</div>
<div class="line"> ├── general_spi.c # Реализация SPI</div>
<div class="line"> ├── general_tim.c # Реализация TIM</div>
<div class="line"> └── general_uart.c # Реализация UART</div>
</div><!-- fragment --><h1 class="doxsection"><a class="anchor" id="инструкция-по-подключению"></a>
Инструкция по подключению</h1>
<ol type="1">
<li><b>Склонируйте субмодуль</b> в ваш проект:</li>
</ol>
<div class="fragment"><div class="line">git submodule add https://git.arktika.cyou/Razvalyaev/STM32_General path/to/STM32_General</div>
<div class="line">git submodule update --init --recursive</div>
</div><!-- fragment --><ol type="1">
<li>В <span class="tt">mylibs_config.h</span> <b>настройте конфигурации</b> (<a class="el" href="group___g_e_n_e_r_a_l___c_o_n_f_i_g_s.html">General Configs</a>):</li>
<li><b>Обновление библиотеки</b>:</li>
</ol>
<p>После обновления субмодуля из Git, исходные файлы библиотеки будут обновлены, но ваши конфиги останутся в целевой папке и не перезапишутся:</p>
<div class="fragment"><div class="line">git submodule update --remote</div>
</div><!-- fragment --> </div></div><!-- PageDoc -->
<a href="doxygen_crawl.html"></a>
</div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>