Git Product home page Git Product logo

treg / acuparse Goto Github PK

View Code? Open in Web Editor NEW

This project forked from acuparse/acuparse

0.0 1.0 0.0 5.12 MB

Captures, stores, and displays data from an AcuRite‎ 5-in-1/Atlas weather station and towers via an Access/smartHUB. Uploads to Weather Underground, Weathercloud, PWS, and CWOP.

Home Page: https://www.acuparse.com

License: GNU Affero General Public License v3.0

Shell 1.44% PHP 95.75% JavaScript 0.67% CSS 2.14%

acuparse's Introduction

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

See it in action @ ghwx.ca

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, Weathercloud, PWS Weather, and CWOP. 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.

Notice: This program is open source 3rd party software. It is neither written nor supported by AcuRite®‎. This software requires a working AcuRite®‎ Access/smartHUB. Weather data gets redirected from your Access/smartHUB to your Acuparse server. It is captured, stored, and passed along to MyAcuRite. The response from MyAcuRite gets sent back to the Access/smartHUB. Although the syslog may assist with diagnosing issues; if you cannot send data to MyAcuRite, you may experience trouble with Acuparse. Users currently having trouble sending updates to Weather Underground should find Acuparse much more stable.

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.
  • 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 JSON data for use in external applications.
  • Customizable email outage notifications.
  • Google Invisible reCAPTCHA and Analytics support.

What's Missing:

  • Not all Atlas data is currently logged!
    • Lightning, Light, and UV coming in Version 3.
  • 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 is built around a single Access/smartHUB and 5-in-1/Atlas sensor.

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, a JSON array, or plain text formatted for watermarking.

  • HTML: http(s)://<yourip/domain>/?weather
  • Archive HTML: http(s)://<yourip/domain>/archive?html
  • JSON: http(s)://<yourip/domain>/?json
  • Tower JSON: http(s)://<yourip/domain>/?json_tower&sensor=<SENSOR ID>
  • Plain Text: http(s)://<yourip/domain>/?cam

Installation:

Requires LAMP stack. Some PHP, Apache, and GNU/Linux experience recommended.

Note: If you are not using an Access, you will need to setup a DNS redirect using a DNS server on your local network.

See docs/INSTALL.md for detailed installation instructions.

Installing on a fresh instance of a Debian based OS is the only officially supported and tested install method.

Acuparse can, in theory, be run locally on a Raspberry Pi(Raspbian). Some installer modifications might be required, if not using a supported OS.

Access Users

The Acurite Access sends data to MyAcuRite using an SSL connection. By Default Apache will use the snake oil cert to serve over HTTPS. For most users, this should be sufficient. If you use a hostname, you will need to install and configure an SSL certificate. The installer will ask and attempt to generate a Lets Encrypt cert for you.

Quick Install:

Info: Installer supports Debian Stretch(9), Ubuntu 18.04 LTS, and Raspbian Stretch(9).

Install the base operating system and update. Then download and run the installer.

wget https://raw.githubusercontent.com/acuparse/installer/master/install.sh && sudo sh install.sh | tee ~/acuparse.log

Troubleshooting:

If you experience unexpected results during or after your install, remove the config file and try again.

sudo rm /opt/acuparse/src/usr/config.php

Updating:

Detailed upgrade instructions for significant releases will be published in the docs/updates folder if required.

  • Pull the changes from Git.

    cd /opt/acuparse && sudo git pull

  • Connect to your site to complete the update.

Donations:

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

Buy 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:

Support for the core application/bugs is handled via GitHub Issues.

For everything else, join the Users Mailing List.

If you require advanced assistance, consider commercial licencing and support.

Release Notes:

See CHANGELOG.md for detailed release notes.

Contributing:

See CONTRIBUTING.md for more details.

acuparse's People

Contributors

maxwellpower avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.