Component: RGB LED LP5030 LP5036 (LEDs)

Author	Matrix TSL
Version	1.0
Category	LEDs

RGB LED LP5030 LP5036 component

An I2C Based RGB LED driver with 30 or 36 individual constant-current sinks. Used to drive 10 or 12 RGB LEDs with a wide range of applications.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	GetRGB
Gets the RGB colour of a single LED.
- BYTE	Address
Range: 0-11
- BYTE	RGB
Byte array containing at least 3 bytes to store Red, Green and Blue
- VOID	Return

	SetBrightness
Allows the brightness of a single LED to be specified as a byte from 0 to 255. Default on reset is 255.
- BYTE	Address
Range: 0-11
- BYTE	Brightness
Brightness value: Range 0-255
- VOID	Return

	ReadReg
Reads the data from one or more sequential registers
- BYTE	Address
- BYTE	Data
- BYTE	Count
- VOID	Return

	WriteReg
Writes data to one or more sequential registers
- BYTE	Address
- BYTE	Data
- BYTE	Count
- VOID	Return

	SetRGB
Allows the colour of a single LED to be specified in RGB.
- BYTE	Address
Range: 0-11
- BYTE	RGB
Byte array containing at least 3 bytes to set Red, Green and Blue
- VOID	Return

	GetBrightness
Gets the brightness of a single LED.
- BYTE	Address
Range: 0-11
- BYTE	RGB
Byte array containing at least 3 bytes to store Red, Green and Blue
- BYTE	Return

	SetUnitAddress
Allows the component to taklk to more then one IC or broadcast to all connected ICs.
- BYTE	Address
Range: 0-3 = Individual / 4 = Broadcast
- VOID	Return

	Initialise
Starts up the I2C comms ready for communicating with the LP503x module. Must be called before any of the other component macros are called.
- VOID	Return

	Refresh
Clocks out the current colour data to the LEDs from the values stored in RAM
- VOID	Return

	ShiftLEDs1D
Shifts the LED colours in 1D and wraps
- BYTE	Direction
0 = Forwards, 1 = Backwards
- BYTE	DataMode
0=ResetToZero, 1=WrapAroundDisplay, 2=Smear
- VOID	Return

	DrawLine3D
Draws a line on a 3D array of LEDs
- UINT	X1
Start X Coordinate
- UINT	Y1
Start Y Coordinate
- UINT	Z1
Start Z Coordinate
- UINT	X2
End X Coordinate
- UINT	Y2
End Y Coordinate
- UINT	Z2
End Z Coordinate
- BYTE	R
Red Colour Channel
- BYTE	G
Green Colour Channel
- BYTE	B
Blue Colour Channel
- VOID	Return

	Delay_T1H
- VOID	Return

	GetLEDIndex2D
Sets the index of a single LED in RAM as a 2D array.
- UINT	X
LED Column to change the colour / Range: 0 to (LED Column - 1)
- UINT	Y
LED Row to change the colour / Range: 0 to (LED Row - 1)
- UINT	Return

	DrawRectangle2D
Draws a basic 2D rectangle onto the LEDs
- BYTE	X1
- BYTE	Y1
- BYTE	X2
- BYTE	Y2
- BYTE	DrawStyle
Sets the draw style - 0=Soild, 1=Edge, 2=Corners
- BYTE	R
- BYTE	G
- BYTE	B
- VOID	Return

	ShiftLEDs2D
Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable***
[[File:]] -	X
Number of pixels to shift the display -1 to 1 / 0 = No Shift
[[File:]] -	Y
Number of pixels to shift the display -1 to 1 / 0 = No Shift
- BYTE	DataMode
0=ResetToZero, 1=WrapAroundDisplay, 2=Smear
- VOID	Return

	GetLEDIndex3D
Gets the index of a single LED in RAM as a 3D array.
- UINT	X
LED Column to change the colour / Range: 0 to (LED Column - 1)
- UINT	Y
LED Row to change the colour / Range: 0 to (LED Row - 1)
- UINT	Z
LED Layer to change the colour / Range: 0 to (LED Layer - 1)
- UINT	Return

	DrawCuboid3D
Draws a basic 3D cuboid onto the LEDs
- BYTE	X1
Start X pixel coordinate
- BYTE	Y1
Start Y pixel coordinate
- BYTE	Z1
Start Z pixel coordinate
- BYTE	X2
End X pixel coordinate
- BYTE	Y2
End Y pixel coordinate
- BYTE	Z2
End Z pixel coordinate
- BYTE	DrawStyle
Sets the draw style - 0=Soild, 1=Edge, 2=Corners
- BYTE	R
Red Colour Channel
- BYTE	G
Green Colour Channel
- BYTE	B
White Colour Channel
- VOID	Return

	Initialise
Inisialises the RGB colour RAM to 0,0,0 = LED Off and clocks out the data to initialise all the LED ICs in the chain.
- VOID	Return

	ShiftLEDs3D
Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable***
[[File:]] -	X
Number of pixels to shift the display -1 to 1 / 0 = No Shift
[[File:]] -	Y
Number of pixels to shift the display -1 to 1 / 0 = No Shift
[[File:]] -	Z
Number of pixels to shift the display -1 to 1 / 0 = No Shift
- BYTE	DataMode
0=ResetToZero, 1=WrapAroundDisplay, 2=Smear
- VOID	Return

	Initialise
Sets up the data memory and draws the simulated LED cube on the panel.
- VOID	Return

	Initialise
Starts up the formula flowcode PWM for motor control and performs the wait for button press
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	MODPMSHAPE
Sets PM waveform shape to; 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4.
- BYTE	Shape
Sets PM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4).
- VOID	Return

	ARB4
Loads the binary-data to an existing arbitrary waveform memory location ARB4.
- BYTE	Waveform
- VOID	Return

	CLKSRRet
Returns the clock source <INT> or <EXT>.
[[File:]] -	Return

	MODPMDEV
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°).
[[File:]] -	Degrees
Sets PM waveform deviation in degrees (-360 - 360).
- VOID	Return

	MSTLOCK
Sends signal to SLAVE generator to get synchronised
- VOID	Return

	HILVL
Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V).
[[File:]] -	HighLevel
Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V).
- VOID	Return

	ARB3
Loads the binary-data to an existing arbitrary waveform memory location ARB3.
- UINT	Waveform
- VOID	Return

	WAVE
Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB
- BYTE	WaveType
0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB.
- VOID	Return

	CALADJ
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100).
[[File:]] -	Calibrate
Adjust the selected calibration value (-100 - 100).
- VOID	Return

	STBRet
Returns the value of the Status Byte Register in <nr1> numeric format.
- BYTE	Return

	ARB2
Loads the binary-data to an existing arbitrary waveform memory location ARB2.
- UINT	Waveform
- VOID	Return

	EERRet
Query and clear execution error number register.
- STRING	Return

	MODFMSRC
Sets FM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets FM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODAMFREQ
Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
[[File:]] -	Frequency
Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
- VOID	Return

	ESE
Sets the Standard Event Status Enable Register to the value of <nrf>.
- BYTE	Value
Value of register 0-255
- VOID	Return

	ARB1
Loads the binary-data to an existing arbitrary waveform memory location ARB1.
- UINT	Waveform
16 Bit binary number for arbitrary waveform.
- VOID	Return

	ARB4DEFRet
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4.
- STRING	Return

	CLS
Clears status byte register of the interface.
- VOID	Return

	MSTRELOCK
Resynchronises the two generators in MASTER-SLAVE mode.
- VOID	Return

	NOISLVL
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%)
- BYTE	Percent
Sets the output noise level in percent. (0 - 50)
- VOID	Return

	LOCKMODE
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP.
- BYTE	Mode
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP).
- VOID	Return

	ADDRESSRet
Returns the instruments address
[[File:]] -	Return

	MODPMSRC
Sets PM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets PM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODPWMSRC
Sets PWM waveform source to; 0 = INT, 1 = EXT.
[[File:]] -	Source
Sets PWM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MOD
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM.
- BYTE	Modulation
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM).
- VOID	Return

	ISTRet
Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true.
[[File:]] -	Return

	LRNRet
Returns the complete setup of the instrument as a binary data block
[[File:]] -	Return

	OPCRet
Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential.
[[File:]] -	Return

	SWPTYPE
Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP.
- BYTE	Type
Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP).
- VOID	Return

	PULSRANGE
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3.
- BYTE	Range
Sets the pulse rise and fall range. (1, 2 or 3)
- VOID	Return

	TSTRet
The generator has no self test capability and the response is always 0 <rmt>.
[[File:]] -	Return

	BSTTRGPOL
Sets the burst trigger slope to; 0 = POS, 1 = NEG.
[[File:]] -	Slope
Set the burst trigger slope (0 = POS, 1 = NEG).
- VOID	Return

	ARB3Ret
Returns the binary-data from an existing abbitrary wavefrom memory location.
- UINT	Return

	BSTPHASE
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360)
[[File:]] -	Degrees
Sets the burst phase in degrees (-360 - 360)
- VOID	Return

	IDNRet
Returns the instrument identification. The IDN is saved to the variable passed from the function 'ReturnIDN'. The return parameter is TRUE when the IDN is successfully returned.
- STRING	ReturnIDN
- STRING	Return

	SWPTRGPER
Sets the sweep trigger period to <nrf> seconds
[[File:]] -	Seconds
Set the sweep trigger period in seconds.
- VOID	Return

	PULSDLY
Sets the waveform delay to <nrf> sec
[[File:]] -	Sec
- VOID	Return

	Initialise
Opens the COM port ready for communications.
- VOID	Return

Property reference

	Properties
	Driver IC
	Address Pins
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API
Specifies the API component on the panel to interact with to provide comms simulation.
	Connections
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	SDA
Pin used for SDA (data signal)
	SDA Remap Pin
	SCL
Pin used for SCL (clock signal)
	SCL Remap Pin
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Simulations
	Simulate Comms