Editing SmartPlug Help File

Jump to navigation Jump to search

Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.

The system administrator who locked it offered this explanation: restoring Database, Access will be restored shortly

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 2: Line 2:
 
   
 
   
  
Help file for smart plug application ( Documentation for Ver7 ).  You can also get a lot of information about how the program works by looking at the GUI and its explanation:  '''[[SmartPlug GUI Images]]'''.
+
Help file for smart plug application ( Ver4 )
  
  
Line 8: Line 8:
  
 
*Works with multiple smartplugs.
 
*Works with multiple smartplugs.
*Provides on, off, timing, and  energy recording functions from a graphical user interface ( gui ), see '''[[SmartPlug GUI Images]]'''.
+
*Provides on, off, timing, and  energy recording functions from a graphical user interface ( gui )
*Supports graphing of data.  Currently power and energy over time.  Multiple devices on one graph.
+
*Supports graphing of data.
*Supports comma separated values ( csv ) output of data to text files.
+
*Supports csv output of data.
 
*Saves data to a sql lite database that you can use any way you wish.
 
*Saves data to a sql lite database that you can use any way you wish.
 
*Highly configurable.
 
*Highly configurable.
Line 16: Line 16:
 
= Two Applications =  
 
= Two Applications =  
  
This program is actually 2 main programs. The first program is for control of the smartplugs and capture of data, the second for the graphing and processing of the data.  The main routines may be run by respectively running: smart_plug.py graph_smart_plug.py  I think ( but have not tested ) they may be run at the same time.
+
This program is actually 2 main programs ( I may merge them later ). The first program is for control of the smartplugs and capture of data, the second for the graphing and processing of the data.  The main routines may be run by respectively running: smart_plug.py graph_smart_plug.py  I think ( but have not tested ) they may be run at the same time.
  
 
= Download and Install =  
 
= Download and Install =  
  
There is really no install program.  Currently the application is intended for those who have at least a little familiarity with Python coding and can just insert the downloaded code into their development environment and run it. Code at '''[https://github.com/russ-hensel/smart_plug/tree/master russ-hensel/Smart_plug Application ]''' For most of you it will not run due to dependency problems.  You will need to add them.  Pretty much read the error messages and install the missing code.  I use Anaconda Spyder so my preferred tool is conda ( conda install pyHS100 ).  If conda does not work or you do not use it use pip.  pyHS100, a library for smart plugs is pretty likely to be missing ( pip install pyHS100) .  Depending on your installation there may be more.
+
There is really no install program.  Currently the application is intended for those who have at least a little familiarity with Python coding and can just insert the downloaded code into their development environment and run it. For most of you it will not run due to dependency problems.  You will need to add them.  Pretty much read the error messages and install the missing code.  I use Anaconda Spyder so my preferred tool is conda ( conda install pyHS100 ).  If conda does not work or you do not use it use pip.  pyHS100, a library for smart plugs is pretty likely to be missing ( pip install pyHS100) .  Depending on your installation there may be more.
  
 
Much of the application is configurable through the parameter.py file, but the default should give you an application that runs, including a default database.  You probably will not be able to talk to your smartplugs, because the parameters do need to be told what and where ( tcpip address ) they are.
 
Much of the application is configurable through the parameter.py file, but the default should give you an application that runs, including a default database.  You probably will not be able to talk to your smartplugs, because the parameters do need to be told what and where ( tcpip address ) they are.
Line 41: Line 41:
 
= How To:... =  
 
= How To:... =  
  
Some stuff is pretty obvious from the GUI, take a look at it as well as reading the material here [[SmartPlug GUI Images]].
+
*Edit the parameter file:
 +
*View the log:
 +
*Create a new empty database:
 +
*Add a new device:
 +
*Record data:
 +
*Set a timer:
 +
*See status:
 +
*Make a graph:
 +
*Export a csv file:
 +
*Install:
 +
*Debug:
 +
*Change Parameters:
 +
*Retrieve data from plug: On the GUI, but not implemented.
  
 +
=  How to Use the Parameter File =
  
== Either/Both Applications ==
+
You need a text editor sutiable for .py files to manage the parameter file ( parameters.py )
 
 
Some operations work the same way in both applications
 
*Install: see section above.
 
*Debug:  see section below.
 
*Edit the parameter file:  *Change Parameters: Use the application button <Edit Parms> ( after configuring for your editor ) or any text editor suitable for Python ( no tabs ) on the file parameters.py.  See also: The section below, [[Configuration Files For Python]] and [[SmartPlug GUI Images]]
 
*Edit the log file:  This is a standard python logging file.  Useful for debugging and general tracking of the application.  You can set the level of the logging using the parameter file.
 
*Backup the database: Just make a copy of the database using your file manager.  It is all in one file, but you can make multiple databases.
 
*Add a new device or change device data: edit the parameter file, device_list.  Restart the application. <Restart> will do it
 
*Quick Restart of the application:  As perhaps after a parameter change.  Use the <Restart> button.  See also: [[SmartPlug GUI Images]]
 
*Make a graph: Use the graphing application or Live Graph ... see sections below. See also: [[SmartPlug GUI Images]].
 
*Switch databases:  Use browse control on GUI.  Please do not change while db operations are active.
 
 
 
*Get Help: Press the <Help> button.  Depending on how it is setup in parameters.py you may see this page.
 
*Work with text in message area:  See buttons to the left of the area.
 
 
 
== Smart Plug Application ==
 
This is the application in smart_plug.py  Many action are in the GUI see: [[SmartPlug GUI Images]].
 
*Turn plug on/off: Use the <Plug On> checkbox.
 
*Record data from Plug: Data is saved to the database. Use the check box <Record>.
 
*Monitor Plug: continuously monitor and display
 
*Set a timer:  Use drop down list to select time, then press <Start Timer..> Time remaining will be displayed on the GUI.
 
*Find plugs on your network:  Press the <Probe Plugs> button.  Scan can take a long time ( minutes ).  Use parameters to control how the scan is conducted.
 
*Get Data about a Plug:  Press the button with the plug name.  Info appears in the message area.
 
*Start a live graph:  Use the <Live Graph> checkbox, you should have monitor checked for some devices.  Data is accumulated in memory, not the database. Live graph is a graph of the data as it comes in.  Will only collect data for devices whose monitor button is turned on.  Data is deleted when graph is stopped.
 
*Save CSV file: <Save CSV>  Save the data to a CSV file, live_data.csv.  Saves time ( python timestamp ) and power.  Delimiter is actually a tab character.  Data is appended if file already exists.
 
 
 
== Graphing Application ==
 
 
 
This is the application in smart_plug_graphing.py.  It generally preforms operations on the database, mostly graphing, but also some other operations.
 
*Choose what data to graph - which devices, and for what time period. There are several ways to do this:
 
**Set the dates in the parameter file.
 
**Use the date and time controls on the GUI. 
 
**Use the radio button controls on the GUI.
 
*Save graph as .png file: Icon on the graph
 
*Zoom in on part of the graph: Icon on the graph
 
*Change the zero point ( time ) for the graph -- see parameters.py
 
*Move the graph lines around within the graph frame: Icon on the graph
 
*Change the units on the time scale of the graph -- see parameters.py
 
*Change the max and minimum values on the graph -- see parameters.py or zoom the graph
 
*Export a csv file:  Saves time ( python timestamp ), power and energy.  Delimiter is actually a tab character.  File name is data.csv Data is appended if file already exists.
 
*Create a new empty database:  There is a button on the graphing application.  First set the file name ( including full path ) to a non existent file.  You can browse to an existing file and then edit the name.
 
*Set default size of the graph: parameters.py.
 
 
 
=  How to Use the Parameter File =
 
See: [[Configuration Files For Python]]
 
You need a text editor suitable for .py files to manage the parameter file ( parameters.py )
 
 
This includes most text editors.  I particularity like:
 
This includes most text editors.  I particularity like:
  
*notepad++
+
    notepad++
*geany
+
    geany
  
 
You can also use the editor that comes in many python development environments, the simplest of
 
You can also use the editor that comes in many python development environments, the simplest of
Line 102: Line 69:
 
Once you configure an editor in parameters.py you can edit from the <Edit Parms> in the GUI ( see below )
 
Once you configure an editor in parameters.py you can edit from the <Edit Parms> in the GUI ( see below )
  
When editing there are couple of gotchas to watch out for.
+
    When editing there are couple of gotchas to watch out for.
* Python cares about capitalization, use the capitalization indicated in the default files and the example code.
+
        * Python cares about capitalization, use the capitalization indicated in the default
* Python also cares a lot about how lines are indented.  Do not change the indentation from the sample files, and always indent using spaces ( not tabs. most text editors will use spaces automatically for .py files, even if you use the tab key )
+
          files and the example code.
 +
        * Python also cares a lot about how lines are indented.  Do not change the indentation from
 +
          the sample files, and always indent using spaces ( not tabs. most text editors will use spaces
 +
          automatically for .py files, even if you use the tab key )
 +
 
 +
    First time editing of the parameters.py file
  
Editing of the parameters.py file
+
        Use your chosen text editor to open the file parameters
  
*Edit so the program finds your devices.
+
specify in parameters.py with
**See above in Download and Install
+
    self.ex_editor          =  r"D:\apps\Notepad++\notepad++.exe"  # use r" or the backslashes will not work, or you can use forward slashes instead they may be wrong
*Enable your favorite editor to work with the application.
+
    but they work.
**self.ex_editor          =  r"D:\apps\Notepad++\notepad++.exe"  # use r" or the backslashes will not work, or you can use forward slashes instead they may be wrong but they work.
 
*Lots of other settings:
 
**Read the comments in parameters.py and change as desired.  If a setting does not work let me know.
 
*If you mess up.
 
**Re download and get back to the original file.
 
  
 
= Working With Database Files =  
 
= Working With Database Files =  
Line 135: Line 102:
  
 
see: [[SmartPlug GUI Images]]
 
see: [[SmartPlug GUI Images]]
 +
 +
= General =
 +
 +
 +
 +
 +
= System Buttons =
 +
 +
                    * The edit functions work only after you have configured parameters.py for your systems text editor
 +
<Edit Log>          >Open the application python log file using the system editor specified in parameters.py file
 +
<Edit Parms>        >Open the application parameters.py file using the system editor, after the file has been modified
 +
                    the system can be quickly restarted using the Restart button.
 +
 +
 +
<Restart>          >Quickly restarts the system after the parameters.py file is changed or any time you want to restart the system
 +
                    from its current defaults
  
 
= Debugging =  
 
= Debugging =  
Line 145: Line 128:
  
 
Most issues will probably be missing libraries, parameters.py issues, or just bugs in my code (email me ).
 
Most issues will probably be missing libraries, parameters.py issues, or just bugs in my code (email me ).
 
<!-----------
 
 
 
  
 
= Work Flow Overview =
 
= Work Flow Overview =
Line 173: Line 152:
 
     It may give you useful feedback on what the system is doing.
 
     It may give you useful feedback on what the system is doing.
  
this cannot bee seen
 
------------->
 
 
= Links =
 
 
*[[Python Control of Smart Plugs]] main page for this project
 
* see categories below as well
 
 
  
[[Category:Python SmartPlug]] [[category:Python]] [[category:Python Projects]]
+
[[Category:Python SmartPlug]] [[category:Python]]

Please note that all contributions to OpenCircuits may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see OpenCircuits:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)