Added usage section to README.md
This commit is contained in:
23
README.md
23
README.md
@@ -11,6 +11,29 @@ Maybe it's straightforward or obvious, but just for completeness: the name comes
|
||||
2. The ability to turn on and off tasmota devices ("on" and "off" pronounced directly one after the other sounds (a bit) like "onov")
|
||||
|
||||
|
||||
## CLI Usage
|
||||
|
||||
```
|
||||
usage: Tasmotonov - simply toggle multiple tasmota lights [-h] [-v] [--version] {file,inline} data {on,off,toggle}
|
||||
|
||||
A very simple script which allows you to turn on/off multiple tasmota devices specified.
|
||||
|
||||
positional arguments:
|
||||
{file,inline} Select either to read the adresses (of the devices) from a "file" or from "inline"
|
||||
data Either the path to the file, or a comma- or semicolon-separated list of tasmota adresses.
|
||||
{on,off,toggle} Select to turn all tasmota devices "on" or "off" or "toggle" (case insensitive)
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-v, --verbose Turn on verbose file output
|
||||
--version show program's version number and exit
|
||||
|
||||
Info: if you choose a file as source, this files needs to contain the addresses of the tasmota devices either comma-separated, semicolon-separated, or newline-separated!
|
||||
|
||||
© Benjamin Burkhardt, 2025
|
||||
```
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
The CLI script ([tasmotonov.py](tasmotonov.py)) relies on two libaries apart from python3's standard libraries:
|
||||
|
Reference in New Issue
Block a user