Spec-Zone.ru › Hammerspoon

hs.milight

Простые средства управления мостом MiLight LED WiFi (также известный как LimitlessLED и EasyBulb)

Обзор API

  • Константы - Полезные значения, которые нельзя изменить
    • maxBrightness
    • minBrightness
  • Конструкторы - Вызовы API, которые возвращают объект, обычно тот, который предлагает методы API
    • new
  • Методы - Вызовы API, которые могут быть выполнены только с объектом, возвращаемым конструктором
    • delete
    • disco
    • send
    • zoneBrightness
    • zoneColor
    • zoneOff
    • zoneOn
    • zoneWhite

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

Константы

maxBrightness
Подпись hs.milight.maxBrightness
Тип Константа
Описание

Указывает максимальное значение яркости, которое может быть использовано. По умолчанию равно 25
Источник extensions/milight/milight.lua строка 14
minBrightness
Подпись hs.milight.minBrightness
Тип Константа
Описание

Указывает минимальное значение яркости, которое может быть использовано. По умолчанию равно 0
Источник extensions/milight/milight.lua строка 9

Конструкторы

new
Подпись hs.milight.new(ip[, port]) -> bridge
Тип Конструктор
Описание

Создает новый объект моста, который будет подключен к предоставленному IP-адресу и порту
Параметры
  • ip - Строка, содержащая IP-адрес устройства MiLight WiFi-моста. Для удобства можно использовать широковещательный адрес вашей сети (например, 192.168.0.255)
  • port - Необязательное число, содержащее UDP-порт для связи с мостом. По умолчанию 8899
Возвращаемое значение
  • Объект hs.milight
Примечания
  • Нельзя использовать 255.255.255.255 в качестве IP-адреса, для этого требуется повышенный уровень привилегий для процесса Hammerspoon
Источник extensions/milight/libmilight.m строка 73

Методы

delete
Подпись hs.milight:delete()
Тип Метод
Описание

Удаляет объект hs.milight
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/milight/libmilight.m строка 121
disco
Подпись hs.milight:disco() -> bool
Тип Метод
Описание

Проходит по режимом дискотеки
Параметры
  • Нет
Возвращаемое значение
  • Истина, если команда была отправлена правильно, в противном случае ложь
Источник extensions/milight/milight.lua строка 90
send
Подпись hs.milight:send(cmd[, value]) -> bool
Тип Метод
Описание

Отправляет команду на мост
Параметры
  • cmd - Команда из таблицы hs.milight.cmd
  • value - Необязательное значение, если это уместно для команды (по умолчанию 0x00)
Возвращаемое значение
  • Истина, если команда была отправлена, в противном случае ложь
Примечания
  • Это команда низкого уровня, обычно вы должны использовать определенный метод для операции, которую вы хотите выполнить
Источник extensions/milight/libmilight.m строка 140
zoneBrightness
Подпись hs.milight:zoneBrightness(zone, value) -> integer
Тип Метод
Описание

Устанавливает яркость для указанной зоны
Параметры
  • zone - Число, определяющее, на какой зоне выполнять операцию. 0 для всех зон, 1-4 для зон от первой до четвёртой
  • value - Число, содержащее уровень яркости для установки, между hs.milight.minBrightness и hs.milight.maxBrightness
Возвращаемое значение
  • Число, содержащее значение, которое было отправлено на WiFi-мост, или -1, если произошла ошибка
Источник extensions/milight/milight.lua строка 107
zoneColor
Подпись hs.milight:zoneColor(zone, value) -> bool
Тип Метод
Описание

Устанавливает цвет RGB для указанной зоны
Параметры
  • zone - Число, определяющее, на какой зоне выполнять операцию. 0 для всех зон, 1-4 для зон от первой до четвёртой
  • value - Число от 0 до 255, представляющее цвет
Возвращаемое значение
  • Истина, если команда была отправлена правильно, в противном случае ложь
Примечания
  • Значение цвета не является обычным цветовым значением RGB, а скорее справочным значением в внутренней таблице в оборудовании ламп. Хотя любое число от 0 до 255 является допустимым, некоторые полезные значения стоит знать:
  • 00 - Фиолетовый
  • 16 - Королевский синий
  • 32 - Нежно-голубой
  • 48 - Бирюзовый
  • 64 - Мятно-зеленый
  • 80 - Морской зелёный
  • 96 - Зеленый
  • 112 - Лимонно-зелёный
  • 128 - Жёлтый
  • 144 - Жёлто-оранжевый
  • 160 - Оранжевый
  • 176 - Красный
  • 194 - Розовый
  • 210 - Фуксия
  • 226 - Сиреневый
  • 240 - Лавандовый
Источник extensions/milight/milight.lua строка 121
zoneOff
Подпись hs.milight:zoneOff(zone) -> bool
Тип Метод
Описание

Выключает указанную зону
Параметры
  • zone - Число, определяющее, на какой зоне выполнять операцию. 0 для всех зон, 1-4 для зон от первой до четвёртой
Возвращаемое значение
  • Истина, если команда была отправлена правильно, в противном случае ложь
Источник extensions/milight/milight.lua строка 64
zoneOn
Подпись hs.milight:zoneOn(zone) -> bool
Тип Метод
Описание

Включает указанную зону
Параметры
  • zone - Число, определяющее, на какой зоне выполнять операцию. 0 для всех зон, 1-4 для зон от первой до четвёртой
Возвращаемое значение
  • Истина, если команда была отправлена правильно, в противном случае ложь
Источник extensions/milight/milight.lua строка 77
zoneWhite
Подпись hs.milight:zoneWhite(zone) -> bool
Тип Метод
Описание

Устанавливает указанную зону на белый цвет
Параметры
  • zone - Число, определяющее, на какой зоне выполнять операцию. 0 для всех зон, 1-4 для зон от первой до четвёртой
Возвращаемое значение
  • Истина, если команда была отправлена правильно, в противном случае ложь
Источник extensions/milight/milight.lua строка 154

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

Spec-Zone.ru

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