Skip to content

Commit

Permalink
noolite cli description
Browse files Browse the repository at this point in the history
  • Loading branch information
dima117 committed Jan 29, 2023
1 parent a6dc718 commit ecbbc9a
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 10 deletions.
50 changes: 42 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@

## Установка

Package Manager

```
Install-Package ThinkingHome.NooLite -Version 4.1.0
```

.NET CLI

```
dotnet add package ThinkingHome.NooLite --version 4.1.0
```
Expand Down Expand Up @@ -201,3 +193,45 @@ void ClearAllChannels()
```csharp
void ExitServiceMode()
```


## Интерфейс командной строки

Кроме пакета `ThinkingHome.NooLite`, предоставляющего API для управления нагрузкой с помощью адаптера nooLite, доступна утилита `ThinkingHome.NooLite.Console`, которая предоставляет те же самые возможности для управления с помощью интерфейса командной строки.

### Установка

```shell
$ dotnet tool update --global ThinkingHome.NooLite.Console
```

### Использование

Вывести список портов на компьютере

```shell
$ noolite ports
```

Список доступных команд

```shell
$ noolite --help
```

Описание и список параметров конкретной команды

```shell
# noolite [command] --help

$ noolite set-brightness --help
```

### Пример использования

Включить нагрузку в канале `13` адаптера, подключенного к порту `/dev/tty.usbserial-AL00HDFI` в режиме `noolite-F`

```shell
$ noolite on /dev/tty.usbserial-AL00HDFI 13 -f
```

2 changes: 0 additions & 2 deletions ThinkingHome.NooLite.sln
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution items", "Solution items", "{9F985476-D7AE-4BCF-8F15-5E16D6A5FC44}"
ProjectSection(SolutionItems) = preProject
README.md = README.md
.travis.yml = .travis.yml
appveyor.yml = appveyor.yml
Package.xml = Package.xml
global.json = global.json
EndProjectSection
Expand Down

0 comments on commit ecbbc9a

Please sign in to comment.