Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/borischumichev/actuate

CLI for an actuator control systems
https://github.com/borischumichev/actuate

Last synced: about 1 month ago
JSON representation

CLI for an actuator control systems

Awesome Lists containing this project

README

        

# actuatee
### Установка
Для корректной работы необходимо использовать Node v0.10.*
Скачать дистрибутивы 0.10.40 можно тут [https://nodejs.org/dist/v0.10.40/](https://nodejs.org/dist/v0.10.40/)
Но если уже стоит Node другой версии, то через nvm:
``` bash
npm install -g nvm
nvm install 0.10.40
nvm use 0.10.40
npm install -g actuatee
```

Для установки CLI:
``` bash
npm i -g actuatee
```

### Цикл работы с CLI
Минимальный цикл работы с программой должен включать последовательность из команд на вкл./откл. привода и разреш./запрещ. работы двигателя. Дополнительно могут быть посланы команды на отработку требуемой координаты или последовательности координат:
``` bash
actuatee on - включение привода
actuatee allow - разрешение работы двигателя
[ команды на отработку координаты или последовательности ]
actuatee disallow - запрещение работы двигателя
actuatee off - выключение привода
```

### Доступные команды

#### Единичные

`ls` – выводит список последовательных портов

`on` – включение привода

`off` – отключение привода

`allow` – разрешение работы привода

`disallow` – запрещение работы привода

`move ` – установка треьбуемого положения выхдного звена привода

`setstate` – установка битовой маски состояния привода

#### Множественные

`sine` – подача для отработки сигнала синусоидальной формы
##### Опции:

`-a, --amplitude ` амплитуда, % (by default 50)

`-f, --frequency ` частота, Гц (by default 0.3)

`-P, --periods ` число периодов (by default 3)

### Доступные опции

`-h, --help` выводит подсказку

`-V, --version` версия CLI

`-o, --out ` путь для записи отчетных данных, если опция не указана запись фыполняться не будет

`-p, --port ` путь к порту (не указывается для команд `on`, `off`, `allow`, `disallow`, `ls`), можно не указывать, если путь указать в фонфигурационном файле: при отсутсвии опции `-p` путь в порту считывается из файла `./actuate.conf.json`. Если файла нет а опция не задана программа завершиться с ошибкой. Файл `./actuate.conf.json` должен иметь вид:

```
{
"port": "/dev/cu.usbserial-A600ISGW"
}
```