/*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2008-2012. All Rights Reserved.                        */
/* Open Source Software - may be modified and shared by FRC teams. The code   */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project.                                                               */
/*----------------------------------------------------------------------------*/

package edu.wpi.first.wpilibj;

import edu.wpi.first.wpilibj.communication.FRCNetworkCommunicationsLibrary.tResourceType;
import edu.wpi.first.wpilibj.communication.UsageReporting;
import edu.wpi.first.wpilibj.livewindow.LiveWindow;

/**
 * VEX Robotics Victor 888 Speed Controller
 * 
 * The Vex Robotics Victor 884 Speed Controller can also be used with this
 * class but may need to be calibrated per the Victor 884 user manual.
 */
public class Victor extends SafePWM implements SpeedController {

    /**
     * Common initialization code called by all constructors.
     *
     * Note that the Victor uses the following bounds for PWM values.  These values were determined
     * empirically and optimized for the Victor 888. These values should work reasonably well for
     * Victor 884 controllers also but if users experience issues such as asymmetric behaviour around
     * the deadband or inability to saturate the controller in either direction, calibration is recommended.
     * The calibration procedure can be found in the Victor 884 User Manual available from VEX Robotics:
     * http://content.vexrobotics.com/docs/ifi-v884-users-manual-9-25-06.pdf
     *
     *   - 2.027ms = full "forward"
     *   - 1.525ms = the "high end" of the deadband range
     *   - 1.507ms = center of the deadband range (off)
     *   - 1.49ms = the "low end" of the deadband range
     *   - 1.026ms = full "reverse"
     */
    private void initVictor() {
        setBounds(2.027, 1.525, 1.507, 1.49, 1.026);
        setPeriodMultiplier(PeriodMultiplier.k2X);
        setRaw(m_centerPwm);
		setZeroLatch();

        LiveWindow.addActuator("Victor", getChannel(), this);
        UsageReporting.report(tResourceType.kResourceType_Victor, getChannel());
    }

    /**
     * Constructor.
     *
     * @param channel The PWM channel that the Victor is attached to. 0-9 are on-board, 10-19 are on the MXP port
     */
    public Victor(final int channel) {
        super(channel);
        initVictor();
    }

    /**
     * Set the PWM value.
     *
     * @deprecated For compatibility with CANJaguar
     *
     * The PWM value is set using a range of -1.0 to 1.0, appropriately
     * scaling the value for the FPGA.
     *
     * @param speed The speed to set.  Value should be between -1.0 and 1.0.
     * @param syncGroup The update group to add this Set() to, pending UpdateSyncGroup().  If 0, update immediately.
     */
    public void set(double speed, byte syncGroup) {
        setSpeed(speed);
        Feed();
    }

    /**
     * Set the PWM value.
     *
     * The PWM value is set using a range of -1.0 to 1.0, appropriately
     * scaling the value for the FPGA.
     *
     * @param speed The speed value between -1.0 and 1.0 to set.
     */
    public void set(double speed) {
        setSpeed(speed);
        Feed();
    }

    /**
     * Get the recently set value of the PWM.
     *
     * @return The most recently set value for the PWM between -1.0 and 1.0.
     */
    public double get() {
        return getSpeed();
    }

    /**
     * Write out the PID value as seen in the PIDOutput base object.
     *
     * @param output Write out the PWM value as was found in the PIDController
     */
    public void pidWrite(double output) {
        set(output);
    }
}
