Difference between revisions of "Component: Injector (AT) (Simulation)"
(XML import) |
(XML import) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
| − | | 1. | + | | 1.1 (Release) |
|- | |- | ||
| width="20%" style="color: gray;" | Category | | width="20%" style="color: gray;" | Category | ||
| Line 23: | Line 23: | ||
==Examples== | ==Examples== | ||
| − | + | GSM Example File | |
| + | {{Fcfile|GSM_Test.fcfx|GSM Example}} | ||
| + | Example should show the following on the display on the panel and on the hardware. | ||
| + | [[File:GSMPan.jpg]] | ||
| + | |||
| + | |||
| + | The AT injector component allows us to simulate the response of the GSM module. | ||
| + | |||
| + | [[File:GSMInject.jpg]] | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
| Line 33: | Line 41: | ||
''This component inherits simulation macros from ''[[Component: ID cc936c18_5d20_42c4_b940_d3c7ea7ca802|Data Injector]] | ''This component inherits simulation macros from ''[[Component: ID cc936c18_5d20_42c4_b940_d3c7ea7ca802|Data Injector]] | ||
| + | |||
| + | ===<span style="font-weight: normal;"><u><tt>InitialiseInjector</tt></u></span>=== | ||
| + | Sets up the injector ready to receive commands or send data | ||
| + | |||
| + | '''Parameters''' | ||
| + | |||
| + | :[[Variable Types|<- STRING]] ''InjectorName'' | ||
| + | ::Name of the console that will be created | ||
| + | ::''This parameter may be returned back to the caller'' | ||
| + | |||
| + | |||
| + | '''Return value''' | ||
| + | |||
| + | :[[Variable Types|BYTE]] | ||
| + | |||
===<span style="font-weight: normal;"><u><tt>TxByte</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>TxByte</tt></u></span>=== | ||
| Line 104: | Line 127: | ||
:[[Variable Types|HANDLE]] | :[[Variable Types|HANDLE]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 11:25, 13 February 2015
| Author | Matrix Ltd |
| Version | 1.1 (Release) |
| Category | Simulation |
| This inherits from Data Injector | |
Contents
Injector (AT) component
Comms data injector to replicate basic AT command syntax. The component will record each incoming character until the termination character is received. Once this happens the component will respond by echoing back the received data followed by an "OK" reply.
Examples
GSM Example File
GSM Example
Example should show the following on the display on the panel and on the hardware.
The AT injector component allows us to simulate the response of the GSM module.
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
This component inherits simulation macros from Data Injector
InitialiseInjector
Sets up the injector ready to receive commands or send data
Parameters
- <- STRING InjectorName
- Name of the console that will be created
- This parameter may be returned back to the caller
Return value
TxByte
Puts a byte onto the comms channel.
Parameters
- BYTE DataByte
Return value
- This call does not return a value
RxByte
Gets a byte from the comms channel - 255 signifies no more data available
Parameters
- This macro has no parameters
Return value
GetTxConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
This call is provided by Data Injector
Parameters
- This macro has no parameters
Return value
ChangeState
Changes the state for I2C or SPI type comms where the data bytes along are not enough to go on.
This call is provided by Data Injector
Parameters
- BYTE NewState
- Assigns new state, 0=default
Return value
- This call does not return a value
GetRxConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
This call is provided by Data Injector
Parameters
- This macro has no parameters
Return value
GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
Parameters
- This macro has no parameters
Return value
Property reference
Circular Buffer Size
This property is of type Unsigned integer and can be referenced with the variable name CircularBufferSize.
Amount of room in the circular buffers before running out of memory.
e.g. max command that can be recorded.
Termination Character
This property is of type Fixed list of ints and can be referenced with the variable name TermChar.
Character that will trigger the AT Injector to automatically switch from recording to repeating.
