Editing Command Assistant 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 7: | Line 7: | ||
= Application Features = | = Application Features = | ||
− | * | + | * |
− | |||
*Highly configurable. | *Highly configurable. | ||
− | |||
− | = | + | |
− | + | = 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. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | |||
With the edited parameter file saved, restart the application. Not working? Double check or email me. | With the edited parameter file saved, restart the application. Not working? Double check or email me. | ||
Line 53: | Line 28: | ||
*Install: see section above. | *Install: see section above. | ||
*Debug: see section below. | *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 [[ | + | *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]] 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. | *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. | *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. | *Work with text in message area: See buttons to the left of the area. | ||
+ | |||
+ | |||
= How to Use the Parameter File = | = How to Use the Parameter File = |