Component: Scale Linear Template (Advanced Shapes)

Author	Matrix Ltd
Version	1.2
Category	Advanced Shapes

Scale Linear Template component

A base component for drawing scales on horizontal or vertical strips. Can be used to simplify the building of rulers, meters and slider controls. Mouse handling is built in for easy construction of interactive controls.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	GetValue
Get the current value from the scale. Will be either the most recent value set by "SetValue", or, if set to "Control" mode, the latest mouse clicked value.
[[File:]] -	Return

	SetValue
Set the value for the scale. If a pointer object is defined, it will move to point at the new value.
[[File:]] -	Value
Value to set - will be constrained to the minumum-maximum range.
- VOID	Return

	SetLabel
Set the text of the component's label.
- STRING	Text
New text to set.
- VOID	Return

	SetRange
Set new maximum and minimum values for the scale.
[[File:]] -	Minimum
The minimum value of the scale (Bottom of the component)
[[File:]] -	Maximum
The maximum value of the scale (Top of the component)
- VOID	Return

	SetRange
Set the minimum and maximum values of the scale
[[File:]] -	Minimum
Minimum value for the scale
[[File:]] -	Maximum
Maximum value for the scale
- VOID	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-29
[[File:]] -	State
Range: 0-1
- 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

	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	Channel
- BYTE	Prescaler
- BYTE	Period
- 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

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-29
[[File:]] -	State
Range: 0-1
- 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

	ADCSampleAverage10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0, 3-7
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- UINT	Return

	OneWireScanBus
Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.
- BYTE	Channel
Channel Index: Range 0 - I2C 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

	OneWireReceiveByte
Receives a byte from the one wire bus a bit at a time
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	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

	OneWireGetDeviceCount
Returns the number of devices found by the last ScanBus operation.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

	PWMSetPrescaler
Sets the prescaler for the PWM output
- BYTE	Channel
Range: 0 - 11
- BYTE	Prescaler
- BYTE	Period
- VOID	Return

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

	ADCSampleArray10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet
- BYTE	ADCChannel
Range: 0, 3-7
- BYTE	SampleCount
Range: 1- 32
- UINT	SampleDelay
Delay in us between each sample
- UINT	Samples
10-bit samples returned from the function
- VOID	Return

	ADCSampleAverage8
Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0, 3-7
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- BYTE	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

Property reference

	Properties
	Pointer
Sets an object to act as the pointer for the scale. If in 'Display' mode, the pointer will move to show the incoming "SetValue" numbers. In "Control" mode, it will act as an object for setting the value using mouse clicks/drags.
	Track
An object to represent a 'track' parallel to the scale upon which the moving part travels. If the scale is resized or moved, the 'track' object will also be scaled or moved. For example, the 'track' object could be a simple black rectangle to represent the 'slot' in which a slider control moves.
	Orientation
Whether the scale and/or motion should be along the X-axis (horizontal) or Y-axis (vertical)
	Function
Set the mode of the component... Display - the pointer object moves only when a value is set using the 'SetValue' macro. Control - the pointer can be moved using the mouse to set a new value, which can then be read using the 'GetValue' macro.
	Resolution
Determines the amount of detail in the scale graphics - larger values will require more memory and/or loading time etc.
	BG Color
Colour of the background object.
	Positive Color
Markings colour for positive scale values.
	Negative Color
Markings colour for negative values.
	Label Color
Color for the text label.
	Offset %
Distance of the main line from the left or bottom of the component. % of component size.
	Start %
Start position of the scale from the left/bottom of the component. % of component size.
	End %
End position of the scale from the left/bottom of the component. % of component size.
	Thickness
Thickness of the main scale line.
	Show
Whether to show or hide the main scale line.
	Divisions
Number of major divisions of the scale - these can be numbered.
	Offset %
Position of the division lines across the scale - % of component size,.
	Thickness
Thickness of the division lines.
	Subdivisions
Number of smaller divsions between the numbered ones. Set to zero if not required.
	Subs Offset
Position of the sub-division line ends. % of width across the component.
	Subs Thickness
Thickness of the sub-division lines..
	Show
Whether to show or hide the divisions and sub-divisions.
	Maximum
Maximum number to show on the scale.
	Minimum
Minimum number to show on the scale.
	Decimals
Number of decimal places to show on the numbers.
	Offset %
Distance acrross the scale width to show the numbers. % of component size.
	Text Size %
Text height of the scale numbers. % of component size.
	Font
Font for the scale numbers.
	Show
Whether to show or hide the scale numbers.
	Text
Text label for the component to aid identification.
	Offset X %
X - position of the label. % of Width.
	Offset Y %
Y position of label. % of height.
	Text Size %
Text size of label. % of component size.
	Font
Font for the component label.
	Show
Whether to show or hide the text label.
	Connections
	Simulations