View on GitHub

Acuparse Documentation

Configuration Guides and Installation/Upgrade Resources

Installation Guide:

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

Can be run locally or on a remote/cloud server.

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

DNS Redirect

Note: Access users can use the included script to modify the Access upload server instead of, or as well as, redirecting DNS.
See /admin/access once logged into your site.

If you are connecting your Access/SmartHUB directly to Acuparse, you can install Bind9 and redirect the DNS locally. Otherwise, you will need a DNS server installed on your network. See docs/DNS.md

smartHUB

Access

Automated Acuparse Installation:

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

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

Raspberry Pi

Manual Acuparse Installation:

Email Server Config:

Run dpkg-reconfigure exim4-config and choose the correct values for your system. Most users will need to select internet site; mail is sent and received directly using SMTP and accept the rest of the defaults.

Install Acuparse:

SSL Certificate Installation:

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, install a certificate!

Setup Database:

Finish Up:

Optional:

Check Installation:

Syslog:

View your syslog to see the data flowing through your system and to look for any trouble. Enable debug logging for a more detailed view.

Data Display:

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

Aside from the primary interface, you can also pull the bootstrap formatted HTML data or a JSON array, for use in outside applications.

Database Trimming:

Readings get stored in multiple temporary database tables. This temporary data should be cleaned up regularly to avoid ballooning the database. When the external updater runs, it archives the most recent readings to the archive table for later use.

Database trimming is accomplished via the MySQL event scheduler.

If you find that the event scheduler is not behaving, ensure MySQL is up to date. Some upgrades from Debian 8 will not upgrade the database properly.

Barometer Readings:

You can modify the barometer readings used by Acuparse. Set your Access/smartHUB to use station pressure using MyAcuRite and adjust your offset. Readings are only modified in Acuparse and sent to 3rd party sites. It does not modify the reading MyAcuRite receives from your Access/smartHUB.

Check the syslog and watch for your changes. Once your Access/smartHUB is reporting updated readings, modify the Acuparse config with your required offset.

Barometer Source:

If you are using an Access and a SmartHUB at the same time, it can cause trouble with barometer readings. Since they can be slightly different.

Uploading Data:

Detailed instructions for each available in docs/external.

Master Sensor:

By default Acuparse will use the 5N1/Atlas sensor to upload data to external sites. To upload data from a tower, change the Master Temp/Humidity Sensor. Changing the sensor sends those readings externally instead of the 5N1/Atlas data. You can also choose to use the tower readings for the data archive or use the readings from the 5N1/Atlas.

MyAcuRite Responses:

Access:

When MyAcuRite receives your readings, it responds with a JSON response in the following format:

Variable Description
timezone Local timezone offset of the Access.
ID1 Weather Underground Station ID.
PASSWORD1 Weather Underground Station Password.
sensor1 Sensor used to send data to Weather Underground.
elevation Elevation of the Access in feet.

SmartHUB:

Notice: To prevent firmware updates, the SmartHUB response is now being generated by Acuparse. The response generated by MyAcuRite is no longer sent back to the smartHUB.

smartHUB settings modified using the MyAcuRite site will not be reflected by the smartHUB.

When MyAcuRite receives your readings, it responds with a JSON response in the following format:

Variable Description
localtime Local time the reading was received. Keeps time on the Access/smartHUB and is used mainly for rainfall readings.
checkversion The current firmware version available. Currently 224.
ID1 Weather Underground Station ID.
PASSWORD1 Weather Underground Station Password.
sensor1 Sensor used to send data to Weather Underground.
elevation Elevation of the smartHUB in feet.

Acuparse will now always respond with: {"localtime":"00:00:00","checkversion":"224"}. Setting localtime to the local time of your Acuparse install.

Email Outage Notifications:

Outage notifications are sent to all registered admins. You can configure some simple values for outage checking, the system will email you when there is no data received.

The updater first checks to see if there is new data to send. If there isn’t, it will start the email process. If there is no new data due to updates not being received in the configured period, Acuparse will send an email at your chosen interval.

Tower Sensors:

Acuparse allows for the addition of as many Tower sensors as the Access/smartHUB will pass along. You can choose which sensors are shown publicly or only to logged in users. Towers are configured and arranged using the admin settings.

Web Cam Installation (optional):

Three scripts are included in the cam/templates directory. They are used to get and process images from an IP camera.

Images get stored in src/pub/img/cam. They should be backed up regularly to avoid loss.

Script Description
local.sh Runs on a host local to the camera (such as an NVR) and sends the image to the Acuparse server.
remote.sh Processes an image on the Acuparse server.
combined.sh Processes an image when the camera and Acuparse are both installed locally.

Local/Remote Setup:

Combined Setup:

Info: Ensure ImageMagick is installed and available. Otherwise, images will not get processed.

Invisible reCAPTCHA:

Recaptcha loads on the authentication and contact forms, as well as, when requesting a password reset.