hs.battery
Информация о батарее/питании Все функции здесь могут возвращать nil, если запрошенная информация недоступна.
Этот модуль основан в основном на коде из предыдущей версии Mjolnir от Steven Degutis.
Подмодули
Обзор 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. |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Исходный код | extensions/battery/battery.lua строка 365 |
adapterSerialNumber
| Подпись | hs.battery.adapterSerialNumber() -> integer | string |
|---|---|
| Тип | Функция |
| Описание |
Возвращает серийный номер подключенного источника питания, если он есть. |
| Параметры |
|
| Возвращает |
|
| Исходный код | extensions/battery/battery.lua строка 314 |
amperage
| Подпись | hs.battery.amperage() -> number |
|---|---|
| Тип | Функция |
| Описание |
Возвращает количество тока, протекающего через батарею, в мАч. |
| Параметры |
|
| Возвращает |
|
| Исходный код | extensions/battery/battery.lua строка 159 |
batterySerialNumber
| Подпись | hs.battery.batterySerialNumber() -> string |
|---|---|
| Тип | Функция |
| Описание |
Возвращает серийный номер батареи, если он есть. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/battery/battery.lua строка 328 |
batteryType
| Подпись | hs.battery.batteryType() -> string |
|---|---|
| Тип | Функция |
| Описание |
Возвращает тип присутствующей батареи или nil, если батареи нет. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/battery/battery.lua строка 300 |
capacity
| Подпись | hs.battery.capacity() -> number |
|---|---|
| Тип | Функция |
| Описание |
Возвращает текущую емкость батареи в мАч. |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/battery/battery.lua строка 92 |
cycles
| Подпись | hs.battery.cycles() -> number |
|---|---|
| Тип | Функция |
| Описание |
Возвращает количество циклов разрядки батареи. |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/battery/battery.lua строка 44 |
designCapacity
| Подпись | hs.battery.designCapacity() -> number |
|---|---|
| Тип | Функция |
| Описание |
Возвращает расчетную емкость батареи в мАч. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/battery/battery.lua строка 109 |
getAll
| Подпись | hs.battery.getAll() -> table |
|---|---|
| Тип | Функция |
| Описание |
Получить всю доступную информацию о батарее. |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/battery/battery.lua строка 342 |
health
| Подпись | hs.battery.health() -> string |
|---|---|
| Тип | Функция |
| Описание |
Возвращает состояние здоровья батареи. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/battery/battery.lua строка 200 |
healthCondition
| Подпись | hs.battery.healthCondition() -> string or nil |
|---|---|
| Тип | Функция |
| Описание |
Возвращает состояние здоровья батареи. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/battery/battery.lua строка 214 |
isCharged
| Подпись | hs.battery.isCharged() -> boolean |
|---|---|
| Тип | Функция |
| Описание |
Возвращает состояние заряда батареи. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/battery/battery.lua строка 258 |
isCharging
| Signature | hs.battery.isCharging() -> boolean |
|---|---|
| Type | Function |
| Description |
Возвращает состояние зарядки батареи |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/battery.lua строка 244 |
isFinishingCharge
| Signature | hs.battery.isFinishingCharge() -> boolean or string |
|---|---|
| Type | Function |
| Description |
Возвращает true, если батарея завершает зарядку |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/battery.lua строка 272 |
maxCapacity
| Signature | hs.battery.maxCapacity() -> number |
|---|---|
| Type | Function |
| Description |
Возвращает максимальную емкость батареи в мАч |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/battery/battery.lua строка 75 |
name
| Signature | hs.battery.name() -> string |
|---|---|
| Type | Function |
| Description |
Возвращает имя батареи |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/battery.lua строка 61 |
otherBatteryInfo
| Signature | hs.battery.otherBatteryInfo() -> table |
|---|---|
| Type | Function |
| Description |
Возвращает информацию о батареях, не являющихся блоками питания (например, аксессуарах Bluetooth) |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/libbattery.m строка 110 |
percentage
| Signature | hs.battery.percentage() -> number |
|---|---|
| Type | Function |
| Description |
Возвращает текущий процент заряда батареи |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/battery.lua строка 123 |
powerSource
| Signature | hs.battery.powerSource() -> string |
|---|---|
| Type | Function |
| Description |
Возвращает текущий источник питания |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/libbattery.m строка 55 |
powerSourceType
| Signature | hs.battery.powerSourceType() -> string |
|---|---|
| Type | Function |
| Description |
Возвращает текущий тип источника питания |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/battery.lua строка 286 |
privateBluetoothBatteryInfo
| Signature | hs.battery.privateBluetoothBatteryInfo() -> table |
|---|---|
| Type | Function |
| Description |
Возвращает информацию об устройствах Bluetooth, используя частные API Apple |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/battery/libbattery.m строка 171 |
timeRemaining
| Signature | hs.battery.timeRemaining() -> number |
|---|---|
| Type | Function |
| Description |
Возвращает оставшееся время работы батареи в минутах |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/libbattery.m строка 33 |
timeToFullCharge
| Signature | hs.battery.timeToFullCharge() -> number |
|---|---|
| Type | Function |
| Description |
Возвращает оставшееся время до полной зарядки батареи в минутах |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/battery.lua строка 230 |
voltage
| Signature | hs.battery.voltage() -> number |
|---|---|
| Type | Function |
| Description |
Возвращает текущее напряжение батареи в мВ |
| Parameters |
|
| Returns |
|
| Source | extensions/battery/battery.lua строка 145 |
warningLevel
| Подпись | hs.battery.warningLevel() -> string |
|---|---|
| Тип | Функция |
| Описание |
Возвращает строку, определяющую текущее состояние предупреждения о заряде батареи. |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | 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