Spec-Zone.ru › Hammerspoon

hs.wifi.watcher

Отслеживайте изменения в связанной сети Wi-Fi

Обзор API

  • Константы — полезные значения, которые нельзя изменить
    • eventTypes
  • Конструкторы — вызовы API, возвращающие объект, обычно тот, который предоставляет методы API
    • new
  • Методы — вызовы API, которые можно выполнять только на объекте, возвращённом конструктором
    • start
    • stop
    • watchingFor

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

Константы

eventTypes
Подпись hs.wifi.watcher.eventTypes[]
Тип Константа
Описание

Таблица, содержащая возможные типы событий, которые может отслеживать данный наблюдатель.

Примечания
  • Доступны следующие события для отслеживания:
  • "SSIDChange" — отслеживает изменение связанной сети для интерфейса Wi-Fi
  • "BSSIDChange" — отслеживает изменение базовой станции, к которой подключен интерфейс Wi-Fi
  • "countryCodeChange" — отслеживает изменение принятого кода страны для интерфейса Wi-Fi
  • "linkChange" — отслеживает изменение состояния соединения для интерфейса Wi-Fi
  • "linkQualityChange" — отслеживает изменение RSSI или скорости передачи для интерфейса Wi-Fi
  • "modeChange" — отслеживает изменение режима работы интерфейса Wi-Fi
  • "powerChange" — отслеживает изменение состояния питания интерфейса Wi-Fi
  • "scanCacheUpdated" — отслеживает обновление кэша сканирования интерфейса Wi-Fi новой информацией
Источник extensions/wifi/libwifi_watcher.m строка 364

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

new
Подпись hs.wifi.watcher.new(fn) -> watcher
Тип Конструктор
Описание

Создаёт нового наблюдателя событий сети Wi-Fi

Параметры
  • fn — функция, которая будет вызываться при возникновении отслеживаемого события Wi-Fi. Функция должна ожидать 2 или 4 аргумента, как описано в примечаниях ниже.
Возвращаемое значение
  • Объект hs.wifi.watcher
Примечания
  • Для обратной совместимости по умолчанию отслеживается только "SSIDChange", поэтому существующий код может продолжать игнорировать аргументы функции обратного вызова, если вы не добавите или не измените события с помощью hs.wifi.watcher:watchingFor.
  • Функция обратного вызова должна ожидать от 3 до 5 аргументов в зависимости от отслеживаемых событий. Возможные аргументы следующие:
    • watcher, "SSIDChange", interface — происходит при изменении связанной сети для интерфейса Wi-Fi
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "SSIDChange"
      • interface — имя интерфейса, для которого произошло событие
    • Используйте hs.wifi.currentNetwork([interface]) для идентификации новой сети, которая может быть равна nil, когда вы выходите из сети.
    • watcher, "BSSIDChange", interface — происходит при изменении базовой станции, к которой подключен интерфейс Wi-Fi
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "BSSIDChange"
      • interface — имя интерфейса, для которого произошло событие
    • watcher, "countryCodeChange", interface — происходит при изменении принятого кода страны для интерфейса Wi-Fi
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "countryCodeChange"
      • interface — имя интерфейса, для которого произошло событие
    • watcher, "linkChange", interface — происходит при изменении состояния соединения для интерфейса Wi-Fi
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "linkChange"
      • interface — имя интерфейса, для которого произошло событие
    • watcher, "linkQualityChange", interface — происходит при изменении RSSI или скорости передачи для интерфейса Wi-Fi
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "linkQualityChange"
      • interface — имя интерфейса, для которого произошло событие
      • rssi — значение RSSI для текущей связанной сети на интерфейсе Wi-Fi
      • rate — скорость передачи для текущей связанной сети на интерфейсе Wi-Fi
    • watcher, "modeChange", interface — происходит при изменении режима работы интерфейса Wi-Fi
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "modeChange"
      • interface — имя интерфейса, для которого произошло событие
    • watcher, "powerChange", interface — происходит при изменении состояния питания интерфейса Wi-Fi
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "powerChange"
      • interface — имя интерфейса, для которого произошло событие
    • watcher, "scanCacheUpdated", interface — происходит при обновлении кэша сканирования интерфейса Wi-Fi новой информацией
      • watcher — сам объект наблюдателя
      • message — сообщение, определяющее событие, в данном случае "scanCacheUpdated"
      • interface — имя интерфейса, для которого произошло событие
Источник extensions/wifi/libwifi_watcher.m строка 215

Методы

start
Подпись hs.wifi.watcher:start() -> watcher
Тип Метод
Описание

Запускает наблюдатель SSID

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.wifi.watcher
Источник extensions/wifi/libwifi_watcher.m строка 282
stop
Подпись hs.wifi.watcher:stop() -> watcher
Тип Метод
Описание

Останавливает наблюдатель SSID

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.wifi.watcher
Источник extensions/wifi/libwifi_watcher.m строка 300
watchingFor
Подпись hs.wifi.watcher:watchingFor([messages]) -> watcher | current-value
Тип Метод
Описание

Получение или установка конкретных типов событий Wi-Fi для генерации обратного вызова с помощью данного наблюдателя.

Параметры
  • messages — необязательная таблица или список строк, определяющих типы событий, для которых этот наблюдатель должен вызывать обратный вызов. Вы можете указать несколько типов событий для отслеживания. По умолчанию { "SSIDChange" }.
Возвращаемое значение
  • если значение предоставлено, возвращает объект наблюдателя; в противном случае возвращает текущие значения в виде таблицы строк.
Примечания
  • возможные значения для этого метода описаны в hs.wifi.watcher.eventTypes.
  • специальная строка "all" указывает, что должны отслеживаться все типы событий.
Источник extensions/wifi/libwifi_watcher.m строка 318

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

Spec-Zone.ru

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