Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-laser-egismos/badge/?version=latest
:target: https://circuitpython-laser-egismos.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/furbrain/CircuitPython_laser_egismos/workflows/Build%20CI/badge.svg
:target: https://github.com/furbrain/CircuitPython_laser_egismos/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
Device driver for the egismos series of lasers, available at
https://www.egismos.com/laser-measuring-optoelectronics-module
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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-laser-egismos/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-laser-egismos
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-laser-egismos
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-laser-egismos
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 laser_egismos
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
import busio
import digitalio
from laser_egismos import Laser
laser_power = digitalio.DigitalInOut(board.D10)
laser_power.switch_to_output(True)
uart = busio.UART(board.D8, board.D9, baudrate=9600)
laser = Laser(uart)
laser.set_buzzer(False)
laser.set_laser(True)
time.sleep(3)
laser.set_laser_(False)
time.sleep(0.1)
print(f"Distance is {laser.distance}cm")
Documentation
=============
API documentation for this library can be found on `Read the Docs
<https://circuitpython-laser-egismos.readthedocs.io/>`_.
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/furbrain/CircuitPython_laser_egismos/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-laser-egismos",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,laser_egismos,laser,egismos,rangefinder,distance",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/38/33/bd9e941f5b5f5db3181759e7be03b385a20ced8f0e580abf0660639d7372/circuitpython-laser-egismos-1.2.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-laser-egismos/badge/?version=latest\n :target: https://circuitpython-laser-egismos.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/furbrain/CircuitPython_laser_egismos/workflows/Build%20CI/badge.svg\n :target: https://github.com/furbrain/CircuitPython_laser_egismos/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\nDevice driver for the egismos series of lasers, available at\nhttps://www.egismos.com/laser-measuring-optoelectronics-module\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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\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/circuitpython-laser-egismos/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-laser-egismos\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-laser-egismos\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 .env/bin/activate\n pip3 install circuitpython-laser-egismos\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 laser_egismos\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n\n import board\n import busio\n import digitalio\n\n from laser_egismos import Laser\n\n laser_power = digitalio.DigitalInOut(board.D10)\n laser_power.switch_to_output(True)\n\n\n uart = busio.UART(board.D8, board.D9, baudrate=9600)\n laser = Laser(uart)\n laser.set_buzzer(False)\n laser.set_laser(True)\n time.sleep(3)\n laser.set_laser_(False)\n time.sleep(0.1)\n print(f\"Distance is {laser.distance}cm\")\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs\n<https://circuitpython-laser-egismos.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out `this guide\n<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/furbrain/CircuitPython_laser_egismos/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Device driver for the egismos series of lasers, available at https://www.egismos.com/laser-measuring-optoelectronics-module",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/furbrain/CircuitPython_laser_egismos"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"laser_egismos",
"laser",
"egismos",
"rangefinder",
"distance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd31c91cffc03469dfe2f8e7c2e5d04f19eab3810180c0a42ff0c83faa55bea6",
"md5": "e51fb997b6b89913a872ed31b7826cef",
"sha256": "f06ee8674b5ae60229e3411d99e06d7c48494c06124ad28ac3b7812fc217f0e3"
},
"downloads": -1,
"filename": "circuitpython_laser_egismos-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e51fb997b6b89913a872ed31b7826cef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6968,
"upload_time": "2023-06-01T22:14:17",
"upload_time_iso_8601": "2023-06-01T22:14:17.052112Z",
"url": "https://files.pythonhosted.org/packages/cd/31/c91cffc03469dfe2f8e7c2e5d04f19eab3810180c0a42ff0c83faa55bea6/circuitpython_laser_egismos-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3833bd9e941f5b5f5db3181759e7be03b385a20ced8f0e580abf0660639d7372",
"md5": "308fb745534d9f7c7b1efdf33054601b",
"sha256": "60069ab15adcdcd4e253d49a3571bf0648adc83ee34488fb8ac704acf17820e4"
},
"downloads": -1,
"filename": "circuitpython-laser-egismos-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "308fb745534d9f7c7b1efdf33054601b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28385,
"upload_time": "2023-06-01T22:14:19",
"upload_time_iso_8601": "2023-06-01T22:14:19.175039Z",
"url": "https://files.pythonhosted.org/packages/38/33/bd9e941f5b5f5db3181759e7be03b385a20ced8f0e580abf0660639d7372/circuitpython-laser-egismos-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-01 22:14:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "furbrain",
"github_project": "CircuitPython_laser_egismos",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-laser-egismos"
}
JSON
