From 58b73d720dad5b4375b3e8a37782ac716f23311e Mon Sep 17 00:00:00 2001 From: jwansek Date: Tue, 21 Nov 2023 19:06:14 +0000 Subject: Updated documentation --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 9246fa0..7639e70 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # TasmotaCLI Quick CLI script for turning on and off Tasmota-flashed plugs + +## Command line usage + +``` +usage: tasmota-cli.py [-h] -d DEVICE_HOST [-u USER] [-t] + +optional arguments: + -h, --help show this help message and exit + -d DEVICE_HOST, --device-host DEVICE_HOST + Tasmota host port + -u USER, --user USER Username to login with + -t, --toggle Toggle current power status +``` + +## Example output + +``` +{ + "TotalStartTime": "2022-11-09T21:11:01", + "Total": 144.706, + "Yesterday": 0.361, + "Today": 0.288, + "Power": 16, + "ApparentPower": 27, + "ReactivePower": 22, + "Factor": 0.58, + "Voltage": 242, + "Current": 0.113 +} +'12VBrickPlug' is currently ON +``` -- cgit v1.2.3