Cutlery/beestat
1
0
Fork 0
mirror of https://github.com/beestat/app.git synced 2025-05-24 02:14:03 -04:00
Code Actions Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Jon Ziebell 2019-06-13 21:18:20 -04:00 committed by GitHub
parent ed62657e54
commit 34eb464d22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 54 additions and 195 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

249
README.md
View File

@ -1,212 +1,71 @@
# Sponsors
### BrowserStack ![BrowserStack](https://3fxtqy18kygf3on3bu39kh93-wpengine.netdna-ssl.com/wp-content/themes/browserstack/img/browserstack-logo.svg)
I use [BrowserStack](https://www.browserstack.com) to help me test and debug in devices that I do not have physical access to. They provide free access to their tools for open source projects.
<h1 align="center">Welcome to beestat! 👋</h1>
<p align="center">
<a href="https://github.com/beestat/app/issues" target="_blank">
<img src="https://img.shields.io/github/issues/beestat/app.svg" />
</a>
<a href="https://github.com/beestat/app/issues?q=is%3Aissue+is%3Aclosed" target="_blank">
<img src="https://img.shields.io/github/issues-closed/beestat/app.svg" />
</a>
<a href="https://github.com/beestat/app/blob/master/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/beestat/app.svg" />
</a>
<a href="https://github.com/beestat/app/commits/master" target="_blank">
<img src="https://img.shields.io/github/last-commit/beestat/app.svg" />
</a>
</p>
# Patch Notes
### Beestat 1.3 (1/24/2019 - 4/4/2019)
### Bug Fixes:
- Fixed sensors not sorting alphabetically [[#92]](https://github.com/ziebelje/beestat-issues/issues/92)
- Fixed beestat not logging you out if ecobee access is revoked/fails [[#95]](https://github.com/ziebelje/beestat-issues/issues/95)
- Fixed graph exports not using correct font [[#50]](https://github.com/ziebelje/beestat-issues/issues/50)
- Fixed broken API cache; should improve performance [[#97]](https://github.com/ziebelje/beestat-issues/issues/97)
- Fixed system card not turning circle orange when heat is running (heat pumps only)
- Fixed some longstanding bugs where bad data from ecobee (temperature values out of range, etc) could throw exceptions
- Added toggle for gap fill on Aggregate Runtime
- Fixed gap fill not working if data was present but wrong
<p align="center">
<a href="https://status.beestat.io" target="_blank">
<img src="https://img.shields.io/uptimerobot/status/m782893860-419cc0327f06e1ed9af8cac6.svg" />
</a>
<a href="https://status.beestat.io" target="_blank">
<img src="https://img.shields.io/uptimerobot/ratio/7/m782893860-419cc0327f06e1ed9af8cac6.svg" />
</a>
</p>
### Enhancements:
- General
- Enabled orientation choice when pinning app on mobile devices [[#93]](https://github.com/ziebelje/beestat-issues/issues/93)
- Added Air Filter info popup [[#96]](https://github.com/ziebelje/beestat-issues/issues/96)
- Added localized caching to prevent sending unnecessary API calls (improves performance)
- UI
- Made loading animation a little bit cooler
- Switched to icon set with larger selection
- Updated styling to be less "gray all the time"
- API
- Added beestat-cached-until header to indicate when the API call will stop returning a cached response
- Home Comparisons
- Added Home Comparisons page
- Added "My Home" card
- Shows the detected system types for heat, aux heat, and cool (95% accurate)
- Allows changing the detected system types for heat, aux heat, and cool
- Shows geographical region (usually State/Provice, Country)
- Geographical region is determined based on address stored with ecobee
- Shows property characteristics (structure type, stories, square feet, age)
- Added "Comparison Settings" card
- Allows you to choose the date your temperature profile is calculated from
- Allows you to choose the region you compare your home to
- Allows you to choose the type of home you compare your home to
- Added "Heat Score" card
- Heat Score is a measure of how quickly your home heats using your base heat system (not aux) compared to other homes. Cycles per hour and balance point are also factored in
- Added "Cool Score" card
- Cool Score is a measure of how quickly your home cools compared to other homes. Cycles per hour and balance point are also factored in.
- Added "Resist Score" card
- Resist Score is a measure of the rate at which your home's temperature changes when no heat/cool is running compared to other homes
- Added new "Temperature Profile" card
- Shows the "Resist" data much like the old Temperature Profile card
- Also added a heat profile line to show the rate of heat change when your heat is running
- Also added a heat profile line to show the rate of heat change when your cool is running
---
> Beestat connects with your thermostat and provides you with useful charts and analytics so that you can make informed decisions and see how the changes you make lower your energy footprint.
### Beestat 1.22 (12/13/2018 - 1/23/2019)
### Bug Fixes:
- Fixed temperature incorrectly rounding on System and Recent Activity [[#84]](https://github.com/ziebelje/beestat-issues/issues/84)
- Ecobee fixed authorization screen showing that beestat gets write permissions instead of just read [[#33]](https://github.com/ziebelje/beestat-issues/issues/33)
- Fixed thermostats with no internal sensors breaking application
- Fixed Aggregate Runtime double counting heat stage 1 for gas furnaces [[#89]](https://github.com/ziebelje/beestat-issues/issues/89)
- Fixed Aggregate Runtime aux getting cut off in certain circumstances
## 👍 Sponsors
### Enhancements:
- Added ability to issue API keys for programmatic access to beestat [[#12]](https://github.com/ziebelje/beestat-issues/issues/) [[Link]](https://documenter.getpostman.com/view/6332024/RznFnd9912)
- Mobile app pinning uses "standalone" instead of "fullscreen" to mimic most other apps
- Added "Add to Home Screen" dialog on Android [[Link]](https://developers.google.com/web/fundamentals/app-install-banners/#the_mini-info_bar)
- Added friendly names for a number of recently added thermostat model numbers [[Link]](https://www.ecobee.com/home/developer/api/documentation/v1/objects/Thermostat.shtml#modelNumber)
- Updated setpoint to be one (heat/cool) or two (auto) lines instead of shaded range
- Updated API to return proper data types on int, boolean, and float values
- Decreased timeout when connecting to ecobee to 5 seconds
- Added error messages alerts to the GUI
- Slightly improved performance of API caching
- Improved readibility of outdoor temperature line on Aggregate Runtime
### BrowserStack
<a href="https://www.browserstack.com/" target="_blank"><img src="https://marker.io/vendor/img/logo/browserstack-logo.svg" height="48px"/></a><br/>
I use BrowserStack to help me test and debug in devices that I do not have physical access to. They provide free access to their tools for open source projects.
---
### SmartyStreets
<a href="https://smartystreets.com/" target="_blank"><img src="https://d79i1fxsrar4t.cloudfront.net/assets/img/company/brand/smartystreets.b24876d8.png" height="48px"/></a><br/>
SmartyStreets powers real time address lookup and normalization. This gives beestat accurate location information for home comparisons. SmartyStreets provided a free year of US address lookups.
### Beestat 1.21 (11/4/2018 - 12/12/2018)
### Bug Fixes:
- Fixed comfort profiles not displaying correctly historically
- Fixed heat/cool differential temperature beestat alert not respecting temperature units
- Fixed loading percentages showing as negative on graphs
- Fixed some graphs never loading
- Fixed some alert icons not displaying correctly
- Fixed API call looping
- Fixed switching thermostats failing due to race condition
- Fixed temperature rounding sometimes being too precise
- Fixed error when setting a graph date range to the current date range
- Fixed error reporting not working
### Enhancements
- Moved beestat to host with Digital Ocean
- Added log out button
- Added outdoor humidity (tooltip only)
- Added automatic syncing of data behind the scenes (https://www.patreon.com/posts/new-patron-perk-23002191)
- Tweaked accessory series to separate it a bit from the fan series
- Improved performance of graph rendering when resizing browser
- Decreased smoothing on recent activity graph
- Added framework for adding new dashboards (will use for beestat 1.3)
## ✨ Demo
### Beestat 1.2 (11/4/2018)
### Bug Fixes:
- Fixed dry contact sensors on EMS Si showing up as "undefined"
- Fixed fractional degrees incorrectly showing up on aggregate runtime y-axis
- Restored historical data lost during 1.1 conversion that ecobee no longer has (hotfixed)
- Slightly tweaked aggregate runtime adjustments for missing data to be more accurate
See a demo of the app at <a href="https://demo.beestat.io" target="_blank">demo.beestat.io</a>.
### Enhancements
- Design
- Significantly improved look & feel
- Added popup menus to group less common functionality
- Added modal windows as necessary/useful
- Changed color palette slightly
- System
- Added humidity
- Added mode (cool/heat/auto)
- Added setpoint
- Added running equipment (cool, heat, aux, fan, ventilator, humidifier, dehumidifier, economizer)
- Added status (schedule/override)
- Added currently active comfort profile
- Added model number
- Added serial number
- Added firmware revision
- Added weather station
- Added first connected date
- Added live updating (every 5 minutes; will be enabled within a week post-update)
- Updated thermostat switcher to include system mode (cool/heat)
- Updated thermostat switcher to include thermostat temperature
- Sensors
- Added occupancy indicator
- Added in-use indicator
- Added temperature above/below average temperature indicator
- Added live updating (every 5 minutes)
- Alerts (new card)
- Added custom beestat alerts for heat/cool differential temp
- Alerts can be dismissed from beestat (does not affect alerts on your thermostat)
- Patreon (new card)
- You can now support beestat on Patreon: https://www.patreon.com/beestat
- Patreon banner can be hidden if you link your Patreon account and you are a supporter
- Patreon banner can be hidden for one month at a time if you are not a supporter
- There are no software limitations if you are not a supporter
- Other
- Added fractional degrees to mostly everything
- Updated settings to store on server instead of client (which thermostat you have open, chart settings, alert settings, etc)
- Updated storage schema to more genericly support different thermostat types (working towards Nest support)
- Added "beestat.io" watermark to chart exports
- Improved API call caching
- Improved help screens a bit
- Fixed tooltip positioning going off the edge on mobile
- Recent Activity
- Added indoor humidity
- Added follow me (Home, Away, Sleep, etc)
- Note: Uses your current schedule so it can be wrong if you changed your schedule recently; fix is pending
- Added system mode (tooltip only)
- Added duration for all equipment runs (ex: see that your heat ran for 2h 32m)
- Added accessory
- Added colors to tooltip
- Combined Heat1/2 & Cool1/2 into a single entry on the legend
- Added deferred loading; loading of application is not blocked by this chart
- Aggregate Runtime
- Updated tooltip to show time more granularly (ex: 2h 10m instead of rounding to 2h)
- Added colors to tooltip
- Added deferred loading; loading of application is not blocked by this chart
- Home Efficiency
- Restyled graph to be nicer and more intuitive
- Removed home & location info
- Added arbitrary "efficiency score" and ranking. Higher score is better. Lower percentile is better.
- More changes to this coming in the next version of beestat
- Added deferred loading; loading of application is not blocked by this chart
---
## 📦 Run your own instance
### Beestat 1.1 (7/20/2018)
#### Bug Fixes:
- Fixed runtime over-reporting for multi-stage systems
- Fixed multiple stages not showing up for non-heat pump systems
- Fixed non-heat pump systems showing heat as aux
- Fixed graph rendering bug when changing the time range on Aggregate Runtime graph
- Fixed rendering issue on Temperature Profile graph when resizing
- Fixed too many fonts loading
- Fixed setpoint series generally behaving poorly in many circumstances
- Fixed database query failing when time zone was positive UTC (hotfixed)
- Fixed invalid date on aggregate runtime graph (hotfixed)
This is possible but untested and unsupported. Clone the code, throw it on a web server, and see what happens. The most help I can offer at the moment is to rename `api/cora/setting.example.php` to `api/cora/setting.php` and use the comments to help configure the installation.
#### Enhancements:
- Added smoothing to inside and outside temperature series on Recent Activity graph
- Added 1d, 3d, 7d options to Recent Activity graph
- Added basic help descriptions to all graphs
- Added useful links to footer
- Added privacy page
- Improved overall look & feel of graphs slightly (size, colors, fonts, icons, etc)
- Improved performance of Recent Activity graph, especially when resizing or toggling series
- Improved chart export sizes/filenames
- Updated chart axis to not change when toggling series
- Rewrote entire frontend to not be a heap of garbage
### Other Notes:
- Upon logging in all thermostat data will fully re-sync as there is new data added that was not synced previously.
## 🤝 Contributing
### Known Issues:
- Re-sync is causing historical weather data (before April 2018) to be missing as ecobee no longer has this data
- Re-sync is causing historical thermostat data (before May 2017) to sometimes be missing as ecobee is no longer reporting this data
Contributions, issues and feature requests are welcome.
---
### Beestat 1.0 (5/8/2018)
#### Bug Fixes:
- N/A
## Author
#### Enhancements:
- Basic system view
- Recent activity graph
- Aggregate runtime graph
- Temperature Profile graph (beta)
👤 **Jon Ziebell**
Hi! This is a passion project of mine and I'm thrilled to be able to share it with the world. I developed beestat from the ground up and have tons of ideas to grow this project further.
<p align="center">
<a href="https://www.patreon.com/beestat" target="_blank">
<img src="https://img.shields.io/badge/Support%20beestat-83+-lightgrey.svg?style=social&logo=patreon" />
</a>
<a href="https://twitter.com/beestat_io" target="_blank">
<img src="https://img.shields.io/twitter/follow/beestat_io.svg?style=social" />
</a>
<a href="https://reddit.com/r/beestat" target="_blank">
<img src="https://img.shields.io/reddit/subreddit-subscribers/beestat.svg?style=social" />
</a>
</p>