Files
MicrochipFor32/Doc/xml/classbsp___m_a_x6675.xml
XerolySkinner 08f9f63eb3 内容大更新
更加规范化
加入modbus类
优化帮助文档
2022-11-22 03:43:24 +08:00

158 lines
8.9 KiB
XML

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.5" xml:lang="zh">
<compounddef id="classbsp___m_a_x6675" kind="class" language="C++" prot="public">
<compoundname>bsp_MAX6675</compoundname>
<includes refid="bsp___m_a_x6675_8h" local="no">bsp_MAX6675.h</includes>
<sectiondef kind="protected-attrib">
<memberdef kind="variable" id="classbsp___m_a_x6675_1a6b4e52e8861a88b7201c1bb5e70aa40a" prot="protected" static="no" mutable="no">
<type>SPI_HandleTypeDef *</type>
<definition>SPI_HandleTypeDef* bsp_MAX6675::hspi</definition>
<argsstring></argsstring>
<name>hspi</name>
<qualifiedname>bsp_MAX6675::hspi</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" line="57" column="19" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" bodystart="57" bodyend="-1"/>
<referencedby refid="classbsp___m_a_x6675_1ae241abb7c21d7bf551543046a92e6025" compoundref="bsp___m_a_x6675_8cpp" startline="49" endline="55">bsp_MAX6675</referencedby>
<referencedby refid="classbsp___m_a_x6675_1aaf35defa67c560c795005ba8ee61324c" compoundref="bsp___m_a_x6675_8cpp" startline="64" endline="70">ReadTemperature</referencedby>
</memberdef>
<memberdef kind="variable" id="classbsp___m_a_x6675_1a546cf5ce462d8bee441b66ca7e6c270a" prot="protected" static="no" mutable="no">
<type>GPIO_TypeDef *</type>
<definition>GPIO_TypeDef* bsp_MAX6675::GPIOx_CS</definition>
<argsstring></argsstring>
<name>GPIOx_CS</name>
<qualifiedname>bsp_MAX6675::GPIOx_CS</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" line="58" column="14" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" bodystart="58" bodyend="-1"/>
<referencedby refid="classbsp___m_a_x6675_1ae241abb7c21d7bf551543046a92e6025" compoundref="bsp___m_a_x6675_8cpp" startline="49" endline="55">bsp_MAX6675</referencedby>
<referencedby refid="classbsp___m_a_x6675_1aaf35defa67c560c795005ba8ee61324c" compoundref="bsp___m_a_x6675_8cpp" startline="64" endline="70">ReadTemperature</referencedby>
</memberdef>
<memberdef kind="variable" id="classbsp___m_a_x6675_1a925d408718c644d56e5ffebd25150c4f" prot="protected" static="no" mutable="no">
<type>uint16_t</type>
<definition>uint16_t bsp_MAX6675::GPIO_Pin_CS</definition>
<argsstring></argsstring>
<name>GPIO_Pin_CS</name>
<qualifiedname>bsp_MAX6675::GPIO_Pin_CS</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" line="59" column="10" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" bodystart="59" bodyend="-1"/>
<referencedby refid="classbsp___m_a_x6675_1ae241abb7c21d7bf551543046a92e6025" compoundref="bsp___m_a_x6675_8cpp" startline="49" endline="55">bsp_MAX6675</referencedby>
<referencedby refid="classbsp___m_a_x6675_1aaf35defa67c560c795005ba8ee61324c" compoundref="bsp___m_a_x6675_8cpp" startline="64" endline="70">ReadTemperature</referencedby>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classbsp___m_a_x6675_1ae241abb7c21d7bf551543046a92e6025" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>bsp_MAX6675::bsp_MAX6675</definition>
<argsstring>(SPI_HandleTypeDef *hspi, GPIO_TypeDef *GPIOx_CS, uint16_t GPIO_Pin_CS)</argsstring>
<name>bsp_MAX6675</name>
<qualifiedname>bsp_MAX6675::bsp_MAX6675</qualifiedname>
<param>
<type>SPI_HandleTypeDef *</type>
<declname>hspi</declname>
</param>
<param>
<type>GPIO_TypeDef *</type>
<declname>GPIOx_CS</declname>
</param>
<param>
<type>uint16_t</type>
<declname>GPIO_Pin_CS</declname>
</param>
<briefdescription>
<para>构造一个MAX6675对象 </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>*hspi</parametername>
</parameternamelist>
<parameterdescription>
<para>设置的hspi,举例输入:&amp;hspi1 </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>*GPIOx_CS</parametername>
</parameternamelist>
<parameterdescription>
<para>设置的选通端口,举例输入:GPIOA </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>GPIO_Pin_CS</parametername>
</parameternamelist>
<parameterdescription>
<para>设置的选通针脚,举例输入:GPIO_PIN_0 </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>无返回 </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" line="51" column="1" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.cpp" bodystart="49" bodyend="55"/>
<references refid="classbsp___m_a_x6675_1a925d408718c644d56e5ffebd25150c4f" compoundref="bsp___m_a_x6675_8h" startline="59">GPIO_Pin_CS</references>
<references refid="classbsp___m_a_x6675_1a546cf5ce462d8bee441b66ca7e6c270a" compoundref="bsp___m_a_x6675_8h" startline="58">GPIOx_CS</references>
<references refid="classbsp___m_a_x6675_1a6b4e52e8861a88b7201c1bb5e70aa40a" compoundref="bsp___m_a_x6675_8h" startline="57">hspi</references>
</memberdef>
<memberdef kind="function" id="classbsp___m_a_x6675_1aaf35defa67c560c795005ba8ee61324c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>float</type>
<definition>float bsp_MAX6675::ReadTemperature</definition>
<argsstring>(void)</argsstring>
<name>ReadTemperature</name>
<qualifiedname>bsp_MAX6675::ReadTemperature</qualifiedname>
<param>
<type>void</type>
</param>
<briefdescription>
<para>访问目前温度 </para>
</briefdescription>
<detaileddescription>
<para><simplesect kind="return"><para>返回浮点类型温度 </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" line="55" column="7" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.cpp" bodystart="64" bodyend="70"/>
<references refid="classbsp___m_a_x6675_1a925d408718c644d56e5ffebd25150c4f" compoundref="bsp___m_a_x6675_8h" startline="59">GPIO_Pin_CS</references>
<references refid="classbsp___m_a_x6675_1a546cf5ce462d8bee441b66ca7e6c270a" compoundref="bsp___m_a_x6675_8h" startline="58">GPIOx_CS</references>
<references refid="classbsp___m_a_x6675_1a6b4e52e8861a88b7201c1bb5e70aa40a" compoundref="bsp___m_a_x6675_8h" startline="57">hspi</references>
</memberdef>
</sectiondef>
<briefdescription>
<para>MAX6675的一个对象类 </para>
</briefdescription>
<detaileddescription>
<para><simplesect kind="note"><para>硬件SPI需要设置如下 Date Size:16 Bits MSB First 分频速度合适即可 需要准备一个CS管脚以控制选通 </para>
</simplesect>
</para>
</detaileddescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" line="49" column="1" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_MAX6675.h" bodystart="49" bodyend="60"/>
<listofallmembers>
<member refid="classbsp___m_a_x6675_1ae241abb7c21d7bf551543046a92e6025" prot="public" virt="non-virtual"><scope>bsp_MAX6675</scope><name>bsp_MAX6675</name></member>
<member refid="classbsp___m_a_x6675_1a925d408718c644d56e5ffebd25150c4f" prot="protected" virt="non-virtual"><scope>bsp_MAX6675</scope><name>GPIO_Pin_CS</name></member>
<member refid="classbsp___m_a_x6675_1a546cf5ce462d8bee441b66ca7e6c270a" prot="protected" virt="non-virtual"><scope>bsp_MAX6675</scope><name>GPIOx_CS</name></member>
<member refid="classbsp___m_a_x6675_1a6b4e52e8861a88b7201c1bb5e70aa40a" prot="protected" virt="non-virtual"><scope>bsp_MAX6675</scope><name>hspi</name></member>
<member refid="classbsp___m_a_x6675_1aaf35defa67c560c795005ba8ee61324c" prot="public" virt="non-virtual"><scope>bsp_MAX6675</scope><name>ReadTemperature</name></member>
</listofallmembers>
</compounddef>
</doxygen>