class LCD160CR

The LCD160CR class provides an interface to the display. Create aninstance of this class and use its methods to draw to the LCD and getthe status of the touch panel.

For example:

importlcd160crlcd=lcd160cr.LCD160CR('X')lcd.set_orient(lcd160cr.PORTRAIT)lcd.set_pos(0,0)lcd.set_text_color(lcd.rgb(255,0,0),lcd.rgb(0,0,0))lcd.set_font(1)lcd.write('Hello MicroPython!')print('touch:',lcd.get_touch())

Constructors

classlcd160cr.LCD160CR(connect=None,*,pwr=None,i2c=None,spi=None,i2c_addr=98)

Construct an LCD160CR object. The parameters are:

• connect is a string specifying the physical connection of the LCDdisplay to the board; valid values are “X”, “Y”, “XY”, “YX”.Use “X” when the display is connected to a pyboard in the X-skinposition, and “Y” when connected in the Y-skin position. “XY”and “YX” are used when the display is connected to the right orleft side of the pyboard, respectively.

• pwr is a Pin object connected to the LCD’s power/enabled pin.

• i2c is an I2C object connected to the LCD’s I2C interface.

• spi is an SPI object connected to the LCD’s SPI interface.

• i2c_addr is the I2C address of the display.

One must specify either a validconnect or all ofpwr,i2c andspi.If a validconnect is given then any ofpwr,i2c orspi which arenot passed as parameters (i.e. they areNone) will be created based on thevalue ofconnect. This allows to override the default interface to thedisplay if needed.

The default values are:

• “X” is for the X-skin and uses:pwr=Pin("X4"),i2c=I2C("X"),spi=SPI("X")

• “Y” is for the Y-skin and uses:pwr=Pin("Y4"),i2c=I2C("Y"),spi=SPI("Y")

• “XY” is for the right-side and uses:pwr=Pin("X4"),i2c=I2C("Y"),spi=SPI("X")

• “YX” is for the left-side and uses:pwr=Pin("Y4"),i2c=I2C("X"),spi=SPI("Y")

Seethis imagefor how the display can be connected to the pyboard.

Static methods

staticLCD160CR.rgb(r,g,b)

Return a 16-bit integer representing the given rgb color values. The16-bit value can be used to set the font color (seeLCD160CR.set_text_color()) pen color (seeLCD160CR.set_pen())and draw individual pixels.

LCD160CR.clip_line(data,w,h):

Clip the given line data. This is for internal use.

Instance members

The following instance members are publicly accessible.

LCD160CR.w

LCD160CR.h

The width and height of the display, respectively, in pixels. Thesemembers are updated when callingLCD160CR.set_orient() and shouldbe considered read-only.

Setup commands

LCD160CR.set_power(on)

Turn the display on or off, depending on the given value ofon: 0 orFalsewill turn the display off, and 1 orTrue will turn it on.

LCD160CR.set_orient(orient)

Set the orientation of the display. Theorient parameter can be oneofPORTRAIT,LANDSCAPE,PORTRAIT_UPSIDEDOWN,LANDSCAPE_UPSIDEDOWN.

LCD160CR.set_brightness(value)

Set the brightness of the display, between 0 and 31.

LCD160CR.set_i2c_addr(addr)

Set the I2C address of the display. Theaddr value must have thelower 2 bits cleared.

LCD160CR.set_uart_baudrate(baudrate)

Set the baudrate of the UART interface.

LCD160CR.set_startup_deco(value)

Set the start-up decoration of the display. Thevalue parameter can be alogical or ofSTARTUP_DECO_NONE,STARTUP_DECO_MLOGO,STARTUP_DECO_INFO.

LCD160CR.save_to_flash()

Save the following parameters to flash so they persist on restart and power up:initial decoration, orientation, brightness, UART baud rate, I2C address.

Pixel access methods

The following methods manipulate individual pixels on the display.

LCD160CR.set_pixel(x,y,c)

Set the specified pixel to the given color. The color should be a 16-bitinteger and can be created byLCD160CR.rgb().

LCD160CR.get_pixel(x,y)

Get the 16-bit value of the specified pixel.

LCD160CR.get_line(x,y,buf)

Low-level method to get a line of pixels into the given buffer.To readn pixelsbuf should be2*n+1 bytes in length. The first byteis a dummy byte and should be ignored, and subsequent bytes represent thepixels in the line starting at coordinate(x, y).

LCD160CR.screen_dump(buf,x=0,y=0,w=None,h=None)

Dump the contents of the screen to the given buffer. The parametersx andyspecify the starting coordinate, andw andh the size of the region. Ifworh areNone then they will take on their maximum values, set by the sizeof the screen minus the givenx andy values.buf should be large enoughto hold2*w*h bytes. If it’s smaller then only the initial horizontal lineswill be stored.

LCD160CR.screen_load(buf)

Load the entire screen from the given buffer.

Drawing text

To draw text one sets the position, color and font, and then usesLCD160CR.write to draw the text.

LCD160CR.set_pos(x,y)

Set the position for text output usingLCD160CR.write(). The positionis the upper-left corner of the text.

LCD160CR.set_text_color(fg,bg)

Set the foreground and background color of the text.

LCD160CR.set_font(font,scale=0,bold=0,trans=0,scroll=0)

Set the font for the text. Subsequent calls towrite will use the newlyconfigured font. The parameters are:

• font is the font family to use, valid values are 0, 1, 2, 3.

• scale is a scaling value for each character pixel, where the pixelsare drawn as a square with side length equal toscale + 1. The valuecan be between 0 and 63.

• bold controls the number of pixels to overdraw each character pixel,making a bold effect. The lower 2 bits ofbold are the number ofpixels to overdraw in the horizontal direction, and the next 2 bits arefor the vertical direction. For example, abold value of 5 willoverdraw 1 pixel in both the horizontal and vertical directions.

• trans can be either 0 or 1 and if set to 1 the characters will bedrawn with a transparent background.

• scroll can be either 0 or 1 and if set to 1 the display will do asoft scroll if the text moves to the next line.

LCD160CR.write(s)

Write text to the display, using the current position, color and font.As text is written the position is automatically incremented. Thedisplay supports basic VT100 control codes such as newline and backspace.

Drawing primitive shapes

Primitive drawing commands use a foreground and background color set by theset_pen method.

LCD160CR.set_pen(line,fill)

Set the line and fill color for primitive shapes.

LCD160CR.erase()

Erase the entire display to the pen fill color.

LCD160CR.dot(x,y)

Draw a single pixel at the given location using the pen line color.

LCD160CR.rect(x,y,w,h)

LCD160CR.rect_outline(x,y,w,h)

LCD160CR.rect_interior(x,y,w,h)

Draw a rectangle at the given location and size using the pen linecolor for the outline, and the pen fill color for the interior.Therect method draws the outline and interior, while the other methodsjust draw one or the other.

LCD160CR.line(x1,y1,x2,y2)

Draw a line between the given coordinates using the pen line color.

LCD160CR.dot_no_clip(x,y)

LCD160CR.rect_no_clip(x,y,w,h)

LCD160CR.rect_outline_no_clip(x,y,w,h)

LCD160CR.rect_interior_no_clip(x,y,w,h)

LCD160CR.line_no_clip(x1,y1,x2,y2)

These methods are as above but don’t do any clipping on the inputcoordinates. They are faster than the clipping versions and can beused when you know that the coordinates are within the display.

LCD160CR.poly_dot(data)

Draw a sequence of dots using the pen line color.Thedata should be a buffer of bytes, with each successive pair ofbytes corresponding to coordinate pairs (x, y).

LCD160CR.poly_line(data)

Similar toLCD160CR.poly_dot() but draws lines between the dots.

Touch screen methods

LCD160CR.touch_config(calib=False,save=False,irq=None)

Configure the touch panel:

• Ifcalib isTrue then the call will trigger a touch calibration ofthe resistive touch sensor. This requires the user to touch variousparts of the screen.

• Ifsave isTrue then the touch parameters will be saved to NVRAMto persist across reset/power up.

• Ifirq isTrue then the display will be configured to pull the IRQline low when a touch force is detected. Ifirq isFalse then thisfeature is disabled. Ifirq isNone (the default value) then nochange is made to this setting.

LCD160CR.is_touched()

Returns a boolean:True if there is currently a touch force on the screen,False otherwise.

LCD160CR.get_touch()

Returns a 3-tuple of:(active, x, y). If there is currently a touch forceon the screen thenactive is 1, otherwise it is 0. Thex andy valuesindicate the position of the current or most recent touch.

Advanced commands

LCD160CR.set_spi_win(x,y,w,h)

Set the window that SPI data is written to.

LCD160CR.fast_spi(flush=True)

Ready the display to accept RGB pixel data on the SPI bus, resetting the locationof the first byte to go to the top-left corner of the window set byLCD160CR.set_spi_win().The method returns an SPI object which can be used to write the pixel data.

Pixels should be sent as 16-bit RGB values in the 5-6-5 format. The destinationcounter will increase as data is sent, and data can be sent in arbitrary sizedchunks. Once the destination counter reaches the end of the window specified byLCD160CR.set_spi_win() it will wrap around to the top-left corner of that window.

LCD160CR.show_framebuf(buf)

Show the given buffer on the display.buf should be an array of bytes containingthe 16-bit RGB values for the pixels, and they will be written to the areaspecified byLCD160CR.set_spi_win(), starting from the top-left corner.

Theframebuf module can be used to construct frame buffersand provides drawing primitives. Using a frame buffer will improveperformance of animations when compared to drawing directly to the screen.

LCD160CR.set_scroll(on)

Turn scrolling on or off. This controls globally whether any window regions willscroll.

LCD160CR.set_scroll_win(win,x=-1,y=0,w=0,h=0,vec=0,pat=0,fill=0x07e0,color=0)

Configure a window region for scrolling:

• win is the window id to configure. There are 0..7 standard windows forgeneral purpose use. Window 8 is the text scroll window (the ticker).

• x,y,w,h specify the location of the window in the display.

• vec specifies the direction and speed of scroll: it is a 16-bit valueof the form0bF.ddSSSSSSSSSSSS.dd is 0, 1, 2, 3 for +x, +y, -x,-y scrolling.F sets the speed format, with 0 meaning that the windowis shiftedS % 256 pixel every frame, and 1 meaning that the windowis shifted 1 pixel everyS frames.

• pat is a 16-bit pattern mask for the background.

• fill is the fill color.

• color is the extra color, either of the text or pattern foreground.

LCD160CR.set_scroll_win_param(win,param,value)

Set a single parameter of a scrolling window region:

• win is the window id, 0..8.

• param is the parameter number to configure, 0..7, and correspondsto the parameters in theset_scroll_win method.

• value is the value to set.

LCD160CR.set_scroll_buf(s)

Set the string for scrolling in window 8. The parameters must be a stringwith length 32 or less.

LCD160CR.jpeg(buf)

Display a JPEG.buf should contain the entire JPEG data. JPEG data shouldnot include EXIF information. The following encodings are supported: BaselineDCT, Huffman coding, 8 bits per sample, 3 color components, YCbCr4:2:2.The origin of the JPEG is set byLCD160CR.set_pos().

LCD160CR.jpeg_start(total_len)

LCD160CR.jpeg_data(buf)

Display a JPEG with the data split across multiple buffers. There must bea single call tojpeg_start to begin with, specifying the total number ofbytes in the JPEG. Then this number of bytes must be transferred to thedisplay using one or more calls to thejpeg_data command.

LCD160CR.feed_wdt()

The first call to this method will start the display’s internal watchdogtimer. Subsequent calls will feed the watchdog. The timeout is roughly 30seconds.

LCD160CR.reset()

Reset the display.

Constants

lcd160cr.PORTRAIT

lcd160cr.LANDSCAPE

lcd160cr.PORTRAIT_UPSIDEDOWN

lcd160cr.LANDSCAPE_UPSIDEDOWN

Orientations of the display, used byLCD160CR.set_orient().

lcd160cr.STARTUP_DECO_NONE

lcd160cr.STARTUP_DECO_MLOGO

lcd160cr.STARTUP_DECO_INFO

Types of start-up decoration, can be OR’ed together, used byLCD160CR.set_startup_deco().