-
Notifications
You must be signed in to change notification settings - Fork 36
/
changelog
250 lines (161 loc) · 7.62 KB
/
changelog
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# Raspi-Sump Changelog
Version 1.9.4
- Fix configuration bug that was killing systemd raspisump.service on logout and not automatically starting the service on boot.
Version 1.9.3
- Added rsumpsupport script which creates a trace file of the application environment to help troubleshoot issues
Version 1.9.2
- Bugfix. Error was getting thrown if missing an option for line_color in raspisump.conf
Version 1.9.1
- Bugfix. Error was getting thrown if missing an option for smtp_ssl in raspisump.conf
Version 1.9
- Added systemd functionality for rsump.py and rsumpwebchart.py
- Update to local pi web page home
- Added full upgrade instructions for version 1.8 and lower to 1.9
- deprecated rsumpmonitor.py/checkpid.py and replace with systemd
Version 1.8.2
- Code refactoring around handling of configuration file
- Pinned version 1.8.2 to hcsr04sensor version 1.7 or higher
- Fixed some inaccurate info in the raspisump.conf comments
Version 1.8.1
- Added support for SSL email. Previously only supported TLS.
Version 1.8
- Added enhancements to the local raspberrypi website.
- local raspberrypi website mobile friendly
Version 1.7.2
Note: No new functionality in this release. Simply a refactoring of code and
a change to way code is tested. Optional Upgrade.
- Refactored code to use fstrings instead of .format for strings
- Migrated to Unittests from Nose
- Other refactoring for tests
Version 1.7.1
- Fixed bug in date autoformatters on todaychart.py. Should have proper date settings now (HH:MM:SS)
Version 1.7
- Raspi-Sump is no longer dependant on the pi user account. Can be installed and run as any user that is a member of the gpio group.
- Made changes to the install instructions related to the lighttpd webserver for chart viewing.
Version 1.6.1
- Fixed error logging when running rsumpmonitor.py.
Version 1.6
- Streamline logging code
- Better error messages to logfiles and stdout for troubleshooting
- Heartbeat alert now displays date and time of next alert rather than minutes until next alert.
Version 1.5
- Fixed bug in rsumpmonitor.py that was not restarting the process
- Fix lighttpd.conf for proper create-mime.conf.pl location
Version 1.4.1
- Unpinned Raspi-Sump to a specific version of hcsr04sensor in setup.py
- Updated install instructions.
Version 1.4
- Add on demand email testing with command 'emailtest's
Version 1.3
- Add support for Raspberry Pi OS 11 (codename bullseye)
Version 1.2.3
- pinned to hcsr04sensor dependency >=1.6 in setup.py
Version 1.2.2
- hcsr04sensor v1.6 module no longer handles rounding of readings. Now handled by Raspi-Sump
- reading.py now using depth method in hcsr04sensor as depth_metric and depth_imperial are deprecated.
Version 1.2.1
- Add section to conf file to change line color in the charts.
[charts]
line_color = FB921D #default
Version 1.2
- Add hostname to email alert body to better identify which instance of raspisump is alerting
- Add a heartbeat email at a user defined interval to ensure that email is working as intended
Version 1.1.2
- Fix charts displaying improper hour formatting on x axis when using matplotlib version 2 in Raspbian Stretch.
Version 1.1.1
- prevent application from logging negative waterlevels.
Version 1.1
- Add error logging to identify possible faulty cables or sensors. Versions
prior to this would only hang and consume 100% CPU. As of this version a
faulty cable or sensor will cause the application to exit gracefully and write
a log to '/home/pi/raspi-sump/logs/error_log' alerting you to a faulty cable or
sensor.
Example;
2016-11-26 10:26:42,\*\*ERROR - Signal not received. Possible cable or sensor problem.
Version 1.0.2
- minor addition to alerts.py. Adds a timestamp to the alert message body. Thanks to Brian Heiland for the suggestion.
Version 1.0.1
- minor change to alerts.py that still had a line for testing code in it.
Version 1.0.0
- Python 3 compatible
- This version has no new functionality. It is given the first major version 1.0.0 as
it is now fully Python2 and Python3 compatible.
- Important info added for Gmail users to send alerts. See issue tracker;
https://github.com/alaudet/raspi-sump/issues/6
Version 0.8.0
- Option to receive alerts on low water levels instead of high. This would allow
you to monitor a drinking water source for example.
Version 0.7.0
- Add option to limit SMS Email alerts to a defined interval to prevent
spamming yourself with alerts every minute or less. Can now be set in the
raspisum.conf file as alert_interval. Default is 5 minutes if option is not
set.
Version 0.6.1.1
- Bug fix. Pypi download was failing
Version 0.6.1
- new instructions and configuration for local web server.
Version 0.6.0
- sensor module removed from raspisump and now uses hcsr04sensor library.
- numerous changes to raspisump.conf
- added unit variable
- changed critical_distance to critical_water_level
- added better explanations of variables
- changes to reading.py to add metric and imperial parameters sent to hcsr04sensor
- changes to setup.py
- add instructions for setting up a local webserver on your Pi for chart viewing
- add rsumpwebchart.py in bin folder to create a webchart from the command line or cron
- add webchart.py module to create charts for web viewing on Pi local webserver (called from rsumpwebchart.py)
Version 0.5.3
- Bug fix to address the change in RPi.GPIO 0.5.11 as follows;
'GPIO.cleanup() unsets the current pin mode'
This version of Raspi-Sump is compatible with RPi.GPIO 0.5.11
Version 0.5.2
- Additional explanation on raspisump.conf
- Documentation changes
Version 0.5.1
- Add option to send alerts to multiple recipients
- Change to raspisump.conf
Version 0.5.0
First non beta release.
Small changes to install instructions.
Version 0.4.0beta1
- Seperated program into scripts and modules.
- Removed the manual install instructions in favor of packaged install only.
Version 0.3.0beta3
- fixed error in setup.py
Version 0.3.0beta2
- fix raspisump.conf getting deleted on upgrade
- upgrade makes a backup of raspisump.conf to raspisump.conf.save
- Updated Instructions
Version 0.3.0beta1
- fix checkpid .py for raspisump_alternate.py process
- packaging with pip
- new install instructions for automated and manual installs
Version 0.2.1
- Minor changes to some code.
- no longer using my own code to round numbers. Using round() method instead
- small corrections to License
- eliminated some duplicate code around logging
Version 0.2
- Configuration file to store variables
- use cron to run the script at 1 minute intervals rather than in the script
- use raspisump_alternate.py if you want to run raspisump as a continuous
process without cron. Use only if you need to use intervals less than one minute.
- use checkpid.py if using as continuous process to monitor health of raspisump
process and restart it if stopped.
- PEP8 changes to code
- other code cleanup
- Added MIT License
- Added changelog
Version 0.1B
- Report water level in pit as opposed to distance of water from sensor
- todaychart.py to graph the water level
- add simulations for testing functionality without using RPi.GPIO
- Documentation for using raspisump
- added rudimentary cron examples
Verions 0.1A
- 60 second interval monitoring of sump pit water level
- measures distance between sensor and water
- Error handling to compensate for fringe readings
- Readings logged to csv file.
- Automated SMS Email Alerts if water depth exceeds 35 cm in the sump pit.