Difference between revisions of "Component: MIAC GSM (MIAC: Addon Modules)"

Latest revision as of 13:13, 7 February 2023

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

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
-| [http://www.matrixtsl.com Matrix TSL]
+|
 |-
-| width="20%" style="color: gray;" | Version
+| width="20%" style="color:gray;" | Version
-| 1.0 (Release)
+| 1.0
 |-
-| width="20%" style="color: gray;" | Category
+| width="20%" style="color:gray;" | Category
 | MIAC: Addon Modules
 |}
+==MIAC GSM component==
-==[[File:Component Icon 018199e8_ef66_49af_bac0_483043d71830.png|Image]] MIAC GSM component==
 GSM Addon for MIAC System.
-==Examples==
+==Component Source Code==
-''<span style="color:red;">No additional examples</span>''
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ma_gsm.fcfx FC_Comp_Source_ma_gsm.fcfx]
-==Downloadable macro reference==
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ma_gsm.fcfx FC_Comp_Source_ma_gsm.fcfx]
-===<span style="font-weight: normal;"><u><tt>GSM_SetStart</tt></u></span>===
+==Detailed description==
-Sets the state of the GSM module Start pin.
-(Low level GSM interface)
-'''Parameters'''
-:[[Variable Types|BYTE]] ''State''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>GSM_CheckNetworkStatus</tt></u></span>===
-Returns the state of the GSM network.
-= Not connected, 1 = connected, 255 = no reply from GSM.
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|BYTE]]
+''No detailed description exists yet for this component''
-===<span style="font-weight: normal;"><u><tt>GSM_SendCommand</tt></u></span>===
+==Examples==
-Sends a command string to the GSM module.
-= Command sent ok, 255 = No Reply
-'''Parameters'''
-:[[Variable Types|<- STRING]] ''Command''
-::''This parameter may be returned back to the caller''
-:[[Variable Types|BYTE]] ''SendCR''
-'''Return value'''
-:[[Variable Types|BYTE]]
-===<span style="font-weight: normal;"><u><tt>GSM_SendScript</tt></u></span>===
-Send an AT command script.
-Returns 0 for fail, 1 for success and 255 for unrecognised script idx.
-'''Parameters'''
-:[[Variable Types|BYTE]] ''idx''
-'''Return value'''
-:[[Variable Types|BYTE]]
+''<span style="color:red;">No additional examples</span>''
-===<span style="font-weight: normal;"><u><tt>GSM_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>GSM_GetCharCount</tt></u></span>===
-Returns the number of characters waiting to be read from the receive buffer.
-(Low level GSM interface)
-'''Parameters'''
+==Macro reference==
-:''This macro has no parameters''
+===AnalogInput===
+{| 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;" | '''AnalogInput'''
+|-
+| colspan="2" | Read the ADC value of a Terminal Returns 12 bit ADC reading&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Terminal
+|-
+| colspan="2" | Terminal number to be read&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-'''Return value'''
+===DigitalInput===
+{| 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;" | '''DigitalInput'''
+|-
+| colspan="2" | Read the value of a terminal &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Terminal
+|-
+| 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|BYTE]]
+===DigitalOutput===
+{| 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;" | '''DigitalOutput'''
+|-
+| colspan="2" | Set a Terminal Output to High (Value=1) or Low (Value=0)&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Terminal
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Value
+|-
+| 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>GSM_CheckForIncoming</tt></u></span>===
-Checks to see if any incoming phone call or SMS message.
-= Nothing, 1 = Text Received, 2 = Phone Ringing
+===GSM_AnswerIncomingCall===
+{| 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;" | '''GSM_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''
+===GSM_CheckForIncoming===
+{| 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;" | '''GSM_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'''
+===GSM_CheckNetworkStatus===
+{| 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;" | '''GSM_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]]
+===GSM_DialNumber===
+{| 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;" | '''GSM_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''
+|}
-===<span style="font-weight: normal;"><u><tt>GSM_HangUpCall</tt></u></span>===
-Ends a voice based call.
-Returns 0 for success and 255 for failure.
+===GSM_GetCharCount===
+{| 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;" | '''GSM_GetCharCount'''
+|-
+| colspan="2" | Returns the number of characters waiting to be read from the receive buffer. (Low level GSM interface) &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''
+===GSM_GetCharacter===
+{| 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;" | '''GSM_GetCharacter'''
+|-
+| colspan="2" | Returns the next character waiting to be read from the receive buffer. (Low level GSM interface) &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'''
+===GSM_GetStatus===
+{| 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;" | '''GSM_GetStatus'''
+|-
+| colspan="2" | Returns status bits from the GSM module. Bit 6 = CTS, Bit 12 = STATUS (LED), Bit 13 = RING (Low level GSM interface) &nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-:[[Variable Types|BYTE]]
+===GSM_GetTextNumber===
+{| 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;" | '''GSM_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''
+|}
-===<span style="font-weight: normal;"><u><tt>GSM_SetReset</tt></u></span>===
-Sets the state of the GSM module Reset pin.
-State = 0 will hold the module in the reset state
+===GSM_GetTextString===
+{| 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;" | '''GSM_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''
+|}
-(Low level GSM interface)
-'''Parameters'''
+===GSM_HangUpCall===
+{| 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;" | '''GSM_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''
+|}
-:[[Variable Types|BYTE]] ''State''
+===GSM_Initialize===
+{| 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;" | '''GSM_Initialize'''
+|-
+| colspan="2" | Resets and restarts the GSM module 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''
+|}
-'''Return value'''
-:''This call does not return a value''
+===GSM_ReadString===
+{| 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;" | '''GSM_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''
+|}
-===<span style="font-weight: normal;"><u><tt>GSM_DialNumber</tt></u></span>===
+===GSM_SendCharacter===
-Performs a standard voice call by dialling the number specified.
+{| 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;" | '''GSM_SendCharacter'''
+|-
+| colspan="2" | Sends the byte character to the GSM module. (Low level GSM interface) &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Byte
+|-
+| 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''
+|}
-Returns 0 for call in progress and 255 for no response.
-'''Parameters'''
+===GSM_SendCommand===
+{| 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;" | '''GSM_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]] ''Number''
-::''This parameter may be returned back to the caller''
+===GSM_SendScript===
+{| 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;" | '''GSM_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''
+|}
-'''Return value'''
-:[[Variable Types|BYTE]]
+===GSM_SendTextMessage===
+{| 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;" | '''GSM_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''
+|}
-===<span style="font-weight: normal;"><u><tt>GSM_StringReceive</tt></u></span>===
+===GSM_SetRTS===
-Attempts to receive a string from the GSM modem.
+{| 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;" | '''GSM_SetRTS'''
+|-
+| colspan="2" | Sets the state of the GSM module RTS pin. (Low level GSM interface)&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | State
+|-
+| 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''
+|}
-Returns 1 if successful, 0 on timeout
-'''Parameters'''
+===GSM_SetReset===
+{| 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;" | '''GSM_SetReset'''
+|-
+| colspan="2" | Sets the state of the GSM module Reset pin. State = 0 will hold the module in the reset state (Low level GSM interface)&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | State
+|-
+| 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''
+|}
-:''This macro has no parameters''
+===GSM_SetStart===
+{| 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;" | '''GSM_SetStart'''
+|-
+| colspan="2" | Sets the state of the GSM module Start pin. (Low level GSM interface)&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | State
+|-
+| 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''
+|}
-'''Return value'''
-:[[Variable Types|BYTE]]
+===GSM_StringReceive===
+{| 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;" | '''GSM_StringReceive'''
+|-
+| colspan="2" | Attempts to receive a string from the GSM modem. Returns 1 if successful, 0 on timeout&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>LED_Control</tt></u></span>===
+===LED_Control===
-Sets the indicator LED On (State=1) or Off (State=0)
+{| 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;" | '''LED_Control'''
+|-
+| colspan="2" | Sets the indicator LED On (State=1) or Off (State=0)&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | State
+|-
+| 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'''
-:[[Variable Types|BYTE]] ''State''
+===MIAC_Module_GetAck===
+{| 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;" | '''MIAC_Module_GetAck'''
+|-
+| colspan="2" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | CAN_ID
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | CMD_ID
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | TimeOut
+|-
+| 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'''
+===MIAC_Module_GetData===
+{| 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;" | '''MIAC_Module_GetData'''
+|-
+| colspan="2" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Index
+|-
+| 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''
+|}
-:''This call does not return a value''
+===MIAC_Module_Init===
+{| 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;" | '''MIAC_Module_Init'''
+|-
+| colspan="2" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | CAN_ID
+|-
+| 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''
+|}
-===<span style="font-weight: normal;"><u><tt>GSM_AnswerIncomingCall</tt></u></span>===
-Answers the phone for an incoming type call.
-Returns 0 for success and 255 for failure.
+===MIAC_Module_Message===
+{| 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;" | '''MIAC_Module_Message'''
+|-
+| colspan="2" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | CAN_ID
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | CMD_ID
+|-
+| 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'''
-:''This macro has no parameters''
+===MIAC_Module_PushData===
+{| 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;" | '''MIAC_Module_PushData'''
+|-
+| colspan="2" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Data
+|-
+| 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''
+|}
-'''Return value'''
+===MIAC_Module_SetData===
+{| 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;" | '''MIAC_Module_SetData'''
+|-
+| colspan="2" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Count
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | D0
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | D1
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | D2
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | D3
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | D4
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | D5
+|-
+| 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''
+|}
-:[[Variable Types|BYTE]]
-===<span style="font-weight: normal;"><u><tt>GSM_SetRTS</tt></u></span>===
-Sets the state of the GSM module RTS pin.
-(Low level GSM interface)
-'''Parameters'''
-:[[Variable Types|BYTE]] ''State''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>GSM_Initialize</tt></u></span>===
-Resets and restarts the GSM module
-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]]
-===<span style="font-weight: normal;"><u><tt>GSM_SendCharacter</tt></u></span>===
-Sends the byte character to the GSM module.
-(Low level GSM interface)
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Byte''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>GSM_ReadString</tt></u></span>===
-Copies the data from the data string array to a local string variable
-'''Parameters'''
-:[[Variable Types|BYTE]] ''NumBytes''
-'''Return value'''
-:[[Variable Types|STRING]]
-===<span style="font-weight: normal;"><u><tt>DigitalOutput</tt></u></span>===
-Set a Terminal Output to High (Value=1) or Low (Value=0)
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Terminal''
-:[[Variable Types|BYTE]] ''Value''
-'''Return value'''
-:[[Variable Types|BYTE]]
+===MIAC_Module_WR===
-===<span style="font-weight: normal;"><u><tt>GSM_GetTextString</tt></u></span>===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Collects the text message data from an incoming text message.
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-'''Parameters'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MIAC_Module_WR'''
+|-
-:[[Variable Types|BYTE]] ''NumBytes''
+| colspan="2" | &nbsp;
+|-
+|-
-'''Return value'''
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | CAN_ID
-:[[Variable Types|STRING]]
+|-
+| colspan="2" | &nbsp;
+|-
-===<span style="font-weight: normal;"><u><tt>GSM_GetStatus</tt></u></span>===
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-Returns status bits from the GSM module.
+| width="90%" | CMD_ID
+|-
-Bit 6 = CTS, Bit 12 = STATUS (LED), Bit 13 = RING
+| colspan="2" | &nbsp;
+|-
-(Low level GSM interface)
+| width="10%" align="center" | [[File:]] -
+| width="90%" | Count
-'''Parameters'''
+|-
+| colspan="2" | &nbsp;
-:''This macro has no parameters''
+|-
+| width="10%" align="center" | [[File:]] -
+| width="90%" | Start
-'''Return value'''
+|-
+| colspan="2" | &nbsp;
-:[[Variable Types|UINT]]
+|-
+| width="10%" align="center" | [[File:]] -
+| width="90%" | More
-===<span style="font-weight: normal;"><u><tt>AnalogInput</tt></u></span>===
+|-
-Read the ADC value of a Terminal
+| colspan="2" | &nbsp;
+|-
-Returns 12 bit ADC reading
+| 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'''
+|}
-:[[Variable Types|BYTE]] ''Terminal''
-::Terminal number to be read
-'''Return value'''
-:[[Variable Types|UINT]]
-===<span style="font-weight: normal;"><u><tt>GSM_GetTextNumber</tt></u></span>===
-Collects the sender's phone number from an incoming text message.
-'''Parameters'''
-:[[Variable Types|BYTE]] ''NumBytes''
-'''Return value'''
-:[[Variable Types|STRING]]
-===<span style="font-weight: normal;"><u><tt>DigitalInput</tt></u></span>===
-Read the value of a terminal
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Terminal''
-'''Return value'''
-:[[Variable Types|BYTE]]
-===<span style="font-weight: normal;"><u><tt>GSM_GetCharacter</tt></u></span>===
-Returns the next character waiting to be read from the receive buffer.
-(Low level GSM interface)
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|BYTE]]
-==Simulation macro reference==
-''This component does not contain any simulation macros''
 ==Property reference==
-<span style="font-weight: normal;"><u>Module Type</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''MODULE_TYPE''.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|-
-<span style="font-weight: normal;"><u>Module Address</u></span>
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Module Type
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ORDINAL''.
+|-
+| colspan="2" | &nbsp;
-''<span style="color:red;">No additional information</span>''
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Module Address
+|-
-<span style="font-weight: normal;"><u>Script Count</u></span>
+| colspan="2" | &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]]
+| width="90%" | Script Count
-Maximum number of scripts to store in the device's ROM
+|-
+| colspan="2" | Maximum number of scripts to store in the device's ROM&nbsp;
-<span style="font-weight: normal;"><u>Script1</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
-This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''script1''.
+| 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>Expect Echo</u></span>
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Expect Echo
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''expect_echo''.
+|-
+| colspan="2" | &nbsp;
-''<span style="color:red;">No additional information</span>''
+|}