Jump to content

Component: GSM (EB066, Generic AT) (Wireless): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,424 edits
XML import
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
| Matrix Ltd.
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 2.0 (Release)
| 2.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Wireless
| 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.


==[[File:Component Icon 0d02ccfd_4cda_42b8_91d8_5392f491f9af.png|Image]] GSM (EB066, Generic AT) component==
==Component Source Code==
Low level routines for controlling a standard AT GSM / GPRS interface
Also available in the form of the EB066 GSM E-block.


==Examples==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_GSM.fcfx FC_Comp_Source_GSM.fcfx]
{{Fcfile|GSM_Test.fcfx|GSM Example}}
Example should show the following on the display on the panel and on the hardware.


[[File:GSMPan.jpg]]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_GSM.fcfx FC_Comp_Source_GSM.fcfx]


==Detailed description==


The AT injector component allows us to simulate the response of the GSM module.


[[File:GSMInject.jpg]]


==Downloadable macro reference==


===<span style="font-weight: normal;"><u><tt>DialNumber</tt></u></span>===
Performs a standard voice call by dialling the number specified.


Returns 0 for call in progress and 255 for no response.


'''Parameters'''


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




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>GetTextString</tt></u></span>===
Collects the text message data from an incoming text message.


'''Parameters'''


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




'''Return value'''


:[[Variable Types|STRING]]
''No detailed description exists yet for this component''


==Examples==


===<span style="font-weight: normal;"><u><tt>SendString</tt></u></span>===
Example program that checks for network connection and then allows a number to be texted or voice dialled.
Sends a string to the GSM module.


'''Parameters'''
Waits for connection to be established before allowing texts or calls to be made.


:[[Variable Types|<- STRING]] ''Text''
The number at the top of the file in the calculation icon needs to be edited to a number to connect to for texts and calls.
::''This parameter may be returned back to the caller''




'''Return value'''
Arduino Connections:


:''This call does not return a value''
D8-D13 - LEDs / D8 = Connection Status - Flashing = Connecting /  D9 Text sending / D10 Call Active


D0-D7 - GSM


===<span style="font-weight: normal;"><u><tt>SendScript</tt></u></span>===
A0-A5 - Switches - A0 = Send Text / A1 = Start voice call / A2 = End call
Send an AT command script.


Returns 0 for fail, 1 for success and 255 for unrecognised script idx.
{{Fcfile|GSM_DEMO_Arduino.fcfx|Arduino GSM Example}}


'''Parameters'''


:[[Variable Types|BYTE]] ''idx''
PIC Connections


B0-B7 - LEDs / B0 = Connection Status - Flashing = Connecting /  B1 Text sending / B2 Call Active


'''Return value'''
C0-C7 - GSM


:[[Variable Types|BYTE]]
A0-A7 - Switches - A0 = Send Text / A1 = Start voice call / A2 = End call


{{Fcfile|GSM_DEMO.fcfx|PIC GSM Example}}


===<span style="font-weight: normal;"><u><tt>AnswerIncomingCall</tt></u></span>===
==Macro reference==
Answers the phone for an incoming type call.


Returns 0 for success and 255 for failure.
===AnswerIncomingCall===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


'''Parameters'''


:''This macro has no parameters''
===CheckForIncoming===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}




'''Return value'''
===CheckNetworkStatus===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


:[[Variable Types|BYTE]]


===DeleteAllMessages===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


===<span style="font-weight: normal;"><u><tt>SendCommand</tt></u></span>===
Sends a command string to the GSM module.


0 = Command sent ok, 255 = No Reply
===DialNumber===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


'''Parameters'''


:[[Variable Types|<- STRING]] ''Command''
===GetTextNumber===
::''This parameter may be returned back to the caller''
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


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


===GetTextString===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


'''Return value'''


:[[Variable Types|BYTE]]
===HangUpCall===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}




===<span style="font-weight: normal;"><u><tt>GetTextNumber</tt></u></span>===
===Initialise===
Collects the sender's phone number from an incoming text message.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


'''Parameters'''


:[[Variable Types|BYTE]] ''NumBytes''
===ReadString===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}




'''Return value'''
===SendCommand===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


:[[Variable Types|STRING]]


===SendScript===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


===<span style="font-weight: normal;"><u><tt>HangUpCall</tt></u></span>===
Ends a voice based call.


Returns 0 for success and 255 for failure.
===SendString===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


'''Parameters'''


:''This macro has no parameters''
===SendTextMessage===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}




'''Return value'''
===StringReceive===
 
{| class="mtx-class-macrotable wikitable"
:[[Variable Types|BYTE]]
|-
 
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
 
| width="90%" class="mtx-class-macrohead" | '''StringReceive'''
===<span style="font-weight: normal;"><u><tt>ReadString</tt></u></span>===
|-
Copies the data from the data string array to a local string variable
| colspan="2" | Attempts to receive a string from the GSM modem.&nbsp;
 
|-
'''Parameters'''
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
:[[Variable Types|BYTE]] ''NumBytes''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
'''Return value'''
 
:[[Variable Types|STRING]]
 
 
===<span style="font-weight: normal;"><u><tt>SendTextMessage</tt></u></span>===
Sends the text message data specified to the number specified using the SMS protocol.
 
Returns 0 for success and 255 for failure.
 
'''Parameters'''
 
:[[Variable Types|<- STRING]] ''Number''
::''This parameter may be returned back to the caller''
 
:[[Variable Types|<- STRING]] ''Message''
::''This parameter may be returned back to the caller''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>StringReceive</tt></u></span>===
Attempts to receive a string from the GSM modem.
 
'''Parameters'''
 
:''This macro has no parameters''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>DeleteAllMessages</tt></u></span>===
Removes all pending text messages from the GSM module.
 
Returns 0 for success and 255 for fail.
 
'''Parameters'''
 
:''This macro has no parameters''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>CheckNetworkStatus</tt></u></span>===
Returns the state of the GSM network.
 
0 = Not connected, 1 = connected, 255 = no reply from GSM.
 
'''Parameters'''
 
:''This macro has no parameters''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>CheckForIncoming</tt></u></span>===
Checks to see if any incoming phone call or SMS message.
 
0 = Nothing, 1 = Text Received, 2 = Phone Ringing
 
'''Parameters'''
 
:''This macro has no parameters''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
Sets up the GSM module.
 
Returns 0 for OK, 255 for no reply and 254 for command fail.
 
'''Parameters'''
 
:''This macro has no parameters''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
 
==Simulation macro reference==
 
''This component does not contain any simulation macros''




==Property reference==
==Property reference==
<span style="font-weight: normal;"><u>Expect Echo</u></span>


This property is of type ''True or false'' and can be referenced with the variable name ''expect_echo''.
{| class="mtx-class-macrotable wikitable"
 
|-
Sets if we expect an echo of any data we send out to the GSM modem.
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
Most AT type modems (e.g. GSM modules) will automatically echo back incoming data.
|-
 
|-
<span style="font-weight: normal;"><u>String Array Size</u></span>
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Expect Echo
This property is of type ''Signed integer'' and can be referenced with the variable name ''string_size''.
|-
 
| 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;
Amount of RAM memory to dedicate to receiving responces from the GSM
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
<span style="font-weight: normal;"><u>Message Array Size</u></span>
| width="90%" | String Array Size
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''message_size''.
| colspan="2" | Amount of RAM memory to dedicate to receiving responces from the GSM&nbsp;
 
|-
Amount of RAM memory to dedicate to storing the last SMS message received by the GSM.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Message Array Size
<span style="font-weight: normal;"><u>Script Count</u></span>
|-
 
| colspan="2" | Amount of RAM memory to dedicate to storing the last SMS message received by the GSM.&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''script_count''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Maximum number of scripts to store in the device's ROM
| width="90%" | Script Count
 
|-
<span style="font-weight: normal;"><u>Script1</u></span>
| colspan="2" | Maximum number of scripts to store in the device's ROM&nbsp;
 
|-
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''script1''.
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 
| width="90%" | Script1
ASCII based AT command data stored in ROM and used when sending script 1
|-
 
| colspan="2" | ASCII based AT command data stored in ROM and used when sending script 1&nbsp;
<span style="font-weight: normal;"><u>Channel</u></span>
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::CHANNEL''.
| width="90%" class="mtx-class-propfolder" | Connections
 
|-
UART Channel selector
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.
| width="90%" | Channel
 
|-
Hardware channels use the selected peripheral on-board the target microcontroller.
| colspan="2" | 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.&nbsp;
 
|-
<span style="font-weight: normal;"><u>TX</u></span>
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | TX
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::TX''.
|-
 
| colspan="2" | Pin to be used for Transmit data&nbsp;
Pin to be used for Transmit data
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
<span style="font-weight: normal;"><u>RX</u></span>
| width="90%" | RX
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::RX''.
| colspan="2" | Pin to be used for Receive data&nbsp;
 
|-
Pin to be used for Receive data
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Use Flow Control
<span style="font-weight: normal;"><u>Use Flow Control</u></span>
|-
 
| colspan="2" | 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.&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::FLOWEN''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Flow Control (Handshake) enable or disable.
| width="90%" | Baud Options
 
|-
     On: Two I/O pins are used to control the flow of data in and out of the device.
| colspan="2" | Baud rate option selector&nbsp;
 
|-
     Off: Flow control is disabled.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Baud Rate
<span style="font-weight: normal;"><u>Baud Options</u></span>
|-
 
| colspan="2" | &nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::BAUD_LIST''.
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
Baud rate option selector
| width="90%" class="mtx-class-propfolder" | Simulation
 
|-
<span style="font-weight: normal;"><u>Baud Rate</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_uart::BAUD''.
| width="90%" | Label
 
|-
''<span style="color:red;">No additional information</span>''
| colspan="2" | Textual label shown on the component I/O flasher&nbsp;
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Scope Traces
<span style="font-weight: normal;"><u>Label</u></span>
|-
 
| 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;
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
Textual label shown on the component I/O flasher
| width="90%" | Console Data
 
|-
<span style="font-weight: normal;"><u>Scope Traces</u></span>
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::ScopeTraces''.
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
| width="90%" | Console Columns
Selects if the scope traces are automatically added to the data recorder window or not.
|-
 
| colspan="2" | Number of characters that can be displayed on a single line of the console.&nbsp;
     Simulation - draws an approximation of the UART data onto the scope trace.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
     ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
| width="90%" | Data Source
 
|-
<span style="font-weight: normal;"><u>Console Data</u></span>
| 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;
 
|}
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
 
<span style="font-weight: normal;"><u>Console Columns</u></span>
 
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.
 
<span style="font-weight: normal;"><u>Data Source</u></span>
 
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.

Latest revision as of 14:37, 13 July 2026

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

Example program that checks for network connection and then allows a number to be texted or voice dialled.

Waits for connection to be established before allowing texts or calls to be made.

The number at the top of the file in the calculation icon needs to be edited to a number to connect to for texts and calls.


Arduino Connections:

D8-D13 - LEDs / D8 = Connection Status - Flashing = Connecting / D9 Text sending / D10 Call Active

D0-D7 - GSM

A0-A5 - Switches - A0 = Send Text / A1 = Start voice call / A2 = End call

Arduino GSM Example


PIC Connections

B0-B7 - LEDs / B0 = Connection Status - Flashing = Connecting / B1 Text sending / B2 Call Active

C0-C7 - GSM

A0-A7 - Switches - A0 = Send Text / A1 = Start voice call / A2 = End call

PIC GSM Example

Macro reference

AnswerIncomingCall

AnswerIncomingCall
Answers the phone for an incoming type call. Returns 0 for success and 255 for failure. 
- 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


CheckNetworkStatus

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


DeleteAllMessages

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


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


GetTextNumber

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


GetTextString

GetTextString
Collects the text message data 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


Initialise

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


ReadString

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


SendCommand

SendCommand
Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply 
- STRING Command
 
- BYTE SendCR
 
- BYTE 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


SendString

SendString
Sends a string to the GSM module.  
- STRING Text
 
- VOID 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


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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_GSM_(EB066,_Generic_AT)_(Wireless)&oldid=47949"