hs.tangent

Определения зарезервированных идентификаторов действий.

• alt — переключает функцию «ALT».
• nextKnobBank — переключает следующий банк регуляторов.
• prevKnobBank — переключает предыдущий банк регуляторов.
• nextButtonBank — переключает следующий банк кнопок.
• prevBasketBank — переключает предыдущий банк кнопок.
• nextTrackerballBank — переключает следующий банк трекболов.
• prevTrackerballBank — переключает предыдущий банк трекболов.
• nextMode — переключает следующий режим.
• prevMode — переключает предыдущий режим.
• goToMode — переключает на указанный режим, требуя аргумент с идентификатором режима.
• toggleJogShuttle — переключает режим джойстика/шуттла.
• toggleMouseEmulation — переключает эмуляцию мыши.
• fakeKeypress — генерирует нажатие клавиши, требуя аргумент с кодом клавиши.
• showHUD — отображает HUD на экране.
• goToKnobBank — переходит к определённому банку регуляторов, требуя аргумент с номером банка.
• goToButtonBank — переходит к определённому банку кнопок, требуя аргумент с номером банка.
• goToTrackerballBank — переходит к определённому банку трекболов, требуя аргумент с номером банка.

Таблица резервированных идентификаторов параметров.

• transportRing — транспортное кольцо.
• fakeKeypress — отправляет поддельное нажатие клавиши.

Определения команд IPC от Hammerspoon к HUB.

Автоматически отправлять ответ «Определение приложения». По умолчанию true.

IP-адрес, по которому находится Tangent Hub. По умолчанию 127.0.0.1.

Порт, который отслеживает Tangent Hub. По умолчанию 64246.

Устанавливает обратный вызов при получении новых сообщений.

• callbackFn - функция, которая будет установлена как обратный вызов для hs.tangent. Если предоставленное значение равно nil, любая существующая функция обратного вызова будет удалена.

• true в случае успеха, в противном случае false

• Полную документацию по API Tangent можно загрузить здесь.
• Функция обратного вызова должна принимать 1 аргумент и не должна ничего возвращать.
• Этот единственный аргумент будет таблицей, которая может содержать одну или несколько команд. Каждая команда — это отдельная таблица со следующим содержимым:
  • id — идентификатор сообщения входящего сообщения
  • metadata — таблица данных для команды Tangent (см. ниже).
• Таблица metadata вернёт следующее, в зависимости от id для обратного вызова:
  • connected — Соединение с Tangent Hub установлено успешно.
  • disconnected — Соединение с Tangent Hub разорвано.
  • initiateComms — Инициализирует общение между Hub и приложением.
    • protocolRev — Номер ревизии протокола.
    • numPanels — Количество подключённых панелей.
    • panels
      • panelID — Идентификатор панели.
      • panelType — Тип подключённой панели.
    • data — Необработанные данные с Tangent Hub.
  • parameterChange — Запрос на инкремент параметра в приложении.
    • paramID — Значение ID параметра.
    • increment — Значение приращения, которое должно быть применено к параметру.
  • parameterReset — Запрос на изменение параметра в приложение на его значение по умолчанию.
    • paramID — Значение ID параметра.
  • parameterValueRequest — Запрос на отправку ParameterValue (0x82) команды Hub.
    • paramID — Значение ID параметра.
  • menuChange — Запрос изменения индекса меню на +1 или -1.
    • menuID — Значение ID меню.
    • increment — Приращение, на которое необходимо изменить индекс меню (всегда целое число +1 или -1).
  • menuReset — Запрос на изменение меню на его значение по умолчанию.
    • menuID — Значение ID меню.
  • menuStringRequest — Запрос отправки MenuString (0x83) команды Hub.
    • menuID — Значение ID меню.
  • actionOn — Запрос выполнения указанного действия.
    • actionID — Значение ID действия.
  • modeChange — Запрос смены режима на указанный.
    • modeID — Значение ID режима.
  • transport — Запрос перемещения активного транспортного средства.
    • jogValue — Количество шагов джойстика для перемещения транспортного средства.
    • shuttleValue — Значение приращения для изменения скорости шаттла.
  • actionOff — Запрос отмены указанного действия.
    • actionID — Значение ID действия.
  • unmanagedPanelCapabilities — Используется только при работе в режиме управления панелью. Отправляется в ответ на UnmanagedPanelCapabilitiesRequest (0xA0) команду.
    • panelID — Идентификатор панели, как указано в InitiateComms команде.
    • numButtons — Количество кнопок на панели.
    • numEncoders — Количество энкодеров на панели.
    • numDisplays — Количество дисплеев на панели.
    • numDisplayLines — Количество строк на каждом дисплее на панели.
    • numDisplayChars — Количество символов в каждой строке на каждом дисплее на панели.
  • unmanagedButtonDown — Используется только при работе в режиме управления панелью. Выдается при нажатии кнопки.
    • panelID — Идентификатор панели, как указано в InitiateComms команде.
    • buttonID — Аппаратный идентификатор кнопки
  • unmanagedButtonUp — Используется только при работе в режиме управления панелью. Выдается при отпускании кнопки.
    • panelID — Идентификатор панели, как указано в InitiateComms команде.
    • buttonID — Аппаратный идентификатор кнопки.
  • unmanagedEncoderChange — Используется только при работе в режиме управления панелью. Выдаётся при перемещении энкодера.
    • panelID — Идентификатор панели, как указано в InitiateComms команде.
    • paramID — Аппаратный идентификатор энкодера.
    • increment — Значение приращения.
  • unmanagedDisplayRefresh — Используется только при работе в режиме управления панелью. Выдаётся при подключении панели или возвращении фокуса панели вашему приложению.
    • panelID — Идентификатор панели, как указано в InitiateComms команде.
  • panelConnectionState
    • panelID — Идентификатор панели, как указано в InitiateComms команде.
    • state — Состояние подключения панели, true если подключена, false если отключена.

Подключается к Tangent Hub.

• applicationName - Название вашего приложения в виде строки
• systemPath - Строка, содержащая абсолютный путь к каталогу, который содержит XML-файлы Controls и Default Map.
• [userPath] - Необязательная строка, содержащая абсолютный путь к каталогу, который содержит XML-файлы User’s Default Map.

• success - true в случае успеха, в противном случае nil
• errorMessage - Сообщения об ошибках в виде строки или nil если success равно true.

Проверяет, подключены ли вы к Tangent Hub.

• None

• true если подключены, в противном случае false

Отключается от Tangent Hub.

• None

• None

Проверяет установлено ли программное обеспечение Tangent Hub.

• None

• true если Tangent Hub установлен, в противном случае false.

Отправляет сообщение "строка байтов" в Tangent Hub.

• byteString - Строка байтов для отправки в tangent.

• success - true если подключены, в противном случае false
• errorMessage - Сообщение об ошибке, если произошла ошибка, в виде строки

• Это должна быть полная закодированная строка для отправляемой команды без начального раздела 'size', который функция будет рассчитывать автоматически.
• В целом, следует использовать более конкретные функции, которые упаковывают команду для вас, такие как sendParameterValue(...). Эта функция может использоваться для отправки сообщения, которое этот API ещё не поддерживает.
• Полную документацию по API Tangent можно загрузить здесь.

Сообщает Hub о значительном изменении настроек программного управления.

• Нет

• true при успехе или false и сообщение об ошибке в противном случае.

• Hub отвечает запросом на все текущие значения программного управления, которым он в данный момент управляет.

Отправляет сведения об приложении в Hub Tangent.

• appName - Читаемое человеком имя приложения.
• systemPath - Строка, содержащая абсолютный путь к каталогу, который содержит файлы XML для управления и карты по умолчанию (Строка пути)
• userPath - Строка, содержащая абсолютный путь к каталогу, который содержит файлы XML пользовательской карты по умолчанию (Строка пути)

• true при успехе, false и сообщение об ошибке, если возникла проблема.

• Если сведения не предоставлены, используются сведения, сохраненные в модуле.

Обновляет Hub строками символов, которые будут отображаться на подключённых панелях, если есть место.

• messages - Список сообщений для отправки.
• doubleHeight - Необязательный список booleans, указывающий, является ли соответствующее сообщение двухстрочным.

• true при успехе, или false и сообщение об ошибке в противном случае.

• Строки могут быть 32-символьными, однострочными или 16-символьными двухстрочными. Они будут отображаться в порядке получения; первая строка отображается вверху дисплея.
• Если строка не определена как двухстрочная, она займёт следующую строку.
• Если строка определена как двухстрочная, она займёт следующие 2 строки.
• Максимальное количество строк, которое будет использоваться приложением, должно быть указано в файле XML управления.
• Текст, превышающий 32 (однострочный) или 16 (двухстрочный) символов, будет усечён.
• Если весь текст однострочный, таблица doubleHeight может быть опущена.

Подсвечивает элемент управления на любой панели, где эта функция доступна.

• targetID - Идентификатор любого параметра, меню, действия или режима, определённого приложением (целое без знака)
• active - Если true, элемент управления подсвечивается, в противном случае нет.

• true при успешной отправке, false и сообщение об ошибке в противном случае.

• При применении к режимам, кнопки, сопоставленные с зарезервированным действием "Перейти к режиму" для данного режима, будут подсвечены.

Устанавливает индикатор элемента управления на любой панели, где эта функция доступна.

• targetID - Идентификатор любого параметра, меню, действия или режима, определённого приложением
• active - Если true, элемент управления отображается, в противном случае нет.

• true при успешной отправке, false и сообщение об ошибке в противном случае.

• Этот индикатор управляется аргументом atDefault для параметров и меню. Таким образом, эта команда применяется только к элементам управления, сопоставленным с действиями и режимами.
• При применении к режимам, кнопки, сопоставленные с зарезервированным действием "Перейти к режиму" для данного режима, будут иметь установленный индикатор.

Обновляет концентратор значением меню.

• menuID - Значение идентификатора меню (Целое без знака)
• value - Текущее значение параметра, представленное строкой
• atDefault - если true значение представляет собой значение по умолчанию. В противном случае false.

• true в случае успеха, или false и сообщение об ошибке в противном случае.

• Затем концентратор обновляет отображения любых панелей, которые в настоящее время отображают меню.
• Если отправлено значение nil, концентратор не будет пытаться отобразить значение для меню. Однако флаг atDefault все равно будет распознан.

Обновляет концентратор значением режима.

• modeID - Значение идентификатора режима (Целое без знака)

• true в случае успеха, или false и сообщение об ошибке в противном случае.

• Затем концентратор меняет режим и запрашивает все текущие значения управляемых им программных элементов управления.

Запрашивает от концентратора ответ с последовательностью команд PanelConnectionState (0x35) для отчета о статусе подключенных/отключенных каждого настроенного экрана.

• Нет

• true если отправлено успешно, false и сообщение об ошибке в противном случае.

• Один запрос может привести к нескольким ответам состояния.

Обновляет концентратор значением параметра.

• paramID - Значение идентификатора параметра (Целое без знака)
• value - Текущее значение параметра (Число с плавающей запятой)
• atDefault - если true значение представляет собой значение по умолчанию. По умолчанию false.

• true в случае успеха, или false и сообщение об ошибке в противном случае.

• Затем концентратор обновляет отображения любых панелей, которые в настоящее время отображают значение параметра.

Динамически переименовывает элемент управления.

• targetID - Идентификатор любого определённого в приложении параметра, меню, действия или режима (Беззнаковое целое число)
• newName - Новое имя.

• true в случае успеха, false и сообщение об ошибке в противном случае.

• Указанная строка заменит обычный текст, полученный из файла XML элементов управления.
• Чтобы удалить любое существующее переименование, установите newName в значение "", это удалит любое переименование и вернёт систему к отображению обычного текста.
• При применении к режимам также изменится текст, отображаемый на кнопках, сопоставленных с резервным действием «Переход в режим» для этого конкретного режима.

Обновляет Центр данными, которые будут отображаться на определённой панели на заданной строке и с заданной позиции, в зависимости от возможностей панели.

• panelID - Идентификатор панели, полученный в команде InitiateComms (Беззнаковое целое число)
• displayID - Идентификатор отображаемого объекта (Беззнаковое целое число)
• lineNum - Номер строки отображаемого объекта, где 1 — это верхняя строка (Беззнаковое целое число)
• pos - Позиция в строке для начала записи, где 1 — это первый столбец (Беззнаковое целое число)
• message - Строка текста (Строка символов)

• true в случае успеха, или false и сообщение об ошибке в противном случае.

• Используется только при работе в режиме неопределённой панели.
• Если старший бит любого символа текста в message установлен, он будет отображаться инвертированным (темный текст на светлом фоне).

Запрашивает у Центра ответ с помощью команды UnmanagedPanelCapabilities (0x30).

• panelID - Идентификатор панели, полученный в команде InitiateComms (Беззнаковое целое число)

• true в случае успеха, или false и сообщение об ошибке в противном случае.

• Используется только при работе в режиме неопределённой панели

Устанавливает уровень ведения журнала.

• loglevel - может быть 'nothing', 'error', 'warning', 'info', 'debug' или 'verbose'; или соответствующее число от 0 до 5

• Нет