org.usfirst.frc.team1736.lib.WebServer

Class CasseroleDriverView

java.lang.Object

org.usfirst.frc.team1736.lib.WebServer.CasseroleDriverView

public class CasseroleDriverView
extends java.lang.Object

DESCRIPTION:
Driver View webpage definition class. Adds new things to the driver view webpage (webcam mjpeg videos or dials). Has methods to update the dial displayed values.
ASSUMPTIONS:
Be sure the casserole webserver is started at some point, otherwise the webpage won't be displayed.
USAGE:

1. Instantiate class
2. On init, call newDial and newWebcam once per object to be displayed on the driver view webpage.
3. During runtime, call setDialValue to update the dial value display

Constructor Summary

Constructors

Constructor and Description
CasseroleDriverView()

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<org.usfirst.frc.team1736.lib.WebServer.DriverViewObject>	getAllObjects()
static void	newBoolean(java.lang.String name_in, java.lang.String color_in) Create a new Boolean indicator to display on the driver view webpage.
static void	newDial(java.lang.String name_in, double min_in, double max_in, double step_in, double min_acceptable_in, double max_acceptable_in) Create a new dial to display on the driver view webpage.
static void	newStringBox(java.lang.String name_in) Create a new String to display on the driver view webpage.
static void	newWebcam(java.lang.String name_in, java.lang.String url_in, double marker_x, double marker_y, double img_rotate_deg) Add a new webcam to the driver view webpage.
static void	setBoolean(java.lang.String name_in, boolean value_in) Display a new value on an existing boolean display
static void	setDialValue(java.lang.String name_in, double value_in) Display a new value on an existing dial at runtime
static void	setStringBox(java.lang.String name_in, java.lang.String value_in) Display a new value on an existing string box at runtime
static void	setWebcamCrosshairs(java.lang.String name_in, double x_pct, double y_pct) Update the location of the crosshairs on the webcam stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CasseroleDriverView

public CasseroleDriverView()

Method Detail

newDial

public static void newDial(java.lang.String name_in,
                           double min_in,
                           double max_in,
                           double step_in,
                           double min_acceptable_in,
                           double max_acceptable_in)

Create a new dial to display on the driver view webpage. Should be called at init, as new dials cannot be added at runtime. Dials are designed for two purposes: providing detailed value information at runtime, as well as at-a-glance indication of acceptable/unacceptable. The numbers and units presented on the dial provide the first, while the red/green outline around the arc of travel shows the operator whether the value is acceptable without reading any numbers. Use the min/max acceptable limit arguments to define this range.

Parameters:

name_in - Name of the value to display. Also used to reference the value when updating it.

min_in - Minimum value displayed on the dial.

max_in - Maximum value displayed on the dial.

step_in - Step value between dial tick marks.

min_acceptable_in - Lower limit of green display area on drawn dial.

max_acceptable_in - Upper limit of green display area on drawn dial.

newWebcam

public static void newWebcam(java.lang.String name_in,
                             java.lang.String url_in,
                             double marker_x,
                             double marker_y,
                             double img_rotate_deg)

Add a new webcam to the driver view webpage. Should be called at init, as new webcams cannot be added at runtime.

Parameters:

url_in - Web address of the motion JPEG stream from the camera.

marker_x - X draw position of the crosshairs (in percent - 0% is full left, 100% is full right).

marker_y - Y draw position of the crosshairs (in percent - 0% is full top, 100% is full bottom).

img_rotate_deg - Degrees clockwise to rotate the image to be displayed. Crosshairs are drawn on top of the already-rotated image.

name_in - Name of the web stream. Internal uses only, currently...

newStringBox

public static void newStringBox(java.lang.String name_in)

Create a new String to display on the driver view webpage. Should be called at init, as new string values cannot be added at runtime. Strings are hard to read and should be used sparingly. If at all possible, use a boolean or dial.

Parameters:

name_in - Name of the value to display. Also used to reference the value when updating it.

newBoolean

public static void newBoolean(java.lang.String name_in,
                              java.lang.String color_in)

Create a new Boolean indicator to display on the driver view webpage. Should be called at init, as new indicators values cannot be added at runtime. Designing with these indicators should follow a "dark console" philosophy: or normal operations, all indicators should be dark. Red indicators should illuminate for very bad abmormailites (pressure low, batt voltage low, etc). Yellow is for less severe conditions which degrade performance. Green is for conditions which are not usually present, but are good. (ex: ball in intake).

Parameters:

name_in - Name of the value to display. Also used to reference the value when updating it.

color_in - Color to display. Currently, only supported values are "red", "yellow", and "green".

setDialValue

public static void setDialValue(java.lang.String name_in,
                                double value_in)

Display a new value on an existing dial at runtime

Parameters:

name_in - Name of the dial to update

value_in - Value to display on the dial. Should be in the min/max range assigned for the dial, or the displayed value will be truncated.

setStringBox

public static void setStringBox(java.lang.String name_in,
                                java.lang.String value_in)

Display a new value on an existing string box at runtime

Parameters:

name_in - Name of the dial to update

value_in - Value to display on the dial. Should be in the min/max range assigned for the dial, or the displayed value will be truncated.

setBoolean

public static void setBoolean(java.lang.String name_in,
                              boolean value_in)

Display a new value on an existing boolean display

Parameters:

name_in - Name of the dial to update

value_in - Value to display on the indicator.

setWebcamCrosshairs

public static void setWebcamCrosshairs(java.lang.String name_in,
                                       double x_pct,
                                       double y_pct)

Update the location of the crosshairs on the webcam stream

getAllObjects

public static java.util.ArrayList<org.usfirst.frc.team1736.lib.WebServer.DriverViewObject> getAllObjects()

Returns:

a set of DriverViewObjects which can be used for working on the set of all things on the driver view.