Component: Injector (API Digital Input) (Test Injectors)

Author	Matrix Ltd
Version	1.2
Category	Test Injectors

Injector (API Digital Input) component

Data injector to allow a physical digital input pin to be attached to a simulated component. The component will poll for any input state changes via SCADA Slave enabled hardware. Enabling the Flowcode simulation runtime to directly interface with a physical I/O pin.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	InitialiseInjector
Sets up the injector ready to receive commands or send data
- STRING	InjectorName
Name of the console that will be created
- BYTE	Return

	RxByteCount
Returns the number of bytes currently sat in the receive buffer.
- UINT	Return

	TxByte
Puts a byte onto the comms channel.
- BYTE	DataByte
- VOID	Return

	RxByte
Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available
- UINT	Return

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
[[File:]] -	Return

	UARTSend
- BYTE	Channel
- BYTE	Data
- VOID	Return

	Initialise
Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail.
- BYTE	Return

	SampleAccel
Samples the accelerometer 0 = no new data, 1 = new data available
- BYTE	Return

	Left
Rotates the robot left - waits for the angle to be traversed before returning
- UINT	Angle
Angle to turn in degrees
- VOID	Return

	ReadIR
Reads an IR sensor 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft
- BYTE	index
0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft
- UINT	Return

	LCDDrawPixel
Allows a single pixel on the LCD to be set or cleared
- BYTE	X
X Pixel 0-127
- BYTE	Y
Y Pixel 0-31
- BYTE	State
0=White (Off), 1=Black (On)
- VOID	Return

	ServoSetPosition
Allows one of the servo positions to be assigned
- BYTE	Channel
Range 0-3
- BYTE	Position
Range 0-255
- VOID	Return

	CardBitmap
Displays a monochrome bitmap read from the card on the LCD
- BYTE	X
Range 0-127
- BYTE	Y
Range 0-31
- STRING	Filename
- BYTE	Return

	CardRecordMic
Records an audio stream on the card from the microphone
- BYTE	BitDepth
0=8-bit, 1=16-bit
- BYTE	SampleRate
Sample Rate 0=8KHz, 1=16KHz
- UINT	RecordTime
Time to record for in seconds, Range 0-65535
- STRING	Filename
- BYTE	Return

	CardOpen
Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK
- STRING	Filename
- BYTE	Return

	Forwards
Drives the robot forwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	ReadBearing
Reads the compass bearing based on the degrees clockwise from magnetic north.
[[File:]] -	Return

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
[[File:]] -	Return

	LCDDrawLine
Allows a single pixel width line to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ServoAutoMoveToPosition
Allows one of the servo positions to move gradually to a new position
- BYTE	Channel
Range 0-3
- BYTE	Position
Range 0-255
- VOID	Return

	ReadAllValue
Reads a single value stored from the read all command Index dictates which sensor value to read
- BYTE	Index
0=SW, 1-8=IR, 9-10=Line, 11=Light, 12=Mic, 13-15=Accel
- UINT	Return

	LCDBacklight
Allows the LCD backlight brighntess to be adjusted
- BYTE	Intensity
Range 0-100, 0=Off, 1=Min Brightness, 100=Max Brightness
- VOID	Return

	LCDDrawRect
Allows a rectangle to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ReadLine
Reads one of the IR line sensors 0-1 0=Left, 1=Right
- BYTE	index
0=Left, 1=Right
- UINT	Return

	ServoDisable
Allows one of the servo outputs 0-3 to be disabled
- BYTE	Channel
Range 0-3
- VOID	Return

	ServoEnable
Allows one of the servo outputs 0-3 to be enabled
- BYTE	Channel
Range 0-3
- VOID	Return

	CardReadByte
Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end
- BYTE	Return

	CardErase
Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK
- STRING	Filename
- BYTE	Return

	CardWriteByte
Appends a byte to the end of the currently open file
- BYTE	Data
- VOID	Return

	EncoderRead
Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit.
- BYTE	index
0=Left, 1=Right
- UINT	Return

	SetMotors
Sets the motor speeds without feedback Range -100 to 100
[[File:]] -	Left
Range -100 to 100
[[File:]] -	Right
Range -100 to 100
- VOID	Return

	Backwards
Drives the robot backwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	EncoderReset
Resets the motor encoder counters
- VOID	Return

	LCDVerbose
Allows the LCD to automatically report the API commands as they get processed. Default - verbose on
- BYTE	State
0=Off 1=On
- VOID	Return

	SetProp
Allows the COM port property to be set from a parent component.
- STRING	PropName
- ULONG	PropVal
- VOID	Return

	CardInit
Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK
- BYTE	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

	LCDClear
Clears the LCD
- VOID	Return

Property reference

	Properties
	API Slave
SCADA Slave component to use to pipe data to a physical SPI bus
	Number of Pins
Specifies the number of pins the component can monitor and control.
	Poll Rate
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware
	Connections
	Simulations