Component: GSM (EB066, Generic AT) (Wireless)

Author	Matrix Ltd.
Version	2.0
Category	Wireless

GSM (EB066, Generic AT) component

Low level routines for controlling a standard AT GSM / GPRS interface Also available in the form of the EB066 GSM E-block.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

DialNumber

	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

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

SendString

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

SendScript

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

SendCommand

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

AnswerIncomingCall

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

GetTextNumber

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

HangUpCall

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

ReadString

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

SendTextMessage

	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

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

DeleteAllMessages

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

CheckNetworkStatus

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

CheckForIncoming

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

Initialise

	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
	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.
	TX
Pin to be used for Transmit data
	RX
Pin to be used for Receive data
	Use Flow Control
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.
	Baud Options
Baud rate option selector
	Baud Rate
	Simulation
	Label
Textual label shown on the component I/O flasher
	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.