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 ) | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
= Application Features = | = Application Features = | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | Works with multiple smartplugs | |
+ | Provides on off functions from a graphical user interface ( gui ) | ||
+ | Highly configurable | ||
+ | Supports graphing of data | ||
+ | Supports csv output of data | ||
+ | Saves data to a sql lite database that you can use any way you wish | ||
− | |||
− | = | + | ============ First Use of the SmartPlug Application =============== |
− | + | The application is set up with a default database, but it need some information | |
+ | on your devices. | ||
− | |||
− | + | ......... | |
− | + | = How to Use the Parameter File = | |
− | + | You need a text editor sutible for .py files to manage the parameter file ( parameters.py ) | |
− | + | This includes most text editors. I particurlay like: | |
− | |||
− | |||
− | |||
− | |||
− | + | notepad++ | |
+ | geany | ||
− | + | You can also use the editor that comes in many python development enviroments, the simples of | |
+ | which may be Idle. But there are many many others. If you are reading this you probably have | ||
+ | some experience. | ||
− | + | A 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 ) | ||
− | + | 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 insterd they may be wrong | |
− | + | but they work. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
= Working With Database Files = | = Working With Database Files = | ||
Line 129: | Line 83: | ||
− | |||
− | |||
− | + | ||
+ | |||
+ | |||
+ | |||
+ | = The GUI = | ||
+ | |||
+ | |||
+ | = 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 = | ||
− | |||
− | + | Watch the console for error messages and in particular look for modules that may be missing ( I do not provide these, pip or conda should install them ) | |
− | + | ||
− | |||
− | |||
− | |||
Line 152: | Line 121: | ||
= Work Flow Overview = | = Work Flow Overview = | ||
− | == Just a bit of theory the may be helpful - Some Definitions | + | ================= Just a bit of theory the may be helpful - Some Definitions = |
Databases | Databases | ||
Line 173: | Line 142: | ||
It may give you useful feedback on what the system is doing. | It may give you useful feedback on what the system is doing. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | [[category:Python]] |