{ "info": { "author": "Gaston Williams", "author_email": "fourstix@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries", "Topic :: System :: Hardware" ], "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/sparkfun-circuitpython-serlcd/badge/?version=latest\n :target: https://sparkfun-circuitpython-serlcd.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://discord.gg/nBQh6qu\n :alt: Discord\n\n.. image:: https://travis-ci.org/fourstix/Sparkfun_CircuitPython_SerLCD.svg?branch=master\n :target: https://travis-ci.org/fourstix/Sparkfun_CircuitPython_SerLCD\n :alt: Build Status\n\nCircuitPython library for the Sparkfun SerLCD displays. This library is ported from\n`SparkFun SerLCD Arduino Library `_\n\n`SparkFun 16x2 SerLCD - Black on RGB 3.3V (LCD-14072) `_\n\n.. image:: https://cdn.sparkfun.com/r/140-140/assets/parts/1/1/9/2/5/14072-SparkFun_16x2_SerLCD_-_Black_on_RGB_3.3V-05.jpg\n :target: https://www.sparkfun.com/products/14072\n :alt: SparkFun 16x2 SerLCD - Black on RGB 3.3V (LCD-14072)\n\n`SparkFun 16x2 SerLCD - RGB on Black 3.3V (LCD-14073) `_\n\n.. image:: https://cdn.sparkfun.com/r/140-140/assets/parts/1/1/9/2/6/14073-SparkFun_16x2_SerLCD_-_RGB_on_Black_3.3V-05.jpg\n :target: https://www.sparkfun.com/products/14073\n :alt: SparkFun 16x2 SerLCD - RGB on Black 3.3V (LCD-14073)\n\n`SparkFun 20x4 SerLCD - Black on RGB 3.3V (LCD-14074) `_\n\n.. image:: https://cdn.sparkfun.com/r/140-140/assets/parts/1/1/9/2/7/14074-SparkFun_20x4_SerLCD_-_Black_on_RGB_3.3V-05.jpg\n :target: https://www.sparkfun.com/products/14074\n :alt: SparkFun 20x4 SerLCD - Black on RGB 3.3V (LCD-14074)\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython `_\n* `Adafruit Bus Device `_\n* `Sparkfun SerLCD Hardware `_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle `_.\n\nRaspberry Pi Setup\n------------------\n Adafruit has an excellent tutorial on `Installing CircuitPython Libraries on Raspberry Pi\n `_.\n \nQuick Start Summary:\n\n* Start with the latest version of Raspbian with Wifi configured.\n\n* Enable SSH, I2C and SPI.\n\n.. code-block:: shell\n\n sudo raspi-config\n\n* Update your system to the latest version.\n\n.. code-block:: shell\n\n sudo apt-get update\n sudo apt-get upgrade\n\n* Update the python tools\n\n.. code-block:: shell\n\n sudo pip3 install --upgrade setuptools\n\n(If pip3 is not installed, install it and rerun the command)\n\n.. code-block:: shell\n\n sudo apt-get install python3-pip\n\n* Install the CircuitPython libraries\n\n.. code-block:: shell\n\n pip3 install RPI.GPIO\n pip3 install adafruit-blinka\n\nInstalling from PyPI\n--------------------\n On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\n PyPI `_.\n\n Installing this library will also install the dependency adafruit-circuitpython-busdevice.\n\nInstalling from PyPI\n=====================\n\n.. code-block:: shell\n\n pip3 install sparkfun-circuitpython-serlcd\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install sparkfun-circuitpython-serlcd\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 .env\n source .env/bin/activate\n pip3 install adafruit-circuitpython-serlcd\n\nUsage Example\n=============\n* `Sparkfun SerLCD Hookup Guide `_ - The Arduino examples in the Hookup Guide are available for Python with this library\n* `CircuitPython on a Raspberry Pi `_ - Basic information on how to install CircuitPython on a Raspberry Pi.\n\n* Code Example:\n\n .. code-block:: shell\n \n # import the CircuitPython board and busio libraries\n import board\n import busio\n \n # Enable I2C (Qwiic) communication\n from sparkfun_serlcd import Sparkfun_SerLCD_I2C\n i2c = busio.I2C(board.SCL, board.SDA)\n serlcd = Sparkfun_SerLCD_I2C(i2c)\n\n # Enable SPI communication\n #import digitalio\n #from sparkfun_serlcd import Sparkfun_SerLCD_SPI\n #spi = busio.SPI(board.SCK, board.MOSI, board.MISO)\n #\n # Set up chip select, CE0 or D8 is labeled CS on Sparkfun Pi Hat\n #cs = digitalio.DigitalInOut(board.CE0)\n #cs.direction = digitalio.Direction.OUTPUT\n #\n #serlcd = Sparkfun_SerLCD_SPI(spi, cs)\n\n # Enable UART Serial communication\n # SerLCD is connected to the RPi via a USB to TTL 3.3v Serial Cable:\n # https://www.sparkfun.com/products/12977\n # https://www.adafruit.com/product/954\n #import serial\n #from sparkfun_serlcd import Sparkfun_SerLCD_UART\n #\n #usb0 = serial.Serial(\n # port='/dev/ttyUSB0',\n # baudrate = 9600,\n # parity=serial.PARITY_NONE,\n # stopbits=serial.STOPBITS_ONE,\n # bytesize=serial.EIGHTBITS,\n # timeout=1)\n #\n #serlcd = Sparkfun_SerLCD_UART(usb0)\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n`_\nbefore contributing to help this project stay welcoming.\n\nBuilding locally\n================\n\nZip release files\n-----------------\n\nTo build this library locally you'll need to install the\n`circuitpython-build-tools `_ package.\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install circuitpython-build-tools\n\nOnce installed, make sure you are in the virtual environment:\n\n.. code-block:: shell\n\n source .env/bin/activate\n\nThen run the build:\n\n.. code-block:: shell\n\n circuitpython-build-bundles --filename_prefix sparkfun-circuitpython-serlcd --library_location .\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/fourstix/Sparkfun_CircuitPython_SerLCD", "keywords": "adafruit blinka circuitpython micropython serlcd sparkfun display", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sparkfun-circuitpython-serlcd", "package_url": "https://pypi.org/project/sparkfun-circuitpython-serlcd/", "platform": "", "project_url": "https://pypi.org/project/sparkfun-circuitpython-serlcd/", "project_urls": { "Homepage": "https://github.com/fourstix/Sparkfun_CircuitPython_SerLCD" }, "release_url": "https://pypi.org/project/sparkfun-circuitpython-serlcd/1.0.1/", "requires_dist": null, "requires_python": "", "summary": "CircuitPython driver library for the Sparkfun SerLCD displays", "version": "1.0.1" }, "last_serial": 5547355, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "2e94adbb2b646d9477fe0dc937e63b31", "sha256": "fdc241522561e49422cc11906601c59c4784ddb2e5b24a9fe6e0b83a158cad51" }, "downloads": -1, "filename": "sparkfun-circuitpython-serlcd-0.0.1.tar.gz", "has_sig": false, "md5_digest": "2e94adbb2b646d9477fe0dc937e63b31", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30864, "upload_time": "2019-07-17T18:02:55", "url": "https://files.pythonhosted.org/packages/73/70/516ed383bddbc3f113030e1b079134ad4efa9634cc161e4477270105c6a1/sparkfun-circuitpython-serlcd-0.0.1.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "20ca62846f695235cee58bdc2b313d2e", "sha256": "037cbc9f4de093792b399443eb9f8fd141c4ddd309f86235299acfb680783665" }, "downloads": -1, "filename": "sparkfun-circuitpython-serlcd-1.0.1.tar.gz", "has_sig": false, "md5_digest": "20ca62846f695235cee58bdc2b313d2e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30816, "upload_time": "2019-07-17T19:18:23", "url": "https://files.pythonhosted.org/packages/ff/7c/47e64c8db490d9f25005c3e9841416753166eeafabcfee8780e581b0a5dd/sparkfun-circuitpython-serlcd-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "20ca62846f695235cee58bdc2b313d2e", "sha256": "037cbc9f4de093792b399443eb9f8fd141c4ddd309f86235299acfb680783665" }, "downloads": -1, "filename": "sparkfun-circuitpython-serlcd-1.0.1.tar.gz", "has_sig": false, "md5_digest": "20ca62846f695235cee58bdc2b313d2e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30816, "upload_time": "2019-07-17T19:18:23", "url": "https://files.pythonhosted.org/packages/ff/7c/47e64c8db490d9f25005c3e9841416753166eeafabcfee8780e581b0a5dd/sparkfun-circuitpython-serlcd-1.0.1.tar.gz" } ] }