hs.razer

Поддержка устройств Razer.

Это расширение в настоящее время поддерживает только Razer Tartarus V2. Оно позволяет вызывать обратные вызовы при нажатии кнопок и использовании колесика прокрутки, а также позволяет изменять светодиодную подсветку кнопок и колесика прокрутки, и управлять тремя индикаторными светодиодами.

По умолчанию Razer Tartarus V2 вызывает стандартные команды клавиатуры (например, нажатие клавиши "01" введёт "1"). Однако, вы можете использовать метод :defaultKeyboardLayout(false) для предотвращения этого. Это достигается переназначением стандартных комбинаций клавиш на «фиктивные» клавиши, чтобы они не вызывали обычных нажатий клавиш в macOS.

Как и расширение hs.streamdeck, это расширение разработано модульно, что позволяет другим разработчикам в будущем добавить поддержку других устройств Razer, если будет интерес.

Это расширение было создано Кристофером Хоккингом для CommandPost.

Это расширение основано на расширении hs.streamdeck, созданном Кристофером Джонсом.

Особая благодарность авторам этих замечательных документов и ресурсов:

Обзор API

Функции - API-вызовы, предлагаемые непосредственно расширением

discoveryCallback
getDevice
init
numDevices
unitTests

Методы - API-вызовы, которые можно сделать только на объекте, возвращённом конструктором

backlightsBreathing
backlightsCustom
backlightsOff
backlightsReactive
backlightsSpectrum
backlightsStarlight
backlightsStatic
backlightsWave
blueStatusLight
brightness
callback
defaultKeyboardLayout
greenStatusLight
name
orangeStatusLight

Документация API

Функции

discoveryCallback

Подпись	`hs.razer.discoveryCallback(fn) -> none`
Тип	Функция
Описание	Устанавливает/очищает обратный вызов для реакции на события обнаружения устройств
Параметры	fn - Функция, которая будет вызываться при подключении или отключении устройства Razer. Она должна принимать следующие аргументы: Булево значение, true, если устройство подключено, false, если отключено Объект hs.razer, представляющий собой подключенное/отключенное устройство
Возвращаемое значение	None
Исходный код	extensions/razer/librazer.m строка 48

getDevice

Подпись	`hs.razer.getDevice(num) -> razerObject \| nil`
Тип	Функция
Описание	Получает объект hs.razer для указанного устройства
Параметры	num - Число, которое должно быть в пределах границ количества подключенных устройств
Возвращаемое значение	Объект hs.razer или `nil` в случае ошибки
Исходный код	extensions/razer/librazer.m строка 92

init

Подпись	`hs.razer.init(fn)`
Тип	Функция
Описание	Инициализирует драйвер Razer и устанавливает обратный вызов обнаружения.
Параметры	fn - Функция, которая будет вызываться при подключении или отключении устройства Razer. Она должна принимать следующие аргументы: Булево значение, true, если устройство подключено, false, если отключено Объект hs.razer, представляющий собой подключенное/отключенное устройство
Возвращаемое значение	None
Примечания	Эта функция должна быть вызвана перед использованием других частей этого модуля
Исходный код	extensions/razer/librazer.m строка 23

numDevices

Подпись	`hs.razer.numDevices() -> number`
Тип	Функция
Описание	Получает количество подключенных устройств Razer
Параметры	None
Возвращаемое значение	Число, содержащее количество устройств Razer, подключенных к системе
Исходный код	extensions/razer/librazer.m строка 75

unitTests

Подпись	`hs.razer.unitTests() -> none`
Тип	Функция
Описание	Выполняет некоторые базовые модульные тесты при подключении Razer Tartarus V2.
Параметры	None
Возвращаемое значение	None
Примечания	Поскольку `hs.razer` зависит от подключения физического устройства для тестирования, этот метод существует, чтобы разработчики Hammerspoon могли тестировать расширение вне обычных тестов на GitHub. Он также может использоваться для устранения неполадок пользователями.
Исходный код	extensions/razer/razer.lua строка 81

Методы

backlightsBreathing

Подпись	`hs.razer:backlightsBreathing([color], [secondaryColor]) -> razerObject, boolean, string \| nil`
Тип	Метод
Описание	Изменяет подсветку клавиатуры в режиме дыхания.
Параметры	[color] - Необязательное значение `hs.drawing.color` [secondaryColor] - Необязательный вторичный `hs.drawing.color`
Возвращаемое значение	Объект `hs.razer`. `true` в случае успеха, иначе `false` Сообщения об ошибке в формате обычного текста в противном случае.
Примечания	Если ни `color` ни `secondaryColor` не предоставлены, будут использоваться случайные цвета.
Исходный код	extensions/razer/librazer.m строка 625

backlightsCustom

Подпись	`hs.razer:backlightsCustom(colors) -> razerObject, boolean, string \| nil`
Тип	Метод
Описание	Изменяет подсветку клавиатуры на пользовательские цвета.
Параметры	colors - Таблица объектов `hs.drawing.color` для каждой отдельной кнопки на вашем устройстве (например, если у вас 20 кнопок, вы должны иметь двадцать цветов в таблице).
Возвращаемое значение	Объект `hs.razer`. `true` в случае успеха, иначе `false` Сообщения об ошибке в формате обычного текста в противном случае.
Примечания	Порядок сверху вниз, слева направо. Вы можете использовать `nil` для кнопок, которые вы не хотите подсветить. Пример использования: ```lua hs.razer.new(0):backlightsCustom({hs.drawing.color.red, nil, hs.drawing.color.green, hs.drawing.color.blue})
Исходный код	extensions/razer/librazer.m строка 665

backlightsOff

Подпись	`hs.razer:backlightsOff() -> razerObject, boolean, string \| nil`
Тип	Метод
Описание	Выключает всю подсветку клавиатуры.
Параметры	None
Возвращаемое значение	Объект `hs.razer`. `true` в случае успеха, иначе `false`. Сообщения об ошибке в формате обычного текста в противном случае.
Исходный код	extensions/razer/librazer.m строка 450

END_OF_DOCUMENT_MARKER ```

backlightsSpectrum

Signature	`hs.razer:backlightsSpectrum() -> razerObject, boolean, string \| nil`
Type	Method
Description	Изменяет подсветку клавиатуры в режим спектра.
Parameters	None
Returns	Объект `hs.razer`. `true` в случае успеха, иначе `false` Сообщения об ошибке в формате простого текста, если произошла ошибка.
Source	extensions/razer/librazer.m строка 517

backlightsStarlight

Signature	`hs.razer:backlightsStarlight(speed, [color], [secondaryColor]) -> razerObject, boolean, string \| nil`
Type	Method
Description	Изменяет подсветку клавиатуры в режим Starlight.
Parameters	speed - Число от 1 (быстро) до 3 (медленно) [color] - Необязательное значение `hs.drawing.color` [secondaryColor] - Необязательное дополнительное значение `hs.drawing.color`
Returns	Объект `hs.razer`. `true` в случае успеха, иначе `false` Сообщения об ошибке в формате простого текста, если произошла ошибка.
Notes	Если ни `color` ни `secondaryColor` не заданы, то будут использованы случайные цвета.
Source	extensions/razer/librazer.m строка 576

backlightsStatic

Signature	`hs.razer:backlightsStatic(color) -> razerObject, boolean, string \| nil`
Type	Method
Description	Изменяет подсветку клавиатуры на один статический цвет.
Parameters	color - Объект `hs.drawing.color`.
Returns	Объект `hs.razer`. `true` в случае успеха, иначе `false`. Сообщения об ошибке в формате простого текста, если произошла ошибка.
Source	extensions/razer/librazer.m строка 424

backlightsWave

Signature	`hs.razer:backlightsWave(speed, direction) -> razerObject, boolean, string \| nil`
Type	Method
Description	Изменяет подсветку клавиатуры в режим волны.
Parameters	speed - Число от 1 (быстро) до 255 (медленно) direction - "влево" или "вправо" в виде строки
Returns	Объект `hs.razer`. `true` в случае успеха, иначе `false` Сообщения об ошибке в формате простого текста, если произошла ошибка.
Source	extensions/razer/librazer.m строка 475

blueStatusLight

Signature	`hs.razer:blueStatusLight(value) -> razerObject, boolean \| nil, string \| nil`
Type	Method
Description	Получение или установка индикатора состояния синего цвета.
Parameters	value - `true` для включения, `false` для выключения`
Returns	Объект `hs.razer`. `true` для включения, `false` для выключения`, or`nil` если произошла ошибка Сообщения об ошибке в формате простого текста, если произошла ошибка.
Source	extensions/razer/librazer.m строка 374

brightness

Signature	`hs.razer:brightness(value) -> razerObject, number \| nil, string \| nil`
Type	Method
Description	Получение или установка яркости Razer клавиатуры.
Parameters	value - Значение яркости - число от 0 (выкл) до 100 (максимальная яркость).
Returns	Объект `hs.razer`. Значение яркости в виде числа или `nil` если произошла ошибка. Сообщения об ошибке в формате простого текста, если произошла ошибка.
Source	extensions/razer/librazer.m строка 221

callback

Signature	`hs.razer:callback(callbackFn) -> razerObject`
Type	Method
Description	Устанавливает или удаляет функцию обратного вызова для объекта `hs.razer`.
Parameters	`callbackFn` - функция, которая будет установлена в качестве обратного вызова для этого объекта `hs.razer`. Если предоставленное значение `nil`, любая существующая функция обратного вызова будет удалена.
Returns	Объект `hs.razer`
Notes	Функция обратного вызова должна принимать 4 аргумента и не должна возвращать ничего: `razerObject` - Объект последовательного порта, который вызвал обратный вызов. `buttonName` - Имя кнопки в виде строки. `buttonAction` - Строка, содержащая "pressed", "released", "up" или "down".
Source	extensions/razer/librazer.m строка 147

defaultKeyboardLayout

Signature	`hs.razer:defaultKeyboardLayout(enabled) -> boolean`
Type	Method
Description	Позволяет переопределить стандартную раскладку клавиатуры на устройстве Razer, чтобы кнопки больше не срабатывали по умолчанию, или восстановить стандартную раскладку клавиатуры.
Parameters	enabled - Если `true` Razer будет использовать стандартную раскладку клавиатуры.
Returns	Объект `hs.razer`. `true` в случае успеха, иначе `false`
Notes	Эта функция в настоящее время работает только на Razer Tartarus V2.
Source	extensions/razer/razer.lua строка 43

greenStatusLight

Signature	`hs.razer:greenStatusLight(value) -> razerObject, boolean \| nil, string \| nil`
Type	Method
Description	Получение или установка индикатора состояния зеленого цвета.
Parameters	value - `true` для включения, `false` для выключения`
Returns	Объект `hs.razer`. `true` для включения, `false` для выключения`, or`nil` если произошла ошибка Сообщения об ошибке в формате простого текста, если произошла ошибка.
Source	extensions/razer/librazer.m строка 326

name

Signature	`hs.razer:name() -> string`
Type	Method
Description	Возвращает читаемое человеком имя устройства Razer.
Parameters	None
Returns	Имя устройства в виде строки.
Source	extensions/razer/librazer.m строка 125

orangeStatusLight

Signature	`hs.razer:orangeStatusLight(value) -> razerObject, boolean \| nil, string \| nil`
Type	Method
Description	Получение или установка индикатора состояния оранжевого цвета.
Parameters	value - `true` для включения, `false` для выключения`
Returns	Объект `hs.razer`. `true` для включения, `false` для выключения`, or`nil` если произошла ошибка Сообщения об ошибке в формате простого текста, если произошла ошибка.
Source	extensions/razer/librazer.m строка 278