Component: Is Sim (Matrix Tools)

Author	Matrix TSL
Version	1.0
Category	Matrix Tools

Is Sim component

A simple component designed to aid in detecting if the current code is running in simulation or on a microcontroller.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	Check
Returns 0 if running on an embedded target or 1 if running in simulation runtime.
[[File:]] -	Return

	Initialise
Initialises the UART ready for IrDA data to be sent or received,
- VOID	Return

	Disconnect
Disconnects from the MQTT server and the network
- BYTE	Return

	Ping
Ping packet is sent to the Server and checks for a reply. Returns non-zero value if successful
- BYTE	Return

	GetPayload
Get the Payload of the last received (Read) packet. Returns the number of bytes for the Payload
- STRING	Payload
- BYTE	Size
Byte count the Payload buffer
- BYTE	Return

	Subscribe
Subscribe to a Topic. Must be Connected first Returns non-zero if successful
- STRING	Topic
- BYTE	Return

	Unsubscribe
Unsubscribe from a Topic. Must be Connected first Returns non-zero if successful
- STRING	Topic
- BYTE	Return

	Initialise
- VOID	Return

	GetPayloadString
Get the Payload of the last received (Read) packet as a string value
- STRING	Payload
- BYTE	Size
- BYTE	Return

	Initialise
Starts up the MQTT component - call this after initialising the NetworkComms component.
- VOID	Return

Property reference

	Properties
	Sim
	Connections
	Simulations