batsoc

Name	batsoc JSON
Version	0.9.3 JSON
	download
home_page
Summary	Library for estimating state of charge from battery cell voltage
upload_time	2023-09-27 20:17:49
maintainer
docs_url	None
author
requires_python	>=3.7
license	MIT
keywords	data mapping
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # batsoc - State of Charge (Battery)

Got a cell voltage and would like to know how much charge is left? 
batsoc to the rescue!

## Installation

```bash
pip install batsoc
```

## Accuracy
Measuring state of charge based on voltage alone is not terribly
accurate. The measured voltage depends on multiple factors besides
the state of charge: temperature and load affect matters as well. 


## Usage

```python
from batsoc import soc, BatteryType
soc(BatteryType.ALKALINE, 1.3)
```

will output 0.633 indicating 63.3% state of charge.

## Supported batteries
### ALKALINE
Any generic 1.5V alkaline battery under low load. 
The curve is defined for 0.8 - 1.6 volts.

### LI_ION
Any generic lithium-ion battery with a nominal voltage of 3.7 or 3.8. 
The curve is defined for 3.0 - 4.2 volts.

### CR2032
A 3V lithium coin cell battery under very low load.
The curve is defined for 2.0 - 3.0 volts. 


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "batsoc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "data,mapping",
    "author": "",
    "author_email": "Matti Eiden <snaipperi@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/fa/00/c5a9e48da35d882f3c504c462bd95e16e7dfac64d724dbed4e5377369bcf/batsoc-0.9.3.tar.gz",
    "platform": null,
    "description": "# batsoc - State of Charge (Battery)\n\nGot a cell voltage and would like to know how much charge is left? \nbatsoc to the rescue!\n\n## Installation\n\n```bash\npip install batsoc\n```\n\n## Accuracy\nMeasuring state of charge based on voltage alone is not terribly\naccurate. The measured voltage depends on multiple factors besides\nthe state of charge: temperature and load affect matters as well. \n\n\n## Usage\n\n```python\nfrom batsoc import soc, BatteryType\nsoc(BatteryType.ALKALINE, 1.3)\n```\n\nwill output 0.633 indicating 63.3% state of charge.\n\n## Supported batteries\n### ALKALINE\nAny generic 1.5V alkaline battery under low load. \nThe curve is defined for 0.8 - 1.6 volts.\n\n### LI_ION\nAny generic lithium-ion battery with a nominal voltage of 3.7 or 3.8. \nThe curve is defined for 3.0 - 4.2 volts.\n\n### CR2032\nA 3V lithium coin cell battery under very low load.\nThe curve is defined for 2.0 - 3.0 volts. \n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Library for estimating state of charge from battery cell voltage",
    "version": "0.9.3",
    "project_urls": null,
    "split_keywords": [
        "data",
        "mapping"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "888da46be871a7e4877abd7bf68cf44aa923e6b63ba05891bcfa12e085a97681",
                "md5": "1eaba460ad485df81ab8c5b9d92896a2",
                "sha256": "f7ab6a2b749a52e4fe6d7ad884b3da7cf825c01bd0c876053eb2517753816cc7"
            },
            "downloads": -1,
            "filename": "batsoc-0.9.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1eaba460ad485df81ab8c5b9d92896a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 5467,
            "upload_time": "2023-09-27T20:17:48",
            "upload_time_iso_8601": "2023-09-27T20:17:48.183477Z",
            "url": "https://files.pythonhosted.org/packages/88/8d/a46be871a7e4877abd7bf68cf44aa923e6b63ba05891bcfa12e085a97681/batsoc-0.9.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa00c5a9e48da35d882f3c504c462bd95e16e7dfac64d724dbed4e5377369bcf",
                "md5": "c7f244cdedaa66084acd69321273e4f5",
                "sha256": "b6a210165654843d6278afe44da3d6ee58edc1773fa4968beffa6c8e665ab484"
            },
            "downloads": -1,
            "filename": "batsoc-0.9.3.tar.gz",
            "has_sig": false,
            "md5_digest": "c7f244cdedaa66084acd69321273e4f5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 6244,
            "upload_time": "2023-09-27T20:17:49",
            "upload_time_iso_8601": "2023-09-27T20:17:49.194469Z",
            "url": "https://files.pythonhosted.org/packages/fa/00/c5a9e48da35d882f3c504c462bd95e16e7dfac64d724dbed4e5377369bcf/batsoc-0.9.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-27 20:17:49",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "batsoc"
}