Skip to content

Commit 0ee61f7

Browse files
rm-hullrm-hull
committed
Doc
1 parent acea8bc commit 0ee61f7

25 files changed

+131
-53
lines changed

‎CHANGES.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ ChangeLog
44
+------------+---------------------------------------------------------------------+------------+
55
| Version | Description | Date |
66
+============+=====================================================================+============+
7+
| **1.1.0** | * Add LS013B4DN04 Monochrome LCD display driver | 2018/01/01 |
8+
+------------+---------------------------------------------------------------------+------------+
79
| **1.0.3** | * Changed version number to inside ``luma/lcd/__init__.py`` | 2017/11/23 |
810
+------------+---------------------------------------------------------------------+------------+
911
| **1.0.2** | * Documentation and dependencies updates | 2017/10/30 |

‎LICENSE.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
The MIT License (MIT)
22
---------------------
33

4-
Copyright (c) 2013-17 Richard Hull & Contributors
4+
Copyright (c) 2013-18 Richard Hull & Contributors
55

66
Permission is hereby granted, free of charge, to any person obtaining a copy
77
of this software and associated documentation files (the "Software"), to deal

‎README.rst‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ luma.lcd **|**
88

99
Luma.LCD
1010
========
11-
**PCD8544, ST7735, HT1621, UC1701X Display Drivers**
11+
**PCD8544, ST7735, HT1621, UC1701X, LS013B4DN04 Display Drivers**
1212

1313
.. image:: https://travis-ci.org/rm-hull/luma.lcd.svg?branch=master
1414
:target: https://travis-ci.org/rm-hull/luma.lcd
@@ -26,12 +26,12 @@ Luma.LCD
2626
.. image:: https://img.shields.io/pypi/v/luma.lcd.svg
2727
:target: https://pypi.python.org/pypi/luma.lcd
2828

29-
.. image:: https://img.shields.io/maintenance/yes/2017.svg?maxAge=2592000
29+
.. image:: https://img.shields.io/maintenance/yes/2018.svg?maxAge=2592000
3030

31-
Python library interfacing LCD displays with the PCD8544, ST7735, HT1621 and
32-
UC1701X driver using SPI on the Raspberry Pi and other linux-based single-board
33-
computers - it provides a Pillow-compatible drawing canvas, and other
34-
functionality to support:
31+
Python library interfacing LCD displays with the PCD8544, ST7735, HT1621,
32+
UC1701X and LS013B4DN04 driver using SPI on the Raspberry Pi and other
33+
linux-based single-board computers - it provides a Pillow-compatible drawing
34+
canvas, and other functionality to support:
3535

3636
* scrolling/panning capability,
3737
* terminal-style printing,
@@ -49,6 +49,8 @@ All modules can be picked up on ebay with a breakout board for a few pounds.
4949

5050
.. image:: https://raw.github.com/rm-hull/luma.lcd/master/doc/images/uc1701x.png
5151

52+
.. image:: https://raw.github.com/rm-hull/luma.lcd/master/doc/images/ls013b4dn04.jpg
53+
5254
Documentation
5355
-------------
5456
Full documentation with installation instructions and examples can be found on
@@ -58,7 +60,7 @@ License
5860
-------
5961
The MIT License (MIT)
6062

61-
Copyright (c) 2013-17 Richard Hull & Contributors
63+
Copyright (c) 2013-18 Richard Hull & Contributors
6264

6365
Permission is hereby granted, free of charge, to any person obtaining a copy
6466
of this software and associated documentation files (the "Software"), to deal

‎doc/images/ls013b4dn04.jpg‎

86.7 KB
Loading

‎doc/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Luma.LCD: Display drivers for PCD8544, ST7735, HT1621, UC1701X
2-
==============================================================
1+
Luma.LCD: Display drivers for PCD8544, ST7735, HT1621, UC1701X, LS013B4DN04
2+
===========================================================================
33
.. image:: https://travis-ci.org/rm-hull/luma.lcd.svg?branch=master
44
:target: https://travis-ci.org/rm-hull/luma.lcd
55

66
.. image:: https://coveralls.io/repos/github/rm-hull/luma.lcd/badge.svg?branch=master
77
:target: https://coveralls.io/github/rm-hull/luma.lcd?branch=master
88

9-
.. image:: https://img.shields.io/maintenance/yes/2017.svg?maxAge=2592000
9+
.. image:: https://img.shields.io/maintenance/yes/2018.svg?maxAge=2592000
1010

1111
.. image:: https://img.shields.io/pypi/pyversions/luma.lcd.svg
1212
:target: https://pypi.python.org/pypi/luma.lcd

‎doc/install.rst‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,25 @@ SCK SPI clock P01-23 GPIO 11 (SCLK)
140140
SDA SPI data P01-19 GPIO 10 (MOSI)
141141
RS Data/command P01-16 GPIO 23
142142
RST Reset P01-18 GPIO 24
143-
CS SPI chip select P01-24 GPIO 8 (CE0) Chip Select
143+
CS SPI chip select P01-24 GPIO 8 (CE0)
144+
============= ================= ======== ==============
145+
146+
LS013B4DN04
147+
"""""""""""
148+
Also known as Adafruit_1393
149+
150+
============= ================= ======== ==============
151+
LCD Pin Remarks RPi Pin RPi Function
152+
============= ================= ======== ==============
153+
VIN +3.3V P01-01 3V3
154+
3V3 +3.3V P01-01 3V3
155+
GND Ground P01-06 GND
156+
SCLK SPI clock P0-23 GPIO 11 (SCLK)
157+
MOSI SPI data P01-19 GPIO 10 (MOSI)
158+
CS SPI chip select P01-24 GPIO 8 (CE0)
159+
EXTMD External mode P01-14 GND
160+
DISP Display on/off P01-16 GPIO 23
161+
EXTIN PWM clock P01-12 GPIO 18 (PWM0)
144162
============= ================= ======== ==============
145163

146164
Installing from PyPI

‎doc/intro.rst‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Introduction
22
------------
3-
Interfacing small LCD displays with the PCD8544, ST7735, HT1621 and UC1701X
4-
driver in Python using SPI on the Raspberry Pi and other linux-based
5-
single-board computers: the library provides a Pillow-compatible drawing
6-
canvas, and other functionality to support:
3+
Interfacing small LCD displays with the PCD8544, ST7735, HT1621, UC1701X and
4+
LS013B4DN04 driver in Python using SPI on the Raspberry Pi and other
5+
linux-based single-board computers: the library provides a Pillow-compatible
6+
drawing canvas, and other functionality to support:
77

88
* scrolling/panning capability,
99
* terminal-style printing,
@@ -36,6 +36,10 @@ switchable backlight:
3636

3737
.. image:: images/uc1701x.png
3838

39+
The LS013B4DN04 display supports a resolution of 96 x 96 monochrome pixels:
40+
41+
.. image:: images/ls013b4dn04.jpg
42+
3943
.. seealso::
4044
Further technical information for the specific device can be found in the
4145
datasheet below:
@@ -44,6 +48,7 @@ switchable backlight:
4448
- :download:`ST7735 <tech-spec/ST7735.pdf>`
4549
- :download:`HT1621 <tech-spec/HT1621.pdf>`
4650
- :download:`UC1701X <tech-spec/UC1701X.pdf>`
51+
- :download:`LS013B4DN04 <tech-spec/LS013B4DN04.pdf>`
4752

4853
As well as display drivers for the physical device, there are emulators that
4954
run in real-time (with pygame) and others that can take screenshots, or

‎doc/python-usage.rst‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,21 @@ Python usage
33

44
Pixel Drivers
55
^^^^^^^^^^^^^
6+
67
The PCD8544 is driven with python using the implementation in the
7-
:py:class:`luma.lcd.device.pcd8544` class. Likewise, to drive the ST7735 or
8-
UC1701X, use the :py:class:`luma.lcd.device.st7735` or
9-
:py:class:`luma.lcd.device.uc1701x` class respectively. Usage is very simple if
10-
you have ever used `Pillow <https://pillow.readthedocs.io/en/latest/>`_ or PIL.
8+
:py:class:`luma.lcd.device.pcd8544` class. Likewise, to drive the ST7735,
9+
UC1701X or LS013B4DN04, use the :py:class:`luma.lcd.device.st7735`,
10+
:py:class:`luma.lcd.device.uc1701x`, :py:class:`luma.lcd.device.ls013b4dn04` or
11+
class respectively. Usage is very simple if you have ever used `Pillow
12+
<https://pillow.readthedocs.io/en/latest/>`_ or PIL.
1113

1214
First, import and initialise the device:
1315

1416
.. code:: python
1517
1618
from luma.core.interface.serial import spi
1719
from luma.core.render import canvas
18-
from luma.lcd.device import pcd8544, st7735, uc1701x
20+
from luma.lcd.device import pcd8544, st7735, uc1701x, ls013b4dn04
1921
2022
serial = spi(port=0, device=0, gpio_DC=23, gpio_RST=24)
2123
device = pcd8544(serial)
@@ -24,8 +26,9 @@ The display device should now be configured for use. Note, all the example code
2426
snippets in this section are interchangeable between PCD8544 and ST7735
2527
devices.
2628

27-
The :py:class:`~luma.lcd.device.pcd8544`, :py:class:`~luma.lcd.device.st7735` and
28-
:py:class:`~luma.lcd.device.uc1701x` classes all expose a
29+
The :py:class:`~luma.lcd.device.pcd8544`, :py:class:`~luma.lcd.device.st7735`,
30+
:py:class:`~luma.lcd.device.uc1701x` and
31+
:py:class:`~luma.lcd.device.ls013b4dn04` classes all expose a
2932
:py:meth:`~luma.lcd.device.pcd8544.display` method which takes an image with
3033
attributes consistent with the capabilities of the device. However, for most
3134
cases, for drawing text and graphics primitives, the canvas class should be
@@ -67,9 +70,10 @@ colour RGB images, whereby 24-bit RGB images are downscaled to 18-bit RGB.
6770
Landscape / Portrait Orientation
6871
""""""""""""""""""""""""""""""""
6972
By default the PCD8544, ST7735 and UC1701X displays will all be oriented in
70-
landscape mode (84x48, 160x128 and 128x64 pixels respectively). Should you have
71-
an application that requires the display to be mounted in a portrait aspect,
72-
then add a :py:attr:`rotate=N` parameter when creating the device:
73+
landscape mode (84x48, 160x128 and 128x64 pixels respectively). The LS013B4DN04
74+
supports a native resolution of 96x96 pixels. Should you have an application
75+
that requires the display to be mounted in a portrait aspect, then add a
76+
:py:attr:`rotate=N` parameter when creating the device:
7377

7478
.. code:: python
7579
@@ -93,9 +97,9 @@ properties reflect the rotated dimensions rather than the physical dimensions.
9397

9498
Seven-Segment Drivers
9599
^^^^^^^^^^^^^^^^^^^^^
96-
The HT1621 is driven with the :py:class:`luma.lcd.device.ht1621` class, but is
97-
not accessed directly: it should be wrapped with the :py:class:`luma.core.virtual.sevensegment`
98-
wrapper, as follows:
100+
The HT1621 is driven with the :py:class:`luma,lcd.device.ht1621` class, but is
101+
not accessed directly: it should be wrapped with the
102+
:py:class:`luma.core.virtual.sevensegment` wrapper, as follows:
99103

100104
.. code:: python
101105
@@ -104,13 +108,13 @@ wrapper, as follows:
104108
105109
device = ht1621()
106110
seg = sevensegment(device)
107-
108-
109-
The **seg** instance now has a :py:attr:`~luma.led_matrix.virtual.sevensegment.text`
110-
property which may be assigned, and when it does will update all digits
111-
according to the limited alphabet the 7-segment displays support. For example,
112-
assuming there are 2 cascaded modules, we have 16 character available, and so
113-
can write:
111+
112+
113+
The **seg** instance now has a
114+
:py:attr:`~luma.led_matrix.virtual.sevensegment.text` property which may be
115+
assigned, and when it does will update all digits according to the limited
116+
alphabet the 7-segment displays support. For example, assuming there are 2
117+
cascaded modules, we have 16 character available, and so can write:
114118

115119
.. code:: python
116120

‎doc/tech-spec/LS013B4DN04.pdf‎

524 KB
Binary file not shown.

‎luma/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# -*- coding: utf-8 -*-
2-
# Copyright (c) 2013-17 Richard Hull and contributors
2+
# Copyright (c) 2013-18 Richard Hull and contributors
33
# See LICENSE.rst for details.
44

55
from pkgutil import extend_path

0 commit comments

Comments
 (0)