Difference between revisions of "Component: GSM (BL0131) (E-blocks 2)"

Revision as of 09:56, 27 January 2023

Author	Matrix Ltd.
Version	1.0
Category	E-blocks 2

GSM (BL0131) component

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	DialNumber
Performs a standard voice call by dialling the number specified. Returns 0 for call in progress and 255 for no response.
- STRING	Number

- BYTE	Return

	GetTextString
Collects the text message data from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	SendString
Sends a string to the GSM module.
- STRING	Text

- VOID	Return

	SendScript
Send an AT command script. Returns 0 for fail, 1 for success and 255 for unrecognised script idx.
- BYTE	idx

- BYTE	Return

	AnswerIncomingCall
Answers the phone for an incoming type call. Returns 0 for success and 255 for failure.
- BYTE	Return

	SendCommand
Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply
- STRING	Command

- BYTE	SendCR

- BYTE	Return

	GetTextNumber
Collects the sender's phone number from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	HangUpCall
Ends a voice based call. Returns 0 for success and 255 for failure.
- BYTE	Return

	ReadString
Copies the data from the data string array to a local string variable
- BYTE	NumBytes

- STRING	Return

	SendTextMessage
Sends the text message data specified to the number specified using the SMS protocol. Returns 0 for success and 255 for failure.
- STRING	Number

- STRING	Message

- BYTE	Return

	StringReceive
Attempts to receive a string from the GSM modem.
- BYTE	Return

	DeleteAllMessages
Removes all pending text messages from the GSM module. Returns 0 for success and 255 for fail.
- BYTE	Return

	CheckNetworkStatus
Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM.
- BYTE	Return

	CheckForIncoming
Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing
- BYTE	Return

	Initialise
Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail.
- BYTE	Return

Property reference

	Properties
	Expect Echo
Sets if we expect an echo of any data we send out to the GSM modem. Most AT type modems (e.g. GSM modules) will automatically echo back incoming data.
	String Array Size
Amount of RAM memory to dedicate to receiving responces from the GSM
	Message Array Size
Amount of RAM memory to dedicate to storing the last SMS message received by the GSM.
	Script Count
Maximum number of scripts to store in the device's ROM
	Script1
ASCII based AT command data stored in ROM and used when sending script 1
	Connections
	Port
With PIC target devices, only port avaible are B & C. If port A, D or E is slected then the port will default ot B or C.
	RX
Pin to be used for Receive data
	RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device,
	TX
Pin to be used for Transmit data
	TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device,
	Baud Options
Baud rate option selector
	Baud Rate

	Reset
Pin to be used for Receive data
	Ring
Pin to be used for Receive data
	Simulation
	Scope Traces
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
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
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 API - Routes the communication data via a data API component on the Panel.

==Macro reference==

	DialNumber
Performs a standard voice call by dialling the number specified. Returns 0 for call in progress and 255 for no response.
- STRING	Number

- BYTE	Return

	GetTextString
Collects the text message data from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	SendString
Sends a string to the GSM module.
- STRING	Text

- VOID	Return

	SendScript
Send an AT command script. Returns 0 for fail, 1 for success and 255 for unrecognised script idx.
- BYTE	idx

- BYTE	Return

	AnswerIncomingCall
Answers the phone for an incoming type call. Returns 0 for success and 255 for failure.
- BYTE	Return

	SendCommand
Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply
- STRING	Command

- BYTE	SendCR

- BYTE	Return

	GetTextNumber
Collects the sender's phone number from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	HangUpCall
Ends a voice based call. Returns 0 for success and 255 for failure.
- BYTE	Return

	ReadString
Copies the data from the data string array to a local string variable
- BYTE	NumBytes

- STRING	Return

	SendTextMessage
Sends the text message data specified to the number specified using the SMS protocol. Returns 0 for success and 255 for failure.
- STRING	Number

- STRING	Message

- BYTE	Return

	StringReceive
Attempts to receive a string from the GSM modem.
- BYTE	Return

	DeleteAllMessages
Removes all pending text messages from the GSM module. Returns 0 for success and 255 for fail.
- BYTE	Return

	CheckNetworkStatus
Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM.
- BYTE	Return

	CheckForIncoming
Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing
- BYTE	Return

	Initialise
Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail.
- BYTE	Return

Property reference

	Properties
	Expect Echo
Sets if we expect an echo of any data we send out to the GSM modem. Most AT type modems (e.g. GSM modules) will automatically echo back incoming data.
	String Array Size
Amount of RAM memory to dedicate to receiving responces from the GSM
	Message Array Size
Amount of RAM memory to dedicate to storing the last SMS message received by the GSM.
	Script Count
Maximum number of scripts to store in the device's ROM
	Script1
ASCII based AT command data stored in ROM and used when sending script 1
	Connections
	Port
With PIC target devices, only port avaible are B & C. If port A, D or E is slected then the port will default ot B or C.
	RX
Pin to be used for Receive data
	RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device,
	TX
Pin to be used for Transmit data
	TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device,
	Baud Options
Baud rate option selector
	Baud Rate

	Reset
Pin to be used for Receive data
	Ring
Pin to be used for Receive data
	Simulation
	Scope Traces
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
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
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 API - Routes the communication data via a data API component on the Panel.

==Macro reference==

	DialNumber
Performs a standard voice call by dialling the number specified. Returns 0 for call in progress and 255 for no response.
- STRING	Number

- BYTE	Return

	GetTextString
Collects the text message data from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	SendString
Sends a string to the GSM module.
- STRING	Text

- VOID	Return

	SendScript
Send an AT command script. Returns 0 for fail, 1 for success and 255 for unrecognised script idx.
- BYTE	idx

- BYTE	Return

	AnswerIncomingCall
Answers the phone for an incoming type call. Returns 0 for success and 255 for failure.
- BYTE	Return

	SendCommand
Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply
- STRING	Command

- BYTE	SendCR

- BYTE	Return

	GetTextNumber
Collects the sender's phone number from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	HangUpCall
Ends a voice based call. Returns 0 for success and 255 for failure.
- BYTE	Return

	ReadString
Copies the data from the data string array to a local string variable
- BYTE	NumBytes

- STRING	Return

	SendTextMessage
Sends the text message data specified to the number specified using the SMS protocol. Returns 0 for success and 255 for failure.
- STRING	Number

- STRING	Message

- BYTE	Return

	StringReceive
Attempts to receive a string from the GSM modem.
- BYTE	Return

	DeleteAllMessages
Removes all pending text messages from the GSM module. Returns 0 for success and 255 for fail.
- BYTE	Return

	CheckNetworkStatus
Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM.
- BYTE	Return

	CheckForIncoming
Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing
- BYTE	Return

	Initialise
Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail.
- BYTE	Return

Property reference

	Properties
	Expect Echo
Sets if we expect an echo of any data we send out to the GSM modem. Most AT type modems (e.g. GSM modules) will automatically echo back incoming data.
	String Array Size
Amount of RAM memory to dedicate to receiving responces from the GSM
	Message Array Size
Amount of RAM memory to dedicate to storing the last SMS message received by the GSM.
	Script Count
Maximum number of scripts to store in the device's ROM
	Script1
ASCII based AT command data stored in ROM and used when sending script 1
	Connections
	Port
With PIC target devices, only port avaible are B & C. If port A, D or E is slected then the port will default ot B or C.
	RX
Pin to be used for Receive data
	RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device,
	TX
Pin to be used for Transmit data
	TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device,
	Baud Options
Baud rate option selector
	Baud Rate

	Reset
Pin to be used for Receive data
	Ring
Pin to be used for Receive data
	Simulation
	Scope Traces
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
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
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 API - Routes the communication data via a data API component on the Panel.

==Macro reference==

	DialNumber
Performs a standard voice call by dialling the number specified. Returns 0 for call in progress and 255 for no response.
- STRING	Number

- BYTE	Return

	GetTextString
Collects the text message data from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	SendString
Sends a string to the GSM module.
- STRING	Text

- VOID	Return

	SendScript
Send an AT command script. Returns 0 for fail, 1 for success and 255 for unrecognised script idx.
- BYTE	idx

- BYTE	Return

	AnswerIncomingCall
Answers the phone for an incoming type call. Returns 0 for success and 255 for failure.
- BYTE	Return

	SendCommand
Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply
- STRING	Command

- BYTE	SendCR

- BYTE	Return

	GetTextNumber
Collects the sender's phone number from an incoming text message.
- BYTE	NumBytes

- STRING	Return

	HangUpCall
Ends a voice based call. Returns 0 for success and 255 for failure.
- BYTE	Return

	ReadString
Copies the data from the data string array to a local string variable
- BYTE	NumBytes

- STRING	Return

	SendTextMessage
Sends the text message data specified to the number specified using the SMS protocol. Returns 0 for success and 255 for failure.
- STRING	Number

- STRING	Message

- BYTE	Return

	StringReceive
Attempts to receive a string from the GSM modem.
- BYTE	Return

	DeleteAllMessages
Removes all pending text messages from the GSM module. Returns 0 for success and 255 for fail.
- BYTE	Return

	CheckNetworkStatus
Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM.
- BYTE	Return

	CheckForIncoming
Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing
- BYTE	Return

	Initialise
Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail.
- BYTE	Return

Property reference

	Properties
	Expect Echo
Sets if we expect an echo of any data we send out to the GSM modem. Most AT type modems (e.g. GSM modules) will automatically echo back incoming data.
	String Array Size
Amount of RAM memory to dedicate to receiving responces from the GSM
	Message Array Size
Amount of RAM memory to dedicate to storing the last SMS message received by the GSM.
	Script Count
Maximum number of scripts to store in the device's ROM
	Script1
ASCII based AT command data stored in ROM and used when sending script 1
	Connections
	Port
With PIC target devices, only port avaible are B & C. If port A, D or E is slected then the port will default ot B or C.
	RX
Pin to be used for Receive data
	RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device,
	TX
Pin to be used for Transmit data
	TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device,
	Baud Options
Baud rate option selector
	Baud Rate

	Reset
Pin to be used for Receive data
	Ring
Pin to be used for Receive data
	Simulation
	Scope Traces
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
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
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 API - Routes the communication data via a data API component on the Panel.

Difference between revisions of "Component: GSM (BL0131) (E-blocks 2)"

Revision as of 09:56, 27 January 2023

Contents

GSM (BL0131) component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBlocks2_GSM_BL0131_2d.fcfx FC_Comp_Source_EBlocks2_GSM_BL0131_2d.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBlocks2_GSM_BL0131_2d.fcfx FC_Comp_Source_EBlocks2_GSM_BL0131_2d.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_GSM_BL0131_2d.fcfx FC_Comp_Source_EBlocks2_GSM_BL0131_2d.fcfx]
 ==Detailed description==
@@ Line 34: / Line 36: @@
 ==Examples==
@@ Line 46: / Line 50: @@
 ==Macro reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DialNumber'''
+|-
+| colspan="2" | Performs a standard voice call by dialling the number specified. Returns 0 for call in progress and 255 for no response.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Number
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTextString'''
+|-
+| colspan="2" | Collects the text message data from an incoming text message.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | NumBytes
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendString'''
+|-
+| colspan="2" | Sends a string to the GSM module. &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Text
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendScript'''
+|-
+| colspan="2" | Send an AT command script. Returns 0 for fail, 1 for success and 255 for unrecognised script idx.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | idx
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AnswerIncomingCall'''
+|-
+| colspan="2" | Answers the phone for an incoming type call. Returns 0 for success and 255 for failure.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendCommand'''
+|-
+| colspan="2" | Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Command
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | SendCR
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTextNumber'''
+|-
+| colspan="2" | Collects the sender's phone number from an incoming text message.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | NumBytes
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''HangUpCall'''
+|-
+| colspan="2" | Ends a voice based call. Returns 0 for success and 255 for failure.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadString'''
+|-
+| colspan="2" | Copies the data from the data string array to a local string variable&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | NumBytes
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendTextMessage'''
+|-
+| colspan="2" | Sends the text message data specified to the number specified using the SMS protocol. Returns 0 for success and 255 for failure.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Number
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Message
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StringReceive'''
+|-
+| colspan="2" | Attempts to receive a string from the GSM modem.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DeleteAllMessages'''
+|-
+| colspan="2" | Removes all pending text messages from the GSM module. Returns 0 for success and 255 for fail.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckNetworkStatus'''
+|-
+| colspan="2" | Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckForIncoming'''
+|-
+| colspan="2" | Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+|-
+| colspan="2" | Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+==Property reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Expect Echo
+|-
+| colspan="2" | Sets if we expect an echo of any data we send out to the GSM modem. Most AT type modems (e.g. GSM modules) will automatically echo back incoming data.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | String Array Size
+|-
+| colspan="2" | Amount of RAM memory to dedicate to receiving responces from the GSM&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Message Array Size
+|-
+| colspan="2" | Amount of RAM memory to dedicate to storing the last SMS message received by the GSM.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Script Count
+|-
+| colspan="2" | Maximum number of scripts to store in the device's ROM&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
+| width="90%" | Script1
+|-
+| colspan="2" | ASCII based AT command data stored in ROM and used when sending script 1&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
+| width="90%" | Port
+|-
+| colspan="2" | With PIC target devices, only port avaible are B & C.  If port A, D or E is slected then the port will default ot B or C.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | RX
+|-
+| colspan="2" | Pin to be used for Receive data&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | RX Remap Pin
+|-
+| colspan="2" | Allows the hardware receive pin to be configured from a list of available pins based on your target device,&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | TX
+|-
+| colspan="2" | Pin to be used for Transmit data&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | TX Remap Pin
+|-
+| colspan="2" | Allows the hardware transmit pin to be configured from a list of available pins based on your target device,&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Baud Options
+|-
+| colspan="2" | Baud rate option selector&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Baud Rate
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | Reset
+|-
+| colspan="2" | Pin to be used for Receive data&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | Ring
+|-
+| colspan="2" | Pin to be used for Receive data&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Scope Traces
+|-
+| colspan="2" | 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.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Console Data
+|-
+| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+| width="90%" | Console Columns
+|-
+| colspan="2" | Number of characters that can be displayed on a single line of the console.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Data Source
+|-
+| colspan="2" | 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      API - Routes the communication data via a data API component on the Panel.&nbsp;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"