File: egctl.1

package info (click to toggle)
egctl 1:0.1-1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 92 kB
  • ctags: 88
  • sloc: ansic: 465; makefile: 44
file content (102 lines) | stat: -rw-r--r-- 2,562 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
.\"
.\" Copyright (c) 2014 Vitaly Sinilin <vs@kp4.ru>
.\"
.\" See the included COPYING file.
.\"
.TH egctl 1 "19 August 2014" egctl
.SH NAME
egctl \- EnerGenie EG-PMS-LAN control utility
.SH SYNOPSIS
.B egctl
.I NAME
.RI [ "S1 S2 S3 S4" ]
.SH DESCRIPTION
.B egctl
is a program to control the state of EnerGenie Programmable surge protector
with LAN interface. It uses native EG-PMS-LAN data exchange protocol
version 2.0 or 2.1, not HTTP. When executed with the only argument it dumps
the state of the specified device. If all five arguments are specified, it
changes the state of the device and dumps the new state.
.br
.SH OPTIONS
.TP
.I NAME
The name of the device to control (as it is specified in the configuration
file). This name has no relation to the IP address or the domain name.
.TP
.I Sn
The action to perform on
.IR n \-th
socket. Possible values are:
.BR on ", " off ", " toggle " and " left .
.SH CONFIGURATION
Configuration file is a table of devices. Each device is described on a
separate line; fields on each line are separated by tabs or spaces.
Lines starting with '#' are comments, blank lines are ignored.
.TP
.B The first field
Name of device. It is a string that will be used to address the device in
the utility commands. It is not necessary to be the same as
.B Server name
in the web interface.
.TP
.B The second field
Protocol. Supported protocols are:
.BR pms20 " and " pms21.
.TP
.B The third field
IP address of device.
.TP
.B The fourth field
TCP port of device.
.RB ( "Power Manager client port"
in the web interface).
.TP
.B The fifth field
Password.
.SH SUPPORTED DEVICES
.TS
lB lB
_	_
l l.
Device	Protocol
EG-PMS-LAN	pms20
EG-PMS2-LAN	pms21
.TE
.SH EXAMPLES
Suppose a user has two EG-PMS-LAN devices configured as follows:
.IP
1. 192.168.0.10, port 5000, password hackme
.br
2. 192.168.10.10, port 5001, password hackmesoftly
.LP
In order to control them using the utility the user needs to create a
configuration file like the following:
.IP
eg1 pms20 192.168.0.10  5000 hackme
.br
eg2 pms20 192.168.10.10 5001 hackmesoftly
.LP
Now she can get the status of the devices with commands
.IP
.B egctl eg1
.br
.B egctl eg2
.LP
and switch the state of the AC power sockets with a command like
.IP
.B egctl eg1 on left left off
.LP
.SH FILES
.TP
.I ~/.egtab
user's configuration file
.TP
.I /etc/egtab
system-wide configuration file
.SH BUGS
This program cannot modify the internal schedule of the device.
.SH AUTHOR
Written by Vitaly Sinilin <vs@kp4.ru>
.SH TRADEMARKS
EnerGenie is a registered trademark of Gembird Holding B.V.