# VehicleIgnitionState

Summary:[Constants](https://developer.android.com/reference/android/car/VehicleIgnitionState#constants)\|[Methods](https://developer.android.com/reference/android/car/VehicleIgnitionState#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/car/VehicleIgnitionState#inhmethods)  

# VehicleIgnitionState

`
public

final

class
VehicleIgnitionState
`  
`

extends Object


``


`

|---|----------------------------------|
| java.lang.Object                    ||
| ↳ | android.car.VehicleIgnitionState |

<br />

*** ** * ** ***

Possible states of a vehicle's ignition.

Applications can use[CarPropertyManager.getProperty(int, int)](https://developer.android.com/reference/android/car/hardware/property/CarPropertyManager#getProperty(int,%20int))with[VehiclePropertyIds.IGNITION_STATE](https://developer.android.com/reference/android/car/VehiclePropertyIds#IGNITION_STATE)to query the vehicle's ignition state.

## Summary

|                                                                         ### Constants                                                                         ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [ACC](https://developer.android.com/reference/android/car/VehicleIgnitionState#ACC) Typically in this state accessories become available (e.g. radio). |
| `int` | [LOCK](https://developer.android.com/reference/android/car/VehicleIgnitionState#LOCK) Steering wheel is locked.                                        |
| `int` | [OFF](https://developer.android.com/reference/android/car/VehicleIgnitionState#OFF) Steering wheel is not locked, engine and all accessories are off.  |
| `int` | [ON](https://developer.android.com/reference/android/car/VehicleIgnitionState#ON) Ignition is in state on.                                             |
| `int` | [START](https://developer.android.com/reference/android/car/VehicleIgnitionState#START) Typically in this state engine is starting (cranking).         |
| `int` | [UNDEFINED](https://developer.android.com/reference/android/car/VehicleIgnitionState#UNDEFINED) The vehicle's ignition state is undefined.             |

|                                                                                           ### Public methods                                                                                            ||
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` static String` | ` `[toString](https://developer.android.com/reference/android/car/VehicleIgnitionState#toString(int))`(int ignitionState) ` Gets a user-friendly representation of an ignition state. |

| ### Inherited methods |
|-----------------------|---|
| From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object`         | ` clone() `                   | | ` boolean`        | ` equals(Object arg0) `       | | ` void`           | ` finalize() `                | | ` final Class<?>` | ` getClass() `                | | ` int`            | ` hashCode() `                | | ` final void`     | ` notify() `                  | | ` final void`     | ` notifyAll() `               | | ` String`         | ` toString() `                | | ` final void`     | ` wait(long arg0, int arg1) ` | | ` final void`     | ` wait(long arg0) `           | | ` final void`     | ` wait() `                    | ||

## Constants

### ACC

```
public static final int ACC
```

Typically in this state accessories become available (e.g. radio). Instrument cluster and engine are turned off

<br />

Constant Value: 3 (0x00000003)  

### LOCK

```
public static final int LOCK
```

Steering wheel is locked. If car can be in`LOCK`and`OFF`state at the same time than HAL must report`LOCK`state.

<br />

Constant Value: 1 (0x00000001)  

### OFF

```
public static final int OFF
```

Steering wheel is not locked, engine and all accessories are off. If car can be in`LOCK`and`OFF`state at the same time than HAL must report`LOCK`state.

If[VehiclePropertyIds.IGNITION_STATE](https://developer.android.com/reference/android/car/VehiclePropertyIds#IGNITION_STATE)is implemented on a BEV, then this state communicates the BEV's High Voltage battery is disconnected and thus the vehicle is OFF.

<br />

Constant Value: 2 (0x00000002)  

### ON

```
public static final int ON
```

Ignition is in state on. Accessories and instrument cluster available, engine might be running or ready to be started.

If[VehiclePropertyIds.IGNITION_STATE](https://developer.android.com/reference/android/car/VehiclePropertyIds#IGNITION_STATE)is implemented on a BEV, then this state communicates the BEV's High Voltage battery is connected and thus the vehicle is ON.

<br />

Constant Value: 4 (0x00000004)  

### START

```
public static final int START
```

Typically in this state engine is starting (cranking).

<br />

Constant Value: 5 (0x00000005)  

### UNDEFINED

```
public static final int UNDEFINED
```

The vehicle's ignition state is undefined.

<br />

Constant Value: 0 (0x00000000)

## Public methods

### toString

```
public static String toString (int ignitionState)
```

Gets a user-friendly representation of an ignition state.

<br />

|                                                                                                                                                                                                                                                                                    Parameters                                                                                                                                                                                                                                                                                     ||
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ignitionState` | `int`: Value is[UNDEFINED](https://developer.android.com/reference/android/car/VehicleIgnitionState#UNDEFINED),[LOCK](https://developer.android.com/reference/android/car/VehicleIgnitionState#LOCK),[OFF](https://developer.android.com/reference/android/car/VehicleIgnitionState#OFF),[ACC](https://developer.android.com/reference/android/car/VehicleIgnitionState#ACC),[ON](https://developer.android.com/reference/android/car/VehicleIgnitionState#ON), or[START](https://developer.android.com/reference/android/car/VehicleIgnitionState#START) <br /> |

|     Returns      ||
|----------|--------|
| `String` | <br /> |