Component: Combo (BL0114) (E-blocks 2)

Author	Matrix TSL
Version	1.0
Category	E-blocks 2

Combo component

A component to drive the BL0114 Combo board including LEDs, Switches, LCD, 7-Segs and analogue inputs.

Detailed description

No detailed description exists yet for this component

Examples

Creates a standard stopwatch with 0.01 second accuracy complete with start/stop/restart functionality.
Displays using the 7-segment displays on the BL0114 Combo
Combo connected to Ports A and B
A4 Start / Stop - A5 Reset
Combo 7-Seg Timer

Macro reference

IO_GetPort

	IO_GetPort
Reads the state of a single port
- BYTE	Bank
0 = Top Bank of Switches, 1 = Bottom Bank of Switches
- BYTE	Return

IO_GetSwitchState

	IO_GetSwitchState
Reads the state of a single switch Returns: 0 = Switch not pressed, 1 = Switch pressed
- BYTE	Bank
0 = Top Bank of Switches, 1 = Bottom Bank of Switches
- BYTE	Switch
0 = SW0, 7 = SW7
- BYTE	Return

IO_ReadAnalogAsByte

	IO_ReadAnalogAsByte
Reads one of the analogue components as an byte value
- BYTE	Channel
0 = Light Sensor, 1 = Potentiometer
- BYTE	Return

IO_ReadAnalogAsInt

	IO_ReadAnalogAsInt
Reads one of the analogue components as an Integer value
- BYTE	Channel
0 = Light Sensor, 1 = Potentiometer
- INT	Return

IO_SetLEDState

	IO_SetLEDState
Sets the state of a single LED
- BYTE	Bank
0 = Top Bank of LEDs, 1 = Bottom Bank of LEDs
- BYTE	LED
0 = LED0, 7 = LED7
- BYTE	State
0 = Off, 1 = On
- VOID	Return

IO_SetPort

	IO_SetPort
Sets the state of a single port
- BYTE	Bank
0 = Top Bank of LEDs, 1 = Bottom Bank of LEDs
- BYTE	Value
- VOID	Return

LCD_Clear

	LCD_Clear
Clears the entire contents of the display.
- VOID	Return

LCD_ClearLine

	LCD_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.
- BYTE	Line
The line to clear, zero being the first (top) line of the display
- VOID	Return

LCD_Command

	LCD_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.
- BYTE	instruction
Send a defined command to the LCD Screen. See datasheet for supported commands.
- VOID	Return

LCD_Cursor

	LCD_Cursor
Moves the cursor on the LCD Display
- 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
- VOID	Return

LCD_PrintAscii

	LCD_PrintAscii
Takes the ascii value for a character and prints the character
- BYTE	character
Holds an ascii value.
- VOID	Return

LCD_PrintFloat

	LCD_PrintFloat
Print a Float number rounded up to a specified amount of decimal places.
- FLOAT	Number
Enter the number or variable to print to the LCD
- BYTE	DecimalPlaces
Enter how many decimal places to round up to (1 - 6)
- VOID	Return

LCD_PrintFormattedNumber

	LCD_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
- ULONG	Number
Enter the number or variable to print to the LCD
- BOOL	Format
0=Signed, 1=Unsigned
- VOID	Return

LCD_PrintNumber

	LCD_PrintNumber
Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767
- INT	Number
Enter the number or variable to print to the LCD
- VOID	Return

LCD_PrintString

	LCD_PrintString
Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro
- STRING	Text
Enter the text or variable to print to the LCD
- VOID	Return

LCD_RAMWrite

	LCD_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
- BYTE	Index
Values 0 to 7
- BYTE	d0
- BYTE	d1
- BYTE	d2
- BYTE	d3
- BYTE	d4
- BYTE	d5
- BYTE	d6
- BYTE	d7
- VOID	Return

LCD_RawSend

	LCD_RawSend
Sends data to the LCD display
- 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
- VOID	Return

LCD_RemapCharacter

	LCD_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.
- 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.
- VOID	Return

LCD_ScrollDisplay

	LCD_ScrollDisplay
Scrolls the display left or right by a number of given positions.
- BYTE	Position
Holds the number of positions to shift the display
- BYTE	Direction
0 = left, 1 = right
- VOID	Return

LCD_Start

	LCD_Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- VOID	Return

Seg_ShowDigit

	Seg_ShowDigit
Displays a digit on the 7-seg display
- 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
- VOID	Return

Seg_ShowSegments

	Seg_ShowSegments
Allows the individual segments of the display to be controlled.
- BYTE	Digit
Which of the digits to change (0 - 3)
- BYTE	Segments
8-bit Binary value to set the segments, bit0 = segA, bit1 = segB...
- VOID	Return

Property reference

	Properties
	Connection Type
	Bank 0 Connections
	Bank 0
	Bank 1 Connections
	Bank 1
	Analog Connections
	Light Sensor
Light Sensor ADC channel Connected to Bank 0 pin 0 which is usually analog pin AN0.
	Potentiometer
Potentiometer ADC channel Connected to Bank 0 pin 1 which is usually analog pin AN1.
	Simulation
	Analog Scope Traces
Controls if traces are automatically added to the data recorder window for the analogue signals on the combo board.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_EBlocks2_COMBO_BL0114.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_EBlocks2_COMBO_BL0114.fcfx