piepd


Namepiepd JSON
Version 0.0.3.6 PyPI version JSON
download
home_pagehttps://github.com/Tsangares/epd
SummaryHigh level ePaper display utilty
upload_time2020-11-28 02:04:35
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Context

This tool is showcased in the project [IotaWorkshop](https://github.com/Tsangares/iotaworkshop)

# Summary

This is a high level e-paper libaray. It supports QR code displays and allows easy lines of text writing along with right text align. Ideally if used this libaray should be imported to use the helpful class `EPD`.

**Note** This works for all waveshare screens when you import it. Simply change the line from,

    from waveshare_epd import epd1in54_V2
	
To whatever screen you have. For instance the 5.83 inch BW screen

    from waveshare_epd import epd5in83
	
Or the color version (bc)

    from waveshare_epd import epd5in8bc
	
	
# Installation

This project depends on `Pillow` but there are a variety of ways of installing it so I did not mark it as a dependency in the pypi package, you can install it using,

    pip install pillow
   
Simply install this package from the pypi repo

    pip install piepd
	
# Command Line Interface

There are a few example displays that can be run through the cli,	

	epd occipied #Displays text saying the tools is occupied
	epd --help #To see altenative displays

# Implementation Example

	from epd import EPD
	epd = EPD()
	epd.setFontSize(21)
	epd.drawText("Hello world",draw=False) #Draws this text on the screen
	epd.drawText("Left",draw=False) #Does not display yet until draw=True
	
	#The following line will right align the text and put it on the previous line
	epd.drawText("Right",right=True,overlap=True,draw=True)
	
	#Once you are completly done using the dislplay run
	epd.close()
# Wiring

| Board pin name | Board pin | RPi pin name | 
|----------------|-----------|--------------|
| VCC            | 1         | 3v3          | 
| GND            | 6         | GND          | 
| DIN            | 19        | GPIO10, MOSI | 
| CLK            | 11        | GPIO11, SCKL | 
| CS             | 24        | GPIO8, CE0   | 
| DC             | 22        | GPIO25       | 
| RST            | 11        | GPIO17       | 
| BUSY           | 18        | GPIO24       |
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Tsangares/epd",
    "name": "piepd",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "william.wyatt@cgu.edu",
    "download_url": "https://files.pythonhosted.org/packages/4c/ea/d164e4e0a3635989b444118c04cdc9765b5814db838dc089a3b63e62ff98/piepd-0.0.3.6.tar.gz",
    "platform": "",
    "description": "## Context\n\nThis tool is showcased in the project [IotaWorkshop](https://github.com/Tsangares/iotaworkshop)\n\n# Summary\n\nThis is a high level e-paper libaray. It supports QR code displays and allows easy lines of text writing along with right text align. Ideally if used this libaray should be imported to use the helpful class `EPD`.\n\n**Note** This works for all waveshare screens when you import it. Simply change the line from,\n\n    from waveshare_epd import epd1in54_V2\n\t\nTo whatever screen you have. For instance the 5.83 inch BW screen\n\n    from waveshare_epd import epd5in83\n\t\nOr the color version (bc)\n\n    from waveshare_epd import epd5in8bc\n\t\n\t\n# Installation\n\nThis project depends on `Pillow` but there are a variety of ways of installing it so I did not mark it as a dependency in the pypi package, you can install it using,\n\n    pip install pillow\n   \nSimply install this package from the pypi repo\n\n    pip install piepd\n\t\n# Command Line Interface\n\nThere are a few example displays that can be run through the cli,\t\n\n\tepd occipied #Displays text saying the tools is occupied\n\tepd --help #To see altenative displays\n\n# Implementation Example\n\n\tfrom epd import EPD\n\tepd = EPD()\n\tepd.setFontSize(21)\n\tepd.drawText(\"Hello world\",draw=False) #Draws this text on the screen\n\tepd.drawText(\"Left\",draw=False) #Does not display yet until draw=True\n\t\n\t#The following line will right align the text and put it on the previous line\n\tepd.drawText(\"Right\",right=True,overlap=True,draw=True)\n\t\n\t#Once you are completly done using the dislplay run\n\tepd.close()\n# Wiring\n\n| Board pin name | Board pin | RPi pin name | \n|----------------|-----------|--------------|\n| VCC            | 1         | 3v3          | \n| GND            | 6         | GND          | \n| DIN            | 19        | GPIO10, MOSI | \n| CLK            | 11        | GPIO11, SCKL | \n| CS             | 24        | GPIO8, CE0   | \n| DC             | 22        | GPIO25       | \n| RST            | 11        | GPIO17       | \n| BUSY           | 18        | GPIO24       |",
    "bugtrack_url": null,
    "license": "",
    "summary": "High level ePaper display utilty",
    "version": "0.0.3.6",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e38439d6e4d6a3a8cadb9c8f33d47c1b",
                "sha256": "dbdcf8f294f8da38c8c48b587bb0b806fc6deac38bb24d80a780644d70f87520"
            },
            "downloads": -1,
            "filename": "piepd-0.0.3.6.tar.gz",
            "has_sig": false,
            "md5_digest": "e38439d6e4d6a3a8cadb9c8f33d47c1b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 177405,
            "upload_time": "2020-11-28T02:04:35",
            "upload_time_iso_8601": "2020-11-28T02:04:35.448934Z",
            "url": "https://files.pythonhosted.org/packages/4c/ea/d164e4e0a3635989b444118c04cdc9765b5814db838dc089a3b63e62ff98/piepd-0.0.3.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-11-28 02:04:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "Tsangares",
    "error": "Could not fetch GitHub repository",
    "lcname": "piepd"
}
        
Elapsed time: 0.16218s