hs.caffeinate

Управление режимами энергопотребления системы (сон, предотвращение сна, блокировка экрана и т. д.)

ПРИМЕЧАНИЕ: Все предотвращения сна будут удалены при вызове hs.reload(). В будущей версии модуля будет сохранение/восстановление состояния при перезагрузке.

Подмодули

hs.caffeinate.watcher

Обзор API

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

currentAssertions
declareUserActivity
fastUserSwitch
get
lockScreen
logOut
restartSystem
sessionProperties
set
shutdownSystem
startScreensaver
systemSleep
toggle

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

Функции

currentAssertions

Подпись	`hs.caffeinate.currentAssertions()`
Тип	Функция
Описание	Получение информации о процессах, которые в настоящее время утверждают ограничения на сон дисплея/питания.
Параметры	Нет
Возвращаемые значения	Таблица, содержащая информацию о текущих утверждениях о питании, с идентификаторами процессов (PID) в качестве ключей, каждый из которых может содержать несколько утверждений
Исходный код	extensions/caffeinate/libcaffeinate.m строка 296

declareUserActivity

Подпись	`hs.caffeinate.declareUserActivity([id])`
Тип	Функция
Описание	Информирование ОС о выполнении пользователем некоторых действий.
Параметры	id - необязательное число, содержащее идентификатор утверждения, возвращённый предыдущим вызовом этой функции
Возвращаемые значения	Число, содержащее идентификатор утверждения, сгенерированный этой функцией
Примечания	Предназначено для моделирования пользовательской активности, например, для предотвращения сна дисплеев или их пробуждения Использование идентификаторов утверждений при многократном вызове этой функции не обязательно, но рекомендуется, если вызовы связаны между собой
Исходный код	extensions/caffeinate/libcaffeinate.m строка 209

fastUserSwitch

Подпись	`hs.caffeinate.fastUserSwitch()`
Тип	Функция
Описание	Отображение экрана «Быстрая смена пользователя» (т. е. экран входа без выхода из системы).
Параметры	Нет
Возвращаемые значения	Нет
Исходный код	extensions/caffeinate/caffeinate.lua строка 109

get

Подпись	`hs.caffeinate.get(sleepType) -> bool or nil`
Тип	Функция
Описание	Запрос о том, предотвращается ли определенный тип сна.
Параметры	sleepType - строка, содержащая тип сна для проверки (см. hs.caffeinate.set() для получения информации о возможных значениях)
Возвращаемые значения	True, если указанный тип сна предотвращается, False — если нет. nil, если sleepType имеет недопустимое значение
Исходный код	extensions/caffeinate/caffeinate.lua строка 55

lockScreen

Подпись	`hs.caffeinate.lockScreen()`
Тип	Функция
Описание	Блокировка дисплеев.
Параметры	Нет
Возвращаемые значения	Нет
Примечания	Эта функция использует закрытые API Apple и, следовательно, может перестать работать в любой версии macOS без предупреждения.
Исходный код	extensions/caffeinate/libcaffeinate.m строка 237

logOut

Подпись	`hs.caffeinate.logOut()`
Тип	Функция
Описание	Запрос выхода текущего пользователя из системы.
Параметры	Нет
Возвращаемые значения	Нет
Исходный код	extensions/caffeinate/caffeinate.lua строка 135

restartSystem

Подпись	`hs.caffeinate.restartSystem()`
Тип	Функция
Описание	Запрос перезагрузки системы.
Параметры	Нет
Возвращаемые значения	Нет
Исходный код	extensions/caffeinate/caffeinate.lua строка 148

sessionProperties

Подпись	`hs.caffeinate.sessionProperties()`
Тип	Функция
Описание	Получение информации от сервера дисплея о текущей сессии.
Параметры	Нет
Возвращаемые значения	Таблица, содержащая информацию о текущей сессии, или nil в случае ошибки
Примечания	Ключи в этом словаре будут различаться в зависимости от текущего состояния системы (например, вход с локального компьютера или удалённый, экран заблокирован или разблокирован).
Исходный код	extensions/caffeinate/libcaffeinate.m строка 271

set

Подпись	`hs.caffeinate.set(sleepType, aValue, acAndBattery)`
Тип	Функция
Описание	Настройка параметров предотвращения сна.
Параметры	sleepType - строка, содержащая тип сна для настройки. Допустимые значения: displayIdle - Управление возможностью перехода экрана (и также системы) в спящий режим при бездействии пользователя. systemIdle - Управление возможностью перехода системы в спящий режим при бездействии пользователя (дисплей может всё ещё переходить в спящий режим). system - Управление возможностью перехода системы в спящий режим по любой причине. aValue - логическое значение, true, если предотвращать указанный тип сна, false — если разрешить acAndBattery - логическое значение, true, если предотвращение сна должно применяться как для подключения к сети переменного тока, так и для работы от батареи, false — если только для подключения к сети переменного тока.
Возвращаемые значения	Нет
Примечания	Эти вызовы не гарантируют предотвращение описанных выше системных действий по переходу в спящий режим. ОС может переопределить их, если сочтет это необходимым (например, если температура процессора станет слишком высокой). Аргумент acAndBattery применяется только к типу сна `system`. Вы можете изменить состояние acAndBattery, вызвав `hs.caffeinate.set()` снова и изменив значение acAndBattery. Опция acAndBattery, похоже, больше не работает — она основана на закрытом API, который запрещён в macOS 10.15 при работе с Hardened Runtime (который Hammerspoon теперь использует).
Исходный код	extensions/caffeinate/caffeinate.lua строка 11

shutdownSystem

Подпись	`hs.caffeinate.shutdownSystem()`
Тип	Функция
Описание	Запрос выхода из системы и выключения питания.
Параметры	Нет
Возвращаемые значения	Нет
Исходный код	extensions/caffeinate/caffeinate.lua строка 161

startScreensaver

Подпись	`hs.caffeinate.startScreensaver()`
Тип	Функция
Описание	Запрос запуска экрана сохранения сессии (который может заблокировать экран, если ОС настроена соответствующим образом).
Параметры	Нет
Возвращаемые значения	Нет
Исходный код	extensions/caffeinate/caffeinate.lua строка 122

systemSleep

Подпись	`hs.caffeinate.systemSleep()`
Тип	Функция
Описание	Запрос немедленного перехода системы в спящий режим.
Параметры	Нет
Возвращаемые значения	Нет
Исходный код	extensions/caffeinate/libcaffeinate.m строка 193

END_OF_DOCUMENT_MARKER

переключить

Подпись	`hs.caffeinate.toggle(sleepType) -> bool or nil`
Тип	Функция
Описание	Переключает текущее состояние указанного типа сна
Параметры	sleepType - Строка, содержащая тип сна для переключения (см. hs.caffeinate.set() для информации о возможных значениях)
Возвращаемое значение	True, если указанный тип сна предотвращается, false — если нет. nil, если sleepType было недопустимым значением
Примечания	Если systemIdle переключается в включенное состояние, это будет применяться только к AC
Источник	extensions/caffeinate/caffeinate.lua строка 82