1. Home
  2. Docs
  3. Zerynth Device Manager
  4. Getting started
  5. The ZDM web user interface

The ZDM web user interface

Go to https://zdm.zerynth.com and login with your zerynth account, you will reach the ZDM home page.

Home Page

From here you can get an overview of your workspaces, search for them and add new ones. 

Each registered user has the “Default Workspace” endowed with the “Default Fleet” that can be used for starting with the ZDM. You can easily add more workspaces and fleets if needed. The Default workspace can’t be deleted.

Keep your project well organized! We suggest using a new workspace for each new project.

Add new Workspace

To add a new workspace, just click the “new Workspace” button on the ZDM home page, indicate the name and optionally add a description and some fleets.

After clicking “Add” the new workspace will be added to the home ready to be managed.

If you don’t indicate any fleet in the form, the default fleet will be created automatically.

Workspace

To open a workspace just click on its tile in the homepage grid. The workspace page allows you to configure the workspace, manage associated devices, create gates and lunch jobs on your devices.

Configuration

The configuration button:    is used to:

  • delete the fleets (you can delete only empty fleets)
  • delete the workspace itself (only if it doesn’t contains devices)

Fleets Management

On the configuration page, you can view and delete fleets by clicking on the recycle bin icon.

Delete a Workspace

Further down the configuration window, you can find the button to permanently delete the workspace. Remember: only workspaces that do not have devices inside can be deleted.

Gates

Gates are the interfaces of the ZDM with external services. The ZDM aggregates data published by your devices into gates that can be exposed to external services via: webhooks and MQTT (coming soon). Gates for specific third party services are also available: we currently support Ubidots, many others will come soon.

Add new Gate

To add a new GATE click on the Add new Gate button, and select the type of Gate you want to create. The new gate form will open.

Webhook

For the Webhook gate, you have to fill the form with: 

  1. The Gate’s name; 
  2. The URL of the endpoint that will receive your data;
  3. the sending period expressed in seconds; 
  4. Select the tag you want agg to aggregate in the gate stream. in Future gates will also support multiple tags.
  5. A token (if needed).

Ubidots GATE

 In the Ubidots gate creation form you will find the Ubidots address url pre-filled. To add a Ubidots webhook you need to add the “device label” of the Ubidots device where you want to receive the data. If you have already created a device on Ubidots, copy it here otherwise insert a device name you prefer (without spaces) and ubidots will create it automatically when the ZDM gate is created. The Ubidots token can be copied from the Ubidots API credential section of the Ubidots user menu. In the Example 2 of this guide you will find more details on how to create a device in Ubidots.

View, activate/deactivate, modify and delete a Gate

Once created, the Gates are added to the Gates tab, and from here it is possible to activate/deactivate them, edit and delete them.

My Devices

At the bottom of the workspace page, you will find the list of the devices associated.

Devices can be filtered by fleets and ordered by creation date. Through the table you can see the “FOTA Status“, so if the device has never received a FOTA you will see: “Never Done”, or “Firmware Version + Data” of the last succesful FOTA update. In the device tab you can also get information about the last message sent by the device to the ZDM.

Selecting one or more devices from the list you can perform mass operations such as FOTA, Custom RPC, Device Reset and other bulk actions that can be selected from the drop down menu on the left.

Add new Fleet

You can add a new fleet on the Workspace  using the “Add new Fleet” button. The form allows creating multiple fleets, just click the “+ add fleet” button, fill the form and click “Add” at the bottom of the dialog.

Add new Device

Just click on the “Add new Device” button on the workspace page. You will be prompted with the device creation form. Here, just fill in “Device Name” and select the fleet to which the device will be associated from the drop-down menu.

Once successfully created, the screen will show the device id and the Password required for device authentication on the ZDM. Please copy the password and the device id, you will need to paste it in the Zerynth Device firmware or in your ZDM client lib based application.

The device created form also reports a ready to copy code that you can easily paste in the ZDM lib and in the ZDM client lib examples.

Very important: for security reasons, device’s password can’t be re-visualized. So, once this window will be closed you will no longer be able to retrieve the generated password!. 

If you lose a device password you can always regenerate it from the specific device page. Device pages can be opened by clicking on each device name in the device list.

Regenerate device password

Bulk Actions

With the bulk actions you can do:

  • Delete a device
  • (many other will be added soon)

just select one or more devices from the table, choose one of the actions in bulk from the drop-down menu and click on “Apply”

FOTA

The FOTA (Firmware Over The Air) update procedure is used to update the firmware of one or more devices remotely.

Important: In order to perform the FOTA of a device you need to virtualize it with a “Fota Enabled” virtual machine.

The first step to start a FOTA update on your devices is to prepare and upload a firmware to the ZDM cloud.

To upload your firmware, open the Zerynth Studio (Note: Zerynth studio v. 2.5.0 or higher is required). Open the project you want to compile and use for the FOTA and click on the Zerynth Device Manager Icon on the left vertical menu.

Now click on the ZDM FOTA Prepare orange button.

Select the ZDM device you want to update and indicate a univoque firmware version identifier (you can’t reuse a version identifier previously used), click prepare.

When the firmware preparation and upload process will be completed Zerynth Studio will prompt you to another window. If you want to go ahead with the FOTA procedure click Open ZDM GUI.

You will be redirected to the ZDM selected device page.

Just click FOTA, select the firmware you just uploaded and click Start.

The FOTA procedure will be scheduled on your device. Refresh the device Status form and you will see the status of the FOTA procedure.

Jobs

Jobs are device actions that the ZDM will be scheduled. Jobs need to be enabled on device firmware associating the functions that will be called when a job request is received.

Once your device or devices are online and programmed with custom Jobs, you can select one or more devices and click the “Jobs” button.

A dialog will come up, which will summarize the list of devices you have selected. 

You will see a cascader with the Jobs that are common to all the devices you have selected. 

Select one, optionally fill in the text box below with the arguments if required, and click the “Launch” button.

Note: If the selected devices do not have common Jobs, or if you select devices without custom Jobs defined in the firmware you will get the: “No Jobs found” message.

Device Page

On the page of a specific device, you will see the info about that device, then the name, the creation date, workspace and fleet of belonging, etc.

In addition you will see the Tag Console, which will show you in real time the data that that device is publishing in a specific tag.

At the top you can see some summary information on your device such as name, id, fleet to which it belongs, associated tags, the firmware version, the status of the jobs called and the last time your device was seen online.

Data Console

At the end of device pages, you can find the Data Console, it allows you to see what data your device publishes in real time.

By clicking in the left checkboxes you can better navigate the published data, they will be presented on the right in the “Show selected Data” box.