---
title: Status Register Wizard
slug: solutions/status-register-wizard
docTags: 
createdAt: 2025-08-15T14:08:59.332Z
---

A *Status Register* allows you to define a register for keeping track of the device status (either connected or disconnected). 

If for a Device the user has selected for the Column **Enable Status Register **to be TRUE, the tool will automatically add a default Status Register JSON Object.

To assist with the definition of the Status Register and ensure that the JSON Object is correctly formatted and includes all required entries, the Device Management Tool provides a Status Register Wizard.

# Access the Status Register Wizard

:::hint{type="info"}
**Notes**:

To access the Status Regsiter Wizard it is required that:

- The Column **Status Register** is not grayed out -> Column **Enable Status Register** is set to TRUE
- The entry in Column **Status Register **is not empty. -> The tool should automatically set the default Status Register JSON Object in this case.
- A **Device Name** is defined
- A **Driver Name** is selected
- A **Driver Group Name** is selected
:::

Select the respective cell in Column **Status Register** for the Device you want to define Status Register.

If all conditions are met, the **Status Register Wizard** button is shown in the Help section of the **LitmusConfiguration **ribbon.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/3n3BH8KaLvWj8KOkFUH62_image.png)

Open the Status Register Wizard by pressing the **Status Register Wizard** button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/p2_9sRGHrpR7w-IHSkstB_image.png" size="60" width="273" height="146" position="center" showCaption="false"}

The Status Register wizard will show.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ofcEVvfY_l7vPBGFI6QMe_image.png)

# Edit a Status Register Property

Select the Status Register Property you want to edit to open its **Edit **screen.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/e-yjcDBWemws-Yt3RZrfK_image.png" size="80" width="1007" height="655" position="center" showCaption="false"}

Edit the **Value **and press the **Modify **button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/wVP7ZllGfE0JLa2uDpij1_image.png" size="80" width="1003" height="652" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

If not both Name and Value are provided, the **Modify **button will remain grayed out and the property can not be saved.

The wizard also performs a verification for each entry and will show any violation in red. In this case the **Modify** button will also be grayed out to prevent the saving of any invalid Status Register Property.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/s_UUgwqFKOKXw72wN7rls_image.png)
:::

:::hint{type="info"}
**Notes**:

Some Drivers can reqire additional Status Register Properties based on what is select.

Example: The users changes the **opcode p**roperties to 180.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/K1j6-wPm5SGkBkCYdURqF_image.png" size="80" width="997" height="593" position="center" showCaption="false"}

Which adds additional Properties which the user can set.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/VeAGxbCHkNWQR0uE27nH6_image.png" size="80" width="999" height="325" position="center" showCaption="false"}
:::

## Status Register Properties with a list of Parameters as value

Some properties require a list of Paramter Sets which are shown as an array of JSON Objects of Parameter Key-Value Pairs. 
To assist with the correct formatting of this Array a Parameter Sets Wizard is available.
To open the Parameter Sets Wizard press the **Wizard** button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/CNgIoGkkGcclR1Ghr2yeV_image.png" size="80" width="1009" height="646" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

If the the Status Register Property has already Parameter Sets defined, they will be shown in the List.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/zX0zhEzuxp-Xur2u07-VU_image.png" size="80" width="1001" height="637" position="center" showCaption="false"}
:::

### Add a set of Parameter Key-Value Pair(s)

To add a new Parameter Key-Value pair, press the **Add **option from the left panel. 

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/X3qo8lUD-S9iOPSAhiGCu_image.png" size="80" width="1012" height="632" position="center" showCaption="false"}

This will add a Set of Parameter Key-Value pairs with an empty value, based on the drivers definition.
It also shows an Index which is added to help keep track of each sets definition.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TKpgHDghdwun2VLqYZaKH_image.png" size="80" width="1004" height="648" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

You can add as many sets of Parameter Key-Value Pairs as you need.

Simply press the **Add **Option again.
:::

### Edit a Parameter Key-Value Pair

Select the Parameter Key-Value pair you want to edit to open its **Edit **screen.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/qIbRMoqijY28g2csZMdB0_image.png" size="80" width="985" height="590" position="center" showCaption="false"}

Edit the **Value **and press the **Modify **button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/B7rfZJTmyP1Fa1luF2qUo_image.png" size="80" width="1011" height="645" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

If not both Name and Value are provided, the **Modify **button will remain grayed out and the Key-Value pair can not be saved.

The wizard also performs a verification for each entry and will show any violation in red. In this case the **Modify** button will also be grayed out to prevent the saving of any invalid Parameter Key-Value pair.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/KVOgZSYN8henMNLbYzBlV_image.png" size="80" width="996" height="638" position="center" showCaption="false"}
:::

### Delete a set of Parameter Key-Value Pair(s)

Select any Parameter Key-Value pair of a specific Parameter Set you want to delete, to open its **Edit **screen.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/LTNiJxNam9XeQl6n3f8___image.png" size="80" width="999" height="622" position="center" showCaption="false"}

To delete the entire set of Parameter Key-Value Pair(s) press the **Delete **button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Fm3synEPRBZhw5rlKxuES_image.png" size="80" width="999" height="622" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

It is not possible to delete individual Parameter Key-Value pairs from a Set. As the entire Set is required by the driver to funtion.
:::

### Save all Parameter Sets

To save the array of Sets of Paramater Key-Value pairs, press the **Save **button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/8-8J4BwOf_JrwQKpuJ3HQ_image.png" size="80" width="1005" height="639" position="center" showCaption="false"}

This will add the correcly formatted Array of JSON Objects as value to the Status Register Property.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/B8_ChJwGFUwp_a3IIRQHR_image.png" size="80" width="1006" height="643" position="center" showCaption="false"}

:::hint{type="warning"}
**Important: **

This will overwrite the current value of the Status Register property in the value field.

**But it does not save the change.**

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ehMAz4OEM83X2HPRFFW-e_image.png" size="80" width="1006" height="643" position="center" showCaption="false"}
:::

### Cancel the Parameter Sets Wizard

If a user decides to not save the current Sets of Parameter Key-Value Pairs, they can press the **Cancel **button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/lXfE0mS_RPeBJbtsNwjtV_image.png" size="80" width="995" height="592" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

This will not overwrite the value in the Value field for the Status Register Property.
:::

## Accept the Array of JSON Objects as value

To fully save the array as actual value for the Status Register Property, press the Modify button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/2Hk_GIS_ycJsIVf4xthro_image.png" size="80" width="1020" height="636" position="center" showCaption="false"}

# Save the Status Register Properties

To save all the Status Register Properties as a new Status Register JSON Object, press the **Save **button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/xv0DHT2IE5xvQCCN1J_ZR_image.png" size="80" width="1004" height="649" position="center" showCaption="false"}

This will create the correctly formatted Status Register JSON Object and store it in column **Status Register** for the device.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/wCLk5BWqGUY08KhzFm9Sr_image.png)

:::hint{type="warning"}
**Important: **This will overwrite the current value in column **Status Register**.
:::

# Cancel the Status Register Wizard

If a user decides to not save the current Status Register Wizard configuration, they can press the **Cancel **button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Zgsb9tcvm951y7-6Ul2iw_image.png" size="80" width="1414" height="678" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

This will not overwrite the  current value in column **Status Register**.
:::