hs.serial

Общение с внешними устройствами через последовательный порт (в основном RS-232).

Поддерживается ORSSerialPort. Скомпилировано @latenitefilms.

Настоящим предоставляется бесплатная лицензия любому лицу, получившему копию данного программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), на использование Программного обеспечения без ограничений, включая, но не ограничиваясь, правами на использование, копирование, модификацию, объединение, публикацию, распространение, сублицензирование и/или продажу копий Программного обеспечения, а также разрешение лицам, которым предоставлено Программное обеспечение, делать то же самое при условии соблюдения следующих условий:

Вышеуказанная информация об авторских правах и настоящее уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ» БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ. В НИКАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ДРУГУЮ ОТВЕТСТВЕННОСТЬ, ВОЗНИКШИЕ В РЕЗУЛЬТАТЕ ДОГОВОРА, ДЕЛИКТА ИЛИ ИНЫМ ОБРАЗОМ, ВОЗНИКШИЕ ИЗ, В СВЯЗИ С ИЛИ В СООТНОШЕНИИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.

Обзор API

Функции - API-вызовы, предлагаемые напрямую расширением

availablePortDetails
availablePortNames
availablePortPaths
deviceCallback

Конструкторы - API-вызовы, возвращающие объект, как правило, предоставляющий API-методы

newFromName
newFromPath

Методы - API-вызовы, которые могут быть выполнены только с объектом, возвращённым конструктором

baudRate
callback
close
dataBits
dtr
isOpen
name
open
parity
path
rts
sendData
shouldEchoReceivedData
stopBits
usesDTRDSRFlowControl
usesRTSCTSFlowControl

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

Функции

availablePortDetails

Подпись	`hs.serial.availablePortDetails() -> table`
Тип	Функция
Описание	Возвращает таблицу данных о подключенных последовательных портах, организованных по имени порта.
Параметры	Нет
Возвращаемое значение	Таблица, содержащая данные IOKit о подключенных последовательных портах, организованных по имени порта.
Исходный код	extensions/serial/libserial.m строка 655

availablePortNames

Подпись	`hs.serial.availablePortNames() -> table`
Тип	Функция
Описание	Возвращает таблицу имён подключенных последовательных портов.
Параметры	Нет
Возвращаемое значение	Таблица, содержащая имена подключенных последовательных портов в виде строк.
Исходный код	extensions/serial/libserial.m строка 631

availablePortPaths

Подпись	`hs.serial.availablePortPaths() -> table`
Тип	Функция
Описание	Возвращает таблицу путей подключенных последовательных портов.
Параметры	Нет
Возвращаемое значение	Таблица, содержащая пути подключенных последовательных портов в виде строк.
Исходный код	extensions/serial/libserial.m строка 683

deviceCallback

Подпись	`hs.serial.deviceCallback(callbackFn) -> none`
Тип	Функция
Описание	Обработчик событий, срабатывающий при добавлении или удалении последовательного порта из системы.
Параметры	callbackFn - функция обратного вызова, или nil для удаления текущего обратного вызова
Возвращаемое значение	Нет
Примечания	Функция обратного вызова должна ожидать 1 аргумент и не должна возвращать ничего: `devices` - Таблица, содержащая имена подключённых последовательных портов в виде строк.
Исходный код	extensions/serial/libserial.m строка 1161

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

newFromName

Подпись	`hs.serial.newFromName(portName) -> serialPortObject`
Тип	Конструктор
Описание	Создаёт новый объект `hs.serial`, используя имя порта.
Параметры	portName - строка, содержащая имя порта.
Возвращаемое значение	Объект `hs.serial` или `nil` в случае ошибки.
Примечания	Действительное имя порта можно найти, проверив `hs.serial.availablePortNames()`.
Исходный код	extensions/serial/libserial.m строка 525

newFromPath

Подпись	`hs.serial.newFromPath(path) -> serialPortObject`
Тип	Конструктор
Описание	Создаёт новый объект `hs.serial`, используя путь.
Параметры	path - строка, содержащая путь (например, "/dev/cu.usbserial").
Возвращаемое значение	Объект `hs.serial` или `nil` в случае ошибки.
Примечания	Действительное имя порта можно найти, проверив `hs.serial.availablePortPaths()`.
Исходный код	extensions/serial/libserial.m строка 558

Методы

baudRate

Подпись	`hs.serial:baudRate([value], [allowNonStandardBaudRates]) -> number \| serialPortObject`
Тип	Метод
Описание	Получает или устанавливает скорость передачи данных для последовательного порта.
Параметры	value - необязательное число для установки скорости передачи данных. [allowNonStandardBaudRates] - необязательный логический тип, для включения нестандартных скоростей передачи данных. По умолчанию `false`.
Возвращаемое значение	Если значение указано, метод возвращает объект последовательного порта. В противном случае, метод возвращает скорость передачи данных как число.
Примечания	Данная функция поддерживает следующие стандартные скорости передачи данных как числа: 300, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, 115200, 230400. Если скорость передачи данных не задана, она по умолчанию составляет 115200.
Исходный код	extensions/serial/libserial.m строка 783

callback

Подпись	`hs.serial:callback(callbackFn) -> serialPortObject`
Тип	Метод
Описание	Устанавливает или удаляет функцию обратного вызова для объекта `hs.serial`.
Параметры	`callbackFn` - функция, которая должна быть установлена как функция обратного вызова для объекта `hs.serial`. Если указанное значение равно `nil`, любая существующая функция обратного вызова удаляется.
Возвращаемое значение	Объект `hs.serial`
Примечания	Функция обратного вызова должна ожидать 4 аргумента и не должна возвращать ничего: `serialPortObject` - Объект последовательного порта, который сработал обратный вызов. `callbackType` - Строка, содержащая "opened", "closed", "received", "removed" или "error". `message` - Если `callbackType` равно "received", то это полученные данные как строка. Если `callbackType` равно "error", это сообщение об ошибке как строка. `hexadecimalString` - Если `callbackType` равно "received", то это полученные данные как шестнадцатеричная строка.
Исходный код	extensions/serial/libserial.m строка 591

close

Подпись	`hs.serial:close() -> serialPortObject`
Тип	Метод
Описание	Закрывает последовательный порт.
Параметры	Нет
Возвращаемое значение	Объект `hs.serial`.
Исходный код	extensions/serial/libserial.m строка 765

END_OF_DOCUMENT_MARKER

dataBits

Signature	`hs.serial:dataBits([value]) -> number \| serialPortObject`
Type	Method
Description	Получает или задаёт количество битов данных для последовательного порта.
Parameters	value - Необязательное число для задания количества битов данных. Может быть от 5 до 8.
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает количество битов данных как число. Значение по умолчанию — 8.
Source	extensions/serial/libserial.m строка 1091

dtr

Signature	`hs.serial:dtr([value]) -> boolean \| serialPortObject`
Type	Method
Description	Получает или задаёт состояние бита DTR (Data Terminal Ready) последовательного порта.
Parameters	value - Необязательное логическое значение.
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает логическое значение.
Notes	Значение по умолчанию — `false`. Установка значения `true`, скорее всего, потребуется для устройств Arduino перед открытием последовательного порта.
Source	extensions/serial/libserial.m строка 972

isOpen

Signature	`hs.serial:isOpen() -> boolean`
Type	Method
Description	Получает, открыт ли последовательный порт.
Parameters	None
Returns	`true` если открыт, иначе `false`.
Source	extensions/serial/libserial.m строка 1122

name

Signature	`hs.serial:name() -> string`
Type	Method
Description	Возвращает имя объекта `hs.serial`.
Parameters	None
Returns	Имя в виде строки.
Source	extensions/serial/libserial.m строка 707

open

Signature	`hs.serial:open() -> serialPortObject \| nil`
Type	Method
Description	Открывает последовательный порт.
Parameters	None
Returns	Объект `hs.serial` или `nil` если порт не удалось открыть.
Source	extensions/serial/libserial.m строка 743

parity

Signature	`hs.serial:parity([value]) -> string \| serialPortObject`
Type	Method
Description	Получает или задаёт чётность для последовательного порта.
Parameters	value - Необязательная строка для задания чётности. Может быть "none", "odd" или "even".
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает строковое значение "none", "odd" или "even".
Source	extensions/serial/libserial.m строка 834

path

Signature	`hs.serial:path() -> string`
Type	Method
Description	Возвращает путь к объекту `hs.serial`.
Parameters	None
Returns	Путь в виде строки.
Source	extensions/serial/libserial.m строка 725

rts

Signature	`hs.serial:rts([value]) -> boolean \| serialPortObject`
Type	Method
Description	Получает или задаёт состояние бита RTS (Request to Send) последовательного порта.
Parameters	value - Необязательное логическое значение.
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает логическое значение.
Notes	Значение по умолчанию — `false`. Установка значения `true`, скорее всего, потребуется для устройств Arduino перед открытием последовательного порта.
Source	extensions/serial/libserial.m строка 1001

sendData

Signature	`hs.serial:sendData(value) -> none`
Type	Method
Description	Отправляет данные через последовательный порт.
Parameters	value - Строка данных для отправки.
Returns	None
Source	extensions/serial/libserial.m строка 1140

shouldEchoReceivedData

Signature	`hs.serial:shouldEchoReceivedData([value]) -> boolean \| serialPortObject`
Type	Method
Description	Получает или задаёт, должен ли порт отображать принятые данные.
Parameters	value - Необязательное логическое значение.
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает логическое значение.
Notes	Значение по умолчанию — `false`.
Source	extensions/serial/libserial.m строка 1030

stopBits

Signature	`hs.serial:stopBits([value]) -> number \| serialPortObject`
Type	Method
Description	Получает или задаёт количество стоповых битов для последовательного порта.
Parameters	value - Необязательное число для задания количества стоповых битов. Может быть 1 или 2.
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает количество стоповых битов как число.
Notes	Значение по умолчанию — 1.
Source	extensions/serial/libserial.m строка 1058

usesDTRDSRFlowControl

Signature	`hs.serial:usesDTRDSRFlowControl([value]) -> boolean \| serialPortObject`
Type	Method
Description	Получает или задаёт, должен ли порт использовать управление потоком DTR/DSR.
Parameters	value - Необязательное логическое значение.
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает логическое значение.
Notes	Значение по умолчанию — `false`.
Source	extensions/serial/libserial.m строка 916

usesRTSCTSFlowControl

Signature	`hs.serial:usesRTSCTSFlowControl([value]) -> boolean \| serialPortObject`
Type	Method
Description	Получает или задаёт, должен ли порт использовать управление потоком RTS/CTS.
Parameters	value - Необязательное логическое значение.
Returns	Если значение указано, метод возвращает объект последовательного порта. В противном случае метод возвращает логическое значение.
Notes	Значение по умолчанию — `false`.
Source	extensions/serial/libserial.m строка 944