# Settings

## Software Version

```
VarName                 Entity         Description

Version                 0              Software Version
```

For **batterX Home** combine the fields `v1`, `v2` and `v3` as `v1.v2.v3`

For **batterX Business** the version number is field `v4`

## System Mode

```
VarName                 Entity          Description

SystemMode              0               System Mode used for batterX Home with cliX v2.0
```

Used only for **batterX Home** with **cliX v2.0**

| Field  | Description                                                                                                       |
| ------ | ----------------------------------------------------------------------------------------------------------------- |
| `mode` | <p>Can be <code>0</code> or <code>1</code></p><p><code>0</code> = UPS Mode</p><p><code>1</code> = Backup Mode</p> |

*When **Backup Mode** is selected, the GPIO outputs 3 & 4 are used internally and are disabled for the user.*

## Min. Battery SoC

```
VarName                 Entity          Description

BatteryMinSoC           0               Minimum Battery State-of-Charge in Hybrid Mode
```

Used only for **batterX Home** with **LiFePO** batteries.

| Field  | Description                                                                                                                          |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `mode` | <p>Can be <code>0</code> or <code>1</code></p><p><code>0</code> = Disabled</p><p><code>1</code> = Enabled</p>                        |
| `v1`   | <p>The min. SoC percentage that should be reserved for power outages</p><p>Can be between <code>15%</code> and <code>100%</code></p> |

*When **disabled**, the default value of **15%** is used.*

## Injection Mode

```
VarName                 Entity          Description

InjectionMode           0               Configuration of the Grid Injection
```

Used only for **batterX Home**

| Field  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mode` | <p>Injection Mode</p><p>Can be <code>0</code>, <code>1</code>, <code>2</code> or <code>3</code></p><p><code>0</code> = Function disabled / Ignore Grid E.Meter</p><p><code>1</code> = Discharge batteries to keep total grid power near zero (EC-ON1)</p><p><code>2</code> = Discharge batteries to keep the power of each phase near zero (EC-ON2)</p><p><code>3</code> = Do not discharge batteries to the unprotected load</p><p><em>If you have external solar inverter connected, with any of the above modes (except mode 0), the batteries will charge when there is excess external solar power available.</em></p> |
| `v1`   | <p>Injection Power</p><p><em>Up to <code>5000</code> watt for <strong>batterX h5</strong></em></p><p><em>Up to <code>10000</code> watt for <strong>batterX h10</strong></em></p>                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `v6`   | <p>Injection Phase</p><p>Can be <code>0</code>, <code>1</code>, <code>2</code> or <code>3</code></p><p><em>Used only for <strong>batterX h5.</strong></em></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

## Ignore Warnings

```
VarName                 Entity          Description

IgnoreWarnings          0               Ignore Warning IDs typed in field s1
```

| Field  | Description                                                                                                   |
| ------ | ------------------------------------------------------------------------------------------------------------- |
| `mode` | <p>Can be <code>0</code> or <code>1</code></p><p><code>0</code> = Disabled</p><p><code>1</code> = Enabled</p> |
| `s1`   | Warning IDs separated by space                                                                                |

The warning IDs typed in the `s1` field will be ignored by the liveX software.\
They will not be logged locally, nor will the be sent over to the cloud.

*This can be useful, for example, when you have only one MPPT string connected to the inverter and you do not want to see the Solar 2 Loss (ID 17922) warning all the time.*

The IDs in the `s1` field are typed as a list of integers separated by space.\
For example: `17920 17922 17954`

*Note: For batterX Business the `s1` field accepts maximum 200 characters, so you can't ignore more than 40 warnings at once.*

## Outputs (GPIO)

```
VarName                 Entity          Description

BxOutPin                1               Relay Output 1
BxOutPin                2               Relay Output 2
BxOutPin                3               Relay Output 3
BxOutPin                4               Relay Output 4
```

Used only for **batterX Home**

| Field  | Description                                                                                                                                                                                                                                                      |
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Label for the output, displayed in the GPIO screen                                                                                                                                                                                                               |
| `mode` | <p>Can be <code>0</code> or <code>1</code></p><p><code>0</code> = The output will always stay <code>LOW</code></p><p><code>1</code> = The output will be set to <code>LOW</code> or <code>HIGH</code>, according to the statement from field <code>s1</code></p> |
| `v4`   | <p>Minimum active time for the output in <code>seconds</code></p><p>The minimum seconds that the output must stay <code>HIGH</code> before it can be turned off (<code>LOW</code>)</p><p>During this time the statement is not being evaluated</p>               |
| `v5`   | <p>Switch-Off delay for the output in <code>seconds</code></p><p>The statement must be <code>FALSE</code> during the entire time, before the output gets turned off (<code>LOW</code>)</p>                                                                       |
| `v6`   | <p>Switch-On delay for the output in <code>seconds</code></p><p>The statement must be <code>TRUE</code> during the entire time, before the output gets turned on (<code>HIGH</code>)</p>                                                                         |
| `s1`   | Statement that is created using the system settings menu in the batterX Portal                                                                                                                                                                                   |

## Inverter Commands

```
VarName                 Entity          Description

GridInjection           0               Enable/Disable Grid Injection
BatteryCharging         0               Enable/Disable Battery Charging
BatteryChargingAC       0               Enable/Disable Battery Charging from AC
BatteryDischarging      0               Enable/Disable Battery Discharging to Load
BatteryDischargingAC    0               Enable/Disable Battery Discharging to Grid
```

Used only for **batterX Home**

| Field  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mode` | <p>Can be <code>0</code>, <code>1</code> or <code>2</code></p><ul><li><code>0</code> = The command will be ignored</li><li><p><code>1</code> = The statement from <code>s1</code> will be evaluated and:</p><ul><li>If the statement returned <code>TRUE</code>, the inverter setting will be set to <code>ENABLED</code></li><li>If the statement returned <code>FALSE</code>, the inverter setting will be set to <code>DISABLED</code></li></ul></li><li><p><code>2</code> = The statement from <code>s1</code> will be evaluated and:</p><ul><li>If the statement returned <code>TRUE</code>, the setting will be set to <code>DISABLED</code></li><li>If the statement returned <code>FALSE</code>, the inverter setting will be set to <code>ENABLED</code></li></ul></li></ul> |
| `v4`   | <p>Minimum active time for the inverter setting in <code>seconds</code></p><p>The minimum seconds that the setting must stay active before it can be deactivated</p><p>During this time the statement is not being evaluated</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `v5`   | <p>Switch-Off delay for the inverter setting in <code>seconds</code></p><p>The statement must be <code>FALSE</code> during the entire time, before the setting gets deactivated</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `v6`   | <p>Switch-On delay for the inverter setting in <code>seconds</code></p><p>The statement must be <code>TRUE</code> during the entire time, before the setting gets activated</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `s1`   | Statement that is created using the system settings menu in the batterX Portal                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

*When `mode` = `2`, `Activated` means `DISABLED`, `Deactivated` means `ENABLED`*

## Inverter Parameters (Read-only)

```
VarName                 Entity          Description

InverterParameters       0              Inverter DateTime
InverterParameters       1              Flag Status
InverterParameters       2              Energy Distribution
InverterParameters       3              LCD Active Time
InverterParameters       4              Waiting time before grid-connection
InverterParameters       5              Battery Type
InverterParameters       6              Solar Energy Priority
InverterParameters      10              Min. Grid-connected Voltage
InverterParameters      11              Max. Grid-connected Voltage
InverterParameters      12              Min. Grid-connected Frequency
InverterParameters      13              Max. Grid-connected Frequency
InverterParameters      14              Max. Grid-connected Average Voltage
InverterParameters      15              Max. Grid Feed-in Power
InverterParameters      16              Feed-in Power Factor
InverterParameters      20              Min. PV Input Voltage
InverterParameters      21              Max. PV Input Voltage
InverterParameters      22              Min. MPPT Voltage
InverterParameters      23              Max. MPPT Voltage
InverterParameters      30              Max. Battery Charging Current
InverterParameters      31              Max. Battery Charging Current From AC
InverterParameters      32              Battery Charging Voltage
InverterParameters      33              Battery Discharging Voltage
InverterParameters      34              Max. Battery Discharging Current in Hybrid Mode
InverterParameters      35              Machine Model
InverterParameters      36              Auto-adjust power factor
InverterParameters      37              Voltage and reactive power
InverterParameters      38              Over-frequency Drop Rated Power
InverterParameters      39              Grid Voltage Recovery Point
InverterParameters      40              Grid Frequency Recovery Point
InverterParameters      41              Grid Voltage Protection Point 2
InverterParameters      42              Grid Frequency Protection Point 2
```

The `InverterParameters` use only the `s1` field  to store the **value** or **list of values** (comma separated) of the `Parameter`. Part of these values are set during the installation procedure.

* **`0 - Inverter DateTime`** - (`Integer`) - *Format: `YYYYMMDDhhmmss`*<br>
* **`1 - Flag Status`** - (`List of Integers`) - `A,B,C,D,E,F,G,H,I,J,K,L,M,N`\
  \&#xNAN;*Each flag can be `0=Disabled` or `1=Enabled`*<br>
  * `A` = `Mute buzzer`
  * `B` = `Mute buzzer in standby mode`
  * `C` = `Mute buzzer in battery mode`
  * `D` = `Wide AC input range`
  * `E` = `Generator as AC input`
  * `F` = `N/G relay close in battery mode`
  * `G` = `Over-voltage derating`
  * `H` = `Over-frequency derating`
  * `I` = `BMS battery connect`
  * `J` = `Under-frequency drop power`
  * `K` = `Low-Voltage Ride Through`
  * `L` = `High-Voltage Ride Through`
  * `M` = `Soft-start AC charging`
  * `N` = `/`<br>
* **`2 - Energy Distribution`** - (`List of Integers`) - `A,B,C,D,E,F,G,H`\
  \&#xNAN;*Each flag can be `0=Disabled` or `1=Enabled`*<br>
  * `A` = `Allow battery charging`
  * `B` = `Allow battery charging AC`
  * `C` = `Allow grid injection`
  * `D` = `Allow battery discharging when PV OK`
  * `E` = `Allow battery discharging when PV not OK`
  * `F` = `Allow battery discharging to Grid when PV OK`
  * `G` = `Allow battery discharging to Grid when PV not OK`
  * `H` = `Allow Q(U) derating function`<br>
* **`3 - LCD Active Time`**<br>
  * `00` = `Always ON`
  * `01` = `30 seconds`
  * `02` = `60 seconds`
  * `10` = `5 minutes`
  * `20` = `10 minutes`<br>
* **`4 - Waiting time before grid-connection`** - (`Integer`) - *Unit: `seconds`*<br>
* **`5 - Battery Type`** - (`Integer`)<br>
  * `0` = `Li-Fe`
  * `1` = `Ordinary`<br>
* **`6 - Solar Energy Priority`** - (`Integer`)<br>
  * `0` = `Battery Load Grid`
  * `1` = `Load Battery Grid`
  * `2` = `Load Grid Battery`<br>
* **`10 - Min. Grid-connected Voltage`** - (`Integer`) - *Unit: `0.01 V`*<br>
* **`11 - Max. Grid-connected Voltage`** - (`Integer`) - *Unit: `0.01 V`*<br>
* **`12 - Min. Grid-connected Frequency`** - (`Integer`) - *Unit: `0.01 Hz`*<br>
* **`13 - Max. Grid-connected Frequency`** - (`Integer`) - *Unit: `0.01 Hz`*<br>
* **`14 - Max. Grid-connected Average Voltage`** - (`Integer`) - *Unit: `0.01 V`*<br>
* **`15 - Max. Grid Feed-in Power`** - (`Integer`) - *Unit: `1 W`*<br>
* **`16 - Feed-in Power Factor`** - (`Integer`) - *Unit: `0.01`*<br>
* **`20 - Min. PV Input Voltage`** - (`Integer`) - *Unit: `0.01 V`*<br>
* **`21 - Max. PV Input Voltage`** - (`Integer`) - *Unit: `0.01 V`*<br>
* **`22 - Min. MPPT Voltage`** - (`Integer`) - *Unit: `0.01 V`*<br>
* **`23 - Max. MPPT Voltage`** - (`Integer`) - *Unit: `0.01 V`*<br>
* **`30 - Max. Battery Charging Current`** - (`Integer`) - *Unit: `0.01 A`*<br>
* **`31 - Max. Battery Charging Current From AC`** - (`Integer`) - *Unit: `0.01 A`*<br>
* **`32 - Battery Charging Voltage`** - (`List of Integers`) - `BULK,FLOAT`<br>
  * `BULK` = `Bulk charging voltage`` `*`(Unit: 0.01 V)`*
  * `FLOAT` = `Floating charging voltage`` `*`(Unit: 0.01 V)`*<br>
* **`33 - Battery Discharging Voltage`** - (`List of Integers`) - `CH,RH,CB,RB`<br>
  * `CH` - `Cut-off voltage when Grid is available`` `*`(Unit: 0.01 V)`*
  * `RH` - `Re-discharging voltage when Grid is available`` `*`(Unit: 0.01 V)`*
  * `CB` - `Cut-off voltage when Grid is unavailable`` `*`(Unit: 0.01 V)`*
  * `RB` - `Re-discharging voltage when Grid is unavailable`` `*`(Unit: 0.01 V)`*<br>
* **`34 - Max. Battery Discharging Current in Hybrid Mode`** - (`Integer`) - *Unit: `1 A`*<br>
* **`35 - Machine Model`**<br>
  * `050` = `Hybrid VDE0126`
  * `051` = `Hybrid AS4777`
  * `052` = `Hybrid DK`
  * `053` = `Hybrid RD1663`
  * `054` = `Hybrid G83`
  * `055` = `Hybrid TaiWan`
  * `056` = `Hybrid USH`
  * `057` = `Hybrid USL`
  * `058` = `Hybrid VDE4105`
  * `059` = `Hybrid Korea`
  * `060` = `Hybrid HongSun`
  * `061` = `Hybrid Sweden`
  * `062` = `Hybrid NRS097`
  * `063` = `Hybrid Indian`
  * `064` = `Hybrid EN50438`
  * `065` = `Hybrid Czech`
  * `066` = `Hybrid DanMark`
  * `067` = `Hybrid Finland`
  * `068` = `Hybrid Ireland`
  * `069` = `Hybrid Norway`
  * `070` = `Hybrid CEI-021`
  * `071` = `Hybrid G59`
  * `072` = `Hybrid NZLD`
  * `073` = `Hybrid Cyprus`
  * `074` = `Hybrid TOR`
  * `075` = `Hybrid EN50549`
  * `076` = `Hybrid G98`
  * `100` = `Grid VDE0126`
  * `101` = `Grid AS4777`
  * `102` = `Grid DK`
  * `103` = `Grid RD1663`
  * `104` = `Grid G83`
  * `105` = `Grid TaiWan`
  * `106` = `Grid USH`
  * `107` = `Grid USL`
  * `108` = `Grid VDE4105`
  * `109` = `Grid Korea`
  * `110` = `Grid HongSun`
  * `111` = `Grid Sweden`
  * `112` = `Grid NRS097`
  * `113` = `Grid Indian`
  * `114` = `Grid EN50438`
  * `115` = `Grid Czech`
  * `116` = `Grid DanMark`
  * `117` = `Grid Finland`
  * `118` = `Grid Ireland`
  * `119` = `Grid Norway`
  * `120` = `Grid CEI-021`
  * `121` = `Grid G59`
  * `122` = `Grid NZLD`
  * `123` = `Grid Cyprus`
  * `124` = `Grid TOR`
  * `125` = `Grid EN50549`
  * `126` = `Grid G98`
  * `150` = `Off-Grid`
  * `151` = `Off-Grid 3`<br>
* **`36 - Auto-adjust power factor`** - (`List of Integers`) - `FLAG,PERC,POWF`<br>
  * `FLAG` = `0=Disable`, `1=Enable`
  * `PERC` = `Start power percentage of auto-adjusting`` `*`(10 to 90 %)`*
  * `POWF` = `Minimum power-factor when power reach 100%`` `*`(90 to 99 x0.01)`*<br>
* **`37 - Voltage and reactive power`** - (`List of Integers`) - `QP,U1,U2,U3,U4`<br>
  * `QP` = `Maximum reactive power`` `*`(Unit: 1 VAR)`*
  * `U1` = `Reduce rated power point 1`` `*`(Unit: 0.01 V)`*
  * `U2` = `Reduce rated power point 2`` `*`(Unit: 0.01 V)`*
  * `U3` = `Reduce rated power point 3`` `*`(Unit: 0.01 V)`*
  * `U4` = `Reduce rated power point 4`` `*`(Unit: 0.01 V)`*<br>
* **`38 - Over-frequency Drop Rated Power`** - (`List of Integers`) - `DRP,DRS,TDT`<br>
  * `DRP` = `Drop rated power point`` `*`(5020 to 5050 x0.01 Hz)`*
  * `DRS` = `Drop rated power slope`` `*`(10 to 100 %)`*
  * `TDT` = `Trigger delay time`` `*`(0 to 2 seconds)`*<br>
* **`39 - Grid Voltage Recovery Point`** - (`List of Integers`) - `OVRP,UVRP`<br>
  * `OVRP` = `Over-voltage recovery point`` `*`(Unit: 0.01 V)`*
  * `UVRP` = `Under-voltage recovery point`` `*`(Unit: 0.01 V)`*<br>
* **`40 - Grid Frequency Recovery Point`** - (`List of Integers`) - `OFRP,UFRP`<br>
  * `OFRP` = `Over-frequency recovery point`` `*`(Unit: 0.01 Hz)`*
  * `UFRP` = `Under-frequency recovery point`` `*`(Unit: 0.01 Hz)`*<br>
* **`41 - Grid Voltage Protection Point 2`** - (`List of Integers`) - `OVPP,UVPP`<br>
  * `OVPP` = `Over-voltage protection point 2`` `*`(Unit: 0.01 V)`*
  * `UVPP` = `Under-voltage protection point 2`` `*`(Unit: 0.01 V)`*<br>
* **`42 - Grid Frequency Protection Point 2`** - (`List of Integers`) - `OFPP,UFPP`<br>
  * `OFPP` = `Over-frequency protection point 2`` `*`(Unit: 0.01 Hz)`*
  * `UFPP` = `Under-frequency protection point 2`` `*`(Unit: 0.01 Hz)`*
