assets/img/logo.svg
Configurator

Models

This guide explains how to manage device models, import them from VireoXrepository, and configure revisions.

What is a model

A model is a template that defines:

  • The type of device (e.g., inverter, turbine, generic device)
  • The vendor (manufacturer)
  • The nominal power of the device
  • The revision (version) of the model
  • The tree template that describes the device variable structure

Each device in the system is associated with a model. When you configure a plant, devices are linked to their corresponding models.

Each model:

  • can have multiple revisions
  • can be imported from VireoXrepository or uploaded locally
  • can be updated when new revisions are available
  • can be deleted only if not used by any device

Overview of Models page

When you open the Models page, you see the list of all imported models, each model is displayed as a card.

Information shown on the card

  • Model name
  • Vendor
  • Latest revision number
  • Number of available revisions
  • Nominal power (if available)
  • Number of devices using the model
  • Type icon (solar, wind, or generic)
  • Update available indicator (orange icon)

The page provides tools to filter and search models:

  • Type filter — Solar, Wind, Other (chip multi-select)
  • Vendor filter — Filter by manufacturer (multi-select dropdown)
  • Search bar — search by model name or vendor

A counter shows how many models are visible out of the total.

Sorting

Click the sort button to cycle through sorting modes:

ModeDescription
AlphabeticalSort by model name (A-Z)
VendorGroup by vendor, then alphabetical
DevicesSort by number of devices using the model (descending)

Main actions

  • Connect to Repository → authenticate with VireoXrepository to enable remote operations
  • Remote Tools (after authentication) → import, update all, delete unused, reset
  • Upload → upload a local .vrx model file
  • Click on a card → open model detail page

Connecting to VireoXrepository

To import or update models from the remote repository, you must first authenticate.

  1. Click Connect to Repository
  2. A popover appears with an authorization code
  3. Click the code to copy it to clipboard
  4. Click Go to Repository to open VireoXrepository in a new tab
  5. Enter the authorization code on the repository site
  6. The system polls for authorization (every 5 seconds)
  7. Once authorized, a success notification appears
After authentication, the Remote Tools dropdown becomes available, giving access to import, update, and delete operations.
Closing the authorization popover while waiting cancels the authentication process.

Model types

The system supports different model types, each with a distinct icon and color:

TypeDescriptionIconColor
Solar (Inverter)Photovoltaic inverter modelsSunAmber
Wind (Turbine)Wind turbine modelsWindSky blue
Generic DeviceOther device typesBoxGray

Importing models from the repository

To import new models from VireoXrepository:

  1. Authenticate with the repository (see above)
  2. Click Remote ToolsImport
  3. A modal shows all available models in the repository
  4. Select the models you want to import
  5. Click Confirm
You can select multiple models to import them all at once.

Uploading a local model

To upload a model from a local file:

  1. Click Upload
  2. Select a .vrx file from your computer
  3. The model is uploaded and appears in the list
Only .vrx files are accepted.

Updating models

When new revisions are available in the repository, an orange icon appears on the model card.

Update all models at once

  1. Click Remote ToolsUpdate all revisions
  2. A modal shows all models with available updates, including:
    • Model name and type
    • Current revision → New revision
  3. Select the models you want to update
  4. Click Confirm

Update a single model

  1. Click on a model card to open the detail page
  2. Open the revision picker dropdown
  3. Click Update
  4. If a newer revision exists in the repository, it is automatically imported
  5. If already up to date, a notification confirms it
You must be authenticated with the repository to check for and pull updates.

Deleting models

Delete unused models (bulk)

  1. Click Remote ToolsDelete all unused
  2. A modal shows only models that are not used by any device
  3. Select the models you want to delete
  4. Click Confirm

Delete a single revision

  1. Open the model detail page
  2. Open the revision picker dropdown
  3. Click Delete
  4. Confirm the deletion in the warning dialog
Deleting a revision is permanent and cannot be undone. If it is the last revision of a model, the model is removed entirely.
You cannot delete a revision that is currently used by devices. The delete button is disabled and a tooltip shows how many devices are using it.

Model detail page

Click on a model card to open the detail page.

The page is organized in tabs:

Tab: Details

Hero section

At the top, you see:

  • Type icon and model name (Vendor + Name)
  • Revision picker — switch between revisions, search, pull updates, delete

Statistics

  • Number of plants where the model is installed
  • Number of devices using the selected revision
  • Nominal power (if available)

Revision description

If the selected revision has a description, it is shown in a dedicated card.

Technical IDs

  • Model ID — unique identifier of the selected revision (click to copy)
  • Tree Template ID — identifier of the associated tree template (click to copy)

Installed on

A tree view showing all plants and devices where the selected revision is installed.


Tab: Tree Template

The tree template editor allows you to view and edit the variable structure of a model.

Tree structure

The left panel shows a tree view with:

  • Folders — groups of variables organized hierarchically (separated by \ in paths)
  • Rules — individual variables with conditions

Rule details

Select a rule to see its details in the right panel:

  • Conditions — field, operation, and value that define when the rule applies
  • Translations — localized labels for the rule

Actions

  • Save — save changes to the tree template
  • Discard — revert all unsaved changes
The tree template tab is only available for models that have an associated tree template.

Tab: Error Codes

This feature is coming soon.

Tab: Power Curve

This feature is coming soon.

Revision management

Each model can have multiple revisions. Revisions represent different versions of the same model.

Revision picker

The revision picker in the model detail page allows you to:

  • Switch between revisions — click on a revision to view its details
  • Search revisions by number or description
  • Pull updates — check the repository for newer revisions
  • Delete a revision (if not in use)

The latest revision is marked with a green badge.


Permissions

Model management operations require the Configurator write permission:

ActionPermission required
View modelsNone
Import / Upload / Update / DeleteConfigurator write
Connect to repositoryConfigurator write
If you don't have write permissions, action buttons appear disabled.

Frequently asked questions

Why can't I see any models?

Models must be imported from VireoXrepository or uploaded locally. Connect to the repository and import the models you need.

What happens when I update a model?

A new revision is imported. Existing device configurations are preserved. New variables or parameters from the updated model become accessible.

Can I use multiple revisions of the same model?

Yes. Different devices can use different revisions of the same model. The revision is specified at the device level.

Why is the "Connect to Repository" button disabled?

Either you are already connected, or you don't have Configurator write permission.

How do I know if a model needs updating?

Models with available updates show an orange arrow icon on their card. You must be authenticated with the repository for update indicators to appear.

Why can't I delete a model?

A model (or revision) can only be deleted if it is not used by any device in the system. Check the "Installed on" section in the model detail to see which devices are using it.

What is a .vrx file?

A .vrx file is a packaged model file that can be uploaded directly to the system without using VireoXrepository.

Copyright © 2026