forked from jgyates/genmon
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgenmon.conf
190 lines (156 loc) · 8.57 KB
/
genmon.conf
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
[GenMon]
# name of the site, used in the web interface and email output (required)
sitename = SiteName
# the serial device name of your serial port. Normally /dev/serial0 or
# /dev/ttyAMA0 for onboard Raspberry Pi Serial ports (required)
port = /dev/serial0
# the name of the folder in the mailbox for searching for incoming email
# commands (required)
incoming_mail_folder = Generator
# once an email command has been processed by genmon.py the email is moved to
# this mailbox folder (required)
processed_mail_folder = Generator/Processed
# The TCP port used for communicating with the other apps like ClientInterface.py
# and the web interface (required)
server_port = 9082
# the Modbus slave address. This *should* not need to be changed from 9d (required)
address = 9d
# location of log files (required)
loglocation = /var/log/
# enable genmon.py to output to the console if True. If this is false the other
# display* commands below are ignored (optional, default False)
displayoutput = False
# display information about genmon.py to the console (optional, default False)
displaymonitor = False
# display controller register contents to the console (optional, default False)
displayregisters = False
# display generator status to the console (optional, default False)
displaystatus = False
# display maintenance information to the console (optional, default False)
displaymaintenance = False
# enable enable code to support reverse engineering of registers. This option,
# when True creates a thread that will monitor registers in the controller and
# send notifications of changed registers. Not used in normal operation (optional,
# default False)
enabledebug = False
# This option will display the contents of additional registers that appear to be
# associated with sensors of some type, for example one register outputs almost
# half of the frequency. I assume this is used internally by the controller.
# (optional, default False)
displayunknown = False
# (optional) This option enables (when True) using and alternate method for writing
# the exercise time. Some version of the Evolution firmware only support the legacy
# method of writing the exercise time. The legacy method is a bit more convoluted
# and the current implementation may result in the exercise time being off by one
# or two minutes from the request set value. (optional, default False). Note
# this option is forced True if a Nexus controller is detected or selected.
# (e.g. use legacy exercise write if using a Nexus controller). When using this
# method the exercise time must be at least three minutes or more from the current
# generator time.
uselegacysetexercise = False
# (optional) Disable the monitoring of the utility line voltage for detecting
# power outages. This will disable the sending of emails when a power outage is
# detected. If you have a Transfer Switch that monitors the utility line and starts
# your generator you may need to set this to true. Most transfer switches requires
# the generator controller to monitor the utility line voltage and notify the switch
# to activate so in most cases this will not be needed. If you software is reading
# zero volts for the utility voltage and you are getting false emails regarding an
# outage then enable this setting.
disableoutagecheck = False
# (optional) True if monitoring a liquid cooled generator, False if air cooled.
# This option is for monitoring active relays in the controller, which are different
# for liquid vs air cooled generators. The software will auto-detect the type of
# generator cooling
#liquidcooled = True
# (optional). The software will auto-detect the controller type. The auto-detect
# can be overridden with this setting. True for Evolution controller, False for
# Nexus Controller.
#evolutioncontroller = True
# (optional) default True. This parameter is only valid for liquid cooled
# Evolution generators, ignored for others. True if your generator uses diesel
# or gasoline, false if you use propane or natural gas. This value is used
# to change how some register values are interpreted and displayed based on
# the fuel type
petroleumfuel = False
# (optional). This parameter will specify the full path of a file that will log
# power outages. An outage is defined by the utility voltage dropping below the
# generator's programmed threshold voltage. Typically the generator has a hold
# off period (usually around 5 seconds) before the generator starts. If utility
# power is rises above the threshold voltage before the hold off timer has
# expired the generator will not start, but the outage will still be logged.
# If this parameter is not present the outage log will be in the same directory
# as genmon.py. To reset the outage log manually delete the outage.txt file.
# (e.g. "sudo rm /home/pi/genmon/outage.txt" )
# outagelog = /home/pi/genmon/outage.txt
# (optional) This parameter will sync the generator time to the system time
# if there is a change in Daylight Savings Time. This does not change the system
# time, only the generator time.
syncdst = False
# (optional) This parameter will sync the generator time to the system time
# once every hour. This does not change the system time, only the generator
# time.
synctime = False
# (optional) This parameter will enable the functionality to support biweekly
# and monthly exercise times (weekly is the default). Note, your generator
# controller must support this functionality before enabling this option.
enhancedexercise = False
# (Optional) This parameter, if true will enable the use of HTTPS
# (secure HTTP) in the Flask web app or user name and password
# authentication, depending on the otpions below. This option is only
# applicable to the web app. This option requires python-openssl library
# to be installed
usehttps = False
# (Optional) This parameter is used with usehttps. If
# userhttps is true, then this option will signal the type of certificate
# to use. If this option is true a self signed certificate (supplied by
# Flask library) will be used. If false, then the a key file (key.pem) and
# a certificate file (cert.pem) must be created and specified in the
# following entries (keyfile, certfile) below.
# For information on how to create your own
# certificate please see this site:
# https://workaround.org/ispmail/jessie/create-certificate
useselfsignedcert = True
# (Optional) These parameters are used if useselfsignedcert is False. They
# specify the path and name of the key file and certificate file.
# example keyfile = /home/pi/genmon/cert.pem
# certfile = /home/pi/genmon/cert.pem
keyfile =
certfile =
# (Optional) This parameter will allow a simple authentication to be used
# and it sets the username of the simple authentication. usehttps must
# be True to use this feature.
# This option is only applicable to the web app.
http_user =
# (Optional) This parameter will allow a simple authentication to be used
# and it sets the password of the simple authentication. usehttps must
# be True to use this feature.
# This option is only applicable to the web app.
http_pass =
# (Optional) This parameter will allow the HTTP port to be set by the web
# interface. The default is 8000, but this setting will override that
# value. This option is only applicable to the web app.
http_port = 8000
# (Optional) This parameter will allow the favicon on the http website to be
# set. Default is favicon.ico included with the project.
# examples favicon=http://www.generac.com/favicon.ico
# favicon=http://www.google.com/favicon.ico
favicon =
# Optional. kwlog. If kW Output is supported for your controller, a log of the
# power is kept by genmon. The default file is named kwlog.txt and resides
# in the same directory as genmon.py. To disable the log uncomment this entry
# and leave the entry blank. To change the path and filename, uncomment and
# provide a full path and filename.
# kwlog=
# The maximum size of the kwlog in megabytes. The default value is 15MB. Uncomment and
# modify this value to override the maximum log file size. An email notification will
# be sent when the log file is 80% of the maximum. All log entries will be removed
# once the log limit is reached.
# kwlogmax = 15
# The following entries are written by genmon.py based on the generator
# settings, serial number and a one time lookup on the internet of the
# serial number. If you are not connected to the internet default
# settings will be used based values read from the generator. Some
# of these settings are editable via the web interface.
# fueltype, model, nominalRPM, nominalKW, nominalFreq
# The following entries are written and maintained by genmon some of
# these are editable in via the web interface: version, autofeedback