Editing ClipBoard Help File

This is the Help "file" for the Python Application whose main page is: [[Python Smart Clipboard]]
 
= Right now this is Junk =
Fix comming soon..... 


Help file for backup application.


= Application Features = 

*Highly configurable.
*GUI shows activity.
.....

= 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 not yet available. 

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

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.

this cannot bee seen 
------------->


= How To:... = 
== Goal ==
This is how I use the program, you could use it differently:

Put a short Python script in a directory.  When this is double clicked start the GUI for the backup program set up to backup the directory to another directory either on the current disk or another disk.


== General ==
 

*Edit the parameter file:  Use your development environment for Python or a text editor to edit parameters.py.  See also: The section below, [[Configuration Files For Python]].  I have a button on the GUI for this. 

<!-----------
this cannot bee seen


*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.
------------->
*Install: see section above.

*Debug:  see section below.

*Quick Restart of the application:  Not in this app, just shutdown and restart.

*Use your preferred text editor. In the parameter file, see below.

*Using the GUI see: [[ClipBoard GUI]]

== More Info Here  ==

=  How to Use the Parameter File = 
See: '''[[Configuration Files For Python]]'''

Editing of the parameters.py file

**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" in Windowd, 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 parameter file.

= The GUI =

see: [[ClipBoard GUI]]

= 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, by default: clipboard.py_log.

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

<!-----------
 
this cannot bee seen 
------------->

= Links =

*[[Python Smart ClipBoard]] main page for this project 

*Click on category page for this project ( '''ClipBoard''' ) below.
*Click on '''What links here''' on the left of this page 



[[category:ClipBoard]] [[category:Python]] [[category:Python Projects]]
@@ Line 1: / Line 1: @@
-This is the Help "file" for the Python Application whose main page is: [[Python Smart ClipBoard]]
+This is the Help "file" for the Python Application whose main page is: [[Python Smart Clipboard]]
-= This Help Page is Early Draft =
+= Right now this is Junk =
+Fix comming soon.....
-  April  .... working on enhancements so may get this page right, had to get wiki here working again, finally is
-Fix coming soon..... No it is not, help is going to link to the main project page.  This material will be reused elsewhere if useful.
-This Python program (clip_board.py) is an application to enhance the windows ( unix ?? ) clipboard by adding the ability to it to:
+Help file for backup application.
-* Transform keyboard contents, referred to as "Transforms".
-* Insert predefined elements into the clipboard, referred to as "Snippets".
-* Open example files in a configurable editor or ide, referred to as "Snips". -- This really does not involve the clipboard, but is a sort of high powered version of snippets
-* Interpret copied text as commands or directions to the system to carry out some action specified in the clipboard contents, for example, browse to some website.
-* The program is easily modified by adding transforms, snips, or snippets, this may require some python programming.
+= Application Features =
-    The program does not have a clipboard history as I, so far, have not found that useful. There are a lot of other apps with this feature.
+*Highly configurable.
+*GUI shows activity.
+.....
+= Download and Install =
-For a quick overview on use once installed see the GUI documentation at: ClipBoard GUI That page will also link to the 4 areas of operation:
+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 not yet available.
-* [[Clipboard Transformations]]
+<!-----------
-* [[Clipboard Snippets]]
-* [[Clipboard Snips]]
-* [[Clipboard Commands]]
+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.
-== Transformations ==
+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.
-Transformations is one of the principal functions of the ClipBoard App, there is a whole page that lists most of them ( they are frequently enhanced keeping up is hard to do )
+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.
-'''[[Clipboard Transformations]]'''
+The section of parameters.py that locates the device looks like this:
-== Commands ==
+        self.device_list       =  [
-Interpret copied text as commands or directions to the system to carry out some action specified in the clipboard contents, for example, browse to some website.
+                { "name": "device_1",  "tcpip": "192.168.0.209", "more": None, "gui_label": None, "gui_combo": None  },
-'''[[Clipboard Commands]]'''
+                { "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  },
-== GUI ==
+                                  ]
+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.
-Using the GUI see: [[ClipBoard GUI]]
-== Meta Tool Bar ==
-the meta tool bar is the button bar across the top, it performs actions ( like help ) that are about the application, like configuration, but are not part of its purpose ( like transforming clipboard contents )
+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.
+this cannot bee seen
+------------->
-== draft material ==
+= How To:... =
+== Goal ==
+This is how I use the program, you could use it differently:
+Put a short Python script in a directory.  When this is double clicked start the GUI for the backup program set up to backup the directory to another directory either on the current disk or another disk.
+== General ==
@@ Line 86: / Line 87: @@
 **Re download and get back to the original parameter file.
-== Links ==
+= The GUI =
-*'''Click on Category ClipBoard ''' below
-*'''[https://opencircuits.com/index.php?title=Python_Smart_ClipBoard Python Smart ClipBoard - OpenCircuits ]'''  main page for this application.
+see: [[ClipBoard GUI]]
+= 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, by default: clipboard.py_log.
+Most issues will probably be missing libraries, parameters.py issues, or just bugs in my code (email me ).
+<!-----------
+this cannot bee seen
+------------->
+= Links =
+*[[Python Smart ClipBoard]] main page for this project
+*Click on category page for this project ( '''ClipBoard''' ) below.
+*Click on '''What links here''' on the left of this page
-[[Category:ClipBoard]]
+[[category:ClipBoard]] [[category:Python]] [[category:Python Projects]]