Component: GSM (EB066, Generic AT) (Wireless): Difference between revisions
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (23 intermediate revisions by 3 users not shown) | |||
| Line 14: | Line 14: | ||
==GSM (EB066, Generic AT) component== | ==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. | 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: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_GSM.fcfx FC_Comp_Source_GSM.fcfx] | |||
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== | ==Detailed description== | ||
| Line 21: | Line 41: | ||
''No detailed description exists yet for this component'' | ''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 | |||
{{Fcfile|GSM_DEMO_Arduino.fcfx|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 | |||
{{Fcfile|GSM_DEMO.fcfx|PIC GSM Example}} | |||
== | ==Macro reference== | ||
{| class="wikitable | ===AnswerIncomingCall=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''AnswerIncomingCall''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Answers the phone for an incoming type call. Returns 0 for success and 255 for failure. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| Line 62: | Line 87: | ||
{| class="wikitable | ===CheckForIncoming=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CheckForIncoming''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===CheckNetworkStatus=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CheckNetworkStatus''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===DeleteAllMessages=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''DeleteAllMessages''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Removes all pending text messages from the GSM module. Returns 0 for success and 255 for fail. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| Line 116: | Line 129: | ||
{| class="wikitable | ===DialNumber=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''DialNumber''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Performs a standard voice call by dialling the number specified. Returns 0 for call in progress and 255 for no response. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| width="90%" | | | width="90%" | Number | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 139: | Line 148: | ||
{| class="wikitable" | ===GetTextNumber=== | ||
{| 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. | |||
|- | |- | ||
|- | |- | ||
| | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| width="90%" | NumBytes | |||
|- | |- | ||
| colspan="2" | | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===GetTextString=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetTextString''' | ||
|- | |- | ||
| colspan="2" | Collects the | | colspan="2" | Collects the text message data from an incoming text message. | ||
|- | |- | ||
|- | |- | ||
| Line 170: | Line 186: | ||
{| class="wikitable | ===HangUpCall=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''HangUpCall''' | ||
|- | |- | ||
| colspan="2" | Ends a voice based call. Returns 0 for success and 255 for failure. | | colspan="2" | Ends a voice based call. Returns 0 for success and 255 for failure. | ||
| Line 183: | Line 200: | ||
{| class="wikitable" | ===Initialise=== | ||
{| 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. | |||
|- | |- | ||
| width="10%" align="center" style=" | |- | ||
| width="90%" | | 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'' | |||
|} | |||
===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 | | colspan="2" | Copies the data from the data string array to a local string variable | ||
| Line 201: | Line 233: | ||
{| class="wikitable | ===SendCommand=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SendCommand''' | ||
|- | |- | ||
| colspan="2" | Sends | | colspan="2" | Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| width="90%" | | | width="90%" | Command | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9- | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| width="90%" | | | width="90%" | SendCR | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 224: | Line 257: | ||
{| class="wikitable" | ===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. | |||
|- | |- | ||
|- | |- | ||
| | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| width="90%" | idx | |||
|- | |- | ||
| colspan="2" | | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| Line 237: | Line 276: | ||
{| class="wikitable" | ===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. | |||
|- | |- | ||
|- | |- | ||
| | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| width="90%" | Text | |||
|- | |- | ||
| colspan="2" | | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===SendTextMessage=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SendTextMessage''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Sends the text message data specified to the number specified using the SMS protocol. Returns 0 for success and 255 for failure. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| width="90% | | width="90%" | Number | ||
|- | |- | ||
| | | colspan="2" | | ||
|- | |- | ||
| | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| width="90%" | Message | |||
|- | |- | ||
| colspan="2" | | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| Line 276: | Line 319: | ||
{| class="wikitable | ===StringReceive=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''StringReceive''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Attempts to receive a string from the GSM modem. | ||
|- | |- | ||
|- | |- | ||
| Line 287: | Line 331: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| Line 324: | Line 366: | ||
| colspan="2" | 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 | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| Line 358: | Line 400: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
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
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
Macro reference
AnswerIncomingCall
| AnswerIncomingCall | |
| Answers the phone for an incoming type call. Returns 0 for success and 255 for failure. | |
| Return | |
CheckForIncoming
| CheckForIncoming | |
| Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing | |
| Return | |
CheckNetworkStatus
| CheckNetworkStatus | |
| Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM. | |
| Return | |
DeleteAllMessages
| DeleteAllMessages | |
| Removes all pending text messages from the GSM module. Returns 0 for success and 255 for fail. | |
| Return | |
DialNumber
| DialNumber | |
| Performs a standard voice call by dialling the number specified. Returns 0 for call in progress and 255 for no response. | |
| Number | |
| Return | |
GetTextNumber
| GetTextNumber | |
| Collects the sender's phone number from an incoming text message. | |
| NumBytes | |
| Return | |
GetTextString
| GetTextString | |
| Collects the text message data from an incoming text message. | |
| NumBytes | |
| Return | |
HangUpCall
| HangUpCall | |
| Ends a voice based call. Returns 0 for success and 255 for failure. | |
| Return | |
Initialise
| Initialise | |
| Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail. | |
| Return | |
ReadString
| ReadString | |
| Copies the data from the data string array to a local string variable | |
| NumBytes | |
| Return | |
SendCommand
| SendCommand | |
| Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply | |
| Command | |
| SendCR | |
| Return | |
SendScript
| SendScript | |
| Send an AT command script. Returns 0 for fail, 1 for success and 255 for unrecognised script idx. | |
| idx | |
| Return | |
SendString
| SendString | |
| Sends a string to the GSM module. | |
| Text | |
| 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. | |
| Number | |
| Message | |
| Return | |
StringReceive
| StringReceive | |
| Attempts to receive a string from the GSM modem. | |
| Return | |