Changes between Version 3 and Version 4 of WikiStart


Ignore:
Timestamp:
2011-09-15 15:48:56 (13 years ago)
Author:
chris
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiStart

    v3 v4  
    44 
    55== Overview of dataMine == 
     6''dataMine'' is a plugin for logging selected UPnP variables to a file, and provides a frontend UI interface to allow graphing of the logged data. The graphing system supports interactive zooming and scrolling to allow the data to be manipulated as the user desires. 
    67 
     8''dataMine'' produces 3 history files to support different levels of zooming, and automatically chooses the correct level of data to display depending on the zoom level. When displaying the highest resolution data, the data is displayed down to the second, and when zoomed out, a subsampled dataset is displayed. The UI dynamically interacts with the user and Vera to display the most appropriate data at the time. 
    79 
    810 
    911== Installation == 
    10 As dataMine makes use of a number of javascript libraries (primarily the flotr graphing package) installation isn't quite as straight forward as a standard plugin. The usual files (XML, JSON, LUA) are loaded in the normal way through the "developers" button in the control panel and all files specific to dataMine are placed into a directory /www/cmh/plugins/dataMine - this includes the js files, and a number of icons for buttons. 
     12As ''dataMine'' makes use of a number of javascript libraries (primarily the flotr graphing package) installation isn't quite as straight forward as a standard plugin. The usual files (XML, JSON, LUA) are loaded in the normal way through the "developers" button in the control panel and all files specific to ''dataMine'' are placed into a directory /www/cmh/plugins/dataMine - this includes the js files, and a number of icons for buttons. 
    1113 
    12 dataMine can generate a lot of data, so it is recommended to install a USB stick. 
     14''dataMine'' can generate a lot of data, so it is recommended to install a USB stick. 
    1315 
    1416Click on MiOS developpers 
    … …  
    4951This ensures the USB stick is remapped when Vera restarts 
    5052 
    51 Once the dataMine device is running, click on the tool icon. You will get the graph tab, and config tab. 
     53Once the ''dataMine'' device is running, click on the tool icon. You will get the graph tab, and config tab. 
    5254Click on the config tab, and select the variables you want to log. All changes to the selected variables should now be logged to files in the /dataMine directory. 
    5355 
    … …  
    5557 
    5658== Use == 
    57 The dataMine plugin installs as a device, and by clicking on the tools button you are presented with two tabs. The first one is the graph tab. This has a listbox to list all the available variables, and a number of buttons. The buttons allow you to select the last day/week/month, or all data, and to scroll and zoom the data. You can also zoom by selecting an area of the graph with the mouse. 
     59The ''dataMine'' plugin installs as a device, and by clicking on the tools button you are presented with two tabs. The first one is the graph tab. This has a listbox to list all the available variables, and a number of buttons. The buttons allow you to select the last day/week/month, or all data, and to scroll and zoom the data. You can also zoom by selecting an area of the graph with the mouse. If you put the mouse close to a data point, the datapoint will be highted with a red circle, and the time and value will be displayed in the bottom righ corner of the graph. (note that there is an issue here - the background UI needs to be scrolled to the top or the mouse position will be incorrect). 
    5860 
    5961[[Image(dataMine1.png)]] 
    … …  
    6567== Under the hood == 
    6668 
     69''dataMine'' records data in CSV files (Comma Separated Value). (Currently) three different files are generated for each variable being recorded - a raw, hourly and daily file. Files are then split to avoid them getting too large (which is a potential problem for constantly changing sensor data such as temperature).  Each time Vera observes a change in the data for a monitored variable, dataMine will log the current value into a file. Each day, the long term history files are generated from the raw data. 
     70 
     71Each line of data in the CSV logfiles includes two numbers - the time of the datapoint (as a unix timestamp), and the data value. For the raw file, the actual changes are logged. For the hourly and daily files, the minimum and maximum value and time are logged for each time period.