Editing SmartPlug Help File

This is the Help "file" for the Python Application whose main page is: *'''[http://www.opencircuits.com/Python_Control_of_Smart_Plugs#Help_.22file.22_for_the_Program Python Control of Smart Plugs - OpenCircuits ]'''
 

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]]'''.


= Application Features = 

*Works with multiple smartplugs.
*Provides on, off, timing, and  energy recording functions from a graphical user interface ( gui ), see '''[[SmartPlug GUI Images]]'''.
*Supports graphing of data.  Currently power and energy over time.  Multiple devices on one graph.
*Supports comma separated values ( csv ) output of data to text files.
*Saves data to a sql lite database that you can use any way you wish.
*Highly configurable.

= Two Applications = 

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 = 

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.

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.

So to tell the application about your plugs.  You should know the address of each plug.  If not you might want to use an application like advanced ip scanner ( google it ).  The smartplug gives up very little information on my scans, but run the scan with the plug plugged in and out, and the address that appears ( or disappears ) it the address of your device.

The section of parameters.py that locates the device looks like this:

        self.device_list       =  [
                { "name": "device_1",  "tcpip": "192.168.0.209", "more": None, "gui_label": None, "gui_combo": None  },
                { "name": "device_2",  "tcpip": "192.168.0.209", "more": None, "gui_label": None, "gui_combo": None  },
                { "name": "device_3",  "tcpip": "192.168.0.209", "more": None, "gui_label": None, "gui_combo": None  },
                                  ]
it is a list of dictionaries.  The entry above is for 3 devices ( but I only have one, so the tcpip address is repeated ) For now only worry about the tcpip address and the name for the device; put in as many devices as you wish to control.

With the edited parameter file saved, restart the application.  You should be able to "talk" to your devices.  Not working?  Double check or email me. 

In the future I may try to add some autodetect features.  There is a routine to discover the plugs in the pyHS100 library, but it does not work for me.

= 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]].


== Either/Both Applications ==

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:

*notepad++
*geany

You can also use the editor that comes in many python development environments, the simplest of
which may be Idle.  But there are many many others.  If you are reading this you probably have
some experience.

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.
* Python cares about capitalization, use the capitalization indicated in the default 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 )

Editing of the parameters.py file

*Edit so the program finds your devices.
**See above in Download and Install
*Enable your favorite editor to work with the application.
**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 = 

* Create a directory for your data and database -- application comes with defaults


* Run database definition routine   button wf1
       You need to name a database, application will default
       You also need your sample file input, start with the one from
       the step above.
       look at output.......


 


= The GUI =

see: [[SmartPlug GUI Images]]

= Debugging = 

There are several application outputs that may be useful for debugging.

* Watch the GUI
* Check the Python console.
* Look at the python log file ( use the GUI button <Edit Log> ( specify your editor in parameters.py first ) or use your editor on the default name of the log file ...\smart_plug\smart_plug.py_log.

Most issues will probably be missing libraries, parameters.py issues, or just bugs in my code (email me ).

<!-----------



= Work Flow Overview =

== Just a bit of theory the may be helpful - Some Definitions ==

Databases
    These encode data in a structured and efficiently searchable format.  It also easily select subsets of
    data and can sort those results.  There are lots of different kinds, but one fairly standard one is a SQL or
    relational database.

Database File
    The file ( or one of the files ) where database information is kept.  We are using sqllite, which keeps a whole database
    in one file.  This makes it very easy to move and/or backup a database.

Table, Record, Column
    in a SQL data base data is stored in Tables ( many tables may be put in one database ).  A table consists of records ( also called rows. )  Each row is information about some "thing".  For example if the "thing" is a person a record
    might contain the person's first name, last name, date of birth.... The table is much like a spread sheet with
    the information on each person in a row.  Each of the items ( first name, last name, date of birth.... ) is called a column.

SQL - Structured Query Language
    This is the language used by relational databases.  Typically the system generated the required SQL and runs
    it.  The user interface often shows the SQL which is quite a bit easier to read than it is to write.
    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]]