Component: Mouse (Controls )

Author	Matrix TSL
Version	1.0
Category	Controls

Mouse component

A component to read the mouse buttons or position of the cursor on the screen.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	GetMouseButtons
Reads the button states for the mouse. 0 = No Buttons Down / 1 = Left Button Down / 2 = Right Button Down 3 = Both Left and Right Buttons Down
- BYTE	Return

	GetMouseOverComponentHandle
Gets the handle of the panel component under the mouse pointer
[[File:]] -	Return

	GetMouseCoords
Gets the coordinates of the mouse in screen coordinates.
[[File:]] -	Axis
0=X, 1=Y
- ULONG	Return

	SetSlaveAddress
Allows the slave address to be overridden from the default slave address specified in the component property. The number of bytes used for the address is fixed by the Slave ID Bytes property to save on RAM usage.
- UINT	SlaveAddress
- VOID	Return

	ChangeFrameType
Default frame type is the type set in the component properties.
- BYTE	Type
0 = Modbus RTU / 1 = Modbus ASCII
- VOID	Return

	ReadCoils
Reads the state of up to eight digital coils. Can pack a max of 8-bits together in a single operation
- UINT	StartAddress
Coil Address Range 0 to (NumCoils - 1)
- BYTE	AddressCount
Range 1-8
- BYTE	Return

	SetHoldingRegister
Sets the state of a single holding register.
- UINT	Address
Coil Address
- UINT	Value
Analogue Value range 0 - 65535
- VOID	Return

	ReadAnalogInput
Reads the value of a single analogue input.
- UINT	Address
Coil Address
- UINT	Return

	CheckForIncoming
Checks for an incoming message and if the data address is within range then also automatically replies with the correct reply. Returns 0 if no comms received, 1 for a succesful transaction, 255 for an error.
- BYTE	Return

	ReadDigitalInputs
Reads the state of up to eight digital inputs. Can pack a max of 8-bits together in a single operation
- UINT	StartAddress
Coil Address Range 0 to (NumCoils - 1)
- BYTE	AddressCount
Range 1-8
- BYTE	Return

	GetLastIncoming
Gets a value from the last incoming command. Index 0 = 0 Read / 1 Write Index 1 = 0 Coils / 1 DigInput / 2 AnInput / 3 Register Index 2 = Address Index 3 = Number
- UINT	Return

	SetAnalogInput
Sets the state of a single analogue input.
- UINT	Address
Coil Address
- UINT	Value
Analogue Value range 0 - 65535
- VOID	Return

	Initialise
Starts up the UART to allow communications and initialises the states of the various Modbus Coils, Inputs and Registers to 0.
- VOID	Return

	AppendStringToFile
Adds the contents of the data string parameter to the end of the currently open file. Returns 0 for success.
- STRING	Data_String
Data to append to the end of the file
- BYTE	Return

	ReadFileSize
Reads the entire size of the current file in bytes.
- ULONG	Return

	SetTimeAndDate
Sets the current time and date. Time = (Hour << 11) + (Min << 5) + (Sec >> 1) Date = (YearFrom1980 << 9) + (Month << 5) + (Day) Additional details can be found here: http://www.maverick-os.dk/FileSystemFormats/FAT16_FileSystem.html#TimeFormat
- UINT	Time
Sets the current Time in FAT Time format hhhhhmmmmmmsssss - S=Secs/2
- UINT	Date
Sets the current Date in FAT Date format yyyyyyymmmmddddd - Y=Years since 1980
- VOID	Return

	Initialise
Attempts to communicate with the SD card and if successful sets up the file system. Returns 0 for success.
- BYTE	Return

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

	ReadAnalogInput
Reads a single digital input.
- BYTE	Channel
- UINT	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
	Connections
	Simulations