Files
MicrochipFor32/Doc/docbook/classbsp___m_a_x6675.xml

149 lines
6.8 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_classbsp___m_a_x6675" xml:lang="zh">
<title>bsp_MAX6675类 参考</title>
<indexterm><primary>bsp_MAX6675</primary></indexterm>
<para>
<para>MAX6675的一个对象类 </para>
</para>
<para>
<computeroutput>#include &lt;bsp_MAX6675.h&gt;</computeroutput>
</para>
<simplesect>
<title>Public 成员函数 </title>
<itemizedlist>
<listitem><para><link linkend="_classbsp___m_a_x6675_1ae241abb7c21d7bf551543046a92e6025">bsp_MAX6675</link> (SPI_HandleTypeDef *<link linkend="_classbsp___m_a_x6675_1a6b4e52e8861a88b7201c1bb5e70aa40a">hspi</link>, GPIO_TypeDef *<link linkend="_classbsp___m_a_x6675_1a546cf5ce462d8bee441b66ca7e6c270a">GPIOx_CS</link>, uint16_t <link linkend="_classbsp___m_a_x6675_1a925d408718c644d56e5ffebd25150c4f">GPIO_Pin_CS</link>)</para>
<para>构造一个MAX6675对象 </para>
</listitem>
<listitem><para>float <link linkend="_classbsp___m_a_x6675_1aaf35defa67c560c795005ba8ee61324c">ReadTemperature</link> (void)</para>
<para>访问目前温度 </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Protected 属性 </title>
<itemizedlist>
<listitem><para>SPI_HandleTypeDef * <link linkend="_classbsp___m_a_x6675_1a6b4e52e8861a88b7201c1bb5e70aa40a">hspi</link></para>
</listitem>
<listitem><para>GPIO_TypeDef * <link linkend="_classbsp___m_a_x6675_1a546cf5ce462d8bee441b66ca7e6c270a">GPIOx_CS</link></para>
</listitem>
<listitem><para>uint16_t <link linkend="_classbsp___m_a_x6675_1a925d408718c644d56e5ffebd25150c4f">GPIO_Pin_CS</link></para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>详细描述</title>
<para>MAX6675的一个对象类 </para>
<para><note><title>注解</title>
<para>硬件SPI需要设置如下 Date Size:16 Bits MSB First 分频速度合适即可 需要准备一个CS管脚以控制选通 </para>
</note>
</para>
<para>
在文件 <link linkend="_bsp___m_a_x6675_8h_source">bsp_MAX6675.h</link><link linkend="_bsp___m_a_x6675_8h_source_1l00049">49</link> 行定义.</para>
</section>
<section>
<title>构造及析构函数说明</title>
<anchor xml:id="_classbsp___m_a_x6675_1ae241abb7c21d7bf551543046a92e6025"/><section>
<title>bsp_MAX6675()</title>
<indexterm><primary>bsp_MAX6675</primary><secondary>bsp_MAX6675</secondary></indexterm>
<indexterm><primary>bsp_MAX6675</primary><secondary>bsp_MAX6675</secondary></indexterm>
<para><computeroutput>bsp_MAX6675::bsp_MAX6675 (SPI_HandleTypeDef * hspi, GPIO_TypeDef * GPIOx_CS, uint16_t GPIO_Pin_CS)</computeroutput></para><para>
<para>构造一个MAX6675对象 </para>
</para>
<para>
<formalpara>
<title>
参数</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*hspi</entry><entry>
<para>设置的hspi,举例输入:&amp;hspi1 </para>
</entry>
</row>
<row>
<entry>*GPIOx_CS</entry><entry>
<para>设置的选通端口,举例输入:GPIOA </para>
</entry>
</row>
<row>
<entry>GPIO_Pin_CS</entry><entry>
<para>设置的选通针脚,举例输入:GPIO_PIN_0 </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>返回</title>
<para>无返回 </para>
</formalpara>
</para>
<para>
在文件 <link linkend="_bsp___m_a_x6675_8cpp_source">bsp_MAX6675.cpp</link><link linkend="_bsp___m_a_x6675_8cpp_source_1l00049">49</link> 行定义.</para>
</section>
</section>
<section>
<title>成员函数说明</title>
<anchor xml:id="_classbsp___m_a_x6675_1aaf35defa67c560c795005ba8ee61324c"/><section>
<title>ReadTemperature()</title>
<indexterm><primary>ReadTemperature</primary><secondary>bsp_MAX6675</secondary></indexterm>
<indexterm><primary>bsp_MAX6675</primary><secondary>ReadTemperature</secondary></indexterm>
<para><computeroutput>float bsp_MAX6675::ReadTemperature (void )</computeroutput></para><para>
<para>访问目前温度 </para>
</para>
<para><formalpara><title>返回</title>
<para>返回浮点类型温度 </para>
</formalpara>
</para>
<para>
在文件 <link linkend="_bsp___m_a_x6675_8cpp_source">bsp_MAX6675.cpp</link><link linkend="_bsp___m_a_x6675_8cpp_source_1l00064">64</link> 行定义.</para>
</section>
</section>
<section>
<title>类成员变量说明</title>
<anchor xml:id="_classbsp___m_a_x6675_1a925d408718c644d56e5ffebd25150c4f"/><section>
<title>GPIO_Pin_CS</title>
<indexterm><primary>GPIO_Pin_CS</primary><secondary>bsp_MAX6675</secondary></indexterm>
<indexterm><primary>bsp_MAX6675</primary><secondary>GPIO_Pin_CS</secondary></indexterm>
<para><computeroutput>uint16_t bsp_MAX6675::GPIO_Pin_CS<computeroutput>[protected]</computeroutput></computeroutput></para><para>
在文件 <link linkend="_bsp___m_a_x6675_8h_source">bsp_MAX6675.h</link><link linkend="_bsp___m_a_x6675_8h_source_1l00059">59</link> 行定义.</para>
</section>
<anchor xml:id="_classbsp___m_a_x6675_1a546cf5ce462d8bee441b66ca7e6c270a"/><section>
<title>GPIOx_CS</title>
<indexterm><primary>GPIOx_CS</primary><secondary>bsp_MAX6675</secondary></indexterm>
<indexterm><primary>bsp_MAX6675</primary><secondary>GPIOx_CS</secondary></indexterm>
<para><computeroutput>GPIO_TypeDef* bsp_MAX6675::GPIOx_CS<computeroutput>[protected]</computeroutput></computeroutput></para><para>
在文件 <link linkend="_bsp___m_a_x6675_8h_source">bsp_MAX6675.h</link><link linkend="_bsp___m_a_x6675_8h_source_1l00058">58</link> 行定义.</para>
</section>
<anchor xml:id="_classbsp___m_a_x6675_1a6b4e52e8861a88b7201c1bb5e70aa40a"/><section>
<title>hspi</title>
<indexterm><primary>hspi</primary><secondary>bsp_MAX6675</secondary></indexterm>
<indexterm><primary>bsp_MAX6675</primary><secondary>hspi</secondary></indexterm>
<para><computeroutput>SPI_HandleTypeDef* bsp_MAX6675::hspi<computeroutput>[protected]</computeroutput></computeroutput></para><para>
在文件 <link linkend="_bsp___m_a_x6675_8h_source">bsp_MAX6675.h</link><link linkend="_bsp___m_a_x6675_8h_source_1l00057">57</link> 行定义.</para>
</section>
<para>
该类的文档由以下文件生成:</para>
D:/gitt/MicrochipFor32/bsp_Device/<link linkend="_bsp___m_a_x6675_8h">bsp_MAX6675.h</link>D:/gitt/MicrochipFor32/bsp_Device/<link linkend="_bsp___m_a_x6675_8cpp">bsp_MAX6675.cpp</link></section>
</section>