KartSetup (kartlib API)

java.lang.Object
- ch.hevs.kart.KartSetup

```
public class KartSetup
extends java.lang.Object
```
Groups all kart settings together and allows a convenient kart setup.

Constructor Summary

Constructors
Constructor and Description

KartSetup()
Creates a new, kart setup with all parameters set to their defaults.

Constructors
Constructor and Description
`KartSetup()` Creates a new, kart setup with all parameters set to their defaults.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KartSetup`	`apply(KartSetup setup)` Applies all parameters of the given Kart setup to this setup.
`KartSetup`	`clearHwSetting(KartHardwareSettings setting)` Clears the given hardware setting flag.
`int`	`driveMaxSpeed()` Returns the maximal speed a kart is allowed to drive with.
`KartSetup`	`driveMaxSpeed(int speed)` Sets the maximal speed a kart is allowed to drive with.
`int`	`drivePwmPeriod()` Returns the drive motor control block PWM period.
`KartSetup`	`drivePwmPeriod(int period)` Sets the drive motor control block PWM period.
`java.util.EnumSet<KartHardwareSettings>`	`hardwareSettings()` Returns the Kart's actual hardware settings.
`KartSetup`	`hardwareSettings(java.util.EnumSet<KartHardwareSettings> hardwareSettings)` Changes all of the hardware settings flags to the given values.
`static KartSetup`	`load(java.lang.String identifier, android.app.Activity activity)` Loads the kart settings from the given name.
`void`	`save(java.lang.String identifier, android.app.Activity activity)` Saves the kart settings under the given identifier.
`KartSetup`	`setHwSetting(KartHardwareSettings setting)` Sets the given hardware setting flag.
`KartSetup`	`steeringCenterPosition(int position)` Sets the steering motor central position.
`int`	`steeringEndSwitchAddress()` Returns the steering end switch address from which emulated end switch the data is considered by the steering FSM.
`KartSetup`	`steeringEndSwitchAddress(int address)` Sets the steering end switch address from which emulated end switch the data is considered by the steering FSM.
`int`	`steeringMaxPosition()` Returns the maximal step count at the opposite site of the stepper end contact switch.
`KartSetup`	`steeringMaxPosition(int position)` Sets the maximal step count of the steering motor.
`int`	`steeringStepPeriod()` Returns the steering motor driver step period.
`KartSetup`	`steeringStepPeriod(int period)` Sets the steering motor driver step period.
`float`	`updateInterval()` Returns the update interval of the Kart in seconds.
`KartSetup`	`updateInterval(float interval)` Sets the update interval of the Kart in seconds.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KartSetup
```
public KartSetup()
```
    Creates a new, kart setup with all parameters set to their defaults.
- Method Detail
  - drivePwmPeriod
```
public int drivePwmPeriod()
```
    Returns the drive motor control block PWM period. The period is defined as the value the main FPGA clock is divided by.
    
    Returns:
    
    PWM period.
  - drivePwmPeriod
```
public KartSetup drivePwmPeriod(int period)
```
    Sets the drive motor control block PWM period. The period is defined as the value the main FPGA clock is divided by. Defaults to 64.
    
    Parameters:
    
    period - PWM period.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - driveMaxSpeed
```
public int driveMaxSpeed()
```
    Returns the maximal speed a kart is allowed to drive with. Values are from 0 to 15.
    
    Returns:
    
    Maximal drive speed.
  - driveMaxSpeed
```
public KartSetup driveMaxSpeed(int speed)
```
    Sets the maximal speed a kart is allowed to drive with. Valid values are in 0...15.
    
    Parameters:
    
    speed - Maximal allowed speed.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - steeringMaxPosition
```
public int steeringMaxPosition()
```
    Returns the maximal step count at the opposite site of the stepper end contact switch.
    
    Returns:
    
    Maximal stepper motor step count.
  - steeringMaxPosition
```
public KartSetup steeringMaxPosition(int position)
```
    Sets the maximal step count of the steering motor. Default value is defined by Kart VHDL.
    design.
    
    Parameters:
    
    position - The value of the step counter at the opposite site of the end switch.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - steeringCenterPosition
```
public KartSetup steeringCenterPosition(int position)
```
    Sets the steering motor central position. Note that this method actually calls the method steeringMaxPosition with 2 times the center position.
    
    Parameters:
    
    position - The value of the step counter at the center.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - steeringStepPeriod
```
public int steeringStepPeriod()
```
    Returns the steering motor driver step period. The period is defined as the value the main FPGA clock is divided by.
    
    Returns:
    
    Steering motor step period.
  - steeringStepPeriod
```
public KartSetup steeringStepPeriod(int period)
```
    Sets the steering motor driver step period. The period is defined as the value the main FPGA clock is divided by. Defaults to 100.
    
    Parameters:
    
    period - Steering motor step period.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - steeringEndSwitchAddress
```
public int steeringEndSwitchAddress()
```
    Returns the steering end switch address from which emulated end switch the data is considered by the steering FSM. This value can be ignored if the option to enable the emulated end contact is not set in the hardware settings.
    
    Returns:
    
    Steering end contact address.
  - steeringEndSwitchAddress
```
public KartSetup steeringEndSwitchAddress(int address)
```
    Sets the steering end switch address from which emulated end switch the data is considered by the steering FSM. This value will be ignored if the option to enable the emulated end contact is not set in the hardware settings. Defaults to 0.
    
    Parameters:
    
    address - Steering end contact address.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - hardwareSettings
```
public java.util.EnumSet<KartHardwareSettings> hardwareSettings()
```
    Returns the Kart's actual hardware settings. Default is all flags cleared.
    
    Returns:
    
    Kart's hardware settings.
  - hardwareSettings
```
public KartSetup hardwareSettings(java.util.EnumSet<KartHardwareSettings> hardwareSettings)
```
    Changes all of the hardware settings flags to the given values.
    
    Parameters:
    
    hardwareSettings - Hardware settings to apply.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - setHwSetting
```
public KartSetup setHwSetting(KartHardwareSettings setting)
```
    Sets the given hardware setting flag.
    
    Parameters:
    
    setting - Hardware setting flag to set.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - clearHwSetting
```
public KartSetup clearHwSetting(KartHardwareSettings setting)
```
    Clears the given hardware setting flag.
    
    Parameters:
    
    setting - Hardware setting flag to clear.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - updateInterval
```
public float updateInterval()
```
    Returns the update interval of the Kart in seconds. This interval is the time between each register update send from the Kart to the Android application.
    
    Returns:
    
    Update interval in seconds.
  - updateInterval
```
public KartSetup updateInterval(float interval)
```
    Sets the update interval of the Kart in seconds. This interval is the time between each register update send from the Kart to the Android application. Note that fractions of seconds is supported too. Defaults to 0.064.
    
    Parameters:
    
    interval - Update interval in seconds.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - apply
```
public KartSetup apply(KartSetup setup)
```
    Applies all parameters of the given Kart setup to this setup.
    
    Parameters:
    
    setup - Kart setup to apply to this kart setup object.
    
    Returns:
    
    Reference to itself in order to chain method calls.
  - save
```
public void save(java.lang.String identifier,
                 android.app.Activity activity)
```
    Saves the kart settings under the given identifier.
    
    Parameters:
    
    identifier - Name for the saved setup.
    
    activity - Activity is needed to access file system.
  - load
```
public static KartSetup load(java.lang.String identifier,
                             android.app.Activity activity)
```
    Loads the kart settings from the given name.
    
    Parameters:
    
    identifier - Identifier of the setup to load.
    
    activity - Activity is needed to access file system.
    
    Returns:
    
    Kart setup object or nil if no setup was found.

Class KartSetup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KartSetup

Method Detail

drivePwmPeriod

drivePwmPeriod

driveMaxSpeed

driveMaxSpeed

steeringMaxPosition

steeringMaxPosition

steeringCenterPosition

steeringStepPeriod

steeringStepPeriod

steeringEndSwitchAddress

steeringEndSwitchAddress

hardwareSettings

hardwareSettings

setHwSetting

clearHwSetting

updateInterval

updateInterval

apply

save

load