2025-04-28 23:15:37 +03:00
|
|
|
### The "STTY" package
|
2025-04-28 22:57:43 +03:00
|
|
|
|
2025-04-28 23:15:37 +03:00
|
|
|
This package provides simplified way to invoke **stty** utility to perform some
|
|
|
|
tasks by means of it. For now the only a few number of functions are implemented:
|
2025-05-18 22:09:04 +03:00
|
|
|
- set tty baudrate
|
|
|
|
- check tty baudrate
|
|
|
|
- test if selected baudrate is available for some tty
|
|
|
|
- test if a given file is a tty
|
2025-04-28 22:57:43 +03:00
|
|
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
1. Download the package by **go get** command:
|
|
|
|
```shell
|
2025-04-28 23:15:37 +03:00
|
|
|
go get code.foilhatguy.casa/pub/stty
|
2025-04-28 22:57:43 +03:00
|
|
|
```
|
2025-04-28 23:15:37 +03:00
|
|
|
|
2025-04-28 22:57:43 +03:00
|
|
|
2. Import package to your golang code:
|
|
|
|
```go
|
|
|
|
import (
|
2025-04-28 23:15:37 +03:00
|
|
|
"code.foilhatguy.casa/pub/stty"
|
2025-04-28 22:57:43 +03:00
|
|
|
)
|
|
|
|
```
|
|
|
|
|
2025-05-18 22:09:04 +03:00
|
|
|
3. Test if some file is a tty:
|
2025-04-28 23:15:37 +03:00
|
|
|
```go
|
2025-05-18 22:09:04 +03:00
|
|
|
err := stty.ValidateTtyFile("/dev/ttyUSB0")
|
2025-04-28 23:15:37 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
4. Use stty object to perform some tasks. For instance, test if baudrate of 9600
|
|
|
|
is available at **/dev/ttyUSB0**:
|
2025-04-28 22:57:43 +03:00
|
|
|
```go
|
2025-05-18 22:09:04 +03:00
|
|
|
err := stty.CMD().TestBaudRate("/dev/ttyUSB0", 9600)
|
|
|
|
```
|
|
|
|
|
|
|
|
If **stty** is not available stty, all methods of object returned by CMD() function
|
|
|
|
will return ERR_TTY_MISSING error.
|