Skip to content
This repository was archived by the owner on Dec 1, 2020. It is now read-only.

Mouse Object

Tim edited this page Jan 27, 2017 · 2 revisions

Functions and constants included in the Chroma Mouse object:

Initialize:

Mouse = Chroma.Mouse()

Functions:

setColor

sets the Mouse-LED-Grid to one color.

Usage: setColor(Color)

Example:

Mouse.setColor(RED) or Mouse.setColor((255,0,0)) //RGB for RED

setbyCol

sets a specific column of LEDs of the MouseLED-Grid to one color.

Usage: setbyCol(Column, Color)

Example:

Mouse.setbyCol(3,RED) or Mouse.setbyCol(3,(255,0,0)) //RGB for RED

setbyRow

sets a specific row of LEDs of the Mouse-LED-Grid to one color.

Usage: setbyRow(Row, Color)

Example:

Mouse.setbyRow(3,RED) or Mouse.setbyRow(3,(255,0,0)) //RGB for RED

setbyGrid

sets a specific LEDs of the Mouse-LED-Grid to one color.

Usage: setbyGrid(X, Y, Color)

Example:

Mouse.setbyGrid(3,4,RED) or Mouse.setbyGrid(3,4,(255,0,0)) //RGB for RED

clearGrid

clears the Mouse-LED-Grid.

Usage: clearGrid()

Example:

Mouse.clearGrid()

applyGrid

applies the Mouse-LED-Grid to the Keyboard.

Usage: applyGrid()

Example:

Mouse.applyGrid()

setBreathing

sets the Mouse to Breathing.

Usage: setBreathing(mode,Color1,Color2)

Mode: 1 - two colors, 0 - random colors

Example:

Mouse.setBreathing(1,RED,GREEN) or Mouse.setBreathing(0,0,0)

setWave

sets the Keyboard to Wave.

Usage: setWave(direction)

Direction: 1 - top to bottom, 2 - bottom to top

Example:

Mouse.setWave(1)

resetEffect

resets the current Chroma-Effect.

Usage: resetEffect()

Example:

Mouse.resetEffect()

Constants:

MaxColumn

Maximum columns of the Mouse-LED-Grid. Hint: Use this as iteration borders.

Example:

Mouse.MaxColumn

MaxLED

Maximum LEDs of the Mouse-LED-Grid. Hint: Use this as iteration borders.

Example:

Mouse.MaxLED

MaxROW

Maximum rows of the Mouse-LED-Grid. Hint: Use this as iteration borders.

Example:

Mouse.MaxRow

Clone this wiki locally