Editing SmartPlug Help File
Jump to navigation
Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
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 ( | + | 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 ) | + | *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. Currently power and energy over time. Multiple devices on one graph. | ||
− | *Supports | + | *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 = | ||
Line 41: | Line 41: | ||
= How To:... = | = How To:... = | ||
− | + | *Edit the parameter file: 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]] | |
− | + | *View the log: Use the application button ( after configuring for your editor ) or any text editor on the file smart_plug.py_log. This is the default file name, it can be changed in parameters.py. | |
− | + | *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. | |
− | + | *Backup the database: Just make a copy of the database. 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. | |
− | + | *Record data: Press the <Record On> button, to stop <Record Off> or close the application. See also: [[SmartPlug GUI Images]]. | |
+ | *Set a timer: See also: [[SmartPlug GUI Images]] | ||
+ | *See status: Of what, work in progress. | ||
+ | *Make a graph: Use the graphing application ... a whole section on this coming soon. See also: [[SmartPlug GUI Images]]. | ||
+ | *Export a csv file: See also: [[SmartPlug GUI Images]] | ||
*Install: see section above. | *Install: see section above. | ||
*Debug: see section below. | *Debug: see section below. | ||
− | + | *Change Parameters: Same as edit the parameter file. | |
− | + | *Retrieve data from plug: On the GUI, but not implemented. | |
− | * | ||
− | |||
*Quick Restart of the application: As perhaps after a parameter change. Use the <Restart> button. See also: [[SmartPlug GUI Images]] | *Quick Restart of the application: As perhaps after a parameter change. Use the <Restart> button. See also: [[SmartPlug GUI Images]] | ||
− | |||
− | |||
− | + | = How to Use the Parameter File = | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | = | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | You need a text editor sutiable for .py files to manage the parameter file ( parameters.py ) | |
− | |||
− | You need a text editor | ||
This includes most text editors. I particularity like: | 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 | You can also use the editor that comes in many python development environments, the simplest of | ||
Line 102: | Line 71: | ||
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 | |
− | + | Use your chosen text editor to open the file parameters | |
− | + | ||
− | + | specify in parameters.py with | |
− | + | 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. | |
− | |||
− | |||
− | |||
= Working With Database Files = | = Working With Database Files = | ||
Line 145: | Line 114: | ||
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 138: | ||
It may give you useful feedback on what the system is doing. | It may give you useful feedback on what the system is doing. | ||
− | |||
− | |||
= Links = | = Links = | ||
*[[Python Control of Smart Plugs]] main page for this project | *[[Python Control of Smart Plugs]] main page for this project | ||
− | |||
− | |||
− | [[Category: | + | *[[Category:Python_SmartPlug]] category page for this project |
+ | |||
+ | |||
+ | [[Category:Python SmartPlug]] [[category:Python]] |