Flowcode Help - User contributions [en]

Component: Bluetooth (BL0170) (E-blocks 2)

2018-09-07T14:43:34Z

SamT: /* Image Bluetooth (BL0170) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon 5f9d5a58_6c01_4588_afa0_df4c01ce161a.png|Image]] Bluetooth (BL0170) component==
Low level routines for controlling a Microchip RN4677 Bluetooth Module.
Also available in the form of the BL0170 Bluetooth E-block.
Uses an interrupt to receive characters from the UART and improve reliability, Must be used with a hardware UART channel.

There are component macros in flowcode 8 that allow you to send to and receive information from the Bluetooth component in the form of a string or a single byte. The component needs to be initialised before it can send or receive information, with the ‘Initialise’ macro.

Make sure the Bluetooth component is connected to the right port in flowcode, corresponding to the port it’s connected to on your E-blocks 2 upstream board.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>ReceiveByte</tt>===
Receives a single data byte from the Bluetooth module.

0xFF signifies no data available.

'''Parameters'''

:[[Variable Types|UINT]] ''Timeout''
::Amount of time to wait in milliseconds 0=Wait forever

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SendString</tt>===
Sends a string to the GSM module.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Command''
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''SendCR''

'''Return value'''

:''This call does not return a value''

===<tt>ReadString</tt>===
Copies the incoming data from the data string array to a local string variable.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to try and read

'''Return value'''

:[[Variable Types|STRING]]

===<tt>SendByte</tt>===
Sends a single data byte out to the Bluetooth module.

'''Parameters'''

:[[Variable Types|BYTE]] ''Data''

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
Sets up the Bluetooth module including:

- Enabling the UART

- Configuring the module (Name / Key / etc)

Returns 1 for OK and 0 for no reply.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Device Name

This property is of type ''Line of text'' and can be referenced with the variable name ''DeviceName''.

Sets the friendly name of the Bluetooth device.

Pair Key

This property is of type ''Line of text'' and can be referenced with the variable name ''PairKey''.

''No additional information''

Discoverable

This property is of type ''True or false'' and can be referenced with the variable name ''InitDisc''.

Is the Bluetooth module discoverable by default?

Reply Timeout

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ReplyTimeout''.

Specifies the amount of time to wait for incoming data before timing out in milliseconds.

Default 2000 = 2 seconds.

RX Buffer Size

This property is of type ''Signed integer'' and can be referenced with the variable name ''string_size''.

Amount of RAM memory to dedicate to receiving responses and incoming data from the BT module.

Default 40

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::CHANNEL''.

UART Channel selector

Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.

Hardware channels use the selected peripheral on-board the target microcontroller.

Baud Options

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::BAUD_LIST''.

Baud rate option selector

Baud Rate

This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_uart::BAUD''.

''No additional information''

TX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::TX''.

Pin to be used for Transmit data

TX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::OutputPins''.

Allows the hardware transmit pin to be configured from a list of available pins based on your target device,

RX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::RX''.

Pin to be used for Receive data

RX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::InputPins''.

Allows the hardware receive pin to be configured from a list of available pins based on your target device,

Use Flow Control

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::FLOWEN''.

Flow Control (Handshake) enable or disable.

On: Two I/O pins are used to control the flow of data in and out of the device.

Off: Flow control is disabled.

Reset Pin

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

''No additional information''

Label

This property is of type ''Line of text'' and can be referenced with the variable name ''label''.

Textual label shown on the component I/O flasher

Scope Traces

This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::ScopeTraces''.

Selects if the scope traces are automatically added to the data recorder window or not.

Simulation - draws an approximation of the UART data onto the scope trace.

ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.

Console Data

This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::ConsoleData''.

Selects if the console data is automatically generated or not

Console Columns

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''cal_uart::ConsoleColumns''.

Number of characters that can be displayed on a single line of the console.

Data Source

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::DataSource''.

Simulation data source used to allow the component to connect to various remote devices

Nothing - Simulation data is ignored

COM port - Routes the communication data to and from a physical or virtual COM port

Injector - Routes the communication data via a data injector component on the Panel.

Component: Colour GLCD (BL0157) (E-blocks 2)

2018-09-07T14:43:00Z

SamT: /* Image Colour GLCD (BL0157) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color: gray;" | Version
| 1.6 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon 25db03ef_5393_4fb8_9b34_87a506428296.png|Image]] Colour GLCD (BL0157) component==
Graphical display component designed to work with the BL0157 E-block.
Based on the ILI9163C 16-bit colour graphical controller IC.

You can use component macros in flowcode 8 to draw various shapes on the colour GLCD such as a circle, an ellipse, a line and a rectangle. There are also macros to turn the backlight on or off, and to print a string of characters or a decimal number on the screen of the GLCD. As it is a ‘colour’ GLCD, you can set the background or foreground colour by inputting values from 0-255 for red, green and blue, in order to create almost any colour in the world. Before the GLCD can take information in, you need to initialise it with a component macro.

Make sure all connections in flowcode are connected to the correct port and pins, the port should correspond to the port that the colour GLCD is connected to on your E-blocks 2 upstream board.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>BacklightOn</tt>===
Sets the backlight enable pin allowing the display backlight to switch on.

Switching the backlight on and off at high speed allow the light to be dimmed.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>PrintNumber</tt>===
This macro prints a decimal number to the Graphical LCD.

'''Parameters'''

:[[Variable Types|INT]] ''Number''
::Byte or Integer number to send to the display.

:[[Variable Types|UINT]] ''X''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y''
::Y pixel coordinate to set the output string position.

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>DrawLine</tt>===
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Plot</tt>===
Sets a pixel with the current foreground colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>DrawEllipse</tt>===
Draws an ellipse object on the display with the center of the ellipse at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''XRadius''
::Radius of the circle on the X axis specified in pixels

:[[Variable Types|UINT]] ''YRadius''
::Radius of the circle on the Y axis specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>FastPlot</tt>===
Sets a pixel with the current foreground colour at current pixel location.

Not compatible with orientations other than 0.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetDisplayOrientation</tt>===
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''Orientation''
::0=Default, 1=90°CW, 2=180°CW, 3=270°CW

'''Return value'''

:''This call does not return a value''

===<tt>BacklightOff</tt>===
Clears the backlight enable pin allowing the display backlight to switch off.

Switching the backlight on and off at high speed allow the light to be dimmed.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>BPlot</tt>===
Sets a pixel with the current background colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>Window</tt>===
Specifies a full screen or sub window of pixels to draw.

Useful when used with the FastPlot function to draw bitmaps at high speed.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

:[[Variable Types|BYTE]] ''X2''

:[[Variable Types|BYTE]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Print</tt>===
This macro prints a string of characters to the Graphical LCD.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Str''
::String of characters to send to the display.
::''This parameter may be returned back to the caller''

:[[Variable Types|UINT]] ''X1''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y1''
::Y pixel coordinate to set the output string position.

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>ClearDisplay</tt>===
This macro clears the display of any previous output by overwriting the entire display with the background colour.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetBackgroundColour</tt>===
Specifies the colour of the background by creating a mixture of red, green and blue.

'''Parameters'''

:[[Variable Types|BYTE]] ''Red''
::0 - 255 where 0 = no red and 255 = maximum red

:[[Variable Types|BYTE]] ''Green''
::0 - 255 where 0 = no green and 255 = maximum green

:[[Variable Types|BYTE]] ''Blue''
::0 - 255 where 0 = no blue and 255 = maximum blue

'''Return value'''

:''This call does not return a value''

===<tt>DrawCircle</tt>===
Draws a circle object on the display with the center of the circle at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''Radius''
::Radius of the circle specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>SetForegroundColour</tt>===
Specifies the colour of the foreground by creating a mixture of red, green and blue.

'''Parameters'''

:[[Variable Types|BYTE]] ''Red''
::0 - 255 where 0 = no red and 255 = maximum red

:[[Variable Types|BYTE]] ''Green''
::0 - 255 where 0 = no green and 255 = maximum green

:[[Variable Types|BYTE]] ''Blue''
::0 - 255 where 0 = no blue and 255 = maximum blue

'''Return value'''

:''This call does not return a value''

===<tt>DrawRectangle</tt>===
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

:[[Variable Types|BYTE]] ''Transparent''
::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.

:[[Variable Types|BYTE]] ''Solid''
::Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.

'''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==
Pixel Height

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''.

Heigt of gLCD canvas measured in pixels.

Pixel Width

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.

Width of gLCD canvas measured in pixels.

Monochrome

This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.

Specifies if the display is capable of colour or monochrome only.

Foreground Color

This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.

Specifies the initial foreground color.

Background Color

This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.

Specifies the initial background color.

Colour Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.

Total color bit depth for the display.

Red Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.

Specifies the red bit depth for the display.

Green Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.

Specifies the green bit depth for the display.

Blue Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.

Specifies the blue bit depth for the display.

Data

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

Data pin connection

Clock

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

Clock pin connection

Chip Select

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

Chip select pin connection

A0

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

Instruction / Command pin connection

Reset

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

Reset pin connection

LED

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

LED backlight strobe pin connection

Display Method

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.

Chooses which method to use when drawing to the gLCD component

The bitmap is the more common mode but may run slowly on some machines.

The point cloud should run faster but may use more memory.

Component: Servo Motor (BL0162) (E-blocks 2)

2018-09-07T14:42:18Z

SamT: /* Image Servo Motor (BL0162) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix TSL
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon bc8ae960_3887_4d08_ac7c_1eedb8e5f6c8.png|Image]] Servo Motor (BL0162) component==
Servo motor component to drive the E-blocks 2 BL0162 Servo Motors board.
Provides up to eight individually addressable connections for standard DC servo motors to be connected.

There are component macros in flowcode which allow you to set the level of trim for each servo channel, and to move it to a certain position. Before you can allow the servo to connect you must use the initialise macro in the program and also the ‘EnableServo’ to specify which servo you are communicating with. There is also a ‘DisableServo’ macro you can use to disable a servo channel again.

Make sure the channels are all connected to the correct port and pin, the port will correspond to the port the servo motor is connected to on the E-blocks 2 upstream board you are using.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>DisableServo</tt>===
Disables a servo channel effectivly disabling the motor.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

'''Return value'''

:''This call does not return a value''

===<tt>SetPosition</tt>===
Moves directly to the specified position with no interpolation.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Position''
::Target position to move towards.

'''Return value'''

:''This call does not return a value''

===<tt>IsAutoMoving</tt>===
Is the AutoMoveToPosition movement complete.

Returns 1 if the servo is still moving.

Returns 0 if the servo movement is complete.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>MoveToPosition</tt>===
Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Position''
::Target position to move towards.

'''Return value'''

:[[Variable Types|BYTE]] : 1 = reached target, 0 = target not reached.

===<tt>SetTrim</tt>===
Allows the level of trim for each servo channel to be adjusted progmatically.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Trim''
::0=0us, 1=+25us, 2=+50us, 3=+75us, 4=+100us, 5=-25us, 6=-50us, 7=-75us, 8=-100us

'''Return value'''

:''This call does not return a value''

===<tt>AutoMoveToPosition</tt>===
Automatically moves towards the new position with a fixed rate of 100 steps per second.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Position''
::Position to move to.

'''Return value'''

:''This call does not return a value''

===<tt>EnableServo</tt>===
Enables a servo channel effectivly setting the position of the motor to the value in the local position variable.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

'''Return value'''

:''This call does not return a value''

===<tt>SetAutoMoveSpeed</tt>===
Sets the speed of the auto move to position macro.

Default speed is 1.

'''Parameters'''

:[[Variable Types|BYTE]] ''Speed''
::1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
Sets up the servo motor interrupts

'''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==
Channels (1 - 8)

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::Channel_Count''.

Set the number of servo's that you need to control.

Value from 1 to 8.

Channel 0

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin0''.

Pin on which to output PWM for the servo motor.

Channel 1

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin1''.

Pin on which to output PWM for the servo motor.

Channel 2

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin2''.

Pin on which to output PWM for the servo motor.

Channel 3

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin3''.

Pin on which to output PWM for the servo motor.

Channel 4

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin4''.

Pin on which to output PWM for the servo motor.

Channel 5

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin5''.

Pin on which to output PWM for the servo motor.

Channel 6

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin6''.

Pin on which to output PWM for the servo motor.

Channel 7

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin7''.

Pin on which to output PWM for the servo motor.

Minimum (us)

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Servo_Controller1::min_pulse_width''.

Shortest pulse width that will be used.

Maximum (us)

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Servo_Controller1::max_pulse_width''.

Longest pulse width used for the PWM signals.

Trim 0

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim0''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 1

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim1''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 2

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim2''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 3

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim3''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 4

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim4''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 5

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim5''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 6

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim6''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 7

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim7''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Servo Object 0

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim0''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 1

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim1''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 2

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim2''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 3

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim3''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 4

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim4''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 5

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim5''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 6

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim6''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 7

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim7''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Component: LCD (BL0169) (E-blocks 2)

2018-09-07T14:41:49Z

SamT: /* Image LCD (BL0169) component */

Component: Switch (BL0145) (E-blocks 2)

2018-09-07T14:40:58Z

SamT: /* Image Switch (BL0145) component */

Component: IO Expander (BL0155) (E-blocks 2)

2018-09-07T14:39:46Z

SamT: /* Image IO Expander (BL0155) component */

Component: GLCD (BL0139) (E-blocks 2)

2018-09-07T14:39:05Z

SamT: /* Image GLCD (BL0139) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix TSL
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon 4d50e925_93e7_43ff_9c9f_8e958b9d714c.png|Image]] GLCD (BL0139) component==
Graphical display component designed to work with the ST7567 type monochrome displays.
Transfers data using a 4-wire SPI interface, cannot read back so pixel based routines won't work
Compatible with the EB2 BL0139 Downstream E-block.

On the mono GLCD you can se the foreground and background colours as either black or white, using the component macros corresponding to the setting of foreground or background. There are also macros which you can put into the program to print a string or a number on the GLCDs screen. You can also draw various shapes on the mono GLCD, such as a circle, an ellipse, a line or a rectangle using component macros.

Make sure the connections in flowcode are all in the correct port and pins, the port letter should be the same as the one which your mono GLCD is connected to on your E-blocks 2 upstream board.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>PrintNumber</tt>===
This macro prints a decimal number to the Graphical LCD.

'''Parameters'''

:[[Variable Types|INT]] ''Number''
::Byte or Integer number to send to the display.

:[[Variable Types|UINT]] ''X''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y''
::Y pixel coordinate to set the output string position.

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>DrawLine</tt>===
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

:[[Variable Types|BYTE]] ''X2''

:[[Variable Types|BYTE]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Write_Data</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''data''

'''Return value'''

:''This call does not return a value''

===<tt>Goto_XY</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''X''

:[[Variable Types|BYTE]] ''Y''

'''Return value'''

:''This call does not return a value''

===<tt>Plot</tt>===
Sets a pixel with the current foreground colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>DrawEllipse</tt>===
Draws an ellipse object on the display with the center of the ellipse at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''XRadius''
::Radius of the circle on the X axis specified in pixels

:[[Variable Types|UINT]] ''YRadius''
::Radius of the circle on the Y axis specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>SetDisplayOrientation</tt>===
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''Orientation''
::0=Default, 1=90°CW, 2=180°CW, 3=270°CW

'''Return value'''

:''This call does not return a value''

===<tt>BPlot</tt>===
Sets a pixel with the current background colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>Print</tt>===
This macro prints a string of characters to the Graphical LCD.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Str''
::String of characters to send to the display.
::''This parameter may be returned back to the caller''

:[[Variable Types|UINT]] ''X1''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y1''
::Y coordinate 0-31

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>ClearDisplay</tt>===
This macro clears the display of any previous output by overwriting the entire display with the background colour.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetBackgroundColour</tt>===
Specifies the colour of the foreground

'''Parameters'''

:[[Variable Types|BYTE]] ''PixelColour''
::0=White, 1=Black

'''Return value'''

:''This call does not return a value''

===<tt>Write_Command</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Command''

'''Return value'''

:''This call does not return a value''

===<tt>DrawCircle</tt>===
Draws a circle object on the display with the center of the circle at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''Radius''
::Radius of the circle specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>SetForegroundColour</tt>===
Specifies the colour of the foreground.

'''Parameters'''

:[[Variable Types|BYTE]] ''PixelColour''
::0=White, 1=Black

'''Return value'''

:''This call does not return a value''

===<tt>DrawRectangle</tt>===
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

:[[Variable Types|BYTE]] ''X2''

:[[Variable Types|BYTE]] ''Y2''

:[[Variable Types|BYTE]] ''Transparent''

:[[Variable Types|BYTE]] ''Solid''

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.

'''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==
Pixel Height

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''.

Heigt of gLCD canvas measured in pixels.

Pixel Width

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.

Width of gLCD canvas measured in pixels.

Monochrome

This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.

Specifies if the display is capable of colour or monochrome only.

Foreground Color

This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.

Specifies the initial foreground color.

Background Color

This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.

Specifies the initial background color.

Color Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.

Number of bits of colour depth available on the display

Red Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.

Number of bits of Red colour depth on the display

Green Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.

Number of bits of Green colour depth on the display

Blue Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.

Number of bits of Blue colour depth on the display

Data Pin

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

''No additional information''

Clock Pin

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

''No additional information''

A0

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

Address pin to tell the display if we are sending commands or data

CS

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

Chip select pin

Reset

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

''No additional information''

Display Method

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.

Chooses which method to use when drawing to the gLCD component

The bitmap is the more common mode but may run slowly on some machines.

The point cloud should run faster but may use more memory.

LCDVersion

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''LCDVersion''.

''No additional information''

Component: WIFI (BL0136) (E-blocks 2)

2018-09-07T14:35:58Z

SamT: /* Image WIFI (BL0136) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 2.1 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon ea9c0946_5f88_4f9a_ae5f_8ba9b981b389.png|Image]] WIFI (BL0136) component==
Wireless LAN component designed to work with the ESP-12S module.
Provides a very simple interface to allow webpages to be hosted from hardware or simulation.
Also available in the form of the BL0136 WIFI E-block.

This component can be used for connecting a system to a wifi network, by using the ‘ScanForSSID’ component macro. Then different macros can be used to read the encryption mode, the signal strength or the specific SSID of one of the networks picked up in the scan. There is also a ‘ConnectToSSID’ macro which allows you to connect your program to a wifi network (as long as you have a sufficient password) and another macro you can use to disconnect from the network again.

As well as connecting to a wifi network, there is a component macro called ‘CreateAccessPoint’ which creates an access point (with a chosen SSID, password, channel, and encryption) for other people to connect to.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>DisconnectFromSSID</tt>===
Disconnects from the current SSID.

Returns 1 if the command was accepted and returned an "OK"

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SendString</tt>===
Sends the given Text.

Appends a CR to the end of the string it SendCR is greater than 0.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Text''
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''SendCR''

'''Return value'''

:''This call does not return a value''

===<tt>ClientConnect</tt>===
Creates a TCP or UDP connection to a remote server.

Returns the state of the connection.

0=Connection failed

1=Connection active

'''Parameters'''

:[[Variable Types|BYTE]] ''Type''
::0 = TCP, 1 = UDP

:[[Variable Types|<- STRING]] ''IPAddress''
::e.g. "192.168.1.20"
::''This parameter may be returned back to the caller''

:[[Variable Types|UINT]] ''Port''
::Remote port number to connect to, HTTP comms = Port 80

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ControlTCPServer</tt>===
Allows a TCP web page server to be switched on and off on the selected port.

Returns 1 if the command was completed correctly.

'''Parameters'''

:[[Variable Types|BYTE]] ''Enable''
::0 = Stop Server, 1 = Start Server

:[[Variable Types|UINT]] ''Port''
::Server port to listen for incoming TCP/IP data requests

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>GetFirmwareVersion</tt>===
Collects the firmware version from the ESP8266 module and returns it as a string.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|STRING]]

===<tt>CheckForPageRequests</tt>===
To be called periodically. Returns non-zero if a request has been processed

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ClientSendRequest</tt>===
Sends out a request for data

'''Parameters'''

:[[Variable Types|<- STRING]] ''Request''
::e.g. "GET / HTTP/1.0\r\n\r\n"
::''This parameter may be returned back to the caller''

'''Return value'''

:''This call does not return a value''

===<tt>ReadSSIDFromScan</tt>===
Collects one of the SSID name strings from the last SSID Scan.

The ScanForSSID macro must be called first.

'''Parameters'''

:[[Variable Types|BYTE]] ''Index''
::SSID Index

'''Return value'''

:[[Variable Types|STRING]]

===<tt>CreateAccessPoint</tt>===
Sets up the wireless LAN module into AP mode to host a wireless network.

Other WIFI enabled devices can then connect to the module.

Returns 1 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''SSID''
::Name of the wireless network to create
::''This parameter may be returned back to the caller''

:[[Variable Types|<- STRING]] ''Password''
::Password used to gain access to the network
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''Channel''
::802.11 Channel Range 1-14

:[[Variable Types|BYTE]] ''Encryption''
::0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetOutValue</tt>===
Set the value of an outbound substitution string

'''Parameters'''

:[[Variable Types|BYTE]] ''index''
::Range 0-4

:[[Variable Types|<- STRING]] ''value''
::''This parameter may be returned back to the caller''

'''Return value'''

:''This call does not return a value''

===<tt>ReadSignalStrengthFromScan</tt>===
Collects the signal strength from the last SSID Scan.

The ScanForSSID macro must be called first.

Value returned is in negative dB, smaller value = better signal

'''Parameters'''

:[[Variable Types|BYTE]] ''Index''
::SSID Index

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadEncryptionModeFromScan</tt>===
Collects one of the encryption modes from the last SSID Scan.

The ScanForSSID macro must be called first.

0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK

'''Parameters'''

:[[Variable Types|BYTE]] ''Index''
::SSID Index

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>GetByteWithTimeout</tt>===
Attempts to receive a byte from the circular buffer.

If nothing is available then waits up to 20 ms for data to become available.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>GetInValue</tt>===
Returns the string value of a Request parameter

'''Parameters'''

:[[Variable Types|BYTE]] ''index''
::Index of the request paramter, starting at zero Range 0-2

'''Return value'''

:[[Variable Types|STRING]]

===<tt>ConnectToSSID</tt>===
Attempts to connect to the given SSID and Key values.

Returns 1 if the SSID has been connected.

'''Parameters'''

:[[Variable Types|<- STRING]] ''SSID''
::''This parameter may be returned back to the caller''

:[[Variable Types|<- STRING]] ''Key''
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''Timeout''
::Number of seconds to wait for the connection, default 2

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanForSSID</tt>===
Checks for wireless networks in the local area which are broadcasting their SSID.

Must not be connected to a network to allow this to function.

Returns the number of wireless networks found, max 8.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Initialise the device with the property data.

Returns 1 if "ready" message successfully received

Returns 0 if no reply from module

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CheckTCPServerIP</tt>===
Collects the local IP address of the active TCP server.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|STRING]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Receive Buffer Size

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RxBufferSize''.

Buffer used to store incoming data ready for processing.

Default 128 Bytes.

Scan Buffer Size

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ScanBufferSize''.

Buffer used to hold SSID names when performing a SSID network scan.

Default 100 Bytes.

Reset Mode

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ResetMode''.

The initialise automatically resets the WIFI module before establishing communications.

Software reset uses an AT command to preform the reset

Hardware reset uses an extra I/O pin to toggle the signal to the reset pin on the module.

Command Termination

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Termination''.

Older versions of the firmware require \r to terminate a AT command string.

Newer versions of the firmware have changed to use \r\n termination.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::CHANNEL''.

UART Channel selector

Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.

Hardware channels use the selected peripheral on-board the target microcontroller.

Baud Options

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::BAUD_LIST''.

Baud rate option selector

Baud Rate

This property is of type ''Signed integer'' and can be referenced with the variable name ''group1::cal_uart1::BAUD''.

''No additional information''

TX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''group1::cal_uart1::TX''.

Pin to be used for Transmit data

TX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::OutputPins''.

Allows the hardware transmit pin to be configured from a list of available pins based on your target device,

RX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''group1::cal_uart1::RX''.

Pin to be used for Receive data

RX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::InputPins''.

Allows the hardware receive pin to be configured from a list of available pins based on your target device,

Reset

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

WLAN module reset pin connection

Use Flow Control

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::FLOWEN''.

Flow Control (Handshake) enable or disable.

On: Two I/O pins are used to control the flow of data in and out of the device.

Off: Flow control is disabled.

Max Web Pages

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PAGES''.

Maximum number of individual webpages we can serve up with the component.

Web Page Timeout

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''TIMEOUT''.

Number of cycles to try and send / receive a webpage before timing out.

Line Delay

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''LineDelay''.

Fixed delay in microseconds sent in between sending a HTML line when running as a web page server.

Name Page 1

This property is of type ''Line of text'' and can be referenced with the variable name ''name1''.

HTML name of webpage 1

HTML Page 1

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html1''.

HTML content for webpage 1

Name Page 2

This property is of type ''Line of text'' and can be referenced with the variable name ''name2''.

HTML name of webpage 2

HTML Page 2

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html2''.

HTML content for webpage 2

Name Page 3

This property is of type ''Line of text'' and can be referenced with the variable name ''name3''.

HTML name of webpage 3

HTML Page 3

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html3''.

HTML content for webpage 3

Name Page 4

This property is of type ''Line of text'' and can be referenced with the variable name ''name4''.

HTML name of webpage 4

HTML Page 4

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html4''.

HTML content for webpage 4

Count

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Outgoing_Count''.

Maximum number of outbound string substitutions

Length 0

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Out_Len_0''.

Number of bytes to reserve for data string.

Count

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Incoming_Count''.

Maximum number of inbound string substitutions

Length 0

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''In_Len_0''.

Number of bytes to reserve for data string.

Label

This property is of type ''Line of text'' and can be referenced with the variable name ''label''.

Text label used to help identify the component on the panel.

Simulation Method

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SimMethod''.

Decides how to handle the simulation of the component.

TCP Base - Allows simulation of the network communications using the TCP Base component and DLL.

COM/Injector - Allows the simulation to connect to real hardware or injectors.

Scope Traces

This property is of type ''True or false'' and can be referenced with the variable name ''group1::cal_uart1::ScopeTraces''.

Selects if the scope traces are automatically added to the data recorder window or not.

Simulation - draws an approximation of the UART data onto the scope trace.

ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.

Console Data

This property is of type ''True or false'' and can be referenced with the variable name ''group1::cal_uart1::ConsoleData''.

Selects if the console data is automatically generated or not

Console Columns

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''group1::cal_uart1::ConsoleColumns''.

Number of characters that can be displayed on a single line of the console.

Data Source

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::DataSource''.

Simulation data source used to allow the component to connect to various remote devices

Nothing - Simulation data is ignored

COM port - Routes the communication data to and from a physical or virtual COM port

Injector - Routes the communication data via a data injector component on the Panel.

Component: WIFI (BL0136) (E-blocks 2)

2018-09-07T14:35:47Z

SamT: /* Image WIFI (BL0136) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 2.1 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon ea9c0946_5f88_4f9a_ae5f_8ba9b981b389.png|Image]] WIFI (BL0136) component==
Wireless LAN component designed to work with the ESP-12S module.
Provides a very simple interface to allow webpages to be hosted from hardware or simulation.
Also available in the form of the BL0136 WIFI E-block.

This component can be used for connecting a system to a wifi network, by using the ‘ScanForSSID’ component macro. Then different macros can be used to read the encryption mode, the signal strength or the specific SSID of one of the networks picked up in the scan. There is also a ‘ConnectToSSID’ macro which allows you to connect your program to a wifi network (as long as you have a sufficient password) and another macro you can use to disconnect from the network again.
As well as connecting to a wifi network, there is a component macro called ‘CreateAccessPoint’ which creates an access point (with a chosen SSID, password, channel, and encryption) for other people to connect to.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>DisconnectFromSSID</tt>===
Disconnects from the current SSID.

Returns 1 if the command was accepted and returned an "OK"

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SendString</tt>===
Sends the given Text.

Appends a CR to the end of the string it SendCR is greater than 0.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Text''
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''SendCR''

'''Return value'''

:''This call does not return a value''

===<tt>ClientConnect</tt>===
Creates a TCP or UDP connection to a remote server.

Returns the state of the connection.

0=Connection failed

1=Connection active

'''Parameters'''

:[[Variable Types|BYTE]] ''Type''
::0 = TCP, 1 = UDP

:[[Variable Types|<- STRING]] ''IPAddress''
::e.g. "192.168.1.20"
::''This parameter may be returned back to the caller''

:[[Variable Types|UINT]] ''Port''
::Remote port number to connect to, HTTP comms = Port 80

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ControlTCPServer</tt>===
Allows a TCP web page server to be switched on and off on the selected port.

Returns 1 if the command was completed correctly.

'''Parameters'''

:[[Variable Types|BYTE]] ''Enable''
::0 = Stop Server, 1 = Start Server

:[[Variable Types|UINT]] ''Port''
::Server port to listen for incoming TCP/IP data requests

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>GetFirmwareVersion</tt>===
Collects the firmware version from the ESP8266 module and returns it as a string.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|STRING]]

===<tt>CheckForPageRequests</tt>===
To be called periodically. Returns non-zero if a request has been processed

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ClientSendRequest</tt>===
Sends out a request for data

'''Parameters'''

:[[Variable Types|<- STRING]] ''Request''
::e.g. "GET / HTTP/1.0\r\n\r\n"
::''This parameter may be returned back to the caller''

'''Return value'''

:''This call does not return a value''

===<tt>ReadSSIDFromScan</tt>===
Collects one of the SSID name strings from the last SSID Scan.

The ScanForSSID macro must be called first.

'''Parameters'''

:[[Variable Types|BYTE]] ''Index''
::SSID Index

'''Return value'''

:[[Variable Types|STRING]]

===<tt>CreateAccessPoint</tt>===
Sets up the wireless LAN module into AP mode to host a wireless network.

Other WIFI enabled devices can then connect to the module.

Returns 1 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''SSID''
::Name of the wireless network to create
::''This parameter may be returned back to the caller''

:[[Variable Types|<- STRING]] ''Password''
::Password used to gain access to the network
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''Channel''
::802.11 Channel Range 1-14

:[[Variable Types|BYTE]] ''Encryption''
::0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetOutValue</tt>===
Set the value of an outbound substitution string

'''Parameters'''

:[[Variable Types|BYTE]] ''index''
::Range 0-4

:[[Variable Types|<- STRING]] ''value''
::''This parameter may be returned back to the caller''

'''Return value'''

:''This call does not return a value''

===<tt>ReadSignalStrengthFromScan</tt>===
Collects the signal strength from the last SSID Scan.

The ScanForSSID macro must be called first.

Value returned is in negative dB, smaller value = better signal

'''Parameters'''

:[[Variable Types|BYTE]] ''Index''
::SSID Index

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadEncryptionModeFromScan</tt>===
Collects one of the encryption modes from the last SSID Scan.

The ScanForSSID macro must be called first.

0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK

'''Parameters'''

:[[Variable Types|BYTE]] ''Index''
::SSID Index

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>GetByteWithTimeout</tt>===
Attempts to receive a byte from the circular buffer.

If nothing is available then waits up to 20 ms for data to become available.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>GetInValue</tt>===
Returns the string value of a Request parameter

'''Parameters'''

:[[Variable Types|BYTE]] ''index''
::Index of the request paramter, starting at zero Range 0-2

'''Return value'''

:[[Variable Types|STRING]]

===<tt>ConnectToSSID</tt>===
Attempts to connect to the given SSID and Key values.

Returns 1 if the SSID has been connected.

'''Parameters'''

:[[Variable Types|<- STRING]] ''SSID''
::''This parameter may be returned back to the caller''

:[[Variable Types|<- STRING]] ''Key''
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''Timeout''
::Number of seconds to wait for the connection, default 2

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanForSSID</tt>===
Checks for wireless networks in the local area which are broadcasting their SSID.

Must not be connected to a network to allow this to function.

Returns the number of wireless networks found, max 8.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Initialise the device with the property data.

Returns 1 if "ready" message successfully received

Returns 0 if no reply from module

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CheckTCPServerIP</tt>===
Collects the local IP address of the active TCP server.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|STRING]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Receive Buffer Size

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RxBufferSize''.

Buffer used to store incoming data ready for processing.

Default 128 Bytes.

Scan Buffer Size

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ScanBufferSize''.

Buffer used to hold SSID names when performing a SSID network scan.

Default 100 Bytes.

Reset Mode

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ResetMode''.

The initialise automatically resets the WIFI module before establishing communications.

Software reset uses an AT command to preform the reset

Hardware reset uses an extra I/O pin to toggle the signal to the reset pin on the module.

Command Termination

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Termination''.

Older versions of the firmware require \r to terminate a AT command string.

Newer versions of the firmware have changed to use \r\n termination.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::CHANNEL''.

UART Channel selector

Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.

Hardware channels use the selected peripheral on-board the target microcontroller.

Baud Options

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::BAUD_LIST''.

Baud rate option selector

Baud Rate

This property is of type ''Signed integer'' and can be referenced with the variable name ''group1::cal_uart1::BAUD''.

''No additional information''

TX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''group1::cal_uart1::TX''.

Pin to be used for Transmit data

TX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::OutputPins''.

Allows the hardware transmit pin to be configured from a list of available pins based on your target device,

RX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''group1::cal_uart1::RX''.

Pin to be used for Receive data

RX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::InputPins''.

Allows the hardware receive pin to be configured from a list of available pins based on your target device,

Reset

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

WLAN module reset pin connection

Use Flow Control

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::FLOWEN''.

Flow Control (Handshake) enable or disable.

On: Two I/O pins are used to control the flow of data in and out of the device.

Off: Flow control is disabled.

Max Web Pages

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PAGES''.

Maximum number of individual webpages we can serve up with the component.

Web Page Timeout

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''TIMEOUT''.

Number of cycles to try and send / receive a webpage before timing out.

Line Delay

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''LineDelay''.

Fixed delay in microseconds sent in between sending a HTML line when running as a web page server.

Name Page 1

This property is of type ''Line of text'' and can be referenced with the variable name ''name1''.

HTML name of webpage 1

HTML Page 1

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html1''.

HTML content for webpage 1

Name Page 2

This property is of type ''Line of text'' and can be referenced with the variable name ''name2''.

HTML name of webpage 2

HTML Page 2

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html2''.

HTML content for webpage 2

Name Page 3

This property is of type ''Line of text'' and can be referenced with the variable name ''name3''.

HTML name of webpage 3

HTML Page 3

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html3''.

HTML content for webpage 3

Name Page 4

This property is of type ''Line of text'' and can be referenced with the variable name ''name4''.

HTML name of webpage 4

HTML Page 4

This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html4''.

HTML content for webpage 4

Count

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Outgoing_Count''.

Maximum number of outbound string substitutions

Length 0

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Out_Len_0''.

Number of bytes to reserve for data string.

Count

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Incoming_Count''.

Maximum number of inbound string substitutions

Length 0

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''In_Len_0''.

Number of bytes to reserve for data string.

Label

This property is of type ''Line of text'' and can be referenced with the variable name ''label''.

Text label used to help identify the component on the panel.

Simulation Method

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SimMethod''.

Decides how to handle the simulation of the component.

TCP Base - Allows simulation of the network communications using the TCP Base component and DLL.

COM/Injector - Allows the simulation to connect to real hardware or injectors.

Scope Traces

This property is of type ''True or false'' and can be referenced with the variable name ''group1::cal_uart1::ScopeTraces''.

Selects if the scope traces are automatically added to the data recorder window or not.

Simulation - draws an approximation of the UART data onto the scope trace.

ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.

Console Data

This property is of type ''True or false'' and can be referenced with the variable name ''group1::cal_uart1::ConsoleData''.

Selects if the console data is automatically generated or not

Console Columns

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''group1::cal_uart1::ConsoleColumns''.

Number of characters that can be displayed on a single line of the console.

Data Source

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''group1::cal_uart1::DataSource''.

Simulation data source used to allow the component to connect to various remote devices

Nothing - Simulation data is ignored

COM port - Routes the communication data to and from a physical or virtual COM port

Injector - Routes the communication data via a data injector component on the Panel.

Component: Bluetooth (BL0170) (E-blocks 2)

2018-09-07T14:35:16Z

SamT: /* Image Bluetooth (BL0170) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon 5f9d5a58_6c01_4588_afa0_df4c01ce161a.png|Image]] Bluetooth (BL0170) component==
Low level routines for controlling a Microchip RN4677 Bluetooth Module.
Also available in the form of the BL0170 Bluetooth E-block.
Uses an interrupt to receive characters from the UART and improve reliability, Must be used with a hardware UART channel.

There are component macros in flowcode 8 that allow you to send to and receive information from the Bluetooth component in the form of a string or a single byte. The component needs to be initialised before it can send or receive information, with the ‘Initialise’ macro.
Make sure the Bluetooth component is connected to the right port in flowcode, corresponding to the port it’s connected to on your E-blocks 2 upstream board.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>ReceiveByte</tt>===
Receives a single data byte from the Bluetooth module.

0xFF signifies no data available.

'''Parameters'''

:[[Variable Types|UINT]] ''Timeout''
::Amount of time to wait in milliseconds 0=Wait forever

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SendString</tt>===
Sends a string to the GSM module.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Command''
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''SendCR''

'''Return value'''

:''This call does not return a value''

===<tt>ReadString</tt>===
Copies the incoming data from the data string array to a local string variable.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to try and read

'''Return value'''

:[[Variable Types|STRING]]

===<tt>SendByte</tt>===
Sends a single data byte out to the Bluetooth module.

'''Parameters'''

:[[Variable Types|BYTE]] ''Data''

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
Sets up the Bluetooth module including:

- Enabling the UART

- Configuring the module (Name / Key / etc)

Returns 1 for OK and 0 for no reply.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Device Name

This property is of type ''Line of text'' and can be referenced with the variable name ''DeviceName''.

Sets the friendly name of the Bluetooth device.

Pair Key

This property is of type ''Line of text'' and can be referenced with the variable name ''PairKey''.

''No additional information''

Discoverable

This property is of type ''True or false'' and can be referenced with the variable name ''InitDisc''.

Is the Bluetooth module discoverable by default?

Reply Timeout

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ReplyTimeout''.

Specifies the amount of time to wait for incoming data before timing out in milliseconds.

Default 2000 = 2 seconds.

RX Buffer Size

This property is of type ''Signed integer'' and can be referenced with the variable name ''string_size''.

Amount of RAM memory to dedicate to receiving responses and incoming data from the BT module.

Default 40

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::CHANNEL''.

UART Channel selector

Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.

Hardware channels use the selected peripheral on-board the target microcontroller.

Baud Options

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::BAUD_LIST''.

Baud rate option selector

Baud Rate

This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_uart::BAUD''.

''No additional information''

TX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::TX''.

Pin to be used for Transmit data

TX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::OutputPins''.

Allows the hardware transmit pin to be configured from a list of available pins based on your target device,

RX

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::RX''.

Pin to be used for Receive data

RX Remap Pin

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::InputPins''.

Allows the hardware receive pin to be configured from a list of available pins based on your target device,

Use Flow Control

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::FLOWEN''.

Flow Control (Handshake) enable or disable.

On: Two I/O pins are used to control the flow of data in and out of the device.

Off: Flow control is disabled.

Reset Pin

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

''No additional information''

Label

This property is of type ''Line of text'' and can be referenced with the variable name ''label''.

Textual label shown on the component I/O flasher

Scope Traces

This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::ScopeTraces''.

Selects if the scope traces are automatically added to the data recorder window or not.

Simulation - draws an approximation of the UART data onto the scope trace.

ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.

Console Data

This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::ConsoleData''.

Selects if the console data is automatically generated or not

Console Columns

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''cal_uart::ConsoleColumns''.

Number of characters that can be displayed on a single line of the console.

Data Source

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::DataSource''.

Simulation data source used to allow the component to connect to various remote devices

Nothing - Simulation data is ignored

COM port - Routes the communication data to and from a physical or virtual COM port

Injector - Routes the communication data via a data injector component on the Panel.

Component: Colour GLCD (BL0157) (E-blocks 2)

2018-09-07T14:34:29Z

SamT: /* Image Colour GLCD (BL0157) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color: gray;" | Version
| 1.6 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon 25db03ef_5393_4fb8_9b34_87a506428296.png|Image]] Colour GLCD (BL0157) component==
Graphical display component designed to work with the BL0157 E-block.
Based on the ILI9163C 16-bit colour graphical controller IC.

You can use component macros in flowcode 8 to draw various shapes on the colour GLCD such as a circle, an ellipse, a line and a rectangle. There are also macros to turn the backlight on or off, and to print a string of characters or a decimal number on the screen of the GLCD. As it is a ‘colour’ GLCD, you can set the background or foreground colour by inputting values from 0-255 for red, green and blue, in order to create almost any colour in the world. Before the GLCD can take information in, you need to initialise it with a component macro.
Make sure all connections in flowcode are connected to the correct port and pins, the port should correspond to the port that the colour GLCD is connected to on your E-blocks 2 upstream board.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>BacklightOn</tt>===
Sets the backlight enable pin allowing the display backlight to switch on.

Switching the backlight on and off at high speed allow the light to be dimmed.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>PrintNumber</tt>===
This macro prints a decimal number to the Graphical LCD.

'''Parameters'''

:[[Variable Types|INT]] ''Number''
::Byte or Integer number to send to the display.

:[[Variable Types|UINT]] ''X''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y''
::Y pixel coordinate to set the output string position.

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>DrawLine</tt>===
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Plot</tt>===
Sets a pixel with the current foreground colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>DrawEllipse</tt>===
Draws an ellipse object on the display with the center of the ellipse at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''XRadius''
::Radius of the circle on the X axis specified in pixels

:[[Variable Types|UINT]] ''YRadius''
::Radius of the circle on the Y axis specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>FastPlot</tt>===
Sets a pixel with the current foreground colour at current pixel location.

Not compatible with orientations other than 0.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetDisplayOrientation</tt>===
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''Orientation''
::0=Default, 1=90°CW, 2=180°CW, 3=270°CW

'''Return value'''

:''This call does not return a value''

===<tt>BacklightOff</tt>===
Clears the backlight enable pin allowing the display backlight to switch off.

Switching the backlight on and off at high speed allow the light to be dimmed.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>BPlot</tt>===
Sets a pixel with the current background colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>Window</tt>===
Specifies a full screen or sub window of pixels to draw.

Useful when used with the FastPlot function to draw bitmaps at high speed.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

:[[Variable Types|BYTE]] ''X2''

:[[Variable Types|BYTE]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Print</tt>===
This macro prints a string of characters to the Graphical LCD.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Str''
::String of characters to send to the display.
::''This parameter may be returned back to the caller''

:[[Variable Types|UINT]] ''X1''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y1''
::Y pixel coordinate to set the output string position.

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>ClearDisplay</tt>===
This macro clears the display of any previous output by overwriting the entire display with the background colour.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetBackgroundColour</tt>===
Specifies the colour of the background by creating a mixture of red, green and blue.

'''Parameters'''

:[[Variable Types|BYTE]] ''Red''
::0 - 255 where 0 = no red and 255 = maximum red

:[[Variable Types|BYTE]] ''Green''
::0 - 255 where 0 = no green and 255 = maximum green

:[[Variable Types|BYTE]] ''Blue''
::0 - 255 where 0 = no blue and 255 = maximum blue

'''Return value'''

:''This call does not return a value''

===<tt>DrawCircle</tt>===
Draws a circle object on the display with the center of the circle at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''Radius''
::Radius of the circle specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>SetForegroundColour</tt>===
Specifies the colour of the foreground by creating a mixture of red, green and blue.

'''Parameters'''

:[[Variable Types|BYTE]] ''Red''
::0 - 255 where 0 = no red and 255 = maximum red

:[[Variable Types|BYTE]] ''Green''
::0 - 255 where 0 = no green and 255 = maximum green

:[[Variable Types|BYTE]] ''Blue''
::0 - 255 where 0 = no blue and 255 = maximum blue

'''Return value'''

:''This call does not return a value''

===<tt>DrawRectangle</tt>===
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

:[[Variable Types|BYTE]] ''Transparent''
::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.

:[[Variable Types|BYTE]] ''Solid''
::Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.

'''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==
Pixel Height

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''.

Heigt of gLCD canvas measured in pixels.

Pixel Width

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.

Width of gLCD canvas measured in pixels.

Monochrome

This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.

Specifies if the display is capable of colour or monochrome only.

Foreground Color

This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.

Specifies the initial foreground color.

Background Color

This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.

Specifies the initial background color.

Colour Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.

Total color bit depth for the display.

Red Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.

Specifies the red bit depth for the display.

Green Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.

Specifies the green bit depth for the display.

Blue Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.

Specifies the blue bit depth for the display.

Data

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

Data pin connection

Clock

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

Clock pin connection

Chip Select

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

Chip select pin connection

A0

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

Instruction / Command pin connection

Reset

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

Reset pin connection

LED

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

LED backlight strobe pin connection

Display Method

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.

Chooses which method to use when drawing to the gLCD component

The bitmap is the more common mode but may run slowly on some machines.

The point cloud should run faster but may use more memory.

Component: Servo Motor (BL0162) (E-blocks 2)

2018-09-07T14:33:41Z

SamT: /* Image Servo Motor (BL0162) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix TSL
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon bc8ae960_3887_4d08_ac7c_1eedb8e5f6c8.png|Image]] Servo Motor (BL0162) component==
Servo motor component to drive the E-blocks 2 BL0162 Servo Motors board.
Provides up to eight individually addressable connections for standard DC servo motors to be connected.

There are component macros in flowcode which allow you to set the level of trim for each servo channel, and to move it to a certain position. Before you can allow the servo to connect you must use the initialise macro in the program and also the ‘EnableServo’ to specify which servo you are communicating with. There is also a ‘DisableServo’ macro you can use to disable a servo channel again.
Make sure the channels are all connected to the correct port and pin, the port will correspond to the port the servo motor is connected to on the E-blocks 2 upstream board you are using.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>DisableServo</tt>===
Disables a servo channel effectivly disabling the motor.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

'''Return value'''

:''This call does not return a value''

===<tt>SetPosition</tt>===
Moves directly to the specified position with no interpolation.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Position''
::Target position to move towards.

'''Return value'''

:''This call does not return a value''

===<tt>IsAutoMoving</tt>===
Is the AutoMoveToPosition movement complete.

Returns 1 if the servo is still moving.

Returns 0 if the servo movement is complete.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>MoveToPosition</tt>===
Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Position''
::Target position to move towards.

'''Return value'''

:[[Variable Types|BYTE]] : 1 = reached target, 0 = target not reached.

===<tt>SetTrim</tt>===
Allows the level of trim for each servo channel to be adjusted progmatically.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Trim''
::0=0us, 1=+25us, 2=+50us, 3=+75us, 4=+100us, 5=-25us, 6=-50us, 7=-75us, 8=-100us

'''Return value'''

:''This call does not return a value''

===<tt>AutoMoveToPosition</tt>===
Automatically moves towards the new position with a fixed rate of 100 steps per second.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

:[[Variable Types|BYTE]] ''Position''
::Position to move to.

'''Return value'''

:''This call does not return a value''

===<tt>EnableServo</tt>===
Enables a servo channel effectivly setting the position of the motor to the value in the local position variable.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::The channel to set the position for. First channel is zero.

'''Return value'''

:''This call does not return a value''

===<tt>SetAutoMoveSpeed</tt>===
Sets the speed of the auto move to position macro.

Default speed is 1.

'''Parameters'''

:[[Variable Types|BYTE]] ''Speed''
::1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
Sets up the servo motor interrupts

'''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==
Channels (1 - 8)

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::Channel_Count''.

Set the number of servo's that you need to control.

Value from 1 to 8.

Channel 0

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin0''.

Pin on which to output PWM for the servo motor.

Channel 1

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin1''.

Pin on which to output PWM for the servo motor.

Channel 2

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin2''.

Pin on which to output PWM for the servo motor.

Channel 3

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin3''.

Pin on which to output PWM for the servo motor.

Channel 4

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin4''.

Pin on which to output PWM for the servo motor.

Channel 5

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin5''.

Pin on which to output PWM for the servo motor.

Channel 6

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin6''.

Pin on which to output PWM for the servo motor.

Channel 7

This property is of type ''Single digital pin'' and can be referenced with the variable name ''Servo_Controller1::pin7''.

Pin on which to output PWM for the servo motor.

Minimum (us)

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Servo_Controller1::min_pulse_width''.

Shortest pulse width that will be used.

Maximum (us)

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Servo_Controller1::max_pulse_width''.

Longest pulse width used for the PWM signals.

Trim 0

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim0''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 1

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim1''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 2

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim2''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 3

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim3''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 4

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim4''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 5

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim5''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 6

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim6''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Trim 7

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Servo_Controller1::trim7''.

Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar

input values will produce the same degree of movement.

Servo Object 0

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim0''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 1

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim1''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 2

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim2''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 3

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim3''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 4

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim4''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 5

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim5''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 6

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim6''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Servo Object 7

This property is of type ''Panel object'' and can be referenced with the variable name ''Servo_Controller1::sim7''.

Drag a servo motor component onto the System Panel, and then select it here, to create

an on screen simulation of the way that your flowchart moves the servo's.

Servo motors should be based on the 'Servo Motor Base' component, or use a custom component

set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)).

Component: LCD (BL0169) (E-blocks 2)

2018-09-07T14:32:32Z

SamT: /* Image LCD (BL0169) component */

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

2018-09-07T14:31:50Z

SamT: /* Image Combo (BL0114) component */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix TSL
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[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
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==

===<tt>Seg_ShowDigit</tt>===
Displays a digit on the 7-seg display

'''Parameters'''

:[[Variable Types|BYTE]] ''Digit''
::Which of the digits to change (0 - 3)

:[[Variable Types|BYTE]] ''Value''
::The value to display (0 - 9)

:[[Variable Types|BYTE]] ''DecimalPoint''
::Decides if the decimal point is lit

'''Return value'''

:''This call does not return a value''

===<tt>LCD_PrintFormattedNumber</tt>===
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'''

:[[Variable Types|ULONG]] ''Number''
::Enter the number or variable to print to the LCD

:[[Variable Types|BOOL]] ''Format''
::0=Signed, 1=Unsigned

'''Return value'''

:''This call does not return a value''

===<tt>LCD_RemapCharacter</tt>===
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'''

:[[Variable Types|BYTE]] ''RemapIdx''
::Remap Index, Range: 0 to (Remap Characters - 1)

:[[Variable Types|BYTE]] ''SearchCharacter''
::Character to look for a replace

:[[Variable Types|BYTE]] ''ReplacementCharacter''
::New character value to use in place of the search character.

'''Return value'''

:''This call does not return a value''

===<tt>LCD_ScrollDisplay</tt>===
Scrolls the display left or right by a number of given positions.

'''Parameters'''

:[[Variable Types|BYTE]] ''Position''
::Holds the number of positions to shift the display

:[[Variable Types|BYTE]] ''Direction''
::0 = left, 1 = right

'''Return value'''

:''This call does not return a value''

===<tt>IO_SetPort</tt>===
Sets the state of a single port

'''Parameters'''

:[[Variable Types|BYTE]] ''Bank''
::0 = Top Bank of LEDs, 1 = Bottom Bank of LEDs

:[[Variable Types|BYTE]] ''Value''

'''Return value'''

:''This call does not return a value''

===<tt>IO_SetLEDState</tt>===
Sets the state of a single LED

'''Parameters'''

:[[Variable Types|BYTE]] ''Bank''
::0 = Top Bank of LEDs, 1 = Bottom Bank of LEDs

:[[Variable Types|BYTE]] ''LED''
::0 = LED0, 7 = LED7

:[[Variable Types|BYTE]] ''State''
::0 = Off, 1 = On

'''Return value'''

:''This call does not return a value''

===<tt>IO_GetPort</tt>===
Reads the state of a single port

'''Parameters'''

:[[Variable Types|BYTE]] ''Bank''
::0 = Top Bank of Switches, 1 = Bottom Bank of Switches

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>LCD_Cursor</tt>===
Moves the cursor on the LCD Display

'''Parameters'''

:[[Variable Types|BYTE]] ''x''
::Set the cursor position in the X plane, 0 is the left most cell

:[[Variable Types|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''

===<tt>LCD_Start</tt>===
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''

===<tt>LCD_Command</tt>===
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'''

:[[Variable Types|BYTE]] ''instruction''
::Send a defined command to the LCD Screen. See datasheet for supported commands.

'''Return value'''

:''This call does not return a value''

===<tt>LCD_RAMWrite</tt>===
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'''

:[[Variable Types|BYTE]] ''Index''
::Values 0 to 7

:[[Variable Types|BYTE]] ''d0''

:[[Variable Types|BYTE]] ''d1''

:[[Variable Types|BYTE]] ''d2''

:[[Variable Types|BYTE]] ''d3''

:[[Variable Types|BYTE]] ''d4''

:[[Variable Types|BYTE]] ''d5''

:[[Variable Types|BYTE]] ''d6''

:[[Variable Types|BYTE]] ''d7''

'''Return value'''

:''This call does not return a value''

===<tt>IO_ReadAnalogAsInt</tt>===
Reads one of the analogue components as an Integer value

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::0 = Light Sensor, 1 = Potentiometer

'''Return value'''

:[[Variable Types|INT]]

===<tt>LCD_PrintString</tt>===
Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro

'''Parameters'''

:[[Variable Types|<- 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''

===<tt>LCD_ClearLine</tt>===
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'''

:[[Variable Types|BYTE]] ''Line''
::The line to clear, zero being the first (top) line of the display

'''Return value'''

:''This call does not return a value''

===<tt>IO_GetSwitchState</tt>===
Reads the state of a single switch

Returns: 0 = Switch not pressed, 1 = Switch pressed

'''Parameters'''

:[[Variable Types|BYTE]] ''Bank''
::0 = Top Bank of Switches, 1 = Bottom Bank of Switches

:[[Variable Types|BYTE]] ''Switch''
::0 = SW0, 7 = SW7

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>IO_ReadAnalogAsByte</tt>===
Reads one of the analogue components as an byte value

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::0 = Light Sensor, 1 = Potentiometer

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>LCD_PrintAscii</tt>===
Takes the ascii value for a character and prints the character

'''Parameters'''

:[[Variable Types|BYTE]] ''character''
::Holds an ascii value.

'''Return value'''

:''This call does not return a value''

===<tt>LCD_PrintNumber</tt>===
Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767

'''Parameters'''

:[[Variable Types|INT]] ''Number''
::Enter the number or variable to print to the LCD

'''Return value'''

:''This call does not return a value''

===<tt>LCD_RawSend</tt>===
Sends data to the LCD display

'''Parameters'''

:[[Variable Types|BYTE]] ''data''
::The data byte to send to the LCD

:[[Variable Types|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''

===<tt>LCD_Clear</tt>===
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''

Component: Switch (BL0145) (E-blocks 2)

2018-09-07T14:31:06Z

SamT: /* Image Switch (BL0145) component */

Component: LED (BL0167) (E-blocks 2)

2018-09-07T14:30:17Z

SamT: /* Image LED (BL0167) component */