diff --git a/README.rst b/README.rst index bdaa12f..e7c6b9a 100644 --- a/README.rst +++ b/README.rst @@ -21,6 +21,37 @@ Introduction MicroPython Driver for the QMC5883L Accelerometer +Installing with mip +==================== + +To install using mpremote + +.. code-block:: shell + + mpremote mip install github:jposada202020/MicroPython_QMC5883L" + +To install directly using a WIFI capable board + +.. code-block:: shell + + mip install github:jposada202020/MicroPython_QMC5883L" + + +Installing Library Examples +============================ + +If you want to install library examples: + +.. code-block:: shell + + mpremote mip install github:jposada202020/MicroPython_QMC5883L/examples.json" + +To install directly using a WIFI capable board + +.. code-block:: shell + + mip install github:jposada202020/MicroPython_QMC5883L/examples.json" + Installing from PyPI diff --git a/examples.json b/examples.json new file mode 100644 index 0000000..7ca863a --- /dev/null +++ b/examples.json @@ -0,0 +1,11 @@ +{ + "urls": [ + ["micropython_qmc5883l/examples/qmc5883l_advanced_settings.py", "github:jposada202020/MicroPython_QMC5883L/examples/qmc5883l_advanced_settings.py"], + ["micropython_qmc5883l/examples/qmc5883l_magnetic_compass.py", "github:jposada202020/MicroPython_QMC5883L/examples/qmc5883l_magnetic_compass.py"], + ["micropython_qmc5883l/examples/qmc5883l_data_rate.py", "github:jposada202020/MicroPython_QMC5883L/examples/qmc5883l_data_rate.py"], + ["micropython_qmc5883l/examples/qmc5883l_oversample.py", "github:jposada202020/MicroPython_QMC5883L/examples/qmc5883l_oversample.py"], + ["micropython_qmc5883l/examples/qmc5883l_field_range.py", "github:jposada202020/MicroPython_QMC5883L/examples/qmc5883l_field_range.py"], + ["micropython_qmc5883l/examples/qmc5883l_simpletest.py", "github:jposada202020/MicroPython_QMC5883L/examples/qmc5883l_simpletest.py"] + ], + "version": "0.1" +} diff --git a/packages.json b/packages.json new file mode 100644 index 0000000..1132760 --- /dev/null +++ b/packages.json @@ -0,0 +1,8 @@ +{ + "urls": [ + ["micropython_qmc5883l/qmc5883l.py", "github:jposada202020/MicroPython_QMC5883L/micropython_qmc5883l/qmc5883l.py"], + ["micropython_qmc5883l/i2c_helpers.py", "github:jposada202020/MicroPython_QMC5883L/micropython_qmc5883l/i2c_helpers.py"], + ["micropython_qmc5883l/__init__.py", "github:jposada202020/MicroPython_QMC5883L/micropython_qmc5883l/__init__.py"] + ], + "version": "0.1" +}