From 7b2668a902aaf2fe9b0b7ed5600cedd25ac396d0 Mon Sep 17 00:00:00 2001 From: Evgeny Zinoviev Date: Mon, 17 May 2021 23:18:05 +0300 Subject: readme: add telnet usage example gif --- PROTOCOL.md | 6 +++++- README.md | 2 +- inverterd-telnet.gif | Bin 0 -> 2087309 bytes 3 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 inverterd-telnet.gif diff --git a/PROTOCOL.md b/PROTOCOL.md index 44eb97a..626fed3 100644 --- a/PROTOCOL.md +++ b/PROTOCOL.md @@ -28,4 +28,8 @@ Sending `EOT` (`0x04`) closes connection. Each response is represented by one or more lines, each ending with `\r\n`, plus extra `\r\n` in the end. -First line is always a status, which may be either `ok` or `err`. \ No newline at end of file +First line is always a status, which may be either `ok` or `err`. + +## Usage example + +![inverterd-telnet](inverterd-telnet.gif) \ No newline at end of file diff --git a/README.md b/README.md index 0eabb79..ece39cc 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ is planned. - `inverterctl` is a full-featured command line utility with all P18 commands supported. - `inverterd` is a daemon that starts a TCP server and implements simple text-based - telnet-compatible chat [protocol](PROTOCOL.md). It supports all commands and options + [telnet-compatible](inverterd-telnet.gif) chat [protocol](PROTOCOL.md). It supports all commands and options supported by inverterctl, and it's supposed to be used instead of interterctl in multi-user or multi-threaded scenarios, where there may be more than one simultaneous request to device, to avoid errors or device lockups. diff --git a/inverterd-telnet.gif b/inverterd-telnet.gif new file mode 100644 index 0000000..dc26a0c Binary files /dev/null and b/inverterd-telnet.gif differ -- cgit v1.2.3