forked from alaudet/raspi-sump
-
Notifications
You must be signed in to change notification settings - Fork 0
/
changelog
161 lines (113 loc) · 5.16 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
Raspi-Sump Changelog
====================
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.