jepler/Adafruit_CircuitPython_AM2320
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
26 commits 2 branches 10 tags 137 KiB
Python 100%
Find a file
dherrada 5917bc33f6 Moved repository from Travis to GitHub Actions
2019-12-27 22:23:20 -05:00
.github/workflows Moved repository from Travis to GitHub Actions 2019-12-27 22:23:20 -05:00
docs add setup.py, add pypi to .travis.yml, misc. tweaks for pypi 2018-07-03 11:04:29 -06:00
examples make I2C init more standard, move try/except into the wakeup location 2018-10-01 22:32:25 -04:00
.gitignore Moved repository from Travis to GitHub Actions 2019-12-27 22:23:20 -05:00
.pylintrc ignore the board module imports in .pylintrc 2018-08-25 14:01:47 +00:00
.readthedocs.yml Initial commit 2018-03-06 22:49:31 -05:00
adafruit_am2320.py add init retries 2018-10-01 22:40:21 -04:00
CODE_OF_CONDUCT.md Initial commit 2018-03-06 22:49:31 -05:00
LICENSE Initial commit 2018-03-06 22:49:31 -05:00
README.rst Moved repository from Travis to GitHub Actions 2019-12-27 22:23:20 -05:00
requirements.txt add setup.py, add pypi to .travis.yml, misc. tweaks for pypi 2018-07-03 11:04:29 -06:00
setup.py add setup.py, add pypi to .travis.yml, misc. tweaks for pypi 2018-07-03 11:04:29 -06:00

README.rst 

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-am2320/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/am2320/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_AM2320/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_AM2320/actions/
    :alt: Build Status

This is a CircuitPython driver for the AM2320 temperature and humidity sensor.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
<<<<<<< HEAD
--------------------
=======
====================

>>>>>>> 433e05190968d94b84de07a2b057e3898ec67dd1
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-am2320/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-am2320

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-am2320

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-am2320

Usage Example
=============

See ``am2320_simpletest.py`` in the examples folder.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/adafruit_CircuitPython_am2320/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.