Commits

Craig Swank committed 9a7d608

added iphone interface to docs

  • Participants
  • Parent commits a941717

Comments (0)

Files changed (7)

File docs/source/ui/command_mode.rst

 User Interface Command Mode
 ============================
 
-Let's turn on something.  As the help menu shows, hitting 'c'  enters
-you into command mode.  Hit any key to exit the help menu and then
-hit 'c'.  The bar at the top shows you are now in 'command mode':
-
-.. image:: images/ui_3.png
-
-Command mode is kind of strange, since I'm no User Interface master.  Here is how it
-works.  While you are in command mode, none of the key bindings that the help menu
-showed you will work.  Instead the keys you press are used to navigate the command mode.
-For example, to turn on the hlt heater you press h (for hlt) then h (for heater).  Now
-the screen looks like this (the effect is pretty subtle on the terminal I'm using here,
-I need to improve that):
+Let's turn on something.  Type 'c' to enter command mode, which should
+now be indicated by the top bar.  
 
 .. image:: images/ui_4.png
 
-You can see that 'hlt' and 'heater' are bold.  Now hit the enter key to turn on the heater:
+Once the ui is in command mode you can use the up and down arrows (or
+for emacs folks like myself, the 'n' and 'p' keys) to highlight the
+output devices in the device tree.
 
 .. image:: images/ui_5.png
 
-To turn it off hit enter again.
+Once the output device you wish to control is highlighed, hit the enter
+key to turn it on.
 
-To turn on some other device you have to first hit 'esc' to exit command mode, then enter
-command mode again by hitting 'c'.
+.. image:: images/ui_6.png
 
-You can also send a command with arguments.  For instance, if you wanted turn on the fan
-for 10 minutes you would hit the following keys 'c' -> 'br' -> 'f' (note you have to type
-'br' because there are two locations, brewery and boiler, that both start with 'b').  Now
-the brewery fan should be bold.  Instead of hitting 'c', you hit 'a' (for arguments).
-You will be prompted for the arguments by a pop up window:
+To turn it off hit enter again.
 
-.. image:: images/ui_6.png
+You can also send a command with arguments.  For instance, if you wanted
+turn on the pump for 5 seconds you can highlight the target device and
+hit the 'a' key (a for arguments).  You will be prompted for the
+arguments by a pop up window:
+
+.. image:: images/ui_7.png
 
-Hit enter after typing the arguments and the fan will turn on for 5 seconds, then turn off 
-(see the docs for Robot Command Language for an explaination on command arguments).
+Hit enter after typing the arguments and the bet two pump will turn on
+for 5 seconds, then turn off  (see the docs for Robot Command Language
+for an explaination on command arguments).
 
-Once again, hit 'esc' to exit command mode.
+Hit 'esc' to exit command mode.

File docs/source/ui/images/iphone.png

Added
New image

File docs/source/ui/images/ui_4.png

Old
Old image
New
New image

File docs/source/ui/images/ui_5.png

Old
Old image
New
New image

File docs/source/ui/images/ui_6.png

Old
Old image
New
New image

File docs/source/ui/images/ui_7.png

Old
Old image
New
New image

File docs/source/ui/ui.rst

    help
    command_mode
    method
+
+You can also download the source code for an `iPhone interface <https://bitbucket.org/cswank/iphonegadgets/>`_ and
+install it on your phone (if you are a registered Apple Developer).  I'm 
+working on getting the iPhone interace released on the app store.
+
+.. image:: images/iphone.png