Ampio Designer

  • Document number: PO-198-EN
  • Version: 4.0
  • Date of publication: November 22, 2023


Introduction

Ampio Designer is a system configuration software. This tutorial introduces key functionalities of this software.

Ampio Designer supports the configuration of modules with the following softwares:

  • from version 10400 for modules with version starting from 10XXX (exception is M-RT-s where version 10600 is required)
  • from version 11500 for modules with version number starting from 11XXX
  • from version 403 of the server image

The Ampio Designer software features interoperability with the CAN configurator and the Smart Home Manager application, which means that they are fully compatible with each other. The configuration of one installation can therefore be carried out in any of these applications and any changes made will be available simultaneously in all three applications.

Connecting

Once the server is powered up, there are two options:
  • connecting M-SERV-s to the LAN network,
  • creating a hotspot in M-SERV-s (more details are available in the document M-SERV server configuration),

The display on the M-SERV-s module will show the IP address of the device, which must be entered into a web browser. After entering the IP, Ampio Designer will start.

First configuration

  • setting the system password,
  • activating the necessary functions,
  • selecting the time zone

Logging into an existing installation

A prerequisite for running Ampio Designer on an existing installation is to update the SD card image and configure the M-SERV-s module password. For a detailed description of this process, please refer to the M-SERV module’s SD card update guide.

If M-SERV-s already has a password configured, then you can access the installation in two ways:

Locally

As in the case of the first configuration, enter the IP address of the device in the search bar of your browser.

A login screen will appear from which you can:

  • download the file to update it offline,
  • cache offline updates,
  • log in by entering a password.

Click to enlarge and open in a new tab.

Via a website

Ampio Designer can also be launched through the designer.ampio.com website. From the site, you can configure the system:

  • locally: by entering the server IP and password,
  • via the cloud: by logging in to installations that are added to Ampio Cloud,
  • using remote support: which is accessed from the Ampio UNI application,
  • offline: by uploading a project file.

Interface components

Ampio Designer top bar

On the top bar of Ampio Designer, it is possible to access the following tabs:

On the right side of the top navigation bar, the following functions can also be accessed:

  • Manage project - options to download or upload a project,
  • Tools - cleaning the database, generating a warranty card for the installation, and uploading offline updates that can be downloaded at the login screen,
  • Restore backup - restoring the Ampio UNI application’s database,
  • Download backup - downloading the Ampio UNI application’s database, Node-Red database, or logs,
  • Language selector - the Ampio Designer tool is available in a couple of languages that can be selected here,
  • Search - after typing in a selected phrase, you can get to the place where the phrase occurs,
  • Toggle colour scheme - the software is available in daytime, as well as nighttime modes

Click to enlarge and open in a new tab.

Ampio Designer bottom bar

The bottom bar of Ampio Designer provides developer information such as:

  • M-SERV-s version for the Ampio UNI application,
  • Identification number of M-SERV-s,
  • Broker version of MQTT,
  • Image number of M-SERV-s,

Click to enlarge and open in a new tab.

Devices tab

This tab displays all devices connected to the CAN network.The table of devices is divided into columns, in which, you can do the following:
  • # - select the module in order to enable options to download data from the device, restart the device or remove the device from the list if it is offline,
  • Ampio MAC - read the MAC address of the device,
  • User MAC - read and assign own MAC address to the device,
  • Soft - check the current device software and update it; the bar under the software number displays the current memory usage of the respective module,
  • Symbol - symbol indicating the type of module,
  • Name - read and assign a custom name to the module,
  • Location - read and assign a location of the module; the location column also gives the ability to identify the device - when a device is turned on, its CAN diode lights up, which allows you to find the module in the distribution board. If it is a panel, its backlight will keep turning on and off.
  • PCB - module hardware version number,
  • Config - go to the device settings

On the right side above the list of devices, you will find:

  • Smart search - after typing a phrase, the list of devices will be searched,
  • Refresh - refreshes the list of devices that are on the CAN network,
  • Show/Hide offline - offline devices can be shown or hidden from the list of devices,
  • Show/Hide unsupported - devices not supported in Ampio Designer can be shown or hidden from the list of devices,
  • Show/Hide filters - filters for the list of devices,
  • Show/Hide columns - adjusts the number of columns displayed,
  • Toggle full screen - hides the Ampio Designer tab bar.

Click to enlarge and open in a new tab.

Device settings

Clicking on the settings icon next to the selected device opens up a new window with tabs:

  • Functionalities - a preview of all current functionalities of a given module,
  • Conditions - access to the conditions in the memory of a given device,
  • Parameters - parameters related to a given type of device.

Locations tab

One of the most important things you can do at the beginning of system programming is to name the locations.

In this tab, by pressing the “plus” button, you can create places/locations to which you will assign specific devices or their flags, inputs/outputs, etc. The tab has two lists:

  • devices
  • locations

Both, before adding objects to a location and after, you can give them names.

Adding an object to a location can be done in two ways:

  • moving an object directly from the device list to the location list.

  • selecting a location from the list after displaying the objects

Logic tab

In this tab you can define all the logic of the devices in the CAN network. On the right side of the top bar you will find:

  • a list of locations created in the location tab,
  • a search engine for conditions and events,
  • an option to import/export conditions/events from a file,
  • a button to scroll the list to events, which are always at the bottom of the list.

And on the left side of the top bar, there are two basic functions:

  • add a condition

Click to enlarge and open in a new tab.

  • add an event

Click to enlarge and open in a new tab.

It is good practice to select a location from the search engine found in the top bar when creating a condition/event. This gives us a narrowed list of devices available at that location. By using the smart input/output search engine, you can significantly shorten the time spent on creating conditions.

Application tab

In this tab, you can create the view of the mobile application for the end customer. Similarly to the Location tab, you can create the groups/rooms that will be visible in the app with the use of the plus button . By creating locations in advance, you can speed up the process significantly.

Each group can be independently managed, devices can be configured, floor plans can be uploaded and icons can be assigned to groups. For each device in the group, personalised settings are available, depending on the facility type.

Settings tab

This tab allows you to customise your system.

USERS

The list of Ampio system users is displayed here. On the right side is the “Add new user” button. By pressing it, you can create a login and password with which the specific user will log into the Ampio UNI application.

Each user can be granted the following rights:

  • Allow adding scenes
  • Allow editing a heating schedule
  • Allow editing the active devices in application
  • Allow editing a server in application
  • Allow remote control from application
  • Allow changing power of a device in application
  • Allow changing device names in application
  • Allow changing the cloud connection settings
  • Allow to access the automation
  • Allow to access the parameters
  • Allow to access the statistics
  • Allow to access the garden irrigation
  • Allow to access message centre
  • Allow to send notifications to all users (automation)
  • Allow to access presence detection
  • Allow to access presence simulation
  • Allow to send events to CAN
  • Allow to send notifications

SIP

From this tab, you can enable or disable SIP service in M-SERV-s or connect to an external SIP provider and manage SIP users.

Click to enlarge and open in a new tab.

NETWORK

M-SERV-s' network settings can be managed here:

SYSTEM

In this tab you have access to the information about M-SERV-s' memory. Here you can modify your time zone and change the time settings in M-SERV-s. The tab also includes tools such as:

  • Change password
  • Update system/Update offline - Ampio system, MQTT, Ampio Designer, Ampio server
  • Enable/disable Node-Red
  • Enable/disable SSH
  • Add to cloud
  • Connect to KNX
  • Restart server

Click to enlarge and open in a new tab.

The ‘Update System’ option not only allows the system to be updated to the latest version, but also for it to be reverted to previously released versions of the software.

RESOURCES

This tab shows the basic resources that the Ampio system contains. Also, you can create or delete events here. When you run the application for the first time, you will see 255 basic events. If you want to use extended events in the Ampio UNI application, you need to add them to the resources.

ICONS

This tab includes an overview of all the icons that are used in the Ampio UNI application. You can change, add or delete them. You can also upload your own custom-designed icons.

Click to enlarge and open in a new tab.

PARAMETERS

In this tab you can edit the default values that are uses in functions when creating conditions, which leads to speeding up your configuration process.

PREFERENCES

This tab was created with the idea of making Ampio Designer more personalised. Currently, there are limited functionalities available here (an option to display linear values as percentages), which will be expanded on in the next stages of planned software development works.

Click to enlarge and open in a new tab.

INTEGRATIONS

In this tab you can add and edit integrations on your M-SERV-s. Integrations can be triggered in three ways:

  • via an event
  • via a rising edge (binary flag on M-SERV-s)
  • via a falling edge (binary flag on M-SERV-s)

In the “action” window, the following options are available:

  • PUSH notifications,
  • download URL,
  • run BASH function,
  • send SMS,
  • scene management,
  • IP radio management.

BACKUPS

Backups in Ampio Designer are created automatically when you log into the software. Backups can also be created manually or uploaded from a file. Each backup can be downloaded, restored or deleted.

Click to enlarge and open in a new tab.

LOGS

In this tab, it is possible to access changes in the status of devices and events existing in the Ampio UNI application. This is a diagnostic tab that allows you to observe changes occurring in the system. You can filter them by date and time or search for a specific device.

Click to enlarge and open in a new tab.

CAN

This is a diagnostic tab that records all traffic on the CAN network. In it you can filter traffic by device, as well as by specific values in hex format.

Click to enlarge and open in a new tab.

API

In this tab, you can share API to your system.

Launching Node-RED with Ampio Designer

The process of getting Node-RED up and running is discussed in the guide Integrating the Ampio system with Node-RED.