acuparse/acuparse repository overview

⁠Acuparse⁠

AcuRite Access/smartHUB and IP Camera Data Processing, Display, and Upload.

⁠Live Example Station

See Acuparse in action via ghwx.ca⁠

⁠How it Works

Acuparse⁠ is a PHP/MySQL program that captures, stores, and displays weather data from an AcuRite 5-in-1/Atlas weather station and tower sensors, via your Access/smartHUB. It uploads weather data to Weather Underground⁠, CWOP⁠, Weathercloud⁠, PWS Weather⁠, Windy⁠, and Windguru⁠. It also processes and stores images from a local network camera for display and uploads to Weather Underground.

Built for weather geeks and designed to be clean, simple, and mobile friendly. It uses a minimal UI with a focus on data, not flashy graphics. Designed to compliment MyAcuRite and other 3rd party's sites and tools.

Acuparse requires a working AcuRite Access/smartHUB. You redirect weather data from your Access/smartHUB to your Acuparse server. It is captured, stored, and then passed along to MyAcuRite untouched. The response received from MyAcuRite is sent back to your Access/smartHUB. If sending data to MyAcuRite is disabled or when using a SmartHUB, Acuparse creates the response.

⁠Features

• Your weather data belongs to you, stored on your OWN server.
• Display live camera images, send them to Weather Underground, and link from other sites like Weathercloud.
• Uploads weather data from your 5-in-1/Atlas and Tower sensors to external providers.
• Customize barometer readings.
• Light and Dark Themes.
• Display data in both ℉ and ℃. Selectable default.
• Multiple tower sensors; public or private.
• Multiple admin or regular user accounts.
  • Regular users can only view private sensor data.
• Archived data display.
• Watch data flow using the syslog.
• Stays online even when MyAcuRite is not.
• Does not require internet access. Can be deployed independently of MyAcuRite.
• Export API with JSON and HTML data for use in external applications.
• Customizable email outage notifications.
• Google Invisible reCAPTCHA and Analytics support.

⁠Installation

See docs/INSTALL.md⁠ for detailed installation instructions.

Installing on a fresh instance of a Debian/Rasbian Buster(10) or Ubuntu 18.04/20.04 is the only officially supported and tested install method.

⁠Quick Install

• Install the base Debian/Ubuntu operating system and update.

• Download and run the installer.

  curl -O https://gitlab.com/acuparse/installer/raw/master/install && sudo bash install | tee ~/acuparse.log
  

  Copy

⁠Docker Compose

See docs/DOCKER.md⁠ for detailed installation instructions.

On a newly installed Debian/Ubuntu System

• Download and run the installer.

  • If you already have Docker installed, see the Docker guide.

  curl -O https://gitlab.com/acuparse/installer/raw/master/install_docker && \ 
  sudo bash install_docker full | tee ~/acuparse.log
  

  Copy

⁠Additional Outputs

The primary user interface uses AJAX to pull the most recent HTML formatted data every minute.

Acuparse includes a Display mode for better viewing while in full-screen.

• Display Mode: http(s)://<yourip/domain>/display
  • Force light theme: http(s)://<yourip/domain>/display?light
  • Force dark theme: http(s)://<yourip/domain>/display?dark

Additionally, you can request Bootstrap 4 formatted HTML, JSON array(s), or plain text formatted for watermarking.

• See the API Guide⁠ for details.

⁠Troubleshooting

See docs/TROUBLESHOOTING.md⁠.

⁠What's Missing

• Advanced Data Reporting.
  • Reports can be run against the database. Open issues for custom report requests and tag them with the reports tag.
    • phpMyAdmin is an excellent tool for advanced manual reporting on your station.
• Charts and Graphing.
  • Since this is available at most external weather sites.
• Multiple Access/smartHUB/5-in-1/Atlas sensors.
  • The current framework built around a single Access/smartHUB and 5-in-1/Atlas sensor.

⁠Donations

If you like Acuparse, please support the project by buying me a coffee!

⁠Licencing

Acuparse is open-source software. Released with an AGPL-3.0+ license. It also uses several other open source scripts. Their licences included where available.

3rd party scripts located in src/pub/lib.

See LICENSE⁠ for more details.

⁠Support and Discussion

Join the discussion on Slack⁠

• Support for the core application/bugs is handled via GitLab Issues⁠.
  • You may also open a new issue by mailing [email protected]⁠.
• Community support is also provided via the Users Mailing List⁠.

If you require advanced or commercial support, send mail to [email protected]⁠.

⁠Release Notes

See CHANGELOG.md⁠ for detailed release notes.

⁠Contributing

See CONTRIBUTING.md⁠ for more details.