Component: GLCD Bitmap Drawer ROM (Graphical Library)

Author	Matrix TSL
Version	2.2
Category	Graphical Library

GLCD Bitmap Drawer ROM component

A component to simplify the process of drawing bitmap images to a graphical display. Stores up to 10 bitmap images inside ROM based look up tables. Compatible with 24-bit / 256 Colour / 16 Colour / Monochrome Bitmaps. The gLCD object property specifies which LCD component to draw the bitmap to. Compatible with GLCD, NeoPixel, MIACv3, HT16K33

Detailed description

No detailed description exists yet for this component

Examples

The Bitmap Drawer component must be linked to the graphical LCD using the gLCD Object property.

Here is an example which loops drawing a monochrome and 24-bit bitmaps to the EBM001 graphical display.

Bitmap Drawer Demo

The bitmap files used in the example can be found here.

Bitmap Drawer Files

Here is another example which overlays several monochrome images to give the impression of animation. Shows a pair of eyes, which can randomly and momentarily look left, right or blink.

Bitmap Drawer Demo 2

The bitmap files used in the example can be found here.

Bitmap Drawer Files 2

Downloadable macro reference

	GetHeight
Returns the height of the loaded bitmap file in pixels.
- BYTE	BitmapIndex
Selects from attached bitmaps. Range: 0-9
- UINT	Return

	GetWidth
Returns the width of the loaded bitmap file in pixels.
- BYTE	BitmapIndex
Selects from attached bitmaps. Range: 0-9
- UINT	Return

	SetTransparentColour
Sets the transparency colour, the colour that is not drawn when transparency is enabled.
- BYTE	R
- BYTE	G
- BYTE	B
- VOID	Return

	Display_BMP
Draws the bitmap image from ROM onto the display at the corrdinates X and Y.
- BYTE	BitmapIndex
Selects from attached bitmaps. Range: 0-9
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- BYTE	Orientation
0=Normal, 1=90 Degrees CW, 2=180 Degrees, 3=270 Degrees CW
- BYTE	Transparency
0=Off, 1=On Don't Draw Any Pixels which match the transparent colour
- BYTE	Flip
0=Normal, 1=FlipWidth, 2=FlipHeight, 3=FlipBoth
- VOID	Return

	Display_BMP_Fast
Draws the bitmap image from ROM onto the display at the corrdinates X and Y. Attempts to draw a row at a time by not forcing coordinates for every pixel so may not work on some displays. Currently only supports colour displays.
- BYTE	BitmapIndex
Selects from attached bitmaps. Range: 0-9
- UINT	X
X Axis coordinate, specifies the location of the left edge of the bitmap image
- UINT	Y
Y Axis coordinate, specifies the location of the top edge of the bitmap image
- BYTE	Transparency
0=Off, 1=On Don't Draw Any Pixels which match the transparent colour
- VOID	Return

	ShowName
Sets the label to show the target object's name
- VOID	Return

	RawEnable
Enables and configures the ADC channel to be an analogue input. Only one ADC channel can be enabled at a time. Any RAW functions will reference the last enabled channel only.
- VOID	Return

	SetChannel
Sets the channel ID for the component
[[File:]] -	ChannelId
Chaannel starting at 0, -1 is unconnected
- VOID	Return

	RawSampleByte
Background call to read the ADC as a byte Call Enable() before this
- BYTE	Return

	GetInt
Blocking call to read the ADC at full bit depth
- UINT	Return

	RawDisable
Disables the previously enabled ADC channel and converts back to digital mode.
- VOID	Return

	GetByte
Blocking call to read the ADC as a byte
- BYTE	Return

	ConnectToAddress
Attempts to connect the data channel to a specific device address on the network.
- STRING	Address
- BYTE	Return

	GetSignalLevel
Returns the signal strength of the last signal received
- BYTE	Return

	ExitCommandMode
Returns from command mode to allow data to be sent and received
- VOID	Return

	MIAC_Module_PushData
- BYTE	Data
- VOID	Return

	ReadAddressFromBuffer
Reads a byte from a 16-bit Zigbee device address
- BYTE	Device
- BYTE	Idx
- BYTE	Return

	SendATCommand
Transmits a string of values to the Zigbee module.
- STRING	Command
Transmits a command to the Zigbee module followed by a carriage return
- VOID	Return

	ScanNetwork
Scans the local network for devices and stores into a local device array. Mode = 0 store device names, mode = 1 store device addresses. Returns the number of devices found.
- BYTE	Mode
- BYTE	Return

	GetATResponse
Waits for a response from the Zigbee module. If the Logging parameter is set then the response is stored in memory allowing the software to read the reply.
- BYTE	Logging
- BYTE	Return

	ReceiveChar
Attempt to receive a byte from the Zigbee module.
- BYTE	nTimeout
- BYTE	Return

	MODPMSHAPE
Sets PM waveform shape to; 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4.
- BYTE	Shape
Sets PM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4).
- VOID	Return

	ARB4
Loads the binary-data to an existing arbitrary waveform memory location ARB4.
- BYTE	Waveform
- VOID	Return

	CLKSRRet
Returns the clock source <INT> or <EXT>.
[[File:]] -	Return

	MODPMDEV
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°).
[[File:]] -	Degrees
Sets PM waveform deviation in degrees (-360 - 360).
- VOID	Return

	MSTLOCK
Sends signal to SLAVE generator to get synchronised
- VOID	Return

	HILVL
Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V).
[[File:]] -	HighLevel
Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V).
- VOID	Return

	ARB3
Loads the binary-data to an existing arbitrary waveform memory location ARB3.
- UINT	Waveform
- VOID	Return

	WAVE
Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB
- BYTE	WaveType
0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB.
- VOID	Return

	CALADJ
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100).
[[File:]] -	Calibrate
Adjust the selected calibration value (-100 - 100).
- VOID	Return

	STBRet
Returns the value of the Status Byte Register in <nr1> numeric format.
- BYTE	Return

	ARB2
Loads the binary-data to an existing arbitrary waveform memory location ARB2.
- UINT	Waveform
- VOID	Return

	EERRet
Query and clear execution error number register.
- STRING	Return

	MODFMSRC
Sets FM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets FM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODAMFREQ
Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
[[File:]] -	Frequency
Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
- VOID	Return

	ESE
Sets the Standard Event Status Enable Register to the value of <nrf>.
- BYTE	Value
Value of register 0-255
- VOID	Return

	ARB1
Loads the binary-data to an existing arbitrary waveform memory location ARB1.
- UINT	Waveform
16 Bit binary number for arbitrary waveform.
- VOID	Return

	ARB4DEFRet
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4.
- STRING	Return

	CLS
Clears status byte register of the interface.
- VOID	Return

	MSTRELOCK
Resynchronises the two generators in MASTER-SLAVE mode.
- VOID	Return

	NOISLVL
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%)
- BYTE	Percent
Sets the output noise level in percent. (0 - 50)
- VOID	Return

	LOCKMODE
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP.
- BYTE	Mode
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP).
- VOID	Return

	ADDRESSRet
Returns the instruments address
[[File:]] -	Return

	MODPMSRC
Sets PM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets PM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODPWMSRC
Sets PWM waveform source to; 0 = INT, 1 = EXT.
[[File:]] -	Source
Sets PWM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MOD
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM.
- BYTE	Modulation
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM).
- VOID	Return

	ISTRet
Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true.
[[File:]] -	Return

	LRNRet
Returns the complete setup of the instrument as a binary data block
[[File:]] -	Return

	OPCRet
Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential.
[[File:]] -	Return

	SWPTYPE
Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP.
- BYTE	Type
Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP).
- VOID	Return

	PULSRANGE
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3.
- BYTE	Range
Sets the pulse rise and fall range. (1, 2 or 3)
- VOID	Return

	TSTRet
The generator has no self test capability and the response is always 0 <rmt>.
[[File:]] -	Return

	BSTTRGPOL
Sets the burst trigger slope to; 0 = POS, 1 = NEG.
[[File:]] -	Slope
Set the burst trigger slope (0 = POS, 1 = NEG).
- VOID	Return

	ARB3Ret
Returns the binary-data from an existing abbitrary wavefrom memory location.
- UINT	Return

	BSTPHASE
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360)
[[File:]] -	Degrees
Sets the burst phase in degrees (-360 - 360)
- VOID	Return

	IDNRet
Returns the instrument identification. The IDN is saved to the variable passed from the function 'ReturnIDN'. The return parameter is TRUE when the IDN is successfully returned.
- STRING	ReturnIDN
- STRING	Return

	SWPTRGPER
Sets the sweep trigger period to <nrf> seconds
[[File:]] -	Seconds
Set the sweep trigger period in seconds.
- VOID	Return

	PULSDLY
Sets the waveform delay to <nrf> sec
[[File:]] -	Sec
- VOID	Return

Property reference

	Properties
	gLCD Object
Graphical LCD Object to draw the bitmap image to
	ColourDisplay
Automatically detects if the graphical LCD object is colour or monochrome
	ROM Bytes
Total number of ROM bytes used to store attached bitmap images.
	Number of Bitmaps
Number of bitmaps the component can store and draw to the LCD. Min 1 / Max 10
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Bitmap File
Bitmap file you wish to embed into the program. Compatible with .bmp files in the following formats: 24-Bit / 256 Colour / 16 Colour / Monochrome
	File Colour Depth
Number of bits per pixel. Currently the component only supports bitmap files with 1-bit or 24-bit colour depth.
	File Length
The number of bytes of ROM the bitmap file will consume. You can vie wthe number of ROM bytes available on your target device using the Device Helper component.
	File Width
Width of the bitmap file in pixels
	File Height
Height of the bitmap file in pixels
	Data Offset
Offset in the file where the bitmap pixel data starts
	Connections
	Simulations