diff --git a/README.rst b/README.rst index 0caa2d5..30fb59c 100644 --- a/README.rst +++ b/README.rst @@ -60,15 +60,13 @@ To install in a virtual environment in your current project: Usage Example ============= -.. code-block:: python +.. code-block:: python3 import time import board - import busio from adafruit_lsm6ds.lsm6dsox import LSM6DSOX - i2c = busio.I2C(board.SCL, board.SDA) - + i2c = board.I2C() # uses board.SCL and board.SDA sox = LSM6DSOX(i2c) while True: diff --git a/adafruit_lsm6ds/__init__.py b/adafruit_lsm6ds/__init__.py index 4efe687..cfd2c27 100644 --- a/adafruit_lsm6ds/__init__.py +++ b/adafruit_lsm6ds/__init__.py @@ -36,30 +36,40 @@ **Hardware:** -* Adafruit LSM6DSOX Breakout +* Adafruit `LSM6DSOX 6 DoF Accelerometer and Gyroscope + `_ -* Adafruit ISM330DHCX Breakout +* Adafruit `ISM330DHCX - 6 DoF IMU - Accelerometer and Gyroscope + `_ -* Adafruit LSM6DSO32 Breakout +* Adafruit `LSM6DSO32 6-DoF Accelerometer and Gyroscope + `_ -* Adafruit LSM6DS33 Breakout +* Adafruit `LSM6DS33 6-DoF Accel + Gyro IMU + `_ -* Adafruit ISM330DHCX + LIS3MDL FEATHERWING +* Adafruit `ISM330DHCX + LIS3MDL FeatherWing - High Precision 9-DoF IMU + `_ -* Adafruit LSM6DSOX + LIS3MDL - 9 DOF IMU Breakout +* Adafruit `LSM6DSOX + LIS3MDL - Precision 9 DoF IMU + `_ -* Adafruit LSM6DS33 + LIS3MDL - 9 DOF IMU Breakout +* Adafruit `LSM6DS33 + LIS3MDL - 9 DoF IMU with Accel / Gyro / Mag + `_ + +* Adafruit `LSM6DSOX + LIS3MDL FeatherWing - Precision 9-DoF IMU + `_ -* Adafruit LSM6DSOX + LIS3MDL 9 DOF IMU FeatherWing **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases - + https://circuitpython.org/downloads +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +* Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register -* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice -* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register """ __version__ = "0.0.0-auto.0" @@ -92,7 +102,7 @@ def add_values(cls, value_tuples): @classmethod def is_valid(cls, value): - "Returns true if the given value is a member of the CV" + """Returns true if the given value is a member of the CV""" return value in cls.string @@ -164,7 +174,8 @@ class LSM6DS: # pylint: disable=too-many-instance-attributes """Driver for the LSM6DSOX 6-axis accelerometer and gyroscope. :param ~busio.I2C i2c_bus: The I2C bus the LSM6DSOX is connected to. - :param address: The I2C address of the sensor + :param int address: TThe I2C device address. Defaults to :const:`0x6A` + """ # ROUnaryStructs: @@ -173,8 +184,6 @@ class LSM6DS: # pylint: disable=too-many-instance-attributes # Structs _raw_accel_data = Struct(_LSM6DS_OUTX_L_A, "