# Battery emulator requests

## battery_emulator_get_parallel

**Note: This request requires a battery toolbox license.**

Get current number of simulated batteries in parallel.

### Request

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_parallel"
**data** | battery_emulator_get_parallel data

#### Data

Key                     | Type   | Required | Valid values
----------------------- | ------ | -------- | ------------
**battery_emulator_id** | String | Yes      | Battery emulator id

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187"
}
```

### Response

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_parallel"
**data** | battery_emulator_get_parallel data

#### Data

Key       | Type   | Required | Description
--------- | ------ | -------- | -----------
**value** | Number | Yes      | The number of batteries in parallel.

```JSON
{
    "value": 2
}
```

## battery_emulator_get_series

**Note: This request requires a battery toolbox license.**

Get current number of simulated batteries in series.

### Request

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_series"
**data** | battery_emulator_get_series data

#### Data

Key                     | Type   | Required | Valid values
----------------------- | ------ | -------- | ------------
**battery_emulator_id** | String | Yes      | Battery emulator id

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187"
}
```

### Response

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_series"
**data** | battery_emulator_get_series data

#### Data

Key       | Type   | Required | Description
--------- | ------ | -------- | -----------
**value** | Number | Yes      | The number of batteries in series.

```JSON
{
    "value": 2
}
```

## battery_emulator_get_soc

**Note: This request requires a battery toolbox license.**

Get State of Charge.

### Request

Key      | Value
-------- | -----
**cmd**  | "battery_emulator_get_soc"
**data** | battery_emulator_get_soc data

#### Data

Key                     | Type   | Required | Valid values
----------------------- | ------ | -------- | ------------
**battery_emulator_id** | String | Yes      | Battery emulator id

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187"
}
```

### Response

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_soc"
**data** | battery_emulator_get_soc data

#### Data

Key       | Type   | Required | Description
--------- | ------ | -------- | -----------
**value** | Number | Yes      | State of charge

```JSON
{
    "value": 50
}
```

## battery_emulator_get_soc_tracking

**Note: This request requires a battery toolbox license.**

Get current state of power supply State of Charge tracking.

### Request

Key      | Value
-------- | -----
**cmd**  | "battery_emulator_get_soc_tracking"
**data** | battery_emulator_get_soc_tracking data

#### Data

Key                     | Type   | Required | Valid values
----------------------- | ------ | -------- | ------------
**battery_emulator_id** | String | Yes      | Battery emulator id

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187"
}
```

### Response

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_soc_tracking"
**data** | battery_emulator_get_soc_tracking data

#### Data

Key         | Type    | Required | Description
----------- | ------- | -------- | -----------
**enabled** | Boolean | Yes      | True if State of Charge tracking is enabled, otherwise false.

```JSON
{
    "enabled": true
}
```

## battery_emulator_get_used_capacity

**Note: This request requires a battery toolbox license.**

Get current power supply used capacity.

### Request

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_used_capacity"
**data** | battery_emulator_get_used_capacity data

#### Data

Key                     | Type   | Required | Valid values
----------------------- | ------ | -------- | ------------
**battery_emulator_id** | String | Yes      | Battery emulator id

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187"
}
```

### Response

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_get_used_capacity"
**data** | battery_emulator_get_used_capacity data

#### Data

Key       | Type   | Required | Description
--------- | ------ | -------- | -----------
**value** | Number | Yes      | Capacity in coulombs (divide by 3.6 to get mAh)

```JSON
{
    "value": 152.0
}
```

## battery_emulator_set_soc

**Note: This request requires a battery toolbox license.**

Set State of Charge in percent.

### Request

Key      | Value
-------- | -----
**cmd**  | "battery_emulator_set_soc"
**data** | battery_emulator_set_soc data

#### Data

Key                     | Type    | Required | Valid values
----------------------- | ------- | -------- | ------------
**battery_emulator_id** | String  | Yes      | Battery emulator id
**value**               | Number  | Yes      | State of Charge in percent

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187"
    "value": 50
}
```

### Response

Parameter | Value
--------- | -----
**cmd**   | "battery_emulator_set_soc"

## battery_emulator_set_soc_tracking

**Note: This request requires a battery toolbox license.**

Set power supply State of Charge tracking.

### Request

Key      | Value
-------- | -----
**cmd**  | "battery_emulator_set_soc_tracking"
**data** | battery_emulator_set_soc_tracking data

#### Data

Key                     | Type    | Required | Valid values
----------------------- | ------- | -------- | ------------
**battery_emulator_id** | String  | Yes      | Battery emulator id
**enable**              | Boolean | Yes      | True enables State of Charge tracking, false disables it.

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187"
    "enable": true
}
```

### Response

Parameter | Value
--------- | -----
**cmd**   | "battery_emulator_set_soc_tracking"

## battery_emulator_set_used_capacity

**Note: This request requires a battery toolbox license.**

Set power supply used capacity.

### Request

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_set_used_capacity"
**data** | battery_emulator_set_used_capacity data

#### Data

Key                     | Type   | Required | Valid values
----------------------- | ------ | -------- | ------------
**battery_emulator_id** | String | Yes      | Battery emulator id
**value**               | Number | Yes      | Capacity in coulombs (multiply mAh by 3.6 to get C)

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187",
    "value": 152.0
}
```

### Response

Parameter | Value
--------- | -----
**cmd**   | "battery_emulator_set_used_capacity"

## battery_emulator_update_profile

**Note: This request requires a battery toolbox license.**

Update battery profile.

### Request

Key      | Value
-------- | ---
**cmd**  | "battery_emulator_update_profile"
**data** | battery_emulator_update_profile data

#### Data

Key                     | Type                  | Required | Valid values
----------------------- | --------------------- | -------- | ------------
**battery_emulator_id** | String                | Yes      | Battery emulator id
**battery_profile_id**  | String                | Yes      | Battery profile id
**mode**                | "keep_soc" or "reset" | Yes      | Mode

```JSON
{
    "battery_emulator_id": "1ce61608-9164-41a9-affb-221f1ea9f187",
    "battery_profile_id": "a287997b-7849-4bb4-8be8-96dc8f1dec5c",
    "mode": "keep_soc"
}
```