forked from micropython/micropython
-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #116 from kwagyeman/kwabena/update_docs_10_18_2023
docs: Update docs to match firmware v4.5.0
- Loading branch information
Showing
12 changed files
with
825 additions
and
433 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
.. currentmodule:: display | ||
.. _display.ST7701: | ||
|
||
class ST7701 -- Display Controller | ||
================================== | ||
|
||
The `ST7701` class is used to initialize the LCD screen controller. | ||
|
||
Constructors | ||
------------ | ||
|
||
.. class:: display.ST7701() | ||
|
||
Creates a controller object to initialize the ST7701 display controller which typically powers | ||
MIPI DSI displays. This class should be passed as the ``cotnroller`` argument to the `DSIDisplay()` | ||
class constructor which will take care of calling the `ST7701.init()` method for you. | ||
|
||
Methods | ||
------- | ||
|
||
.. method:: ST7701.init(display_controller) | ||
|
||
Initializes the display using the display controller which must provide `dsi_write()` and | ||
`dsi_read()` methods. | ||
|
||
.. method:: ST7701.read_id() | ||
|
||
Returns the display id. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
.. currentmodule:: display | ||
.. _display.DisplayData: | ||
|
||
class DisplayData -- Display Data | ||
================================= | ||
|
||
The `DisplayData` class is used for getting information about the attached DisplayPort/HDMI Display. | ||
|
||
Constructors | ||
------------ | ||
|
||
.. class:: display.DisplayData([cec=False, [ddc=False, [ddc_addr=0x50]]]) | ||
|
||
``cec`` Pass `True` to enable CEC communication to an external display (if possible). | ||
|
||
``ddc`` Pass `True` to enable DDC communication to an external display (if possible). | ||
|
||
``ddc_addr`` The I2C address to use to talk to the external display EEPROM. | ||
|
||
Methods | ||
------- | ||
|
||
.. method:: display.DisplayData.display_id() | ||
|
||
Returns the external display EDID data as a bytes() | ||
object. Verifying the EDID headers, checksums, and concatenating all sections into one bytes() | ||
object is done for you. You may then parse this information by `following this guide <https://en.wikipedia.org/wiki/Extended_Display_Identification_Data>`__. | ||
|
||
.. method:: DisplayData.send_frame(dst_addr, src_addr, bytes) | ||
|
||
Sends a packet on the HDMI-CEC bus to ``dst_addr`` with source ``src_addr`` and data ``bytes``. | ||
|
||
.. method:: DisplayData.receive_frame(dst_addr, timeout=1000) | ||
|
||
Waits ``timeout`` milliseconds to receive an HDMI-CEC | ||
frame for address ``dst_addr``. Returns True if the received frame was for ``dst_addr`` and False | ||
if not. On timeout throws an `OSError` Exception. | ||
|
||
.. method:: DisplayData.frame_callback(callback, dst_addr) | ||
|
||
Registers a ``callback`` which will be called on reception of an | ||
HDMI-CEC frame. The callback will receive two arguments of the frame src_addr as an int and | ||
payload as a `bytes()` object. | ||
|
||
``dst_addr`` sets the filter address to listen to on the CEC bus. | ||
|
||
If you use this method do not call `DisplayData.receive_frame()` anymore until the callback is | ||
disabled by passing ``None`` as the callback for this method. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
.. currentmodule:: display | ||
.. _display.DSIDisplay: | ||
|
||
class DSIDisplay -- DSI Display Driver | ||
====================================== | ||
|
||
The `DSIDisplay` class is used for driving MIPI LCDs. | ||
|
||
Example usage for driving the 800x480 MIPI LCD:: | ||
|
||
import sensor, display | ||
|
||
# Setup camera. | ||
sensor.reset() | ||
sensor.set_pixformat(sensor.RGB565) | ||
sensor.set_framesize(sensor.LCD) | ||
sensor.skip_frames() | ||
lcd = display.DSIDisplay(controller=display.ST7701()) | ||
|
||
# Show image. | ||
while(True): | ||
lcd.write(sensor.snapshot()) | ||
|
||
Constructors | ||
------------ | ||
|
||
.. class:: display.DSIDisplay([framesize=display.FWVGA, [refresh=60, [portrait=False, [channel=0, [controller]]]]]) | ||
|
||
``framesize`` One of the standard supported resolutions. | ||
|
||
``refresh`` Sets the LCD refresh rate in hertz. This controls the SPI LCD shield clock. | ||
|
||
``portrait`` Swap the framesize width and height. | ||
|
||
``channel`` The virtual MIPI DSI channel to use to talk to the display. | ||
|
||
``controller`` Pass the controller chip class here to initialize it along with the display. E.g. | ||
`display.ST7701()` which is a standard display controller for MIPI DSI displays. | ||
|
||
Methods | ||
------- | ||
|
||
.. method:: DSIDisplay.deinit() | ||
|
||
Releases the I/O pins and RAM used by the class. This is called automatically on destruction. | ||
|
||
.. method:: DSIDisplay.width() | ||
|
||
Returns the width of the screen. | ||
|
||
.. method:: DSIDisplay.height() | ||
|
||
Returns the height of the screen. | ||
|
||
.. method:: DSIDisplay.refresh() | ||
|
||
Returns the refresh rate. | ||
|
||
.. method:: DSIDisplay.write(image, [x=0, [y=0, [x_scale=1.0, [y_scale=1.0, [roi=None, [rgb_channel=-1, [alpha=256, [color_palette=None, [alpha_palette=None, [hint=0, [x_size=None, [y_size=None]]]]]]]]]]]]) | ||
|
||
Displays an ``image`` whose top-left corner starts at location x, y. You may either pass x, y | ||
separately, as a tuple (x, y), or neither. | ||
|
||
``x_scale`` controls how much the displayed image is scaled by in the x direction (float). If this | ||
value is negative the image will be flipped horizontally. | ||
|
||
``y_scale`` controls how much the displayed image is scaled by in the y direction (float). If this | ||
value is negative the image will be flipped vertically. | ||
|
||
``roi`` is the region-of-interest rectangle tuple (x, y, w, h) of the image to display. This | ||
allows you to extract just the pixels in the ROI to scale. | ||
|
||
``rgb_channel`` is the RGB channel (0=R, G=1, B=2) to extract from an RGB565 image (if passed) | ||
and to render on the display. For example, if you pass ``rgb_channel=1`` this will | ||
extract the green channel of the RGB565 image and display that in grayscale. | ||
|
||
``alpha`` controls how opaque the image is. A value of 256 displays an opaque image while a | ||
value lower than 256 produces a black transparent image. 0 results in a perfectly black image. | ||
|
||
``color_palette`` if not ``-1`` can be `sensor.PALETTE_RAINBOW`, `sensor.PALETTE_IRONBOW`, or | ||
a 256 pixel in total RGB565 image to use as a color lookup table on the grayscale value of | ||
whatever the input image is. This is applied after ``rgb_channel`` extraction if used. | ||
|
||
``alpha_palette`` if not ``-1`` can be a 256 pixel in total GRAYSCALE image to use as a alpha | ||
palette which modulates the ``alpha`` value of the input image being displayed at a pixel pixel | ||
level allowing you to precisely control the alpha value of pixels based on their grayscale value. | ||
A pixel value of 255 in the alpha lookup table is opaque which anything less than 255 becomes | ||
more transparent until 0. This is applied after ``rgb_channel`` extraction if used. | ||
|
||
``hint`` can be a logical OR of the flags: | ||
|
||
* `image.AREA`: Use area scaling when downscaling versus the default of nearest neighbor. | ||
* `image.BILINEAR`: Use bilinear scaling versus the default of nearest neighbor scaling. | ||
* `image.BICUBIC`: Use bicubic scaling versus the default of nearest neighbor scaling. | ||
* `image.CENTER`: Center the image image being displayed on (x, y). | ||
* `image.EXTRACT_RGB_CHANNEL_FIRST`: Do rgb_channel extraction before scaling. | ||
* `image.APPLY_COLOR_PALETTE_FIRST`: Apply color palette before scaling. | ||
|
||
``x_size`` may be passed if ``x_scale`` is not passed to specify the size of the image to display | ||
and ``x_scale`` will automatically be determined passed on the input image size. If neither | ||
``y_scale`` or ``y_size`` are specified then ``y_scale`` internally will be set to be equal to | ||
``x_size`` to maintain the aspect-ratio. | ||
|
||
``y_size`` may be passed if ``y_scale`` is not passed to specify the size of the image to display | ||
and ``y_scale`` will automatically be determined passed on the input image size. If neither | ||
``x_scale`` or ``x_size`` are specified then ``x_scale`` internally will be set to be equal to | ||
``y_size`` to maintain the aspect-ratio. | ||
|
||
.. method:: DSIDisplay.clear([display_off=False]) | ||
|
||
Clears the lcd screen to black. | ||
|
||
``display_off`` if True instead turns off the display logic versus clearing the frame LCD | ||
frame buffer to black. You should also turn off the backlight too after this to ensure the | ||
screen goes to black as many displays are white when only the backlight is on. | ||
|
||
.. method:: DSIDisplay.backlight([value]) | ||
|
||
Sets the lcd backlight dimming value. 0 (off) to 255 (on). | ||
|
||
This controls a PWM signal to a standard backlight dimming circuit. | ||
|
||
Pass no arguments to get the state of the backlight value. | ||
|
||
.. method:: DSIDisplay.dsi_write(cmd, [args=None, [dcs=False]]) | ||
|
||
Send the DSI Display ``cmd`` with ``args``. | ||
|
||
.. method:: DSIDisplay.dsi_read(cmd, [len, [args=None, [dcs=False]]]) | ||
|
||
Read ``len`` using ``cmd`` with ``args`` from the DSI Display. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
.. currentmodule:: display | ||
.. _display.RGBDisplay: | ||
|
||
class RGBDisplay -- RGB Display Driver | ||
====================================== | ||
|
||
The `RGBDisplay` class is used for driving 24-bit parallel LCDs. | ||
|
||
Example usage for driving the 800x480 24-bit Parallel LCD:: | ||
|
||
import sensor, display | ||
|
||
# Setup camera. | ||
sensor.reset() | ||
sensor.set_pixformat(sensor.RGB565) | ||
sensor.set_framesize(sensor.LCD) | ||
sensor.skip_frames() | ||
lcd = display.RGBDisplay() | ||
|
||
# Show image. | ||
while(True): | ||
lcd.write(sensor.snapshot()) | ||
|
||
Constructors | ||
------------ | ||
|
||
.. class:: display.RGBDisplay([framesize=display.FWVGA, [refresh=60, [display_on=True, [portrait=False, [controller]]]]]) | ||
|
||
``framesize`` One of the standard supported resolutions. | ||
|
||
``refresh`` Sets the LCD refresh rate in hertz. This controls the SPI LCD shield clock. | ||
|
||
``display_on`` Enables the display. Pass `False` here when the 24-bit parallel LCD output is | ||
shared by multiple devices like the TFP410 chip for driving HDMI displays to keep the display | ||
off while driving the databus still. | ||
|
||
``portrait`` Swap the framesize width and height. | ||
|
||
``controller`` Pass the controller chip class here to initialize it along with the display. | ||
|
||
Methods | ||
------- | ||
|
||
.. method:: RGBDisplay.deinit() | ||
|
||
Releases the I/O pins and RAM used by the class. This is called automatically on destruction. | ||
|
||
.. method:: RGBDisplay.width() | ||
|
||
Returns the width of the screen. | ||
|
||
.. method:: RGBDisplay.height() | ||
|
||
Returns the height of the screen. | ||
|
||
.. method:: RGBDisplay.refresh() | ||
|
||
Returns the refresh rate. | ||
|
||
.. method:: RGBDisplay.write(image, [x=0, [y=0, [x_scale=1.0, [y_scale=1.0, [roi=None, [rgb_channel=-1, [alpha=256, [color_palette=None, [alpha_palette=None, [hint=0, [x_size=None, [y_size=None]]]]]]]]]]]]) | ||
|
||
Displays an ``image`` whose top-left corner starts at location x, y. You may either pass x, y | ||
separately, as a tuple (x, y), or neither. | ||
|
||
``x_scale`` controls how much the displayed image is scaled by in the x direction (float). If this | ||
value is negative the image will be flipped horizontally. | ||
|
||
``y_scale`` controls how much the displayed image is scaled by in the y direction (float). If this | ||
value is negative the image will be flipped vertically. | ||
|
||
``roi`` is the region-of-interest rectangle tuple (x, y, w, h) of the image to display. This | ||
allows you to extract just the pixels in the ROI to scale. | ||
|
||
``rgb_channel`` is the RGB channel (0=R, G=1, B=2) to extract from an RGB565 image (if passed) | ||
and to render on the display. For example, if you pass ``rgb_channel=1`` this will | ||
extract the green channel of the RGB565 image and display that in grayscale. | ||
|
||
``alpha`` controls how opaque the image is. A value of 256 displays an opaque image while a | ||
value lower than 256 produces a black transparent image. 0 results in a perfectly black image. | ||
|
||
``color_palette`` if not ``-1`` can be `sensor.PALETTE_RAINBOW`, `sensor.PALETTE_IRONBOW`, or | ||
a 256 pixel in total RGB565 image to use as a color lookup table on the grayscale value of | ||
whatever the input image is. This is applied after ``rgb_channel`` extraction if used. | ||
|
||
``alpha_palette`` if not ``-1`` can be a 256 pixel in total GRAYSCALE image to use as a alpha | ||
palette which modulates the ``alpha`` value of the input image being displayed at a pixel pixel | ||
level allowing you to precisely control the alpha value of pixels based on their grayscale value. | ||
A pixel value of 255 in the alpha lookup table is opaque which anything less than 255 becomes | ||
more transparent until 0. This is applied after ``rgb_channel`` extraction if used. | ||
|
||
``hint`` can be a logical OR of the flags: | ||
|
||
* `image.AREA`: Use area scaling when downscaling versus the default of nearest neighbor. | ||
* `image.BILINEAR`: Use bilinear scaling versus the default of nearest neighbor scaling. | ||
* `image.BICUBIC`: Use bicubic scaling versus the default of nearest neighbor scaling. | ||
* `image.CENTER`: Center the image image being displayed on (x, y). | ||
* `image.EXTRACT_RGB_CHANNEL_FIRST`: Do rgb_channel extraction before scaling. | ||
* `image.APPLY_COLOR_PALETTE_FIRST`: Apply color palette before scaling. | ||
|
||
``x_size`` may be passed if ``x_scale`` is not passed to specify the size of the image to display | ||
and ``x_scale`` will automatically be determined passed on the input image size. If neither | ||
``y_scale`` or ``y_size`` are specified then ``y_scale`` internally will be set to be equal to | ||
``x_size`` to maintain the aspect-ratio. | ||
|
||
``y_size`` may be passed if ``y_scale`` is not passed to specify the size of the image to display | ||
and ``y_scale`` will automatically be determined passed on the input image size. If neither | ||
``x_scale`` or ``x_size`` are specified then ``x_scale`` internally will be set to be equal to | ||
``y_size`` to maintain the aspect-ratio. | ||
|
||
.. method:: RGBDisplay.clear([display_off=False]) | ||
|
||
Clears the lcd screen to black. | ||
|
||
``display_off`` if True instead turns off the display logic versus clearing the frame LCD | ||
frame buffer to black. You should also turn off the backlight too after this to ensure the | ||
screen goes to black as many displays are white when only the backlight is on. | ||
|
||
.. method:: RGBDisplay.backlight([value]) | ||
|
||
Sets the lcd backlight dimming value. 0 (off) to 255 (on). | ||
|
||
This controls a PWM signal to a standard backlight dimming circuit. | ||
|
||
Pass no arguments to get the state of the backlight value. |
Oops, something went wrong.