docs » hs.razer

Sets/clears a callback for reacting to device discovery events

• fn - A function that will be called when a Razer device is connected or disconnected. It should take the following arguments:
  • A boolean, true if a device was connected, false if a device was disconnected
  • An hs.razer object, being the device that was connected/disconnected

• None

Gets an hs.razer object for the specified device

• num - A number that should be within the bounds of the number of connected devices

• An hs.razer object or nil if something goes wrong

Initialises the Razer driver and sets a discovery callback.

• fn - A function that will be called when a Razer device is connected or disconnected. It should take the following arguments:
  • A boolean, true if a device was connected, false if a device was disconnected
  • An hs.razer object, being the device that was connected/disconnected

• None

• This function must be called before any other parts of this module are used

Gets the number of Razer devices connected

• None

• A number containing the number of Razer devices attached to the system

Runs some basic unit tests when a Razer Tartarus V2 is connected.

• None

• None

• Because hs.razer relies on a physical device to be connected for testing, this method exists so that Hammerspoon developers can test the extension outside of the usual GitHub tests. It can also be used for user troubleshooting.

Changes the keyboard backlights to the breath mode.

• [color] - An optional hs.drawing.color value
• [secondaryColor] - An optional secondary hs.drawing.color

• The hs.razer object.
• true if successful otherwise false
• A plain text error message if not successful.

• If neither color nor secondaryColor is provided, then random colors will be used.

Changes the keyboard backlights to custom colours.

• colors - A table of hs.drawing.color objects for each individual button on your device (i.e. if there's 20 buttons, you should have twenty colors in the table).

• The hs.razer object.
• true if successful otherwise false
• A plain text error message if not successful.

• The order is top to bottom, left to right. You can use nil for any buttons you don't want to light up.
• Example usage: ```lua

hs.razer.new(0):backlightsCustom({hs.drawing.color.red, nil, hs.drawing.color.green, hs.drawing.color.blue})

Turns all the keyboard backlights off.

• None

• The hs.razer object.
• true if successful otherwise false.
• A plain text error message if not successful.

Changes the keyboard backlights to the reactive mode.

• speed - A number between 1 (fast) and 4 (slow)
• color - A hs.drawing.color object

• The hs.razer object.
• true if successful otherwise false
• A plain text error message if not successful.

Changes the keyboard backlights to the spectrum mode.

• None

• The hs.razer object.
• true if successful otherwise false
• A plain text error message if not successful.

Changes the keyboard backlights to the Starlight mode.

• speed - A number between 1 (fast) and 3 (slow)
• [color] - An optional hs.drawing.color value
• [secondaryColor] - An optional secondary hs.drawing.color

• The hs.razer object.
• true if successful otherwise false
• A plain text error message if not successful.

• If neither color nor secondaryColor is provided, then random colors will be used.

Changes the keyboard backlights to a single static color.

• color - A hs.drawing.color object.

• The hs.razer object.
• true if successful otherwise false.
• A plain text error message if not successful.

Changes the keyboard backlights to the wave mode.

• speed - A number between 1 (fast) and 255 (slow)
• direction - "left" or "right" as a string

• The hs.razer object.
• true if successful otherwise false
• A plain text error message if not successful.

Gets or sets the blue status light.

• value - true for on, false for off`

• The hs.razer object.
• true for on, false for off, ornil` if something has gone wrong
• A plain text error message if not successful.

Gets or sets the brightness of a Razer keyboard.

• value - The brightness value - a number between 0 (off) and 100 (brightest).

• The hs.razer object.
• The brightness as a number or nil if something goes wrong.
• A plain text error message if not successful.

Sets or removes a callback function for the hs.razer object.

• callbackFn - a function to set as the callback for this hs.razer object. If the value provided is nil, any currently existing callback function is removed.

• The hs.razer object

• The callback function should expect 4 arguments and should not return anything:
  • razerObject - The serial port object that triggered the callback.
  • buttonName - The name of the button as a string.
  • buttonAction - A string containing "pressed", "released", "up" or "down".

Allows you to remap the default Keyboard Layout on a Razer device so that the buttons no longer trigger their factory default actions, or restore the default keyboard layout.

• enabled - If true the Razer default will use its default keyboard layout.

• The hs.razer object.
• true if successful otherwise false

• This feature currently only works on the Razer Tartarus V2.

Gets or sets the green status light.

• value - true for on, false for off`

• The hs.razer object.
• true for on, false for off, ornil` if something has gone wrong
• A plain text error message if not successful.

Returns the human readable device name of the Razer device.

• None

• The device name as a string.

Gets or sets the orange status light.

• value - true for on, false for off`

• The hs.razer object.
• true for on, false for off, ornil` if something has gone wrong
• A plain text error message if not successful.