adafruit-mirror/Adafruit_CircuitPython_QMC5883P
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

clean up comments

Browse source
This commit is contained in:
Liz 2025-08-08 13:46:33 -04:00
parent d1fcc8aabd
commit 663419a7e0
3 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.rst
View file

@ -105,7 +105,7 @@ Usage Example
while True:
mag_x, mag_y, mag_z = sensor.magnetic
print(f"X:{mag_x:10.2f}, Y:{mag_y:10.2f}, Z:{mag_z:10.2f} uT")
print(f"X:{mag_x:2.3f}, Y:{mag_y:2.3f}, Z:{mag_z:2.3f} G")
print("")
time.sleep(1)

6
adafruit_qmc5883p.py
View file

@ -100,7 +100,11 @@ _LSB_PER_GAUSS = {RANGE_30G: 1000.0, RANGE_12G: 2500.0, RANGE_8G: 3750.0, RANGE_
class QMC5883P:
"""Driver for the QMC5883P 3-axis magnetometer."""
"""Driver for the QMC5883P 3-axis magnetometer.
:param ~busio.I2C i2c_bus: The I2C bus the QMC5883P is connected to.
:param int address: The I2C address of the device. Defaults to :const:`0x3C`
"""
# Register definitions using adafruit_register
_chip_id = ROUnaryStruct(_CHIPID, "<B")

8
examples/qmc5883p_simpletest.py
View file

@ -10,12 +10,14 @@ import board
import adafruit_qmc5883p
i2c = board.I2C() # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller
i2c = board.I2C()
# i2c = board.STEMMA_I2C()
sensor = adafruit_qmc5883p.QMC5883P(i2c)
# Optional: Configure sensor settings
# configure sensor settings
# defaults to MODE_NORMAL, ODR_50HZ, RANGE_8G
# sensor.mode = adafruit_qmc5883p.MODE_CONTINUOUS
# sensor.data_rate = adafruit_qmc5883p.ODR_10HZ
# sensor.range = adafruit_qmc5883p.RANGE_2G