Component: Panel Console Viewer (Runtime Tools)

Author	Matrix Ltd
Version	1.1
Category	Runtime Tools

Panel Console Viewer component

An easy way to display the data from a console on the panel. Links to a component that generates console data.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	OpenFile
Creates or opens a file ready for streaming data. If the file already exists then the contents will be deleted and the file started again from scratch. Returns 1 if file found and opened.
- STRING	Filename
[[File:]] -	Erase
0=Append existing data, 1=Reset file data
[[File:]] -	Return

	NextRow
Move to the next row in the file
- VOID	Return

	PWMDisable
Disable a PWM output
- BYTE	Channel
Range: 0-1
- VOID	Return

	I2CStart
Put the I2C Module into Start mode
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

	SPITransfer
Transfer a byte using the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- BYTE	DataOut
- BYTE	Return

	I2CReceive
Receive a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
[[File:]] -	Last
Last byte to receive: Range 0-1
- BYTE	Return

	I2CStop
Put the I2C Module into Stop mode
- BYTE	Channel
- VOID	Return

	WIFISetSSID
Assign the SSID and password for the network you wish to connect the board to. Stores the parameters into ROM for later USB free setup.
- STRING	SSID
Name of the network you wish to connect to
- STRING	Password
- VOID	Return

	ServoDisable
Disable a Servo output
- BYTE	Channel
Range: 0-5
- VOID	Return

	SPIPrescaler
Modify the speed of the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- BYTE	Prescaler
Range: 0-2
- VOID	Return

	ServoEnable
Enable a Servo output
- BYTE	Channel
Range: 0-5
- VOID	Return

	ADCSample10
Reads the voltage present on an Alanog pin as an 10-bit value range 0-1023
- BYTE	ADCChannel
Range: 0-5
- UINT	Return

	I2CTransSend
Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
Data to send
- UINT	Count
Number of bytes to send out, MS bit 0x8000 signifies no Stop if set
- UINT	Return

	I2CTransInit
Initialises the I2C Transaction mode with the 7-bit device address
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DeviceAddress
7-bit Device Address
- BYTE	Baud
0=100KHz, 1=400KHz, 2=1MHz
- VOID	Return

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-17
[[File:]] -	State
Range: 0-1
- VOID	Return

	ServoSetPosition8
Sets the position as an 8-bit value
- BYTE	Channel
Range: 0-1
- BYTE	Position
Range: 0-255
- VOID	Return

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	SPIInitialise
Initialsie the SPI module ready for communications
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- VOID	Return

	WIFIGetIP
Gets the IP address of the board. Allows you to setup and get the assigned address via USB before using over WIFI, Use the WIFIIsConnected first to check the WIFI is active.
- STRING	Return

	I2CSend
Transmit a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DataOut
[[File:]] -	Return

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

	PWMSetPrescaler
Sets the prescaler for the PWM output
- BYTE	Prescaler
- VOID	Return

	PWMSetDuty8
Sets the duty for the PWM output
- BYTE	Channel
Range: 0-1
- BYTE	Duty
Range: 0-255
- VOID	Return

	PWMEnable
Enable a PWM output
- BYTE	Channel
Range: 0-1
- VOID	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

	Initialise
- VOID	Return

	LCDClear
Clears the MIAC display
- VOID	Return

	LCDClear
Clears the LCD
- VOID	Return

Property reference

	Properties
	Connect To
	Width
Width of the console ripper component.
	Number of lines
	Clear Old Data
Removes old data from the console viewer when starting simulation if active.
	Connections
	Simulations