alex/GY-63_MS5611
1
0
Fork 0
mirror of https://github.com/RobTillaart/Arduino.git synced 2024-10-03 18:09:02 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
60c9575c7a
GY-63_MS5611/libraries/hmc6352
History
Rob Tillaart 7692ae8cb8 0.4.0 HMC6352
2023-12-05 20:31:39 +01:00
..
.github 0.3.2 HMC6352 + github actions 2023-02-11 13:21:01 +01:00
examples 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00
test 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00
.arduino-ci.yml 0.3.2 hmc6352 2022-11-09 14:34:02 +01:00
CHANGELOG.md 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00
hmc6352.cpp 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00
hmc6352.h 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00
keywords.txt 0.3.1 HMC6352 2021-12-19 13:57:35 +01:00
library.json 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00
library.properties 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00
LICENSE 0.3.2 HMC6352 + github actions 2023-02-11 13:21:01 +01:00
README.md 0.4.0 HMC6352 2023-12-05 20:31:39 +01:00

README.md

Arduino CI Arduino-lint JSON check GitHub issues

License: MIT GitHub release PlatformIO Registry

HMC6352

Arduino library for HMC6352 compass sensor

Description

BETA: WARNING: BETA: WARNING: BETA: WARNING: BETA:

This library is BETA, only tested partially and not thoroughly No guarantees, use at own risk, all disclaimers apply The example sketch can be used to configuration the compass. For switching operational mode one must reboot the device.

WARNING: BETA: WARNING: BETA: WARNING: BETA: WARNING:

0.4.0 Breaking change

Version 0.4.0 introduced a breaking change. You cannot set the pins in begin() any more. This reduces the dependency of processor dependent Wire implementations. The user has to call Wire.begin() and can optionally set the Wire pins before calling begin().

Related

Interface

#include "hmc6352.h"

Constructor

  • hmc6352(uint8_t address, TwoWire *wire = &Wire) set the I2C address and optional the Wire interface.
  • bool begin() initializes library. Returns true if address can be seen on the I2C bus.
  • bool isConnected() Returns true if address can be seen on the I2C bus. Can be used as first order diagnostics.

Base calls standby mode

  • int getHeading() is a combination of askHeading() and readHeading()
  • int askHeading() requests a new read of the heading (compass direction).
  • int readHeading() reads the new value from the device.
  • int wakeUp() if the device is in sleep mode, wake it up.
  • int sleep() puts the device in sleep mode.

Expert calls

Warning: use with care: read the datasheet for the details

  • int factoryReset() idem
  • int setOperationalModus(hmcMode mode, uint8_t frequency, bool periodicReset)
  • int getOperationalModus()
  • int setOutputModus(uint8_t outputModus)
  • int getOutputModus()
  • int callibrationOn()
  • int callibrationOff()
  • int setI2CAddress(uint8_t address) writes the I2C address in EEPROM to use after the next reboot.
  • int getI2CAddress() reads the I2C address stored in EEPROM.

Helper functions

Warning: use with care: read the datasheet for the details

  • int writeEEPROM(uint8_t address, uint8_t data) EEPROM IO function
  • int readEEPROM(uint8_t address) EEPROM IO function
  • int writeRAM(uint8_t address, uint8_t data) RAM IO function
  • int readRAM(uint8_t address) RAM IO function
  • int saveOpMode(byte OpMode) allow power users to set operational mode flags

NOT TESTED

Warning: use with care: read the datasheet for the details

  • int setTimeDelay(uint8_t milliSeconds)
  • int getTimeDelay()
  • int setMeasurementSumming(uint8_t NrOfMeasurements) 1..16
  • int getMeasurementSumming() returns 1..16
  • int updateOffsets(void)

Operation

See examples

Future

Must

  • update documentation

Should

  • testing AVR
  • testing ESP32
  • test examples => more specific?

Could

Wont

Support

If you appreciate my libraries, you can support the development and maintenance. Improve the quality of the libraries by providing issues and Pull Requests, or donate through PayPal or GitHub sponsors.

Thank you,