# hs.hid

HID interface for Hammerspoon, controls and queries caps lock state

Portions sourced from (https://discussions.apple.com/thread/7094207).

# Submodules

hs.hid.led

# API Overview

Functions - API calls offered directly by the extension

get
set
toggle

# API Documentation

# Functions

# get


Signature	`hs.hid.capslock.get() -> bool`
Type	Function
Description	Checks the state of the caps lock via HID
Parameters	None
Returns	true if on, false if off
Notes	None
Examples	None
Source	extensions/hid/hid.lua line 16

# set


Signature	`hs.hid.capslock.set(state) -> bool`
Type	Function
Description	Assigns capslock to the desired state
Parameters	state - A boolean indicating desired state
Returns	true if on, false if off
Notes	None
Examples	None
Source	extensions/hid/hid.lua line 42

# toggle


Signature	`hs.hid.capslock.toggle() -> bool`
Type	Function
Description	Toggles the state of caps lock via HID
Parameters	None
Returns	true if on, false if off
Notes	None
Examples	None
Source	extensions/hid/hid.lua line 29