2019-01-16 15:04:42 -05:00
/*
* This file is part of the Micro Python project , http : //micropython.org/
*
* The MIT License ( MIT )
*
* Copyright ( c ) 2018 Scott Shawcroft for Adafruit Industries
*
* Permission is hereby granted , free of charge , to any person obtaining a copy
* of this software and associated documentation files ( the " Software " ) , to deal
* in the Software without restriction , including without limitation the rights
* to use , copy , modify , merge , publish , distribute , sublicense , and / or sell
* copies of the Software , and to permit persons to whom the Software is
* furnished to do so , subject to the following conditions :
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software .
*
* THE SOFTWARE IS PROVIDED " AS IS " , WITHOUT WARRANTY OF ANY KIND , EXPRESS OR
* IMPLIED , INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY ,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT . IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM , DAMAGES OR OTHER
* LIABILITY , WHETHER IN AN ACTION OF CONTRACT , TORT OR OTHERWISE , ARISING FROM ,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE .
*/
# include "shared-bindings/displayio/Display.h"
# include <stdint.h>
# include "lib/utils/context_manager_helpers.h"
# include "py/binary.h"
# include "py/objproperty.h"
2019-05-13 20:31:30 -04:00
# include "py/objtype.h"
2019-01-16 15:04:42 -05:00
# include "py/runtime.h"
# include "shared-bindings/displayio/Group.h"
# include "shared-bindings/microcontroller/Pin.h"
# include "shared-bindings/util.h"
# include "shared-module/displayio/__init__.h"
# include "supervisor/shared/translate.h"
//| .. currentmodule:: displayio
//|
2019-01-17 03:20:16 -05:00
//| :class:`Display` -- Manage updating a display over a display bus
2019-01-16 15:04:42 -05:00
//| ==========================================================================
//|
2019-01-17 03:20:16 -05:00
//| This initializes a display and connects it into CircuitPython. Unlike other
//| objects in CircuitPython, Display objects live until `displayio.release_displays()`
//| is called. This is done so that CircuitPython can use the display itself.
2019-01-16 15:04:42 -05:00
//|
2019-02-01 03:32:03 -05:00
//| Most people should not use this class directly. Use a specific display driver instead that will
//| contain the initialization sequence at minimum.
//|
2019-07-24 16:25:34 -04:00
//| .. class:: Display(display_bus, init_sequence, *, width, height, colstart=0, rowstart=0, rotation=0, color_depth=16, grayscale=False, pixels_in_byte_share_row=True, bytes_per_cell=1, reverse_pixels_in_byte=False, set_column_command=0x2a, set_row_command=0x2b, write_ram_command=0x2c, set_vertical_scroll=0, backlight_pin=None, brightness_command=None, brightness=1.0, auto_brightness=False, single_byte_bounds=False, data_as_commands=False)
2019-01-16 15:04:42 -05:00
//|
2019-01-18 15:59:23 -05:00
//| Create a Display object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
//|
2019-02-01 03:32:03 -05:00
//| The ``init_sequence`` is bitpacked to minimize the ram impact. Every command begins with a
2019-01-18 15:59:23 -05:00
//| command byte followed by a byte to determine the parameter count and if a delay is need after.
//| When the top bit of the second byte is 1, the next byte will be the delay time in milliseconds.
//| The remaining 7 bits are the parameter count excluding any delay byte. The third through final
//| bytes are the remaining command parameters. The next byte will begin a new command definition.
//| Here is a portion of ILI9341 init code:
//|
//| .. code-block:: python
//|
//| init_sequence = (b"\xe1\x0f\x00\x0E\x14\x03\x11\x07\x31\xC1\x48\x08\x0F\x0C\x31\x36\x0F" # Set Gamma
//| b"\x11\x80\x78"# Exit Sleep then delay 0x78 (120ms)
//| b"\x29\x80\x78"# Display on then delay 0x78 (120ms)
//| )
//| display = displayio.Display(display_bus, init_sequence, width=320, height=240)
//|
//| The first command is 0xe1 with 15 (0xf) parameters following. The second and third are 0x11 and
//| 0x29 respectively with delays (0x80) of 120ms (0x78) and no parameters. Multiple byte literals
//| (b"") are merged together on load. The parens are needed to allow byte literals on subsequent
//| lines.
//|
2019-02-01 03:32:03 -05:00
//| The initialization sequence should always leave the display memory access inline with the scan
//| of the display to minimize tearing artifacts.
//|
2019-06-14 16:30:38 -04:00
//| :param display_bus: The bus that the display is connected to
//| :type display_bus: displayio.FourWire or displayio.ParallelBus
2019-01-18 15:59:23 -05:00
//| :param buffer init_sequence: Byte-packed initialization sequence.
//| :param int width: Width in pixels
//| :param int height: Height in pixels
//| :param int colstart: The index if the first visible column
//| :param int rowstart: The index if the first visible row
2019-02-01 12:33:33 -05:00
//| :param int rotation: The rotation of the display in degrees clockwise. Must be in 90 degree increments (0, 90, 180, 270)
2019-01-18 15:59:23 -05:00
//| :param int color_depth: The number of bits of color per pixel transmitted. (Some displays
//| support 18 bit but 16 is easier to transmit. The last bit is extrapolated.)
2019-07-05 22:01:54 -04:00
//| :param bool grayscale: True if the display only shows a single color.
//| :param bool pixels_in_byte_share_row: True when pixels are less than a byte and a byte includes pixels from the same row of the display. When False, pixels share a column.
2019-07-24 16:25:34 -04:00
//| :param int bytes_per_cell: Number of bytes per addressable memory location when color_depth < 8. When greater than one, bytes share a row or column according to pixels_in_byte_share_row.
//| :param bool reverse_pixels_in_byte: Reverses the pixel order within each byte when color_depth < 8. Does not apply across multiple bytes even if there is more than one byte per cell (bytes_per_cell.)
2019-01-18 15:59:23 -05:00
//| :param int set_column_command: Command used to set the start and end columns to update
//| :param int set_row_command: Command used so set the start and end rows to update
2019-07-05 22:01:54 -04:00
//| :param int write_ram_command: Command used to write pixels values into the update region. Ignored if data_as_commands is set.
2019-02-01 03:32:03 -05:00
//| :param int set_vertical_scroll: Command used to set the first row to show
2019-01-28 21:23:32 -05:00
//| :param microcontroller.Pin backlight_pin: Pin connected to the display's backlight
2019-07-05 22:01:54 -04:00
//| :param int brightness_command: Command to set display brightness. Usually available in OLED controllers.
2019-04-18 15:59:16 -04:00
//| :param bool brightness: Initial display brightness. This value is ignored if auto_brightness is True.
//| :param bool auto_brightness: If True, brightness is controlled via an ambient light sensor or other mechanism.
2019-03-25 02:59:28 -04:00
//| :param bool single_byte_bounds: Display column and row commands use single bytes
2019-04-05 02:15:00 -04:00
//| :param bool data_as_commands: Treat all init and boundary data as SPI commands. Certain displays require this.
2019-01-16 15:04:42 -05:00
//|
STATIC mp_obj_t displayio_display_make_new ( const mp_obj_type_t * type , size_t n_args , const mp_obj_t * pos_args , mp_map_t * kw_args ) {
2019-07-24 16:25:34 -04:00
enum { ARG_display_bus , ARG_init_sequence , ARG_width , ARG_height , ARG_colstart , ARG_rowstart , ARG_rotation , ARG_color_depth , ARG_grayscale , ARG_pixels_in_byte_share_row , ARG_bytes_per_cell , ARG_reverse_pixels_in_byte , ARG_set_column_command , ARG_set_row_command , ARG_write_ram_command , ARG_set_vertical_scroll , ARG_backlight_pin , ARG_brightness_command , ARG_brightness , ARG_auto_brightness , ARG_single_byte_bounds , ARG_data_as_commands } ;
2019-01-16 15:04:42 -05:00
static const mp_arg_t allowed_args [ ] = {
{ MP_QSTR_display_bus , MP_ARG_REQUIRED | MP_ARG_OBJ } ,
{ MP_QSTR_init_sequence , MP_ARG_REQUIRED | MP_ARG_OBJ } ,
2019-01-18 19:37:06 -05:00
{ MP_QSTR_width , MP_ARG_INT | MP_ARG_KW_ONLY | MP_ARG_REQUIRED , } ,
{ MP_QSTR_height , MP_ARG_INT | MP_ARG_KW_ONLY | MP_ARG_REQUIRED , } ,
2019-01-16 15:04:42 -05:00
{ MP_QSTR_colstart , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 0 } } ,
{ MP_QSTR_rowstart , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 0 } } ,
2019-02-01 03:32:03 -05:00
{ MP_QSTR_rotation , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 0 } } ,
2019-01-16 15:04:42 -05:00
{ MP_QSTR_color_depth , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 16 } } ,
2019-07-05 22:01:54 -04:00
{ MP_QSTR_grayscale , MP_ARG_BOOL | MP_ARG_KW_ONLY , { . u_bool = false } } ,
{ MP_QSTR_pixels_in_byte_share_row , MP_ARG_BOOL | MP_ARG_KW_ONLY , { . u_bool = true } } ,
2019-07-24 16:25:34 -04:00
{ MP_QSTR_bytes_per_cell , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 1 } } ,
{ MP_QSTR_reverse_pixels_in_byte , MP_ARG_BOOL | MP_ARG_KW_ONLY , { . u_bool = false } } ,
2019-01-16 15:04:42 -05:00
{ MP_QSTR_set_column_command , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 0x2a } } ,
{ MP_QSTR_set_row_command , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 0x2b } } ,
{ MP_QSTR_write_ram_command , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 0x2c } } ,
2019-02-01 03:32:03 -05:00
{ MP_QSTR_set_vertical_scroll , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = 0x0 } } ,
2019-01-28 21:23:32 -05:00
{ MP_QSTR_backlight_pin , MP_ARG_OBJ | MP_ARG_KW_ONLY , { . u_obj = mp_const_none } } ,
2019-07-19 19:05:13 -04:00
{ MP_QSTR_brightness_command , MP_ARG_INT | MP_ARG_KW_ONLY , { . u_int = NO_BRIGHTNESS_COMMAND } } ,
2019-04-18 15:59:16 -04:00
{ MP_QSTR_brightness , MP_ARG_OBJ | MP_ARG_KW_ONLY , { . u_obj = MP_OBJ_NEW_SMALL_INT ( 1 ) } } ,
{ MP_QSTR_auto_brightness , MP_ARG_BOOL | MP_ARG_KW_ONLY , { . u_bool = false } } ,
2019-03-25 02:59:28 -04:00
{ MP_QSTR_single_byte_bounds , MP_ARG_BOOL | MP_ARG_KW_ONLY , { . u_bool = false } } ,
2019-04-05 02:15:00 -04:00
{ MP_QSTR_data_as_commands , MP_ARG_BOOL | MP_ARG_KW_ONLY , { . u_bool = false } } ,
2019-01-16 15:04:42 -05:00
} ;
mp_arg_val_t args [ MP_ARRAY_SIZE ( allowed_args ) ] ;
mp_arg_parse_all ( n_args , pos_args , kw_args , MP_ARRAY_SIZE ( allowed_args ) , allowed_args , args ) ;
mp_obj_t display_bus = args [ ARG_display_bus ] . u_obj ;
mp_buffer_info_t bufinfo ;
mp_get_buffer_raise ( args [ ARG_init_sequence ] . u_obj , & bufinfo , MP_BUFFER_READ ) ;
2019-01-31 14:00:12 -05:00
mp_obj_t backlight_pin_obj = args [ ARG_backlight_pin ] . u_obj ;
assert_pin ( backlight_pin_obj , true ) ;
const mcu_pin_obj_t * backlight_pin = NULL ;
if ( backlight_pin_obj ! = NULL & & backlight_pin_obj ! = mp_const_none ) {
backlight_pin = MP_OBJ_TO_PTR ( backlight_pin_obj ) ;
assert_pin_free ( backlight_pin ) ;
}
2019-04-18 15:59:16 -04:00
mp_float_t brightness = mp_obj_get_float ( args [ ARG_brightness ] . u_obj ) ;
2019-02-01 03:32:03 -05:00
mp_int_t rotation = args [ ARG_rotation ] . u_int ;
if ( rotation % 90 ! = 0 ) {
mp_raise_ValueError ( translate ( " Display rotation must be in 90 degree increments " ) ) ;
}
2019-01-28 21:23:32 -05:00
2019-01-17 03:20:16 -05:00
displayio_display_obj_t * self = NULL ;
for ( uint8_t i = 0 ; i < CIRCUITPY_DISPLAY_LIMIT ; i + + ) {
2019-01-17 21:19:07 -05:00
if ( displays [ i ] . display . base . type = = NULL | |
displays [ i ] . display . base . type = = & mp_type_NoneType ) {
2019-01-17 03:20:16 -05:00
self = & displays [ i ] . display ;
break ;
}
}
if ( self = = NULL ) {
2019-01-18 19:37:06 -05:00
mp_raise_RuntimeError ( translate ( " Too many displays " ) ) ;
2019-01-16 15:04:42 -05:00
}
self - > base . type = & displayio_display_type ;
2019-04-18 15:59:16 -04:00
common_hal_displayio_display_construct (
self ,
display_bus , args [ ARG_width ] . u_int , args [ ARG_height ] . u_int , args [ ARG_colstart ] . u_int , args [ ARG_rowstart ] . u_int , rotation ,
2019-07-24 16:25:34 -04:00
args [ ARG_color_depth ] . u_int , args [ ARG_grayscale ] . u_bool ,
args [ ARG_pixels_in_byte_share_row ] . u_bool , args [ ARG_bytes_per_cell ] . u_bool , args [ ARG_reverse_pixels_in_byte ] . u_bool ,
2019-07-05 22:01:54 -04:00
args [ ARG_set_column_command ] . u_int , args [ ARG_set_row_command ] . u_int ,
2019-04-18 15:59:16 -04:00
args [ ARG_write_ram_command ] . u_int ,
args [ ARG_set_vertical_scroll ] . u_int ,
bufinfo . buf , bufinfo . len ,
MP_OBJ_TO_PTR ( backlight_pin ) ,
2019-07-05 22:01:54 -04:00
args [ ARG_brightness_command ] . u_int ,
2019-04-18 15:59:16 -04:00
brightness ,
args [ ARG_auto_brightness ] . u_bool ,
args [ ARG_single_byte_bounds ] . u_bool ,
args [ ARG_data_as_commands ] . u_bool
) ;
2019-01-16 15:04:42 -05:00
return self ;
}
2019-04-05 16:03:03 -04:00
// Helper to ensure we have the native super class instead of a subclass.
static displayio_display_obj_t * native_display ( mp_obj_t display_obj ) {
mp_obj_t native_display = mp_instance_cast_to_native_base ( display_obj , & displayio_display_type ) ;
2019-05-13 20:31:30 -04:00
mp_obj_assert_native_inited ( native_display ) ;
2019-04-05 16:03:03 -04:00
return MP_OBJ_TO_PTR ( native_display ) ;
}
2019-01-16 15:04:42 -05:00
//| .. method:: show(group)
//|
2019-01-31 13:29:29 -05:00
//| Switches to displaying the given group of layers. When group is None, the default
//| CircuitPython terminal will be shown.
2019-01-16 15:04:42 -05:00
//|
2019-06-14 16:30:38 -04:00
//| :param Group group: The group to show.
2019-01-16 15:04:42 -05:00
STATIC mp_obj_t displayio_display_obj_show ( mp_obj_t self_in , mp_obj_t group_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-01-25 19:59:18 -05:00
displayio_group_t * group = NULL ;
if ( group_in ! = mp_const_none ) {
2019-05-13 20:31:30 -04:00
group = MP_OBJ_TO_PTR ( native_group ( group_in ) ) ;
2019-01-16 15:04:42 -05:00
}
2019-01-25 19:59:18 -05:00
2019-07-24 16:25:34 -04:00
bool ok = common_hal_displayio_display_show ( self , group ) ;
if ( ! ok ) {
mp_raise_ValueError ( translate ( " Group already used " ) ) ;
}
2019-01-16 15:04:42 -05:00
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_2 ( displayio_display_show_obj , displayio_display_obj_show ) ;
2019-08-14 17:17:35 -04:00
//| .. method:: refresh(*, target_frames_per_second=None, minimum_frames_per_second=1)
2019-01-16 15:04:42 -05:00
//|
2019-08-14 17:17:35 -04:00
//| Waits for the target frame rate and then refreshes the display. If the call is too late for the given target frame rate, then the refresh returns immediately without updating the screen to hopefully help getting caught up. If the current frame rate is below the minimum frame rate, then an exception will be raised.
2019-01-16 15:04:42 -05:00
//|
2019-08-14 17:17:35 -04:00
STATIC mp_obj_t displayio_display_obj_refresh ( mp_obj_t self_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-08-14 17:17:35 -04:00
common_hal_displayio_display_refresh ( self ) ;
2019-01-16 15:04:42 -05:00
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_refresh_soon_obj , displayio_display_obj_refresh_soon ) ;
2019-08-14 17:17:35 -04:00
//| .. attribute:: auto_refresh
2019-01-16 15:04:42 -05:00
//|
2019-08-14 17:17:35 -04:00
//| True when the display is refreshed automatically.
2019-01-16 15:04:42 -05:00
//|
2019-08-14 17:17:35 -04:00
STATIC mp_obj_t displayio_display_obj_get_auto_refresh ( mp_obj_t self_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-08-14 17:17:35 -04:00
return mp_obj_new_bool ( common_hal_displayio_display_get_auto_refresh ( self ) ) ;
2019-01-16 15:04:42 -05:00
}
2019-08-14 17:17:35 -04:00
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_get_auto_refresh_obj , displayio_display_obj_get_auto_refresh ) ;
STATIC mp_obj_t displayio_display_obj_set_auto_refresh ( mp_obj_t self_in , mp_obj_t auto_refresh ) {
displayio_display_obj_t * self = native_display ( self_in ) ;
common_hal_displayio_display_set_auto_refresh ( self , mp_obj_is_true ( auto_refresh ) ) ;
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_2 ( displayio_display_set_auto_refresh_obj , displayio_display_obj_set_auto_refresh ) ;
const mp_obj_property_t displayio_display_auto_refresh_obj = {
. base . type = & mp_type_property ,
. proxy = { ( mp_obj_t ) & displayio_display_get_auto_refresh_obj ,
( mp_obj_t ) & displayio_display_set_auto_refresh_obj ,
( mp_obj_t ) & mp_const_none_obj } ,
} ;
2019-01-16 15:04:42 -05:00
2019-01-28 21:23:32 -05:00
//| .. attribute:: brightness
//|
//| The brightness of the display as a float. 0.0 is off and 1.0 is full brightness. When
2019-04-18 13:57:27 -04:00
//| `auto_brightness` is True, the value of `brightness` will change automatically.
//| If `brightness` is set, `auto_brightness` will be disabled and will be set to False.
2019-01-28 21:23:32 -05:00
//|
STATIC mp_obj_t displayio_display_obj_get_brightness ( mp_obj_t self_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-01-28 21:23:32 -05:00
mp_float_t brightness = common_hal_displayio_display_get_brightness ( self ) ;
if ( brightness < 0 ) {
mp_raise_RuntimeError ( translate ( " Brightness not adjustable " ) ) ;
}
return mp_obj_new_float ( brightness ) ;
}
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_get_brightness_obj , displayio_display_obj_get_brightness ) ;
2019-07-19 19:05:13 -04:00
STATIC mp_obj_t displayio_display_obj_set_brightness ( mp_obj_t self_in , mp_obj_t brightness_obj ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-04-18 13:57:27 -04:00
common_hal_displayio_display_set_auto_brightness ( self , false ) ;
2019-07-19 19:05:13 -04:00
mp_float_t brightness = mp_obj_get_float ( brightness_obj ) ;
if ( brightness < 0 | | brightness > 1.0 ) {
mp_raise_ValueError ( translate ( " Brightness must be 0-1.0 " ) ) ;
}
bool ok = common_hal_displayio_display_set_brightness ( self , brightness ) ;
2019-01-28 21:23:32 -05:00
if ( ! ok ) {
mp_raise_RuntimeError ( translate ( " Brightness not adjustable " ) ) ;
}
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_2 ( displayio_display_set_brightness_obj , displayio_display_obj_set_brightness ) ;
const mp_obj_property_t displayio_display_brightness_obj = {
. base . type = & mp_type_property ,
. proxy = { ( mp_obj_t ) & displayio_display_get_brightness_obj ,
( mp_obj_t ) & displayio_display_set_brightness_obj ,
( mp_obj_t ) & mp_const_none_obj } ,
} ;
//| .. attribute:: auto_brightness
//|
2019-04-18 13:57:27 -04:00
//| True when the display brightness is adjusted automatically, based on an ambient
//| light sensor or other method. Note that some displays may have this set to True by default,
//| but not actually implement automatic brightness adjustment. `auto_brightness` is set to False
//| if `brightness` is set manually.
2019-01-28 21:23:32 -05:00
//|
STATIC mp_obj_t displayio_display_obj_get_auto_brightness ( mp_obj_t self_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-01-28 21:23:32 -05:00
return mp_obj_new_bool ( common_hal_displayio_display_get_auto_brightness ( self ) ) ;
}
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_get_auto_brightness_obj , displayio_display_obj_get_auto_brightness ) ;
STATIC mp_obj_t displayio_display_obj_set_auto_brightness ( mp_obj_t self_in , mp_obj_t auto_brightness ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-01-28 21:23:32 -05:00
common_hal_displayio_display_set_auto_brightness ( self , mp_obj_is_true ( auto_brightness ) ) ;
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_2 ( displayio_display_set_auto_brightness_obj , displayio_display_obj_set_auto_brightness ) ;
2019-03-02 17:50:10 -05:00
const mp_obj_property_t displayio_display_auto_brightness_obj = {
. base . type = & mp_type_property ,
. proxy = { ( mp_obj_t ) & displayio_display_get_auto_brightness_obj ,
( mp_obj_t ) & displayio_display_set_auto_brightness_obj ,
( mp_obj_t ) & mp_const_none_obj } ,
} ;
2019-02-25 19:39:20 -05:00
//| .. attribute:: width
//|
//| Gets the width of the board
//|
//|
STATIC mp_obj_t displayio_display_obj_get_width ( mp_obj_t self_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-03-06 00:25:09 -05:00
return MP_OBJ_NEW_SMALL_INT ( common_hal_displayio_display_get_width ( self ) ) ;
2019-02-25 19:39:20 -05:00
}
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_get_width_obj , displayio_display_obj_get_width ) ;
2019-03-02 17:50:10 -05:00
const mp_obj_property_t displayio_display_width_obj = {
. base . type = & mp_type_property ,
. proxy = { ( mp_obj_t ) & displayio_display_get_width_obj ,
( mp_obj_t ) & mp_const_none_obj ,
( mp_obj_t ) & mp_const_none_obj } ,
} ;
2019-02-25 19:39:20 -05:00
//| .. attribute:: height
//|
//| Gets the height of the board
//|
//|
STATIC mp_obj_t displayio_display_obj_get_height ( mp_obj_t self_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-03-06 00:25:09 -05:00
return MP_OBJ_NEW_SMALL_INT ( common_hal_displayio_display_get_height ( self ) ) ;
2019-02-25 19:39:20 -05:00
}
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_get_height_obj , displayio_display_obj_get_height ) ;
2019-03-02 17:50:10 -05:00
const mp_obj_property_t displayio_display_height_obj = {
2019-01-28 21:23:32 -05:00
. base . type = & mp_type_property ,
2019-03-02 17:50:10 -05:00
. proxy = { ( mp_obj_t ) & displayio_display_get_height_obj ,
( mp_obj_t ) & mp_const_none_obj ,
2019-01-28 21:23:32 -05:00
( mp_obj_t ) & mp_const_none_obj } ,
} ;
2019-01-16 15:04:42 -05:00
2019-07-31 15:00:21 -04:00
//| .. attribute:: rotation
//|
//| The rotation of the display as an int in degrees.
//|
STATIC mp_obj_t displayio_display_obj_get_rotation ( mp_obj_t self_in ) {
displayio_display_obj_t * self = native_display ( self_in ) ;
return MP_OBJ_NEW_SMALL_INT ( common_hal_displayio_display_get_rotation ( self ) ) ;
}
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_get_rotation_obj , displayio_display_obj_get_rotation ) ;
const mp_obj_property_t displayio_display_rotation_obj = {
. base . type = & mp_type_property ,
. proxy = { ( mp_obj_t ) & displayio_display_get_rotation_obj ,
( mp_obj_t ) & mp_const_none_obj ,
( mp_obj_t ) & mp_const_none_obj } ,
} ;
2019-04-06 08:25:08 -04:00
//| .. attribute:: bus
//|
//| The bus being used by the display
//|
//|
STATIC mp_obj_t displayio_display_obj_get_bus ( mp_obj_t self_in ) {
2019-04-05 16:03:03 -04:00
displayio_display_obj_t * self = native_display ( self_in ) ;
2019-04-06 08:25:08 -04:00
return self - > bus ;
}
MP_DEFINE_CONST_FUN_OBJ_1 ( displayio_display_get_bus_obj , displayio_display_obj_get_bus ) ;
const mp_obj_property_t displayio_display_bus_obj = {
. base . type = & mp_type_property ,
. proxy = { ( mp_obj_t ) & displayio_display_get_bus_obj ,
( mp_obj_t ) & mp_const_none_obj ,
( mp_obj_t ) & mp_const_none_obj } ,
} ;
2019-08-16 21:10:09 -04:00
//| .. method:: fill_row(y, buffer)
2019-07-25 15:05:30 -04:00
//|
2019-08-20 10:03:36 -04:00
//| Extract the pixels from a single row
2019-07-25 15:05:30 -04:00
//|
//| :param int y: The top edge of the area
2019-08-16 21:10:09 -04:00
//| :param bytearray buffer: The buffer in which to place the pixel data
STATIC mp_obj_t displayio_display_obj_fill_row ( size_t n_args , const mp_obj_t * pos_args , mp_map_t * kw_args ) {
2019-08-20 10:05:09 -04:00
enum { ARG_y , ARG_buffer } ;
2019-07-25 15:05:30 -04:00
static const mp_arg_t allowed_args [ ] = {
2019-08-20 10:05:09 -04:00
{ MP_QSTR_y , MP_ARG_INT | MP_ARG_REQUIRED , { . u_int = - 1 } } ,
{ MP_QSTR_buffer , MP_ARG_OBJ | MP_ARG_REQUIRED , { } } ,
2019-07-25 15:05:30 -04:00
} ;
mp_arg_val_t args [ MP_ARRAY_SIZE ( allowed_args ) ] ;
mp_arg_parse_all ( n_args - 1 , pos_args + 1 , kw_args , MP_ARRAY_SIZE ( allowed_args ) , allowed_args , args ) ;
displayio_display_obj_t * self = native_display ( pos_args [ 0 ] ) ;
mp_int_t y = args [ ARG_y ] . u_int ;
2019-08-21 15:24:39 -04:00
mp_obj_t * result = args [ ARG_buffer ] . u_obj ;
2019-08-07 15:27:43 -04:00
2019-08-20 17:00:24 -04:00
mp_buffer_info_t bufinfo ;
mp_get_buffer_raise ( result , & bufinfo , MP_BUFFER_WRITE ) ;
2019-08-21 15:24:39 -04:00
if ( bufinfo . typecode ! = BYTEARRAY_TYPECODE ) {
2019-08-16 21:10:09 -04:00
mp_raise_ValueError ( translate ( " Buffer is not a bytearray. " ) ) ;
}
if ( self - > colorspace . depth ! = 16 ) {
mp_raise_ValueError ( translate ( " Display must have a 16 bit colorspace. " ) ) ;
2019-08-07 15:27:43 -04:00
}
2019-07-25 15:05:30 -04:00
displayio_area_t area = {
2019-08-16 21:10:09 -04:00
. x1 = 0 ,
2019-07-25 15:05:30 -04:00
. y1 = y ,
2019-08-16 21:10:09 -04:00
. x2 = self - > width ,
. y2 = y + 1
2019-07-25 15:05:30 -04:00
} ;
uint8_t pixels_per_word = ( sizeof ( uint32_t ) * 8 ) / self - > colorspace . depth ;
2019-08-16 21:10:09 -04:00
uint16_t buffer_size = self - > width / pixels_per_word ;
uint16_t pixels_per_buffer = displayio_area_size ( & area ) ;
if ( pixels_per_buffer % pixels_per_word ) {
buffer_size + = 1 ;
2019-07-25 15:05:30 -04:00
}
2019-08-20 10:05:41 -04:00
uint32_t * result_buffer = bufinfo . buf ;
size_t result_buffer_size = bufinfo . len ;
if ( result_buffer_size > = ( buffer_size * 4 ) ) {
volatile uint32_t mask_length = ( pixels_per_buffer / 32 ) + 1 ;
uint32_t mask [ mask_length ] ;
for ( uint16_t k = 0 ; k < mask_length ; k + + ) {
mask [ k ] = 0x00000000 ;
2019-07-31 12:47:32 -04:00
}
2019-08-20 10:05:41 -04:00
displayio_display_fill_area ( self , & area , mask , result_buffer ) ;
2019-08-07 15:27:43 -04:00
return result ;
} else {
mp_raise_ValueError ( translate ( " Buffer is too small " ) ) ;
2019-07-25 15:05:30 -04:00
}
}
2019-08-16 21:10:09 -04:00
MP_DEFINE_CONST_FUN_OBJ_KW ( displayio_display_fill_row_obj , 1 , displayio_display_obj_fill_row ) ;
2019-07-25 15:05:30 -04:00
2019-01-16 15:04:42 -05:00
STATIC const mp_rom_map_elem_t displayio_display_locals_dict_table [ ] = {
{ MP_ROM_QSTR ( MP_QSTR_show ) , MP_ROM_PTR ( & displayio_display_show_obj ) } ,
{ MP_ROM_QSTR ( MP_QSTR_refresh_soon ) , MP_ROM_PTR ( & displayio_display_refresh_soon_obj ) } ,
{ MP_ROM_QSTR ( MP_QSTR_wait_for_frame ) , MP_ROM_PTR ( & displayio_display_wait_for_frame_obj ) } ,
2019-08-16 21:10:09 -04:00
{ MP_ROM_QSTR ( MP_QSTR_fill_row ) , MP_ROM_PTR ( & displayio_display_fill_row_obj ) } ,
2019-01-28 21:23:32 -05:00
2019-08-14 17:17:35 -04:00
{ MP_ROM_QSTR ( MP_QSTR_auto_refresh ) , MP_ROM_PTR ( & displayio_display_auto_refresh_obj ) } ,
2019-01-28 21:23:32 -05:00
{ MP_ROM_QSTR ( MP_QSTR_brightness ) , MP_ROM_PTR ( & displayio_display_brightness_obj ) } ,
{ MP_ROM_QSTR ( MP_QSTR_auto_brightness ) , MP_ROM_PTR ( & displayio_display_auto_brightness_obj ) } ,
2019-02-25 19:39:20 -05:00
2019-03-02 17:50:10 -05:00
{ MP_ROM_QSTR ( MP_QSTR_width ) , MP_ROM_PTR ( & displayio_display_width_obj ) } ,
{ MP_ROM_QSTR ( MP_QSTR_height ) , MP_ROM_PTR ( & displayio_display_height_obj ) } ,
2019-07-31 15:00:21 -04:00
{ MP_ROM_QSTR ( MP_QSTR_rotation ) , MP_ROM_PTR ( & displayio_display_rotation_obj ) } ,
2019-04-06 08:25:08 -04:00
{ MP_ROM_QSTR ( MP_QSTR_bus ) , MP_ROM_PTR ( & displayio_display_bus_obj ) } ,
2019-01-16 15:04:42 -05:00
} ;
STATIC MP_DEFINE_CONST_DICT ( displayio_display_locals_dict , displayio_display_locals_dict_table ) ;
const mp_obj_type_t displayio_display_type = {
{ & mp_type_type } ,
. name = MP_QSTR_Display ,
. make_new = displayio_display_make_new ,
. locals_dict = ( mp_obj_dict_t * ) & displayio_display_locals_dict ,
} ;