Api.h File Reference

Detailed Description

This file defines the interface for initializing the concrete implementation of the PicoDisplay driver using a 'TPipe' to communicate with an external executable that provides the actual Display/IO.

Note: The implementation creates a thread to execute the TPipe driver in.

TPipe Command format for the LCD Data
-------------------------------------
 
<DD> <HH:MM:SS.sss> writeLCDData <x0> <w> <y0> <h> <hexdata>
Where:
     <DD>                is CPU time since power-up/reset:  Format is: DD HH:MM:SS.sss
     <HH:MM:SS.sss>      is CPU time since power-up/reset:  Format is: DD HH:MM:SS.sss
     <x0>                Top/left X coordinate (in pixel coordinates) of the rectangle
     <w>                 Width (in display coordinates) of the rectangle. Note: <w> should always be greater than 0
     <y0>                Top/left Y coordinate (in pixel coordinates) of the rectangle
     <h>                 height (in display coordinates) of the rectangle. Note: <h> should always be greater than 0
     <hexdata>           Pixel data as 'ASCII HEX' String (upper case and with no spaces).  Each PIXEL is one byte 
                         Pixel layout is row, then column:
                             First Pixel is:   x0, y0
                             Pixel w is:       x0+w, y0
                             Pixel w+1 is:     x0, y0+1
                             Pixel (h*w) is:   x1, y1
 
NOTE: Color/Pixel size RGB322 color resolution
 
 
<DD> <HH:MM:SS.sss> updateLCD
Where:
     <DD>                is CPU time since power-up/reset:  Format is: DD HH:MM:SS.sss
     <HH:MM:SS.sss>      is CPU time since power-up/reset:  Format is: DD HH:MM:SS.sss
     
NOTE: The simulator makes a copy of the 'screen buffer' and ONLY sends 'deltas' to the simulated
      display.  This has significant positive impact on the performance of 'display' on the simulator

#include "colony_config.h"
#include "Cpl/Io/Input.h"
#include "Cpl/Io/Output.h"
#include "Driver/TPipe/Pipe.h"

Include dependency graph for Api.h:

Go to the source code of this file.

Namespaces
namespace	Driver
	namespace
namespace	Driver::PicoDisplay
	The 'PicoDisplay' namespace provides a top-level/composite driver that provides an abstraction that represents the physical hardware of the Pimoroni Pico Display board.
namespace	Driver::PicoDisplay::TPipe
	The 'TPipe' namespace implements the composite PicoDisplay driver using a 'TPipe' to communicate with an external executable that provides the actual Display/IO.

Macros
#define	OPTION_DRIVER_PICO_DISPLAY_TPIPE_RX_FRAME_HANDLER_SIZE   256
	The size, in bytes, of the receive frame buffer used for the TPipe connection.
#define	OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_A_NAME   "A"
	Symbolic name for button: A.
#define	OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_B_NAME   "B"
	Symbolic name for button: B.
#define	OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_X_NAME   "X"
	Symbolic name for button: X.
#define	OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_Y_NAME   "Y"
	Symbolic name for button: Y.
#define	OPTION_DRIVER_PICO_DISPLAY_TPIPE_RGB_LED_NAME   "theOne"
	Symbolic name for the RGB LED.
#define	OPTION_DRIVER_PICO_DISPLAY_LCD_WIDTH   240
	The width, in pixels, of the Display.
#define	OPTION_DRIVER_PICO_DISPLAY_LCD_HEIGHT   135
	The height, in pixels, of the Display.
#define	OPTION_DRIVER_PICO_DISPLAY_TPIP_FRAME_SOF   '^'
	The TPipe SOF character.
#define	OPTION_DRIVER_PICO_DISPLAY_TPIP_FRAME_EOF   ';'
	The TPipe EOF character.

Functions
void	Driver::PicoDisplay::TPipe::initialize (Cpl::Io::Input &tpipeInStream, Cpl::Io::Output &tpipeOutStream) noexcept
	This method initializes the composite driver and provides the IO streams it uses to communicate with the external executable.
Driver::TPipe::Pipe &	Driver::PicoDisplay::TPipe::tpipe () noexcept
	This method returns a handle to the underly TPipe instance.

Macro Definition Documentation

OPTION_DRIVER_PICO_DISPLAY_LCD_HEIGHT

#define OPTION_DRIVER_PICO_DISPLAY_LCD_HEIGHT   135

The height, in pixels, of the Display.

OPTION_DRIVER_PICO_DISPLAY_LCD_WIDTH

#define OPTION_DRIVER_PICO_DISPLAY_LCD_WIDTH   240

The width, in pixels, of the Display.

OPTION_DRIVER_PICO_DISPLAY_TPIP_FRAME_EOF

#define OPTION_DRIVER_PICO_DISPLAY_TPIP_FRAME_EOF   ';'

The TPipe EOF character.

OPTION_DRIVER_PICO_DISPLAY_TPIP_FRAME_SOF

#define OPTION_DRIVER_PICO_DISPLAY_TPIP_FRAME_SOF   '^'

The TPipe SOF character.

OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_A_NAME

#define OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_A_NAME   "A"

Symbolic name for button: A.

OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_B_NAME

#define OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_B_NAME   "B"

Symbolic name for button: B.

OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_X_NAME

#define OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_X_NAME   "X"

Symbolic name for button: X.

OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_Y_NAME

#define OPTION_DRIVER_PICO_DISPLAY_TPIPE_BUTTON_Y_NAME   "Y"

Symbolic name for button: Y.

OPTION_DRIVER_PICO_DISPLAY_TPIPE_RGB_LED_NAME

#define OPTION_DRIVER_PICO_DISPLAY_TPIPE_RGB_LED_NAME   "theOne"

Symbolic name for the RGB LED.

OPTION_DRIVER_PICO_DISPLAY_TPIPE_RX_FRAME_HANDLER_SIZE

#define OPTION_DRIVER_PICO_DISPLAY_TPIPE_RX_FRAME_HANDLER_SIZE   256

The size, in bytes, of the receive frame buffer used for the TPipe connection.