Skip to content

Latest commit

 

History

History
164 lines (105 loc) · 5.1 KB

README_zh-Hant.md

File metadata and controls

164 lines (105 loc) · 5.1 KB
Raw

English | 简体中文 | 繁體中文 | 日本語 | Deutsch | 한국어

LibDriver HMC5883L

MISRA API License

霍尼韋爾HMC5883L是一種設計用於低磁場感應的表面貼裝晶片模塊。 它帶有數位介面，用於低成本羅盤和磁力計等應用。 HMC5883L使用了最先進的高解析度HMC118X系列磁阻感測器，該感測器包含放大、自動消磁、偏移消除，支持1°到2°羅盤航向精度12比特ADC等特性。 HMC5883L是一種3.0x3.0x0.9mm表面封裝16針無鉛晶片載體（LCC）。 HMC5883L的應用包括行动电话、上網本、消費電子產品、自動導航系統和個人導航設備。

LibDriver HMC5883L是LibDriver推出的HMC5883L的全功能驅動，該驅動提供連續模式磁場強度讀取、單次模式磁場讀取等功能並且它符合MISRA標準。

目錄

說明

/src目錄包含了LibDriver HMC5883L的源文件。

/interface目錄包含了LibDriver HMC5883L與平台無關的IIC總線模板。

/test目錄包含了LibDriver HMC5883L驅動測試程序，該程序可以簡單的測試芯片必要功能。

/example目錄包含了LibDriver HMC5883L編程範例。

/doc目錄包含了LibDriver HMC5883L離線文檔。

/datasheet目錄包含了HMC5883L數據手冊。

/project目錄包含了常用Linux與單片機開發板的工程樣例。所有工程均採用shell腳本作為調試方法，詳細內容可參考每個工程裡面的README.md。

/misra目錄包含了LibDriver MISRA程式碼掃描結果。

安裝

參考/interface目錄下與平台無關的IIC總線模板，完成指定平台的IIC總線驅動。

將/src目錄，您使用平臺的介面驅動和您開發的驅動加入工程，如果您想要使用默認的範例驅動，可以將/example目錄加入您的工程。

使用

您可以參考/example目錄下的程式設計範例完成適合您的驅動，如果您想要使用默認的程式設計範例，以下是它們的使用方法。

example basic

#include "driver_hmc5883l_basic.h"

uint8_t res;
uint8_t i;
float m_gauss[3];

res = hmc5883l_basic_init();
if (res != 0)
{
    return 1;
}

...


for (i = 0; i < 3; i++)
{
    hmc5883l_interface_delay_ms(1000);
    res = hmc5883l_basic_read((float *)m_gauss);
    if (res != 0)
    {
        (void)hmc5883l_basic_deinit();

        return 1;
    }
    hmc5883l_interface_debug_print("hmc5883l: x is %0.3f.\n", m_gauss[0]);
    hmc5883l_interface_debug_print("hmc5883l: y is %0.3f.\n", m_gauss[1]);
    hmc5883l_interface_debug_print("hmc5883l: z is %0.3f.\n", m_gauss[2]);
    
    ...
    
}

...

(void)hmc5883l_basic_deinit();

return 0;

example shot

#include "driver_hmc5883l_shot.h"

uint8_t res;
uint8_t i;
float m_gauss[3];

res = hmc5883l_shot_init();
if (res != 0)
{
    return 1;
}

...

for (i = 0; i < 3; i++)
{
    hmc5883l_interface_delay_ms(1000);
    res = hmc5883l_shot_read((float *)m_gauss);
    if (res != 0)
    {
        (void)hmc5883l_shot_deinit();

        return 1;
    }
    hmc5883l_interface_debug_print("hmc5883l: x is %0.3f.\n", m_gauss[0]);
    hmc5883l_interface_debug_print("hmc5883l: y is %0.3f.\n", m_gauss[1]);
    hmc5883l_interface_debug_print("hmc5883l: z is %0.3f.\n", m_gauss[2]);
    
    ...
    
}

...

(void)hmc5883l_shot_deinit();

return 0;

文檔

在線文檔: https://www.libdriver.com/docs/hmc5883l/index.html。

離線文檔: /doc/html/index.html。

貢獻

請參攷CONTRIBUTING.md。

版權

版權 (c) 2015 - 現在 LibDriver 版權所有

MIT 許可證（MIT）

特此免費授予任何獲得本軟件副本和相關文檔文件（下稱“軟件”）的人不受限制地處置該軟件的權利，包括不受限制地使用、複製、修改、合併、發布、分發、轉授許可和/或出售該軟件副本，以及再授權被配發了本軟件的人如上的權利，須在下列條件下：

上述版權聲明和本許可聲明應包含在該軟件的所有副本或實質成分中。

本軟件是“如此”提供的，沒有任何形式的明示或暗示的保證，包括但不限於對適銷性、特定用途的適用性和不侵權的保證。在任何情況下，作者或版權持有人都不對任何索賠、損害或其他責任負責，無論這些追責來自合同、侵權或其它行為中，還是產生於、源於或有關於本軟件以及本軟件的使用或其它處置。

聯繫我們

請聯繫[email protected]。