Component: MIAC GSM (MIAC: Addon Modules)
| Author | |
| Version | 1.0 |
| Category | MIAC: Addon Modules |
MIAC GSM component
GSM Addon for MIAC System.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_ma_gsm.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_ma_gsm.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
AnalogInput
|
AnalogInput |
| Read the ADC value of a Terminal Returns 12 bit ADC reading | |
 - BYTE
|
Terminal |
| Terminal number to be read | |
 - UINT
|
Return |
DigitalInput
|
|
DigitalInput |
| Read the value of a terminal | |
| - BYTE
|
Terminal |
| - BYTE
|
Return |
DigitalOutput
|
|
DigitalOutput |
| Set a Terminal Output to High (Value=1) or Low (Value=0) | |
| - BYTE
|
Terminal |
| - BYTE
|
Value |
| - BYTE
|
Return |
GSM_AnswerIncomingCall
|
|
GSM_AnswerIncomingCall |
| Answers the phone for an incoming type call. Returns 0 for success and 255 for failure. | |
| - BYTE
|
Return |
GSM_CheckForIncoming
|
|
GSM_CheckForIncoming |
| Checks to see if any incoming phone call or SMS message. 0 = Nothing, 1 = Text Received, 2 = Phone Ringing | |
| - BYTE
|
Return |
GSM_CheckNetworkStatus
|
|
GSM_CheckNetworkStatus |
| Returns the state of the GSM network. 0 = Not connected, 1 = connected, 255 = no reply from GSM. | |
| - BYTE
|
Return |
GSM_DialNumber
|
|
GSM_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 |
GSM_GetCharCount
|
|
GSM_GetCharCount |
| Returns the number of characters waiting to be read from the receive buffer. (Low level GSM interface) | |
| - BYTE
|
Return |
GSM_GetCharacter
|
|
GSM_GetCharacter |
| Returns the next character waiting to be read from the receive buffer. (Low level GSM interface) | |
| - BYTE
|
Return |
GSM_GetStatus
|
|
GSM_GetStatus |
| Returns status bits from the GSM module. Bit 6 = CTS, Bit 12 = STATUS (LED), Bit 13 = RING (Low level GSM interface) | |
| - UINT
|
Return |
GSM_GetTextNumber
|
|
GSM_GetTextNumber |
| Collects the sender's phone number from an incoming text message. | |
| - BYTE
|
NumBytes |
| - STRING
|
Return |
GSM_GetTextString
|
|
GSM_GetTextString |
| Collects the text message data from an incoming text message. | |
| - BYTE
|
NumBytes |
| - STRING
|
Return |
GSM_HangUpCall
|
|
GSM_HangUpCall |
| Ends a voice based call. Returns 0 for success and 255 for failure. | |
| - BYTE
|
Return |
GSM_Initialize
|
|
GSM_Initialize |
| Resets and restarts the GSM module Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail. | |
| - BYTE
|
Return |
GSM_ReadString
|
|
GSM_ReadString |
| Copies the data from the data string array to a local string variable | |
| - BYTE
|
NumBytes |
| - STRING
|
Return |
GSM_SendCharacter
|
|
GSM_SendCharacter |
| Sends the byte character to the GSM module. (Low level GSM interface) | |
| - BYTE
|
Byte |
 - VOID
|
Return |
GSM_SendCommand
|
|
GSM_SendCommand |
| Sends a command string to the GSM module. 0 = Command sent ok, 255 = No Reply | |
| - STRING
|
Command |
| - BYTE
|
SendCR |
| - BYTE
|
Return |
GSM_SendScript
|
|
GSM_SendScript |
| Send an AT command script. Returns 0 for fail, 1 for success and 255 for unrecognised script idx. | |
| - BYTE
|
idx |
| - BYTE
|
Return |
GSM_SendTextMessage
|
|
GSM_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 |
GSM_SetRTS
|
|
GSM_SetRTS |
| Sets the state of the GSM module RTS pin. (Low level GSM interface) | |
| - BYTE
|
State |
| - VOID
|
Return |
GSM_SetReset
|
|
GSM_SetReset |
| Sets the state of the GSM module Reset pin. State = 0 will hold the module in the reset state (Low level GSM interface) | |
| - BYTE
|
State |
| - VOID
|
Return |
GSM_SetStart
|
|
GSM_SetStart |
| Sets the state of the GSM module Start pin. (Low level GSM interface) | |
| - BYTE
|
State |
| - VOID
|
Return |
GSM_StringReceive
|
|
GSM_StringReceive |
| Attempts to receive a string from the GSM modem. Returns 1 if successful, 0 on timeout | |
| - BYTE
|
Return |
LED_Control
|
|
LED_Control |
| Sets the indicator LED On (State=1) or Off (State=0) | |
| - BYTE
|
State |
| - VOID
|
Return |
MIAC_Module_GetAck
|
|
MIAC_Module_GetAck |
| - UINT
|
CAN_ID |
| - UINT
|
CMD_ID |
| - UINT
|
TimeOut |
| - BYTE
|
Return |
MIAC_Module_GetData
|
|
MIAC_Module_GetData |
| - BYTE
|
Index |
| - BYTE
|
Return |
MIAC_Module_Init
|
|
MIAC_Module_Init |
| - UINT
|
CAN_ID |
| - VOID
|
Return |
MIAC_Module_Message
|
|
MIAC_Module_Message |
| - UINT
|
CAN_ID |
| - UINT
|
CMD_ID |
| - BYTE
|
Return |
MIAC_Module_PushData
|
|
MIAC_Module_PushData |
| - BYTE
|
Data |
| - VOID
|
Return |
MIAC_Module_SetData
|
|
MIAC_Module_SetData |
| - BYTE
|
Count |
| - BYTE
|
D0 |
| - BYTE
|
D1 |
| - BYTE
|
D2 |
| - BYTE
|
D3 |
| - BYTE
|
D4 |
| - BYTE
|
D5 |
| - VOID
|
Return |
MIAC_Module_WR
|
|
MIAC_Module_WR |
| - UINT
|
CAN_ID |
| - UINT
|
CMD_ID |
| [[File:]] - | Count |
| [[File:]] - | Start |
| [[File:]] - | More |
| - VOID
|
Return |
Property reference
|
Properties |
|
Module Type |
|
|
Module Address |
|
|
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 | |
|
|
Expect Echo |