Improve API docs

Author: virtuald

docs/api_camera.rst

@@ -0,0 +1,50 @@
+JS API: Camera Integration
+==========================
+
+.. code-block:: html
+
+    <script src="/networktables/camera.js"></script>
+    
+.. note:: These functions require `jQuery <http://jquery.com/>`_ to be
+          loaded first!
+
+.. js:function:: loadCameraOnConnect(args)
+
+    This useful helper function will create an img or svg element inside of the
+    div element that you specify. The image will only be connected when a
+    successful NetworkTables connection is detected, to prevent timeout issues.
+    Additionally, this function will attempt to verify that the webcam server is
+    actually up and running before creating the image.
+
+    You should provide an object with an object that can have the following 
+    attributes:
+
+    :param container:   Where to draw things
+    :param proto:       optional, defaults to http://
+    :param host:        optional, if null will use robot's autodetected IP
+    :param port:        optional, webserver port
+    :param image_url:   path to mjpg stream
+    :param data_url:    a file or page that must exist on the webcam server
+    :param wait_img:    optional image to show when not connected
+    :param error_img:   optional image to show when not connected
+    :param attrs:       optional attributes to set on svg or img element
+    :param nosim:       if true, connect to the webcam in simulation mode
+
+    For example, to connect to mjpg-streamer on the RoboRIO:
+    
+    .. code-block:: javascript
+
+        loadCameraOnConnect({
+            container: '#my_div_element',
+            port: 5800,
+            image_url: '/?action=stream',
+            data_url: '/program.json',
+            attrs: {
+                width: 640,
+                height: 480
+            }
+        });
+
+
+    .. note:: This has only been tested with mjpg-streamer, but should work for 
+              other HTTP webcams as well.

docs/api_js.rst

@@ -1,5 +1,13 @@
-JavaScript API
-==============
+JS API: NetworkTables
+=====================
+
+To use these functions, add this to your HTML page:
+
+.. code-block:: html
+
+    <script src="/networktables/networktables.js"></script>
+
+**Note**:
 
 It's very important to note that the Javascript NetworkTables API currently
 has no concept of a table or subtable. When referring to keys when accessing

docs/api_util.rst

@@ -0,0 +1,52 @@
+JS API: Utilities
+=================
+
+To use these functions, add this to your HTML page:
+
+.. code-block:: html
+
+    <script src="/networktables/utils.js"></script>
+
+.. note:: These functions require `jQuery <http://jquery.com/>`_ and
+          `D3 <https://d3js.org/>`_ to be loaded first!
+
+The functions in this file are still experimental in nature, and as we
+expand the number of functions in this file it is expected that the API
+will change.
+
+SendableChooser
+---------------
+
+.. js:function:: attachSelectToSendableChooser(html_id, nt_key)
+
+    Given the id of an HTML ``<select>`` element and the key name of a SendableChooser
+    object setup in networktables, this will sync the select combo box with the
+    contents of the SendableChooser, and you will be able to select an object
+    using the select element.
+
+    :param html_id: An ID of an HTML select element
+    :param nt_key: The name of the NetworkTables key that the SendableChooser
+                   is associated with
+
+    See the WPILib documentation for information on how to use SendableChooser
+    in your robot's program.
+
+.. js:function:: updateSelectWithChooser(html_id, nt_key)
+
+    This function is designed to be used from the onValueChanged callback
+    whenever values from a SendableChooser change, but you probably should
+    prefer to use attachSelectToSendableChooser instead.
+
+    See attachSelectToSendableChooser documentation.
+
+Indicators
+----------
+
+.. js:function:: attachRobotConnectionIndicator(html_id[, size, stroke_width])
+
+    Creates a circle SVG that turns red when robot is not connected, green when
+    it is connected.
+
+    :param html_id: ID to insert svg into
+    :param size: Size of circle
+    :param stroke_width: Border of circle

docs/index.rst

@@ -5,6 +5,8 @@
    :maxdepth: 4
 
    api_js
+   api_util
+   api_camera
    troubleshooting
 
 Indices and tables

pynetworktables2js/js/camera.js

@@ -52,7 +52,7 @@ function $s(elem) {
     
     
     .. note:: This has only been tested with mjpg-streamer, but should work for 
-              other webcams as well.
+              other HTTP webcams as well.
 */
 function loadCameraOnConnect(args) {
     /*