Spec-Zone.ru › Hammerspoon

hs.battery

Информация о батарее/питании Все функции здесь могут возвращать nil, если запрошенная информация недоступна.

Этот модуль основан в основном на коде из предыдущей версии Mjolnir от Steven Degutis.

Подмодули

  • hs.battery.watcher

Обзор API

  • Функции - API-вызовы, предлагаемые напрямую расширением
    • _report
    • adapterSerialNumber
    • amperage
    • batterySerialNumber
    • batteryType
    • capacity
    • cycles
    • designCapacity
    • getAll
    • health
    • healthCondition
    • isCharged
    • isCharging
    • isFinishingCharge
    • maxCapacity
    • name
    • otherBatteryInfo
    • percentage
    • powerSource
    • powerSourceType
    • privateBluetoothBatteryInfo
    • timeRemaining
    • timeToFullCharge
    • voltage
    • warningLevel
    • watts

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

Функции

_report
Подпись hs.battery._report() -> table
Тип Функция
Описание

Возвращает таблицу, содержащую все подробности о источнике питания Mac.

Параметры
  • Нет
Возвращает
  • таблица, содержащая исходные данные о источнике питания Mac.
Примечания
  • Эта функция, как правило, не требуется и предоставляется для отладки. Эта функция объединяет вывод следующих внутренних функций:

    • hs.battery._adapterDetails()
    • hs.battery._powerSources()
    • hs.battery._appleSmartBattery()
    • hs.battery._iopmBatteryInfo()
  • Вы можете просмотреть этот отчет, набрав hs.inspect(hs.battery._report()) (или подмножество его, используя вместо этого одну из вышеперечисленных функций) — он будет интересен в основном при отладке или расширении этого модуля и, как правило, не нужен для использования.

Исходный код extensions/battery/battery.lua строка 365
adapterSerialNumber
Подпись hs.battery.adapterSerialNumber() -> integer | string
Тип Функция
Описание

Возвращает серийный номер подключенного источника питания, если он есть.

Параметры
  • Нет
Возвращает
  • Число или строка, содержащая серийный номер источника питания, или nil, если адаптер не подключен или не предоставляет его.
Исходный код extensions/battery/battery.lua строка 314
amperage
Подпись hs.battery.amperage() -> number
Тип Функция
Описание

Возвращает количество тока, протекающего через батарею, в мАч.

Параметры
  • Нет
Возвращает
  • Число, содержащее количество тока, протекающего через батарею. Значение может быть:
  • Меньше нуля, если батарея разряжается (т. е. компьютер работает от батареи)
  • Ноль, если батарея не заряжается и не разряжается
  • Больше нуля, если батарея заряжается
Исходный код extensions/battery/battery.lua строка 159
END_OF_DOCUMENT_MARKER
batterySerialNumber
Подпись hs.battery.batterySerialNumber() -> string
Тип Функция
Описание

Возвращает серийный номер батареи, если он есть.

Параметры
  • Нет
Возвращаемое значение
  • Строка, содержащая серийный номер батареи, или nil, если батареи нет или батарея/ИБП не предоставляет его.
Источник extensions/battery/battery.lua строка 328
batteryType
Подпись hs.battery.batteryType() -> string
Тип Функция
Описание

Возвращает тип присутствующей батареи или nil, если батареи нет.

Параметры
  • Нет
Возвращаемое значение
  • Строка, содержащая «ИБП» или «Внутренняя батарея», или nil, если батареи нет.
Источник extensions/battery/battery.lua строка 300
capacity
Подпись hs.battery.capacity() -> number
Тип Функция
Описание

Возвращает текущую емкость батареи в мАч.

Параметры
  • Нет
Возвращаемое значение
  • Число, содержащее текущую емкость батареи в мАч.
Примечания
  • Это мера того, насколько заряжена батарея, по сравнению со значением hs.battery.maxCapacity()
Источник extensions/battery/battery.lua строка 92
cycles
Подпись hs.battery.cycles() -> number
Тип Функция
Описание

Возвращает количество циклов разрядки батареи.

Параметры
  • Нет
Возвращаемое значение
  • Количество циклов
Примечания
  • Один цикл — это полная разрядка батареи, за которой следует полная зарядка. Это также может быть совокупностью многих меньших циклов разряда-зарядки (например, 10 итераций разрядки батареи с 100% до 90% и последующей зарядки до 100% каждый раз считается одним циклом).
Источник extensions/battery/battery.lua строка 44
designCapacity
Подпись hs.battery.designCapacity() -> number
Тип Функция
Описание

Возвращает расчетную емкость батареи в мАч.

Параметры
  • Нет
Возвращаемое значение
  • Число, содержащее номинальную максимальную емкость батареи
Источник extensions/battery/battery.lua строка 109
getAll
Подпись hs.battery.getAll() -> table
Тип Функция
Описание

Получить всю доступную информацию о батарее.

Параметры
  • Нет
Возвращаемое значение
  • Таблица, содержащая всю информацию, предоставляемую отдельными функциями в hs.battery
Примечания
  • Если вам требуется несколько фрагментов информации о батарее, эта функция может быть более эффективной, чем вызов нескольких других функций по отдельности.
Источник extensions/battery/battery.lua строка 342
health
Подпись hs.battery.health() -> string
Тип Функция
Описание

Возвращает состояние здоровья батареи.

Параметры
  • Нет
Возвращаемое значение
  • Строка, содержащая одно из {Хорошее, Удовлетворительное, Плохое}, как определено контроллером Apple Smart Battery.
Источник extensions/battery/battery.lua строка 200
healthCondition
Подпись hs.battery.healthCondition() -> string or nil
Тип Функция
Описание

Возвращает состояние здоровья батареи.

Параметры
  • Нет
Возвращаемое значение
  • Nil, если нет данных о состоянии здоровья, или строка, содержащая:
  • «Проверить батарею»
  • «Постоянный отказ батареи»
Источник extensions/battery/battery.lua строка 214
isCharged
Подпись hs.battery.isCharged() -> boolean
Тип Функция
Описание

Возвращает состояние заряда батареи.

Параметры
  • Нет
Возвращаемое значение
  • True, если батарея заряжена, false — если нет.
Источник extensions/battery/battery.lua строка 258
END_OF_DOCUMENT_MARKER
isCharging
Signature hs.battery.isCharging() -> boolean
Type Function
Description

Возвращает состояние зарядки батареи

Parameters
  • None
Returns
  • True, если батарея заряжается, false — если нет
Source extensions/battery/battery.lua строка 244
isFinishingCharge
Signature hs.battery.isFinishingCharge() -> boolean or string
Type Function
Description

Возвращает true, если батарея завершает зарядку

Parameters
  • None
Returns
  • True, если батарея находится в конечной стадии зарядки (например, подзарядка), false — если нет
Source extensions/battery/battery.lua строка 272
maxCapacity
Signature hs.battery.maxCapacity() -> number
Type Function
Description

Возвращает максимальную емкость батареи в мАч

Parameters
  • None
Returns
  • Число, содержащее наблюдаемую максимальную емкость батареи в мАч
Notes
  • Это значение может превышать hs.battery.designCapacity() из-за небольших вариаций в производственной химии по сравнению с проектом
Source extensions/battery/battery.lua строка 75
name
Signature hs.battery.name() -> string
Type Function
Description

Возвращает имя батареи

Parameters
  • None
Returns
  • Строка, содержащая имя батареи
Source extensions/battery/battery.lua строка 61
otherBatteryInfo
Signature hs.battery.otherBatteryInfo() -> table
Type Function
Description

Возвращает информацию о батареях, не являющихся блоками питания (например, аксессуарах Bluetooth)

Parameters
  • None
Returns
  • Таблица, содержащая информацию об остальных известных системе батареях, или пустая таблица, если устройства не найдены
Source extensions/battery/libbattery.m строка 110
percentage
Signature hs.battery.percentage() -> number
Type Function
Description

Возвращает текущий процент заряда батареи

Parameters
  • None
Returns
  • Число, содержащее процент заряда батареи
Source extensions/battery/battery.lua строка 123
powerSource
Signature hs.battery.powerSource() -> string
Type Function
Description

Возвращает текущий источник питания

Parameters
  • None
Returns
  • Строка, содержащая одно из значений: {Питание от сети, Питание от батареи, Питание от ИБП}.
Source extensions/battery/libbattery.m строка 55
powerSourceType
Signature hs.battery.powerSourceType() -> string
Type Function
Description

Возвращает текущий тип источника питания

Parameters
  • None
Returns
  • Строка, содержащая одно из значений: {Питание от сети, Питание от батареи, Отключено}.
Source extensions/battery/battery.lua строка 286
privateBluetoothBatteryInfo
Signature hs.battery.privateBluetoothBatteryInfo() -> table
Type Function
Description

Возвращает информацию об устройствах Bluetooth, используя частные API Apple

Parameters
  • None
Returns
  • Таблица, содержащая информацию об устройствах, использующих частные API Apple.
Notes
  • Эта функция использует частные API Apple — это значит, что она может сломаться без предупреждения при обновлении macOS. Пожалуйста, сообщите нам о сбоях!
  • Эта функция вернёт информацию обо всех подключенных устройствах Bluetooth, но большая часть её будет бесполезной для большинства устройств
  • Таблица содержит следующие ключи:
    • vendorID — числовой идентификатор производителя устройства (идентификатор Apple — 76)
    • productID — числовой идентификатор устройства
    • address — адрес Bluetooth устройства
    • isApple — строка, содержащая "ДА" или "НЕТ", в зависимости от того, является ли это продуктом Apple/Beats или продуктом сторонних разработчиков
    • name — читаемая человеком строка, содержащая имя устройства
    • batteryPercentSingle — для некоторых устройств это будет содержать процент батареи (например, наушники Beats)
    • batteryPercentCombined — нам пока не понятно, что представляет собой это поле. Пожалуйста, сообщите, если вы найдёте здесь ненулевое значение
    • batteryPercentCase — процент заряда батареи футляров AirPods (обратите внимание, что часто это значение будет 0 — футляр AirPods агрессивно переходит в спящий режим)
    • batteryPercentLeft — процент заряда батареи левого наушника AirPods, если он находится вне футляра
    • batteryPercentRight — процент заряда батареи правого наушника AirPods, если он находится вне футляра
    • buttonMode — нам пока не понятно, что представляет собой это поле. Пожалуйста, сообщите, если вы найдёте значение, отличное от 1
    • micMode — для AirPods это соответствует параметру микрофона в настройках Bluetooth устройства
    • leftDoubleTap — для AirPods это соответствует действию двойного касания левой гарнитуры в настройках Bluetooth устройства
    • rightDoubleTap — для AirPods это соответствует действию двойного касания правой гарнитуры в настройках Bluetooth устройства
    • primaryBud — для AirPods это либо «left», либо «right», в зависимости от того, какой наушник в настоящее время считается основным устройством
    • primaryInEar — для AirPods это «ДА» или «НЕТ», в зависимости от того, находится ли основной наушник в ухе
    • secondaryInEar — для AirPods это «ДА» или «НЕТ», в зависимости от того, находится ли дополнительный наушник в ухе
    • isInEarDetectionSupported — поддерживает ли данное устройство обнаружение, когда оно находится в ухе
    • isEnhancedDoubleTapSupported — поддерживает ли это устройство улучшенное двойное касание
    • isANCSupported — мы полагаем, что это, скорее всего, указывает на поддержку активного шумоподавления (например, Beats Solo)
  • Пожалуйста, сообщайте о любых сбоях этой функции — вероятно, есть устройства Bluetooth, которые мы не тестировали, которые могут возвращать странные данные
  • Многие/Большинство/Все продукты сторонних разработчиков, скорее всего, вернут нули для всех полей, связанных с батареей, так же, как и устройства Apple HID. Похоже, что эти частные API в основном предназначены для поддержки наушников Apple/Beats.
Source extensions/battery/libbattery.m строка 171
timeRemaining
Signature hs.battery.timeRemaining() -> number
Type Function
Description

Возвращает оставшееся время работы батареи в минутах

Parameters
  • None
Returns
  • Число, содержащее оставшиеся минуты работы батареи. Значение может быть:
  • Больше нуля, чтобы указать количество оставшихся минут
  • -1, если оставшееся время работы батареи все еще рассчитывается
  • -2, если оставшееся время работы батареи неограниченно (например, система подключена к сети)
Source extensions/battery/libbattery.m строка 33
timeToFullCharge
Signature hs.battery.timeToFullCharge() -> number
Type Function
Description

Возвращает оставшееся время до полной зарядки батареи в минутах

Parameters
  • None
Returns
  • Число, содержащее оставшееся время (в минутах) до полной зарядки батареи, или -1, если оставшееся время все еще рассчитывается
Source extensions/battery/battery.lua строка 230
voltage
Signature hs.battery.voltage() -> number
Type Function
Description

Возвращает текущее напряжение батареи в мВ

Parameters
  • None
Returns
  • Число, содержащее текущее напряжение батареи
Source extensions/battery/battery.lua строка 145
END_OF_DOCUMENT_MARKER
warningLevel
Подпись hs.battery.warningLevel() -> string
Тип Функция
Описание

Возвращает строку, определяющую текущее состояние предупреждения о заряде батареи.

Параметры
  • Нет
Возвращаемое значение
  • строка, определяющая текущее состояние уровня предупреждения. Строка будет одной из "none", "low" или "critical".
Примечания
  • Значение возвращаемых строк следующее:
    • "none" - указывает, что система не находится в ситуации низкого заряда батареи или в настоящее время подключена к источнику питания переменного тока.
    • "low" - система находится в ситуации низкого заряда батареи и может обеспечить не более 20 минут работы. Обратите внимание, что это лишь предположение; 20 минут не гарантируются и будут сильно зависеть от того, что компьютер делает в данный момент, от количества работающих приложений, яркости экрана и т. д.
    • "critical" - система находится в ситуации очень низкого заряда батареи и может обеспечить не более 10 минут работы. Обратите внимание, что это лишь предположение; 10 минут не гарантируются и будут сильно зависеть от того, что компьютер делает в данный момент, от количества работающих приложений, яркости экрана и т. д.
Источник extensions/battery/libbattery.m строка 80
watts
Подпись hs.battery.watts() -> number
Тип Функция
Описание

Возвращает мощность, поступающую в или покидающую батарею, в Вт.

Параметры
  • Нет
Возвращаемое значение
  • Число, содержащее скорость преобразования энергии в батарее. Значение может быть:
  • Меньше нуля, если батарея разряжается (т.е. компьютер работает от батареи)
  • Ноль, если батарея не заряжается и не разряжается
  • Больше нуля, если батарея заряжается
Источник extensions/battery/battery.lua строка 176

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.battery.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API