Component: Combo Board (EB083) (E-blocks 1)

Author	Matrix TSL
Version	1.0 (Release)
Category	E-blocks 1

Combo Board (EB083) component

A simulated version of the EB083 Combo board including LEDs, Switches, LCD, 7-Segs and analogue inputs.

Examples

The following files provide examples of how to use this component:

Arduino Mega 2560 & Combo Board

This blank project consists of the Matrix EB083 Combo Board connected to an Arduino Mega 2560.

Arduino Uno R3 & Combo Board

This blank project consists of the Matrix EB093 Combo Board connected to an Arduino Uno R3.

Note; Due to a limitation in the Arduino Uno hardware, portA6 & PortA7 are replicated from PortA5 in this template.

Downloadable macro reference

Clear

Clears the entire contents of the display.

Parameters

This macro has no parameters

Return value

This call does not return a value

PrintString

Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro

Parameters

<- STRING Text

Enter the text or variable to print to the LCD

This parameter may be returned back to the caller

Return value

This call does not return a value

SetPort

Sets the state of a single port

Parameters

BYTE Port

0 = PortA, 1 = PortB

BYTE Value

Return value

This call does not return a value

GetSwitchState

Reads the state of a single switch

Parameters

BYTE Port

0 = PortA, 1 = PortB

BYTE Switch

0 = SW0, 7 = SW7

Return value

BYTE

PrintAscii

Takes the ascii value for a character and prints the character

Parameters

BYTE character

Holds an ascii value.

Return value

This call does not return a value

PrintNumber

Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767

Parameters

INT Number

Enter the number or variable to print to the LCD

Return value

This call does not return a value

RAMWrite

Modifies the internal memory of the LCD to allow for up to 8 customised characters to be created and stored in the device memory

Parameters

BYTE Index

Values 0 to 7

BYTE d0

BYTE d1

BYTE d2

BYTE d3

BYTE d4

BYTE d5

BYTE d6

BYTE d7

Return value

This call does not return a value

GetPort

Reads the state of a single port

Parameters

BYTE Port

0 = PortA, 1 = PortB

Return value

BYTE

ClearLine

Clears a single line on the display and then moves the cursor to the start of the line to allow you to start populating the line with data.

Parameters

BYTE Line

The line to clear, zero being the first (top) line of the display

Return value

This call does not return a value

Cursor

Moves the cursor on the LCD Display

Parameters

BYTE x

Set the cursor position in the X plane, 0 is the left most cell

BYTE y

Set the cursor position in the Y plane, 0 is the top most cell

Return value

This call does not return a value

Command

Use this method/macro to send a specific command to the LCD. Refer to the Matrix Multimedia EB006 datasheet for a list of supported instructions. For Non-Matrix LCD's refer to the manufacturers datasheet.

Parameters

BYTE instruction

Send a defined command to the LCD Screen. See datasheet for supported commands.

Return value

This call does not return a value

PrintFormattedNumber

Will allow you to print a number up to 32-bits with signed or unsigned formatting.

Signed = -2147483648 to 2147483647

Unsigned = 0 to 4294967295

Parameters

ULONG Number

Enter the number or variable to print to the LCD

BOOL Format

0=Signed, 1=Unsigned

Return value

This call does not return a value

ScrollDisplay

Scrolls the display left or right by a number of given positions.

Parameters

BYTE Position

Holds the number of positions to shift the display

BYTE Direction

0 = left, 1 = right

Return value

This call does not return a value

SegShowDigit

Displays a digit on the 7-seg display

Parameters

BYTE Digit

Which of the digits to change (0 - 3)

BYTE Value

The value to display (0 - 9)

BYTE DecimalPoint

Decides if the decimal point is lit

Return value

This call does not return a value

RawSend

Sends data to the LCD display

Parameters

BYTE data

The data byte to send to the LCD

BOOL type

A boolean to indicate command type: true to write data, false to write a command

Return value

This call does not return a value

ReadAnalogAsByte

Reads one of the analogue components as an byte value

Parameters

BYTE Channel

0 = LDR, 1 = POT

Return value

BYTE

ReadAnalogAsInt

Reads one of the analogue components as an Integer value

Parameters

BYTE Channel

0 = LDR, 1 = POT

Return value

INT

RemapCharacter

Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters.

The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.

Parameters

BYTE RemapIdx

Remap Index, Range: 0 to (Remap Characters - 1)

BYTE SearchCharacter

Character to look for a replace

BYTE ReplacementCharacter

New character value to use in place of the search character.

Return value

This call does not return a value

Start

Startup routine required by the hardware device.

Automatically clears the display after initialising.

Parameters

This macro has no parameters

Return value

This call does not return a value

SetLEDState

Sets the state of a single LED

Parameters

BYTE Port

0 = PortA, 1 = PortB

BYTE LED

0 = LED0, 7 = LED7

BYTE State

Return value

This call does not return a value

Simulation macro reference

This component does not contain any simulation macros

Property reference

Pin A0

This property is of type Single digital pin and can be referenced with the variable name PinA0.

No additional information

Pin A1

This property is of type Single digital pin and can be referenced with the variable name PinA1.

No additional information

Pin A2

This property is of type Single digital pin and can be referenced with the variable name PinA2.

No additional information

Pin A3

This property is of type Single digital pin and can be referenced with the variable name PinA3.

No additional information

Pin A4

This property is of type Single digital pin and can be referenced with the variable name PinA4.

No additional information

Pin A5

This property is of type Single digital pin and can be referenced with the variable name PinA5.

No additional information

Pin A6

This property is of type Single digital pin and can be referenced with the variable name PinA6.

No additional information

Pin A7

This property is of type Single digital pin and can be referenced with the variable name PinA7.

No additional information

Pin B0

This property is of type Single digital pin and can be referenced with the variable name PinB0.

No additional information

Pin B1

This property is of type Single digital pin and can be referenced with the variable name PinB1.

No additional information

Pin B2

This property is of type Single digital pin and can be referenced with the variable name PinB2.

No additional information

Pin B3

This property is of type Single digital pin and can be referenced with the variable name PinB3.

No additional information

Pin B4

This property is of type Single digital pin and can be referenced with the variable name PinB4.

No additional information

Pin B5

This property is of type Single digital pin and can be referenced with the variable name PinB5.

No additional information

Pin B6

This property is of type Single digital pin and can be referenced with the variable name PinB6.

No additional information

Pin B7

This property is of type Single digital pin and can be referenced with the variable name PinB7.

No additional information