# Pycalima
Simple python interface against the Pax Calima® bathroom fan created and sold by Pax®
This module provides a very simple interface against the various GATT characteristics of the Calima fan, most importantly it handles the authentication so values are actually persisted within the fan.
Uses Bleak
## Installation
Install calima
$sudo python3 -m pip install calima
## Demo usage
.. code:: python
from Calima import Calima
fan = Calima("MA:CC:AD:DR:ES:SS", "012345")
print(fan.getAlias())
## Find MAC address
$sudo python3 cmdline.py -l
## Home Assistant integration
Please visit '<https://github.com/timutta/homeassistant-paxcalima>'_.
## Command Line Tool
Pretty useful command line tool which among other things can print all
the characteristics of a fan. It can also search for available fans
if you don't know the MAC address.
For more on using the tool, just run `calima -h`.
## Debugging
Set this to True in pycalima/Calima.py file if want to see more verbose output.
self._debug = False
## Documentation
A good readup introductory readup on BLE reverse engineering can be found
`here <https://medium.com/@urish/reverse-engineering-a-bluetooth-lightbulb-56580fcb7546#.9ltnsvdsn>`_.
Some badly structured details about the protocol can be found in the
`Characteristics file <characteristics.md>`_.
There is currently no documentation on the module yet, check the
Calima.py file to see available functions.
Raw data
{
"_id": null,
"home_page": "https://github.com/timutta/pycalima",
"name": "CalimaCalima2",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pax calima fan bluetooth ble",
"author": "Timo Mutta",
"author_email": "unknown@unknown.com",
"download_url": "https://files.pythonhosted.org/packages/bc/58/3cbb0abbcc80983f468f8323a47bdfb5768fb77a149842d2e6d510239c8e/CalimaCalima2-2.0.2.tar.gz",
"platform": null,
"description": "# Pycalima\r\n\r\nSimple python interface against the Pax Calima\u00c2\u00ae bathroom fan created and sold by Pax\u00c2\u00ae\r\n\r\nThis module provides a very simple interface against the various GATT characteristics of the Calima fan, most importantly it handles the authentication so values are actually persisted within the fan.\r\n\r\nUses Bleak\r\n\r\n## Installation\r\n\r\nInstall calima\r\n $sudo python3 -m pip install calima\r\n\r\n## Demo usage\r\n\r\n.. code:: python\r\n\r\n from Calima import Calima\r\n\r\n fan = Calima(\"MA:CC:AD:DR:ES:SS\", \"012345\")\r\n print(fan.getAlias())\r\n\r\n## Find MAC address\r\n\r\n $sudo python3 cmdline.py -l\r\n\r\n\r\n## Home Assistant integration\r\n\r\nPlease visit '<https://github.com/timutta/homeassistant-paxcalima>'_.\r\n\r\n## Command Line Tool\r\n\r\nPretty useful command line tool which among other things can print all\r\nthe characteristics of a fan. It can also search for available fans \r\nif you don't know the MAC address.\r\n\r\nFor more on using the tool, just run `calima -h`.\r\n\r\n## Debugging\r\n\r\nSet this to True in pycalima/Calima.py file if want to see more verbose output.\r\n\r\n self._debug = False\r\n\r\n## Documentation\r\n\r\nA good readup introductory readup on BLE reverse engineering can be found\r\n`here <https://medium.com/@urish/reverse-engineering-a-bluetooth-lightbulb-56580fcb7546#.9ltnsvdsn>`_.\r\n\r\nSome badly structured details about the protocol can be found in the\r\n`Characteristics file <characteristics.md>`_.\r\n\r\nThere is currently no documentation on the module yet, check the\r\nCalima.py file to see available functions.\r\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python interface for Pax Calima Fan",
"version": "2.0.2",
"split_keywords": [
"pax",
"calima",
"fan",
"bluetooth",
"ble"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "720011d8374d5f02930a2371988349d1",
"sha256": "bf8af204a2d5948a3716d69f53bce0beea8579310848ca99acb21826123529db"
},
"downloads": -1,
"filename": "CalimaCalima2-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "720011d8374d5f02930a2371988349d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9075,
"upload_time": "2022-12-19T23:31:22",
"upload_time_iso_8601": "2022-12-19T23:31:22.377121Z",
"url": "https://files.pythonhosted.org/packages/fa/ee/daa3946d22d48a30ec21ec7f82cb7b5f2f08903e44e461b12ec0390ebd9e/CalimaCalima2-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "22098d5a189eb1528680d4ca0e51d2c6",
"sha256": "58ea2b0f5f469815393b9dcabb4ea3bde24b59a488a4800b740034d8123a374f"
},
"downloads": -1,
"filename": "CalimaCalima2-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "22098d5a189eb1528680d4ca0e51d2c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8150,
"upload_time": "2022-12-19T23:31:23",
"upload_time_iso_8601": "2022-12-19T23:31:23.820905Z",
"url": "https://files.pythonhosted.org/packages/bc/58/3cbb0abbcc80983f468f8323a47bdfb5768fb77a149842d2e6d510239c8e/CalimaCalima2-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-19 23:31:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "timutta",
"github_project": "pycalima",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "calimacalima2"
}
JSON
