Difference between revisions of "Component: Combo (BL0114) (E-blocks 2)"
(XML import - Pre 8.0 release) |
|||
| Line 17: | Line 17: | ||
==[[File:Component Icon d4c04ac8_bbcd_4981_8ce6_9d6c9bb1e26a.png|Image]] Combo (BL0114) component== | ==[[File:Component Icon d4c04ac8_bbcd_4981_8ce6_9d6c9bb1e26a.png|Image]] Combo (BL0114) component== | ||
A component to drive the BL0114 Combo board including LEDs, Switches, LCD, 7-Segs | A component to drive the BL0114 Combo board including LEDs, Switches, LCD, 7-Segs | ||
| − | and analogue inputs. | + | and analogue inputs. |
| + | |||
| + | Make sure both bank 0 and bank 1 are connected to the right ports in flowcode, which correspond to the ports the combo board is connected to on your E-blocks 2 upstream board. There are lots of component macros in flowcode 8, which you can use to read the input from one of the analog devices (potentiometer/LDR) as a byte or an integer, as well as doing many things with the LCD such as printing numbers, strings, formatted numbers or a character which corresponds to an inputted ascii value. There is also a component macro you can use to show a digit on one of the 7-segment displays. On the combo board there are also 16 switches and 16 LEDs, and in flowcode 8 there are component macros which can be used to read the state of a specified switch, or to set the state of a specified LED on the board. Before you can display anything on the LCD screen you must first put the ‘LCD_Start’ macro into the program. | ||
==Examples== | ==Examples== | ||
Revision as of 14:31, 7 September 2018
| Author | Matrix TSL |
| Version | 1.0 (Release) |
| Category | E-blocks 2 |
Contents
- 1 Combo (BL0114) component
- 2 Examples
- 3 Downloadable macro reference
- 3.1 Seg_ShowDigit
- 3.2 LCD_PrintFormattedNumber
- 3.3 LCD_RemapCharacter
- 3.4 LCD_ScrollDisplay
- 3.5 IO_SetPort
- 3.6 IO_SetLEDState
- 3.7 IO_GetPort
- 3.8 LCD_Cursor
- 3.9 LCD_Start
- 3.10 LCD_Command
- 3.11 LCD_RAMWrite
- 3.12 IO_ReadAnalogAsInt
- 3.13 LCD_PrintString
- 3.14 LCD_ClearLine
- 3.15 IO_GetSwitchState
- 3.16 IO_ReadAnalogAsByte
- 3.17 LCD_PrintAscii
- 3.18 LCD_PrintNumber
- 3.19 LCD_RawSend
- 3.20 LCD_Clear
- 4 Simulation macro reference
- 5 Property reference
Combo (BL0114) component
A component to drive the BL0114 Combo board including LEDs, Switches, LCD, 7-Segs and analogue inputs.
Make sure both bank 0 and bank 1 are connected to the right ports in flowcode, which correspond to the ports the combo board is connected to on your E-blocks 2 upstream board. There are lots of component macros in flowcode 8, which you can use to read the input from one of the analog devices (potentiometer/LDR) as a byte or an integer, as well as doing many things with the LCD such as printing numbers, strings, formatted numbers or a character which corresponds to an inputted ascii value. There is also a component macro you can use to show a digit on one of the 7-segment displays. On the combo board there are also 16 switches and 16 LEDs, and in flowcode 8 there are component macros which can be used to read the state of a specified switch, or to set the state of a specified LED on the board. Before you can display anything on the LCD screen you must first put the ‘LCD_Start’ macro into the program.
Examples
No additional examples
Downloadable macro reference
Seg_ShowDigit
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
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
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
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.
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
LCD_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
IO_SetPort
Sets the state of a single port
Parameters
- BYTE Bank
- 0 = Top Bank of LEDs, 1 = Bottom Bank of LEDs
- BYTE Value
Return value
- This call does not return a value
IO_SetLEDState
Sets the state of a single LED
Parameters
- BYTE Bank
- 0 = Top Bank of LEDs, 1 = Bottom Bank of LEDs
- BYTE LED
- 0 = LED0, 7 = LED7
- BYTE State
- 0 = Off, 1 = On
Return value
- This call does not return a value
IO_GetPort
Reads the state of a single port
Parameters
- BYTE Bank
- 0 = Top Bank of Switches, 1 = Bottom Bank of Switches
Return value
LCD_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
LCD_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
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.
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
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
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
IO_ReadAnalogAsInt
Reads one of the analogue components as an Integer value
Parameters
- BYTE Channel
- 0 = Light Sensor, 1 = Potentiometer
Return value
LCD_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
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.
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
IO_GetSwitchState
Reads the state of a single switch
Returns: 0 = Switch not pressed, 1 = Switch pressed
Parameters
- BYTE Bank
- 0 = Top Bank of Switches, 1 = Bottom Bank of Switches
- BYTE Switch
- 0 = SW0, 7 = SW7
Return value
IO_ReadAnalogAsByte
Reads one of the analogue components as an byte value
Parameters
- BYTE Channel
- 0 = Light Sensor, 1 = Potentiometer
Return value
LCD_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
LCD_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
LCD_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
LCD_Clear
Clears the entire contents of the display.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Connection Type
This property is of type Fixed list of ints and can be referenced with the variable name ConnType.
No additional information
Bank 0
This property is of type Digital port byte and can be referenced with the variable name Bank0.
No additional information
Bank 1
This property is of type Digital port byte and can be referenced with the variable name Bank1.
No additional information
