Useful scripts for managing your emoncms installation.
This is a tool for backing up the data in an emoncms.org account or other remote emoncms server to a local computer. It can be used with or without a local installation of emoncms. To use, open Backup/backup.php in a text editor.
-
Set $remote_server and $remote_apikey to correspond to the remote emoncms account you wish to download from.
-
Set $link_to_local_emoncms to true if you wish to access your data within a local installation of emoncms. Set $local_emoncms_location and $local_emoncms_userid to link to your local emoncms installation.
-
Set $link_to_local_emoncms to false if you just want to download the data without linking to a local emoncms install (non-mysql data only). Set $dir to the directory on your computer you wish to download the data. Manually create the folders: phpfina, phpfiwa, phptimeseries, phptimestore within this folder.
-
Run the backup script from terminal with:
php backup.php
Tested with emoncms.org (v8.0.9: 4 July 2014), and local emoncms v8.2.8
If backing up feed data via the normal directory copy method fails due to a disk problem, this data recovery tool may help you extract your feed data skipping the problematic sector on your disk. See forum post here for further information: Data Recovery forum post
To use the data recovery tool, open recover.php and set both source and target directories for the data to recover. Run the recover tool from terminal with:
php recover.php
A tool for checking the integrity of your emoncms phpfiwa, phpfina, phptimeseries and phptimestore feeds. To use, open recover.php and set the engine data directories. Run the recover tool from terminal with:
php integritycheck.php
There are two scripts for converting phpfiwa or phptimestore to phpfina. PHPFina has a much lower write load when used as the storage engine on SD Cards. Using these conversion scripts you can convert your data to PHPFina so that it can be used with the new SD Card branch of emoncms called 'bufferedwrite'
phpfiwa_to_phpfina.php
phptimestore_to_phpfina.php
Set the source and target directory as well as emoncms install location and then run as above.
This script is useful to remove irregularities in feed data, and works through the phpfiwa data files searching for values that are larger or smaller than the limits, when it find one it sets it to NAN which means its ignored in the graph.
To run the script;
sudo php remove_spike.php -i FeedId -n MinValue -x MaxValue
for example to remove value above 5.5V and below 1V (battery feed in V for example) on feed 22 the syntax is;
sudo php remove_spike.php -i 22 -n 1 -x 5.5
ONLY WORKS WITH PHPFIWA DATA!
This shell script can be called manually, or automated by using Node-red or Cron to create a MYSQL dump of your emoncms MYSQL database.
Firstly, edit the mysql_backup_emoncms.sh script as follows;
-u 'username' = your emoncms MYSQL username (default is emoncms)
-p'password' = your emoncms MYSQL password (Note - there is no space after the leading 'p'!!)
'database' = the name of your emoncms MYSQL database (default is emoncms)
Replace '/path/to/' with the absolute path to where your backup will be stored
Make the file executable:
chmod +x mysql_backup_emoncms.sh
To run, from the script installation directory:
./mysql_backup_emoncms.sh
This shell script can be run under 2 different scenarios;
- The script is run immediatly after installing the operating system - BEFORE running
$ sudo rasp-configand expanding the filesystem. This is the preferred option! - If the filesystem has already been expanded, you must unmount the root partition & reduce it's size using Gparted or other similar tools, by at least 350Mb if using a 4Gb SD card, or 1.5Gb if using a larger card.
The script will check your SD card for size and will make the following changes;
On SD cards less than 5Gb capacity
- create a 300Mb data partition formatted to ext2 with a blocksize of 1024 bytes
- create a partition 'buffer' of 10Mb
- expand the root filesystem to fill the available space.
On SD cards more than 5Gb capacity
- create a 1Gb data partition formatted to ext2 with a blocksize of 1024 bytes
- create a partition 'buffer' of 50Mb
- expand the root filesystem to fill the available space.
To run the script, navigate to the usefulscripts/sdpart folder and run sudo ./sdpart - following the prompts.
Reset Emoncms password. Run with:
php resetpassword.php
It then asks for the userid (default:1) and for a new password or option to auto generate:
=======================================
EMONCMS PASSWORD RESET
=======================================
Select userid, or press enter for default:
Using default user 1
Enter new password, or press enter to auto generate:
Auto generated password: 9f7599c8da