[](https://github.com/Andreasdahlberg/husky-tools/actions/workflows/python-package.yml)
[](https://sonarcloud.io/summary/new_code?id=Andreasdahlberg_husky-tools)
# About
huskytools provides tools for interacting with the [HuskyLens AI camera](https://wiki.dfrobot.com/HUSKYLENS_V1.0_SKU_SEN0305_SEN0336).
## Features
* Low-level API for interacting with the HuskyLens camera. It's meant as a replacement
for the [official HuskyLens Python API](https://github.com/HuskyLens/HUSKYLENSPython). It's not a drop-in replacement but all
the functionality, except for I2C-support, is there.
* A command line interface for quick testing and debugging.[NOT IMPLEMENTED YET]
* Helper classes for working with the HuskyLens camera, e.g. a class for working
with faces. [NOT IMPLEMENTED YET]
## Installation
huskytools is available on PyPI, so you can install it with pip:
```bash
pip install huskytools
```
Alternatively, you can install the latest development version of huskytools by
cloning the repository and install it with pip:
```bash
git clone https://github.com/Andreasdahlberg/husky-tools.git
cd husky-tools
pip install .
```
## Usage
### API
This example shows how to connect to the HuskyLens.
```python
from huskytools import huskylens
with huskylens.Interface("/dev/ttyUSB0") as lens:
if lens.knock():
print("HuskyLens connected")
else:
print("HuskyLens not found")
```
This example shows how to get all detected faces from the HuskyLens.
```python
from huskytools import huskylens
with huskylens.Interface("/dev/ttyUSB0") as lens:
if lens.knock():
lens.set_algorithm(huskylens.RecognitionAlgorithm.FACE_RECOGNITION)
for block in lens.get_blocks():
print("Block ID: {}, X: {}, Y: {}".format(block.id, block.x, block.y))
```
### Command line interface
NOT IMPLEMENTED YET
### Helper classes
NOT IMPLEMENTED YET
## Contributing
Contributions are welcome. Please open an issue or a pull request on GitHub.
## Support
If you have any questions or problems, please open an issue on GitHub and i will be happy to help.
Raw data
{
"_id": null,
"home_page": "https://github.com/Andreasdahlberg/husky-tools",
"name": "huskytools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "huskylens face-recognition camera",
"author": "Andreas Dahlberg",
"author_email": "andreas.dahlberg90@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/74/03/fd2777be0026d9c4885b7c7db1778c65c056cb71de2444e9a6153e5c1576/huskytools-0.2.0.tar.gz",
"platform": null,
"description": "[](https://github.com/Andreasdahlberg/husky-tools/actions/workflows/python-package.yml)\n[](https://sonarcloud.io/summary/new_code?id=Andreasdahlberg_husky-tools)\n\n# About\nhuskytools provides tools for interacting with the [HuskyLens AI camera](https://wiki.dfrobot.com/HUSKYLENS_V1.0_SKU_SEN0305_SEN0336).\n\n## Features\n * Low-level API for interacting with the HuskyLens camera. It's meant as a replacement\nfor the [official HuskyLens Python API](https://github.com/HuskyLens/HUSKYLENSPython). It's not a drop-in replacement but all\nthe functionality, except for I2C-support, is there.\n\n* A command line interface for quick testing and debugging.[NOT IMPLEMENTED YET]\n\n* Helper classes for working with the HuskyLens camera, e.g. a class for working\nwith faces. [NOT IMPLEMENTED YET]\n\n## Installation\nhuskytools is available on PyPI, so you can install it with pip:\n```bash\npip install huskytools\n```\n\nAlternatively, you can install the latest development version of huskytools by\ncloning the repository and install it with pip:\n```bash\ngit clone https://github.com/Andreasdahlberg/husky-tools.git\ncd husky-tools\npip install .\n```\n\n## Usage\n\n### API\n\nThis example shows how to connect to the HuskyLens.\n```python\nfrom huskytools import huskylens\n\nwith huskylens.Interface(\"/dev/ttyUSB0\") as lens:\n if lens.knock():\n print(\"HuskyLens connected\")\n else:\n print(\"HuskyLens not found\")\n```\n\nThis example shows how to get all detected faces from the HuskyLens.\n```python\nfrom huskytools import huskylens\n\nwith huskylens.Interface(\"/dev/ttyUSB0\") as lens:\n if lens.knock():\n lens.set_algorithm(huskylens.RecognitionAlgorithm.FACE_RECOGNITION)\n for block in lens.get_blocks():\n print(\"Block ID: {}, X: {}, Y: {}\".format(block.id, block.x, block.y))\n```\n\n### Command line interface\nNOT IMPLEMENTED YET\n\n### Helper classes\nNOT IMPLEMENTED YET\n\n## Contributing\nContributions are welcome. Please open an issue or a pull request on GitHub.\n\n## Support\nIf you have any questions or problems, please open an issue on GitHub and i will be happy to help.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tools for interacting with the HuskyLens AI camera",
"version": "0.2.0",
"split_keywords": [
"huskylens",
"face-recognition",
"camera"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7407e30e7f10a63c77d5d21e111b781dd2cfccc0d789c85aa6d23ab653243747",
"md5": "22beb3f4c43dc00e7d1c276e732a27a7",
"sha256": "4dfb49dcc2a407ac96b45a6ce501681bffb60712a1f0041d730d0df1cffc48f1"
},
"downloads": -1,
"filename": "huskytools-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22beb3f4c43dc00e7d1c276e732a27a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6677,
"upload_time": "2023-01-05T21:35:23",
"upload_time_iso_8601": "2023-01-05T21:35:23.336456Z",
"url": "https://files.pythonhosted.org/packages/74/07/e30e7f10a63c77d5d21e111b781dd2cfccc0d789c85aa6d23ab653243747/huskytools-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7403fd2777be0026d9c4885b7c7db1778c65c056cb71de2444e9a6153e5c1576",
"md5": "849a4307bf50a261d7ffdb5ed068663d",
"sha256": "b30fbc9d714f2c74004db273bf1e24efba39a7c78705b704653f0e8fd4b1f8d8"
},
"downloads": -1,
"filename": "huskytools-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "849a4307bf50a261d7ffdb5ed068663d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6077,
"upload_time": "2023-01-05T21:35:24",
"upload_time_iso_8601": "2023-01-05T21:35:24.552909Z",
"url": "https://files.pythonhosted.org/packages/74/03/fd2777be0026d9c4885b7c7db1778c65c056cb71de2444e9a6153e5c1576/huskytools-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-05 21:35:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Andreasdahlberg",
"github_project": "husky-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "huskytools"
}
JSON
