Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max1704x/badge/?version=latest
:target: https://docs.circuitpython.org/projects/max1704x/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
MAX17048 or MAX17049 battery fuel gauge library
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
This library is intended to work with the MAX17048 or MAX17049 battery fuel gauge
Python/CircuitPython library.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5580>`_
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-max1704x/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-max1704x
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-max1704x
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-max1704x
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_max1704x
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See usage examples of this library in the ``examples/`` folder.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/max1704x/en/latest/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-max1704x",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, max1704x, max17048, max17049, battery, lipoly, lipo, fuel, gauge, monitor",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/8a/2c/383251417fa18064fc1646beafcda9e22d46f129a36308f63230b525afa0/adafruit_circuitpython_max1704x-1.0.11.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max1704x/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/max1704x/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nMAX17048 or MAX17049 battery fuel gauge library\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nThis library is intended to work with the MAX17048 or MAX17049 battery fuel gauge\nPython/CircuitPython library.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5580>`_\n\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-max1704x/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-max1704x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-max1704x\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-max1704x\n\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_max1704x\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee usage examples of this library in the ``examples/`` folder.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/max1704x/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MAX17048 or MAX17049 battery fuel gauge Python/CircuitPython library",
"version": "1.0.11",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" max1704x",
" max17048",
" max17049",
" battery",
" lipoly",
" lipo",
" fuel",
" gauge",
" monitor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2aa932dfbede92db412d522606a3dc9080860d0605671deffffdb7d89473623",
"md5": "6f96cc5f6f93d76e87089a97327f5dca",
"sha256": "c53d9e6a7be3c3ea2e5116036ff52cfa770051fc9e8e1adeb0100a5ccf56a6e8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_max1704x-1.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f96cc5f6f93d76e87089a97327f5dca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6296,
"upload_time": "2024-10-07T22:07:02",
"upload_time_iso_8601": "2024-10-07T22:07:02.474235Z",
"url": "https://files.pythonhosted.org/packages/a2/aa/932dfbede92db412d522606a3dc9080860d0605671deffffdb7d89473623/adafruit_circuitpython_max1704x-1.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a2c383251417fa18064fc1646beafcda9e22d46f129a36308f63230b525afa0",
"md5": "ed17b453e844ad3dba6161743f998ea1",
"sha256": "7568414b92ef9c9b78edb32947a36756914bdc687367998318356a28df6f6dbc"
},
"downloads": -1,
"filename": "adafruit_circuitpython_max1704x-1.0.11.tar.gz",
"has_sig": false,
"md5_digest": "ed17b453e844ad3dba6161743f998ea1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28440,
"upload_time": "2024-10-07T22:07:03",
"upload_time_iso_8601": "2024-10-07T22:07:03.737900Z",
"url": "https://files.pythonhosted.org/packages/8a/2c/383251417fa18064fc1646beafcda9e22d46f129a36308f63230b525afa0/adafruit_circuitpython_max1704x-1.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:07:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MAX1704x",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-max1704x"
}
JSON
