# hs.hid.led

HID LED interface for Hammerspoon, controls the state of keyboard LEDs


# API Overview

Functions - API calls offered directly by the extension

  • set

# API Documentation

# Functions

# set

Signature hs.hid.led.set(name, state) -> bool
Type Function
Description Assigns HID LED to the desired state
Parameters
  • name - LED name: "caps", "scroll" or "num"
  • state - A boolean indicating desired state
Returns
  • true if success, false if error
Notes
  • This function controls the LED state only, to modify capslock state, use hs.hid.capslock.set
Examples None
Source extensions/hid/hid.lua line 66