color_matrix

The color_matrix module contains functions to interact with an attached 3x3 Color Light Matrix (e.g. LEGO part 45608). It enables you to write code that sets or retrieves the color and intensity of the nine LEDs as a whole or individually.

To use the color_matrix module, add the following import statement to your project:

import color_matrix

All functions in the module should be called inside the color_matrix module as a prefix like so:

color_matrix.set_pixel(port.A, 1, 1, (color.BLUE, 10))

Functions

clear(port)	Turn off all pixels on a Color Matrix
get_pixel(port, x, y)	Get the current value of a specific pixel at column X and row Y, represented as a tuple containing the color and intensity.
set_pixel(port, x, y, pixel)	Set the color and intensity of a single pixel at column X and row Y.
show(port, pixels)	Set the color and intensity of all pixels at once on a Color Matrix

color_matrix.clear(port)

Turn off all pixels on a Color Matrix

from hub import port
import color_matrix

color_matrix.clear(port.A)

Parameters:

port (int) – A port from the port submodule in the hub module

Return type:

None

color_matrix.get_pixel(port, x, y)

Get the current value of a specific pixel at column X and row Y, represented as a tuple containing the color and intensity.

from hub import port
import color_matrix

# Print the color and intensity of the 0,0 pixel on the Color
# Matrix connected to port A
print(color_matrix.get_pixel(port.A, 0, 0))

Parameters:

• port (int) – A port from the port submodule in the hub module

• x (int) – The pixel column, range 0–2

• y (int) – The pixel row, range 0–2

Return type:

tuple

color_matrix.set_pixel(port, x, y, pixel)

Set the color and intensity of a single pixel at column X and row Y.

from hub import port
import color
import color_matrix

# Change the color of the 0,0 pixel on the Color Matrix
# connected to port A
color_matrix.set_pixel(port.A, 0, 0, (color.RED, 10))

# Print the color of the 0,0 pixel on the Color Matrix connected
# to port A
print(color_matrix.get_pixel(port.A, 0, 0)[0])

Parameters:

• port (int) – A port from the port submodule in the hub module

• x (int) – The pixel column, range 0–2

• y (int) – The pixel row, range 0–2

• pixel (tuple[int, int]) – A tuple containing color constant and intensity (0–100)

Return type:

None

color_matrix.show(port, pixels)

Set the color and intensity of all pixels at once on a Color Matrix

from hub import port
import color
import color_matrix

# Update all pixels on Color Matrix using the show function

# Create a list with 18 items (color and intensity pairs)
pixels = [(color.BLUE, 10)] * 9

# Update all pixels to show same color and intensity
color_matrix.show(port.A, pixels)

Parameters:

• port (int) – A port from the port submodule in the hub module

• pixels (list[tuple[int, int]]) – A list of tuples specifying color and intensity values for all 9 pixels (see set_pixel() for a description of the individual pixel format)

Return type:

None