diff --git a/README.rst b/README.rst index 2480daf..d43b7de 100644 --- a/README.rst +++ b/README.rst @@ -27,10 +27,49 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. +Installing from PyPI +===================== +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-fxos8700 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-fxos8700 + +To install in a virtual environment in your current project: + +.. code-block:: shell + + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-fxos8700 + Usage Example ============= -See examples/simpletest.py for a demo of the usage. +.. code-block:: python + + import time + import board + import busio + import adafruit_fxos8700 + + i2c = busio.I2C(board.SCL, board.SDA) + sensor = adafruit_fxos8700.FXOS8700(i2c) + + while True: + accel_x, accel_y, accel_z = sensor.accelerometer + mag_x, mag_y, mag_z = sensor.magnetometer + print('Acceleration (m/s^2): ({0:0.3f}, {1:0.3f}, {2:0.3f})'.format(accel_x, accel_y, accel_z)) + print('Magnetometer (uTesla): ({0:0.3f}, {1:0.3f}, {2:0.3f})'.format(mag_x, mag_y, mag_z)) + time.sleep(1.0) Contributing ============ @@ -84,4 +123,4 @@ Now, once you have the virtual environment activated: This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to -locally verify it will pass \ No newline at end of file +locally verify it will pass diff --git a/adafruit_fxos8700.py b/adafruit_fxos8700.py index 413158c..d67b16c 100644 --- a/adafruit_fxos8700.py +++ b/adafruit_fxos8700.py @@ -53,6 +53,9 @@ import adafruit_bus_device.i2c_device as i2c_dev from micropython import const +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700.git" + # Register addresses and other constants: # pylint: disable=bad-whitespace _FXOS8700_ADDRESS = const(0x1F) # 0011111