Top Banner
FM Utrzymanie Ruchu 4.14 Instrukcja użytkownika Konfiguracja FM Maintenance eWEB FM Mobile document 14.4 EN
52

FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Apr 29, 2023

Download

Documents

Khang Minh
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

FM Utrzymanie Ruchu 4.14

Instrukcja użytkownika

Konfiguracja

FM Maintenance

eWEB FM Mobile

document 14.4

EN

Page 2: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 2 of 52

Table of Contents

Table of Contents 2

About the module 5

Document version 6

User manual - FM Maintenance 6

Installation 6

Modul FM Maintenance 7

Module support 7

Devices tab 8

Companies tab 9

Viewing device parameters according to the tree hierarchy, i.e for Campus, Building, Category 9

Maintenance tab 9

Services 9

Faults 10

Warranties 10

Legalization 11

Meters 12

View device parameters by tree hierarchy for the system/devices 13

Details 13

Maintenance 14

Model 14

ID 14

Documents 15

Relationships 15

Reports 16

Report FM Maintenance –Historical value 16

Report FM Maintenance – Consumption 17

Report FM Maintenance – Present value 18

User manual – eWEB FM Mobile 19

Installation 19

Application privacy policy eWeb FM Mobile 19

The principle of downloading and sending data from controllers 19

Configuration - FM Maintenance 20

Manage areas and devices 21

Page 3: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 3 of 52

Area 21

Device setup 22

Model information 23

Details 24

Parameters 24

Documents 25

Relationships 25

Manage device models 26

Manage companies 27

Manage floors 28

Manage graphics 28

Data import 29

Group Permissions 29

Ustawienia 30

About 30

enteliVIZ - JSON 31

Syntax 31

Possible device types 31

Inquiry 31

Companies 31

Companies Manufacturer 32

Companies Supplier 32

Companies Service 33

Devices 34

Devices Type 34

Device Device 35

Device System 36

Device System & Type 37

Documents 39

Documents Device 40

Location 40

Location System 40

Location Device 41

Location Serial 42

Location System & Device & Serial 42

Page 4: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 4 of 52

Owner Location 43

MENU Grafik 43

MENU Categories 43

MENU Graphics 43

MENU Graphics & Category 44

Models 44

Relationships 45

enteliVIZ JSON usage 46

Searching the meter by name and then displaying the electricity consumption and information about the

warranty period. 46

Page 5: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 5 of 52

About the module

FM Maintenance - is software operating in the enteliWEB environment. Integrates data typical for building

resource management systems with the BMS system.

eWEB FM Mobile - is software running under the Android operating system constituting a mobile user

interface.

Basic software functions:

Device database management

Creating a list of devices used on the site along with instructions, catalog cards, projects and serial number.

Business database management

Creating a business contact database. It is possible to assign each company a role of the type:

manufacturers, suppliers, service companies and tenants. Used to create connections between meters

and tenants or devices and manufacturers and service companies.

Easy configuration

Many predefined device types, e.g. counter, recorder, camera, SAP element, KD transition, SWiN element,

analyzer, inverter or air-conditioning unit.

Simplified menu creation mechanisms in graphics

From the menu configurator level it is possible to create a graphic menu appearance with icons displayed

in the menu.

System for managing reviews and failures

Control over periodic reviews of devices and installations. Verification of activities performed by the service.

Full reporting on the course of a service action or failure removal process.

An extensive system of additional reports

The system is equipped with a set of dedicated reports enabling the sending of media billing statements

to email.

Full integration with the enteliWEB BMS system

Access to data and values from controllers such as electrical measurements, operating parameters,

input / output states or setpoints. For the mobile application, login details and user rights identical to those

defined in enteliWEB.

Full integration with enteliVIZ

Along with the module, the enteliVIZ component library is provided to allow you to download any

information from the module.

Dedicated media settlement mechanism

The implemented media settlement mechanism gives the opportunity to associate tenant companies with

water, gas and electricity consumption meters, along with full cyclical reporting.

Page 6: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 6 of 52

Mobile interface

Mobile application for phones and tablets with the Android operating system available from the Google

Play platform.

Support for scanning QR codes and NFC tags

The identifiers mounted next to the devices are read in the application by scanning QR codes or using NFC

communication.

Viewing device operating parameters

The application allows you to view online parameters of devices. The service technician at the device has

access to set values and current readings. It also has the ability to change these parameters.

Instant access to documentation

From the application level, with one click we can verify the serial number of the device, download its

catalog card, user manual or installation design.

Making changes to service status or failure

The application allows you to edit the status of the site, enter notes, photos of reports.

Call from the application

By accessing the contact details of service companies and manufacturers, the application allows

establishing a connection with the appropriate service company or device support department.

Document version

4.14 Introduced 2019.12.30. Includes changes in FM Maintenance 4.14 and eWEB FM Mobile 1.3.12

User manual - FM Maintenance

Installation

The module is installed via the module installer built into the enteliWEB interface.

Installation steps:

1. From https://applicationservices.deltacontrols.com/products (requires login) download the following

items:

a. PAS Plugin Manager (in a version compatible with the installed enteliWEB software)

b. BMS Reporting (in a version compatible with the installed enteliWEB software)

2. From http://pas4u.eu/en/download.html download the following items:

a. FM Maintenance (in a version compatible with the installed enteliWEB software)

b. DCPL Reports (in a version compatible with the installed enteliWEB software)

3. From the module installer level (Management / Management / Management module) install the

modules in order:

a. PAS Plugin Manager

b. BMS Reporting

c. FM Maintenance

d. DCPL Reports

Page 7: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 7 of 52

Modul FM Maintenance

Module support

Fig 1 FM Maintenance menu view.

FM Maintenance menu view:

1. Devices / Companies selection tab

2. Devices hierarchy tree

3. Parameter preview view.

2

3

1

Page 8: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 8 of 52

Fig 2 (Devices tab (on the left) Companies tab (on the right))

Devices tab

In this tab you will find all devices on the object grouped into types. "Campus" is the main type, under it are

"Building" and then "Category" and "System":

The device will be located at the very end of the tree, in the "System" type

Fig 3

1

2

Page 9: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 9 of 52

Companies tab

It allows you to create a contact book of companies such as: Name, NIP, Address, Postal Code, City, Country,

telephone, E-mail, Website. It is possible to delete a company (1) in the "Actions" section and edit parameters

(2) as well as to add a company type (Fig3):

Supplier

Service company

Tenant

Manufacturer

Adding a company is done by clicking the button and completing the mandatory fields:

Short name

Name

Web site

Data from this directory is used in the counter report.

Viewing device parameters according to the tree hierarchy, i.e for Campus, Building,

Category

Maintenance tab

Services

The tab displays a list of devices together with information about the reviews carried out. Adding an overview

is only possible after selecting a specific device in the System tree in the Maintenance tab and under the

Maintenance tab.

Fig 4

Page 10: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 10 of 52

Faults

Fig 5

Warranties

The tab displays a list of devices with the status of the Guarantee:

The line highlighted GRAY the device has no defined warranty period

The line highlighted RED device after the warranty period

The line highlighted GREEN device under warranty

Fig 6

Page 11: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 11 of 52

Legalization

The tab displays a list of counters with the status of Legalization:

The row highlighted in GRAY the device has no defined verification period

A row highlighted in RED device after the verification period

The line highlighted GREEN device with current verification

Fig 7

Page 12: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 12 of 52

Meters

The tab displays a list of counters belonging to the given category. Along with the basic parameters,

descriptions and current values.

Fig 8

Page 13: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 13 of 52

View device parameters by tree hierarchy for the system/devices

Details

This tab is used to view basic information about the device and additional graphics, previews depending on

device configuration.

Fig 9

Page 14: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 14 of 52

Maintenance

This tab is described in „Viewing device parameters according to the three hierarchy, i.e foor Campus, Building,

Category”. In addition, it is increased by two under tabs:

Model

The tab allows you to view device information.

Fig 10

ID

This tab allows you to print an individual device tag, along with a QR code for the eWEB FM Mobile application.

Fig 11

Page 15: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 15 of 52

Documents

List of documents with the option of adding more.

Fig 12

Relationships

The tab gives the possibility to pair other devices with each other.

Fig 13

Page 16: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 16 of 52

Reports

In the Plug-Ins menu there are 4 types of reports associated with the module "FM Maintenance”

Fig 14

Report FM Maintenance –Historical value

Fig 15

The report allows you to create a list of meters with readings for a selected period of time. The last sample

from the selected Time period will be selected for the report. The principle of creating reports is identical with

system reports.

Report format:

Excel

Word

Power Point

PDF

Fig 16

Page 17: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 17 of 52

Report FM Maintenance – Consumption

The report allows you to create a list of meters with readings for the beginning and end of the billing period,

along with the calculation of consumption during that period.

The last sample from the day preceding the selected period will be selected for the report and the last sample

from the day of the selected period will end.

The principle of creating reports is identical to system reports.

Fig 17

Report format:

Excel

Word

Power Point

PDF

Page 18: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 18 of 52

Report FM Maintenance – Present value

The report allows you to create a list of counters with readings from the moment the report is generated. The

current meter value saved in the controller will be read into the report.

The principle of creating reports is identical to system reports.

Fig 18

Report format:

Excel

Word

Power Point

PDF

Page 19: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 19 of 52

User manual – eWEB FM Mobile

Installation

The application is available on Google Play under the name eWebFMMobile and under the link:

https://play.google.com/store/apps/details?id=pl.deltacontrols.ewebfmmobile

(The application is available only for devices with Android version 5.0 and newer)

Application privacy policy eWeb FM Mobile

The privacy policy is available at the following link:

http://www.pas4u.eu/uploads/Moduly%20FM/Polityka%20prywatno%C5%9Bci%20aplikacji%20mobilnej%20V00.pdf

The principle of downloading and sending data from controllers

The methods of downloading data from controllers and changing their values are described in the enteliWEB

documentation, which is available at the following link:

https://help.deltacontrols.com/enteliweb/4.14/help/en/interface/html/group__interfacerestapi.html

Page 20: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 20 of 52

Configuration - FM Maintenance

From the enteliWEB configuration level, select the modules tab

Fig 19

After clicking we get a list of all available modules.

Fig 20

Page 21: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 21 of 52

There are tabs in the FM Maintenance module:

Manage areas and devices

Manage device models

Manage companies

Manage floors

Manage graphics

Data import

Group permissions

Settings

Support

About

Manage areas and devices

Area

Fig 21

1) Individual symbol - generated automatically

2) Display name

3) Type

4) Parent item

5) System owner

6) Description

7) Location

8) Floor

9) Graphic location X

10) Graphic location Y

11) Create area

Mandatory data for creating an area

1

2

3

4

5

6

7

8

9

10

11

Page 22: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 22 of 52

Device setup

Fig 24

Devices can only be added in the system type.

1) Individual symbol - generated automatically

2) Display name

3) Type

4) Notes

5) Location

6) Floor

7) Graphic location X

8) Graphic location Y

9) Installation date

10) Legalization end date

11) Warranty

12) Service interval

13) enteliVIZ graphic

Mandatory data for creating an area

1

2

3

4

5

6

7

8

9

10

11

12

13

Page 23: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 23 of 52

Model information

Fig 25

1) Choice of meter model which is configured in the tab:

Manage areas and devices

2) Meter serial number

3) Manufacturer - it is completed automatically

4) Supplier - automatically completes

5) The company that services the meter

1

2

3

4

5

Page 24: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 24 of 52

Details

Fig 26

In the device type field, select the device that interests us and fill in the fields below depending on the device,

the fields will vary.

Parameters

Fig 27

Possibility to add automation points (read, write) to a given device.

Page 25: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 25 of 52

Documents

Fig 28

Possibility to add instructions, catalog card, project, photos to a given device.

Relationships

Fig 29

The tab gives the possibility to pair other devices with each other.

Page 26: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 26 of 52

Manage device models

Fig 30

By clicking here a window is displayed where the counter name should be entered, after this

the tab "Model settings" will be displayed, where from the drop-down lists we select the manufacturer /

supplier / service company and "Documents" where you can keep documents for a given meter.

Fig 31

Page 27: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 27 of 52

Manage companies

Fig 32

It allows you to create a contact book of companies such as: Name, Tax Identification Number, Address, Postal

Code, City, Country, Telephone, Email, Website. It is possible to delete a company in the "Actions" section and

edit parameters as well as to add a company type (Fig. 32):

Supplier

Service company

Tenant

Manufacturer

Adding a company is done by clicking the button and completing the mandatory fields:

Short name

Name

Website

Data from this directory is used in the counter report.

Fig 33

Page 28: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 28 of 52

Manage floors

Fig 34

Manage graphics

Fig 35

Page 29: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 29 of 52

Data import

Fig 36

Group Permissions

Fig 37

Page 30: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 30 of 52

Ustawienia

Fig 38

About

Fig 39

Basic information about module cooperation in enteliWeb and information about system versions.

Page 31: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 31 of 52

enteliVIZ - JSON

Syntax

EnteliWEB server address + reference to the FM Maintenance module + inquiry

http://127.0.0.1 + /enteliweb/fmmaintenance/api/ + inquiry

Possible device types

Possible device types:

all -> all devices (returns a list of common properties)

standard -> standard devices

meter -> meters

rekorder -> recorders

camera -> CCTV camer

door -> door controler

vfd -> inverter

analyzer -> analyzer

firesystem -> element of the SAP system

securitysystem -> element of the SWiN system

heatingcooling -> heating / cooling unit

Inquiry

Companies

Returns a table of all companies

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/companies

Reply: [{"ID":"454b03b1-3e58-11e8-925e-0c5b8f279a64","ShortName":"SKANSKA S.A.","Name":"SKANSKA

S.A.","TaxID":"","Address":"","ZipCode":"","City":"","Country":"Polska","Phone":"","Email":"",

"WebSite":"https:\/\/www.skanska.pl\/"},{"ID":"5958bd65-3e56-11e8-925e-

0c5b8f279a64","ShortName":"Kamstrup","Name":"Kamstrup Sp. z o.o","TaxID":"","Address":"ul.

Kurzawska 9","ZipCode":"02-296","City":"Warszawa","Country":"Polska","Phone":"+48 22 577 11

00","Email":"","WebSite":"https:\/\/www.kamstrup.com\/pl-pl"},{"ID":"62002178-3e58-11e8-925e-

0c5b8f279a64","ShortName":"SKANSKA PROPERTY","Name":"SKANSKA PROPERTY

POLAND","TaxID":"","Address":"","ZipCode":"","City":"","Country":"Polska","Phone":"","Email":"

","WebSite":"https:\/\/www.skanska.pl\/o-skanska\/"},{"ID":"76c7b493-3e55-11e8-925e-

0c5b8f279a64","ShortName":"Notariusz","Name":"Notariusz","TaxID":"","Address":"","ZipCode":"",

"City":"","Country":"Polska","Phone":"","Email":"","WebSite":"http:\/\/nieznana.pl"},{"ID":"88

b4688f-3e55-11e8-925e-

0c5b8f279a64","ShortName":"\u017babka","Name":"\u017babka","TaxID":"","Address":"","ZipCode":"

","City":"","Country":"Polska","Phone":"","Email":"","WebSite":"http:\/\/nieznana.pl"}]

Answer in the form of a table:

Page 32: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 32 of 52

Companies Manufacturer

Zwraca tabelę danych producenta dla tego urządzenia

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/companies?type=manufacturer&deviceid={DEVICE_ID}

Device ID is a unique meter symbol that can be found in Manage zones and devices under no. 2

Sample symbol used in the example: 8ee4ab72-42da-11e8-925e-0c5b8f279a64

Reply: [{"ID":"5958bd65-3e56-11e8-925e-0c5b8f279a64","ShortName":"Kamstrup","Name":"Kamstrup Sp. z

o.o","TaxID":"","Address":"ul. Kurzawska 9","ZipCode":"02-

296","City":"Warszawa","Country":"Polska","Phone":"+48 22 577 11

00","Email":"","WebSite":"https:\/\/www.kamstrup.com\/pl-pl"}]

Answer in the form of a table:

Companies Supplier

Returns the provider data table for this device

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/companies?type=supplier&deviceid={DEVICE_ID}

Device ID is a unique meter symbol that can be found in Manage zones and devices under no. 2

Sample symbol used in the example: 8ee4ab72-42da-11e8-925e-0c5b8f279a64

Reply: [{"ID":"a7775f8b-3e53-11e8-925e-

0c5b8f279a64","ShortName":"Primawent","Name":"Primawent","TaxID":"","Address":"ul. Tapicerska

17A","ZipCode":"02-172","City":"Warszawa","Country":"Polska","Phone":"+48 22 573 11

20","Email":"[email protected]","WebSite":"http:\/\/www.primawent.pl\/"}]

Answer in the form of a table:

Page 33: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 33 of 52

Companies Service

Returns the service company data table for this device

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/companies?type=service&deviceid={DEVICE_ID}

Device ID is a unique meter symbol that can be found in Manage zones and devices under no. 2

Sample symbol used in the example: 1791716a-b4db-11e8-9f3b-4439c4911ee6

Reply: [{"ID":"d37b3e87-b645-11e8-821f-4439c4911ee6","ShortName":"Example","Name":"Example

company","TaxID":"123-456-123-12","Address":"","ZipCode":"12-

123","City":"Krakow","Country":"Polska","Phone":"123456789","Email":"[email protected]","Web

Site":"http:\/\/example.com"}]

Answer in the form of a table:

Page 34: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 34 of 52

Devices

Returns a table of all devices

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/devices

Reply: [{"ID":"454b03b1-3e58-11e8-925e-0c5b8f279a64","ShortName":"SKANSKA S.A.","Name":"SKANSKA

S.A.","TaxID":"","Address":"","ZipCode":"","City":"","Country":"Polska","Phone":"","Email":"",

"WebSite":"https:\/\/www.skanska.pl\/"},{"ID":"5958bd65-3e56-11e8-925e-

0c5b8f279a64","ShortName":"Kamstrup","Name":"Kamstrup Sp. z o.o","TaxID":"","Address":"ul.

Kurzawska 9","ZipCode":"02-296","City":"Warszawa","Country":"Polska","Phone":"+48 22 577 11

00","Email":"","WebSite":"https:\/\/www.kamstrup.com\/pl-pl"},{"ID":"62002178-3e58-11e8-925e-

0c5b8f279a64","ShortName":"SKANSKA PROPERTY","Name":"SKANSKA PROPERTY

POLAND","TaxID":"","Address":"","ZipCode":"","City":"","Country":"Polska","Phone":"","Email":"

","WebSite":"https:\/\/www.skanska.pl\/o-skanska\/ "}]

Answer in the form of a table:

Devices Type

Query list of devices of a specific type (if no type is given, a list of counters will be returned by

default)

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/devices?type={DEVICE_TYPE}

Device TYPE is a type of device, it can be found in the types of available devices Reply: [{"ID":"5958bd65-3e56-11e8-925e-0c5b8f279a64","ShortName":"Kamstrup","Name":"Kamstrup Sp. z

o.o","TaxID":"","Address":"ul. Kurzawska 9","ZipCode":"02-

296","City":"Warszawa","Country":"Polska","Phone":"+48 22 577 11

00","Email":"","WebSite":"https:\/\/www.kamstrup.com\/pl-pl"}]

Answer in the form of a table:

Page 35: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 35 of 52

Device Device

Inquiry about the details of the device with the given ID (contains general information and assigned to the type

of device)

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/devices?device={DEVICE_ID}

Device ID is a unique meter symbol that can be found in Manage zones and devices under no. 2

Sample symbol used in the example: 8ee4ab72-42da-11e8-925e-0c5b8f279a64

Reply: {"Building":"2cab5507-9192-11e8-a321-00ff05338e85","BuildingName":"Spark C - Liczniki En.

Ch\u0142odniczej","Category":"42617f82-919f-11e8-a321-00ff05338e85","CategoryName":"Odzysk En.

Ch\u0142odniczej","System":"100b7dbc-39a1-11e8-925e-

0c5b8f279a64","SystemName":"Freecooling","SystemOwnerID":"b3c54764-38b3-11e8-925e-

0c5b8f279a64","SystemOwnerName":"Cz\u0119\u015bci wsp\u00f3lne","SystemCode":"8ee4ab72-42da-

11e8-925e-0c5b8f279a64","DeviceID":"8ee4ab72-42da-11e8-925e-

0c5b8f279a64","DisplayName":"LECH_Odzysk_freecooling","Type":"meter","Model":"d6076768-3e56-

11e8-925e-0c5b8f279a64","ModelName":"MULTICAL

602","SerialNumber":"78558812","Manufacturer":"5958bd65-3e56-11e8-925e-

0c5b8f279a64","ManufacturerName":"Kamstrup Sp. z

o.o","ManufacturerShortName":"Kamstrup","Supplier":"a7775f8b-3e53-11e8-925e-

0c5b8f279a64","SupplierName":"Primawent","SupplierShortName":"Primawent","ServiceCompany":"","

ServiceCompanyName":"","ServiceCompanyShortName":"","Location":"","Floor":"B02","FloorName":"L

evel -

2","GraphicX":null,"GraphicY":null,"Notes":"","InstallationDate":"","LegalizationExpiry":"","N

extService":null,"Warranty":24,"ServiceInterval":3,"ObjectReference":null,"bFault":0,"ServiceT

ype":"interval","MeterType":"Thermal_Energy_Cooling","Meter":"5c4a71df-42d9-11e8-925e-

0c5b8f279a64","ReadingStandard":"","ReadingStandardEviz5":"","MeterValue":"\/\/Spark\/1000.AV1

23","MeterValueEviz5":"\/Network\/Spark\/1000\/AV123","MeterCorrection":"","MeterCorrectionEvi

z5":"","MeterRatio":"","MeterRatioEviz5":"","MeterGateway":"\/\/Spark\/58814.DEV58814","MeterG

atewayEviz5":"","MeterMbus":256,"OnlineStatus":null,"OnlineStatusEviz5":"","OnlineType":"=","O

nlineValue":null,"EnergyPath":"\/Meters\/Spark C\/Liczniki En

Ch\u0142odniczej\/LECH_Odzysk_freecooling\/Cooling_Energy_Thermal"}

Answer in the form of a table:

Page 36: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 36 of 52

Device System

Zwraca tabelę urządzeń przypisanych do systemu o podanym ID

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/devices?system={SYSTEM_ID}

System ID is a unique system symbol that can be found in Manage zones and devices under no. 2

Sample symbol used in the example: 100b7dbc-39a1-11e8-925e-0c5b8f279a64

Reply: [{"Building":"2cab5507-9192-11e8-a321-00ff05338e85","BuildingName":"Spark C - Liczniki En.

Ch\u0142odniczej","Category":"42617f82-919f-11e8-a321-00ff05338e85","CategoryName":"Odzysk En.

Ch\u0142odniczej","System":"100b7dbc-39a1-11e8-925e-

0c5b8f279a64","SystemName":"Freecooling","SystemOwnerID":"b3c54764-38b3-11e8-925e-

0c5b8f279a64","SystemOwnerName":"Cz\u0119\u015bci wsp\u00f3lne","SystemCode":"8ee4ab72-42da-

11e8-925e-0c5b8f279a64","DeviceID":"8ee4ab72-42da-11e8-925e-

0c5b8f279a64","DisplayName":"LECH_Odzysk_freecooling","Type":"meter","Model":"d6076768-3e56-

11e8-925e-0c5b8f279a64","ModelName":"MULTICAL

602","SerialNumber":"78558812","Manufacturer":"5958bd65-3e56-11e8-925e-

0c5b8f279a64","ManufacturerName":"Kamstrup Sp. z

o.o","ManufacturerShortName":"Kamstrup","Supplier":"a7775f8b-3e53-11e8-925e-

0c5b8f279a64","SupplierName":"Primawent","SupplierShortName":"Primawent","ServiceCompany":"","

ServiceCompanyName":"","ServiceCompanyShortName":"","Location":"","Floor":"B02","FloorName":"L

evel -

2","GraphicX":null,"GraphicY":null,"Notes":"","InstallationDate":"","LegalizationExpiry":"","N

extService":null,"Warranty":24,"ServiceInterval":3,"ObjectReference":null,"bFault":0,"ServiceT

ype":"interval","MeterType":"Thermal_Energy_Cooling","Meter":"5c4a71df-42d9-11e8-925e-

0c5b8f279a64","ReadingStandard":"","ReadingStandardEviz5":"","MeterValue":"\/\/Spark\/1000.AV1

23","MeterValueEviz5":"\/Network\/Spark\/1000\/AV123","MeterCorrection":"","MeterCorrectionEvi

z5":"","MeterRatio":"","MeterRatioEviz5":"","MeterGateway":"\/\/Spark\/58814.DEV58814","MeterG

atewayEviz5":"","MeterMbus":256,"OnlineStatus":null,"OnlineStatusEviz5":"","OnlineType":"=","O

nlineValue":null,"EnergyPath":"\/Meters\/Spark C\/Liczniki En

Ch\u0142odniczej\/LECH_Odzysk_freecooling\/Cooling_Energy_Thermal"},{"Building":"2cab5507-

9192-11e8-a321-00ff05338e85","BuildingName":"Spark C - Liczniki En.

Ch\u0142odniczej","Category":"42617f82-919f-11e8-a321-00ff05338e85","CategoryName":"Odzysk En.

Ch\u0142odniczej","System":"100b7dbc-39a1-11e8-925e-

0c5b8f279a64","SystemName":"Freecooling","SystemOwnerID":"b3c54764-38b3-11e8-925e-

0c5b8f279a64","SystemOwnerName":"Cz\u0119\u015bci wsp\u00f3lne","SystemCode":"d37a796f-42d9-

11e8-925e-0c5b8f279a64","DeviceID":"d37a796f-42d9-11e8-925e-

0c5b8f279a64","DisplayName":"LECH_freecooling_RAW1","Type":"meter","Model":"d6076768-3e56-

11e8-925e-0c5b8f279a64","ModelName":"MULTICAL

602","SerialNumber":"78558811","Manufacturer":"5958bd65-3e56-11e8-925e-

0c5b8f279a64","ManufacturerName":"Kamstrup Sp. z

o.o","ManufacturerShortName":"Kamstrup","Supplier":"a7775f8b-3e53-11e8-925e-

0c5b8f279a64","SupplierName":"Primawent","SupplierShortName":"Primawent","ServiceCompany":"","

ServiceCompanyName":"","ServiceCompanyShortName":"","Location":"","Floor":"B02","FloorName":"L

evel -2","GraphicX":null,"GraphicY":null,"Notes":"Freecooling centrala

RAW1\n","InstallationDate":"","LegalizationExpiry":"","NextService":null,"Warranty":24,"Servic

eInterval":3,"ObjectReference":null,"bFault":0,"ServiceType":"interval","MeterType":"Thermal_E

nergy_Heating","Meter":"1d82ddc6-42d9-11e8-925e-

0c5b8f279a64","ReadingStandard":"","ReadingStandardEviz5":"","MeterValue":"\/\/Spark\/1000.AV7

10","MeterValueEviz5":"\/Network\/Spark\/1000\/AV710","MeterCorrection":"","MeterCorrectionEvi

z5":"","MeterRatio":"","MeterRatioEviz5":"","MeterGateway":"\/\/Spark\/1000.DEV1000","MeterGat

ewayEviz5":"\/Network\/Spark\/1000\/DEV1000","MeterMbus":7,"OnlineStatus":null,"OnlineStatusEv

iz5":"","OnlineType":"=","OnlineValue":null,"EnergyPath":"\/Meters\/Spark C\/Liczniki En

Ch\u0142odniczej\/LECI_freecooling_RAW1\/Heating_Energy_Thermal"}]

Page 37: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 37 of 52

Answer in the form of a table:

Device System & Type

Query list of devices of a specific type from a given system (if no type is given, a list of counters will be returned

by default)

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/devices?system={SystemID}&type={type}

System ID is a unique system symbol that can be found in Manage zones and devices under no. 2

Sample symbol used in the example: 100b7dbc-39a1-11e8-925e-0c5b8f279a64

type is the device type, it can be found in the types of devices available

Answer for type meter: [{"Building":"f26d26f4-fe16-11e8-8fd5-

b4b52f8474eb","BuildingName":"DeltaControls","Category":"7c70179e-30f9-11e9-8773-

b4b52f8474eb","CategoryName":"Meters","System":"92169365-30f9-11e9-8773-

b4b52f8474eb","SystemName":"Area 1 Meters","SystemOwnerID":"23a68e5c-30fd-11e9-8773-

b4b52f8474eb","SystemOwnerName":"NewTech Co","SystemCode":"0c5d982d-30fa-11e9-8773-

b4b52f8474eb","DeviceID":"0c5d982d-30fa-11e9-8773-b4b52f8474eb","DisplayName":"ELE_01 - Area

1","Type":"meter","Model":null,"ModelName":"","SerialNumber":null,"Manufacturer":"","Manufactu

rerName":"","ManufacturerShortName":"","Supplier":"","SupplierName":"","SupplierShortName":"",

"ServiceCompany":"","ServiceCompanyName":"","ServiceCompanyShortName":"","Location":null,"Floo

r":"","FloorName":"","GraphicX":null,"GraphicY":null,"Notes":null,"InstallationDate":"2018-07-

18","LegalizationExpiry":"2019-02-

12","NextService":null,"Warranty":24,"ServiceInterval":null,"ObjectReference":null,"bFault":0,

"ServiceType":"interval","MeterType":"Electric_Energy_Electric","Meter":"5d48388b-1979-11e9-

a0a6-

b4b52f8474eb","ReadingStandard":"\/\/CloudDEMO\/4000.AV100101","ReadingStandardEviz5":"\/Netwo

rk\/CloudDEMO\/4000\/AV100101","MeterValue":"\/\/CloudDEMO\/4000.AV100102","MeterValueEviz5":"

\/Network\/CloudDEMO\/4000\/AV100102","MeterCorrection":"\/\/CloudDEMO\/4000.AV100103","MeterC

orrectionEviz5":"\/Network\/CloudDEMO\/4000\/AV100103","MeterRatio":"\/\/CloudDEMO\/4000.AV100

104","MeterRatioEviz5":"\/Network\/CloudDEMO\/4000\/AV100104","MeterGateway":null,"MeterGatewa

yEviz5":"","MeterMbus":null,"OnlineStatus":"\/\/CloudDEMO\/4000.BV100101","OnlineStatusEviz5":

"\/Network\/CloudDEMO\/4000\/BV100101","OnlineType":"=","OnlineValue":null,"EnergyPath":"\/Met

ers\/PAS Demo Site\/Electric - sub meters\/ELE_01 - Area

1\/Energy_Electric"},{"Building":"f26d26f4-fe16-11e8-8fd5-

b4b52f8474eb","BuildingName":"DeltaControls","Category":"7c70179e-30f9-11e9-8773-

b4b52f8474eb","CategoryName":"Meters","System":"92169365-30f9-11e9-8773-

b4b52f8474eb","SystemName":"Area 1 Meters","SystemOwnerID":"23a68e5c-30fd-11e9-8773-

b4b52f8474eb","SystemOwnerName":"NewTech Co","SystemCode":"2f2723dd-30fb-11e9-8773-

b4b52f8474eb","DeviceID":"2f2723dd-30fb-11e9-8773-b4b52f8474eb","DisplayName":"WAC_01 - Area

1","Type":"meter","Model":null,"ModelName":"","SerialNumber":null,"Manufacturer":"","Manufactu

rerName":"","ManufacturerShortName":"","Supplier":"","SupplierName":"","SupplierShortName":"",

"ServiceCompany":"","ServiceCompanyName":"","ServiceCompanyShortName":"","Location":"","Floor"

Page 38: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 38 of 52

:"","FloorName":"","GraphicX":null,"GraphicY":null,"Notes":"","InstallationDate":"2016-01-

18","LegalizationExpiry":"","NextService":null,"Warranty":24,"ServiceInterval":3,"ObjectRefere

nce":null,"bFault":0,"ServiceType":"interval","MeterType":"Water_Volume_Cold_Water","Meter":"9

dec211a-197b-11e9-a0a6-

b4b52f8474eb","ReadingStandard":null,"ReadingStandardEviz5":"","MeterValue":"\/\/CloudDEMO\/40

00.AV103102","MeterValueEviz5":"\/Network\/CloudDEMO\/4000\/AV103102","MeterCorrection":"\/\/C

loudDEMO\/4000.AV103103","MeterCorrectionEviz5":"\/Network\/CloudDEMO\/4000\/AV103103","MeterR

atio":"\/\/CloudDEMO\/4000.AV103104","MeterRatioEviz5":"\/Network\/CloudDEMO\/4000\/AV103104",

"MeterGateway":null,"MeterGatewayEviz5":"","MeterMbus":null,"OnlineStatus":"\/\/CloudDEMO\/400

0.BV103101","OnlineStatusEviz5":"\/Network\/CloudDEMO\/4000\/BV103101","OnlineType":"=","Onlin

eValue":null,"EnergyPath":"\/Meters\/PAS Demo Site\/Cold Water - sub meters\/WAC_01 - Area

1\/Volume_Water"},{"Building":"f26d26f4-fe16-11e8-8fd5-

b4b52f8474eb","BuildingName":"DeltaControls","Category":"7c70179e-30f9-11e9-8773-

b4b52f8474eb","CategoryName":"Meters","System":"92169365-30f9-11e9-8773-

b4b52f8474eb","SystemName":"Area 1 Meters","SystemOwnerID":"23a68e5c-30fd-11e9-8773-

b4b52f8474eb","SystemOwnerName":"NewTech Co","SystemCode":"e2ffbacc-30fa-11e9-8773-

b4b52f8474eb","DeviceID":"e2ffbacc-30fa-11e9-8773-b4b52f8474eb","DisplayName":"ELE_05 - FCU

system

1","Type":"meter","Model":null,"ModelName":"","SerialNumber":null,"Manufacturer":"","Manufactu

rerName":"","ManufacturerShortName":"","Supplier":"","SupplierName":"","SupplierShortName":"",

"ServiceCompany":"","ServiceCompanyName":"","ServiceCompanyShortName":"","Location":null,"Floo

r":"","FloorName":"","GraphicX":null,"GraphicY":null,"Notes":null,"InstallationDate":null,"Leg

alizationExpiry":"2021-02-

20","NextService":null,"Warranty":null,"ServiceInterval":null,"ObjectReference":null,"bFault":

0,"ServiceType":"interval","MeterType":"Electric_Energy_Electric","Meter":"4806f5d7-197b-11e9-

a0a6-

b4b52f8474eb","ReadingStandard":null,"ReadingStandardEviz5":"","MeterValue":"\/\/CloudDEMO\/40

00.AV100502","MeterValueEviz5":"\/Network\/CloudDEMO\/4000\/AV100502","MeterCorrection":"\/\/C

loudDEMO\/4000.AV100503","MeterCorrectionEviz5":"\/Network\/CloudDEMO\/4000\/AV100503","MeterR

atio":"\/\/CloudDEMO\/4000.AV100504","MeterRatioEviz5":"\/Network\/CloudDEMO\/4000\/AV100504",

"MeterGateway":null,"MeterGatewayEviz5":"","MeterMbus":null,"OnlineStatus":"\/\/CloudDEMO\/400

0.BV100501","OnlineStatusEviz5":"\/Network\/CloudDEMO\/4000\/BV100501","OnlineType":"=","Onlin

eValue":null,"EnergyPath":"\/Meters\/PAS Demo Site\/Electric - sub meters\/ELE_05 - FCU system

1\/Energy_Electric"}]

Answer in the form of a table:

Page 39: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 39 of 52

Documents

Returns a table of all documents

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/documents

Reply: [{"ID":"2cf9cbd6-6fdf-11e8-a321-00ff05338e85","Group":"model","ObjectID":"b7e08a65-3e56-11e8-

925e-0c5b8f279a64","Index":"1","Name":"2cf9cbd6-6fdf-11e8-a321-

00ff05338e85.pdf","Description":"Karta katalogowa

nak\u0142adki","Type":"CatalogSheet","FilePath":"2cf9cbd6-6fdf-11e8-a321-

00ff05338e85.pdf"},{"ID":"4dd8d57f-6fda-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"47ab0518-3f01-11e8-925e-

0c5b8f279a64","Index":"1","Name":"4dd8d57f-6fda-11e8-a321-

00ff05338e85.pdf","Description":"Karta katalogowa","Type":"CatalogSheet","FilePath":"4dd8d57f-

6fda-11e8-a321-00ff05338e85.pdf"},{"ID":"5b021d6d-6fda-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"47ab0518-3f01-11e8-925e-

0c5b8f279a64","Index":"2","Name":"5b021d6d-6fda-11e8-a321-

00ff05338e85.pdf","Description":"Instrukcja","Type":"UserManual","FilePath":"5b021d6d-6fda-

11e8-a321-00ff05338e85.pdf"},{"ID":"7bcb5d61-6fde-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"7bdf782b-42dc-11e8-925e-

0c5b8f279a64","Index":"1","Name":"7bcb5d61-6fde-11e8-a321-

00ff05338e85.pdf","Description":"Angielska instrukcja

obs\u0142ugi","Type":"UserManual","FilePath":"7bcb5d61-6fde-11e8-a321-

00ff05338e85.pdf"},{"ID":"8cfcb03f-6fde-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"7bdf782b-42dc-11e8-925e-

0c5b8f279a64","Index":"2","Name":"8cfcb03f-6fde-11e8-a321-

00ff05338e85.pdf","Description":"Skr\u00f3cona instrukcja

obs\u0142ugi","Type":"UserManual","FilePath":"8cfcb03f-6fde-11e8-a321-

00ff05338e85.pdf"},{"ID":"98f31dfb-6fdf-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"d6076768-3e56-11e8-925e-

0c5b8f279a64","Index":"1","Name":"98f31dfb-6fdf-11e8-a321-

00ff05338e85.pdf","Description":"Karta katalogowa","Type":"CatalogSheet","FilePath":"98f31dfb-

6fdf-11e8-a321-00ff05338e85.pdf"},{"ID":"a472c6a4-6fdf-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"d6076768-3e56-11e8-925e-

0c5b8f279a64","Index":"2","Name":"a472c6a4-6fdf-11e8-a321-

00ff05338e85.pdf","Description":"Instrukcja","Type":"UserManual","FilePath":"a472c6a4-6fdf-

11e8-a321-00ff05338e85.pdf"},{"ID":"c74ff476-6fde-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"b2143074-3e52-11e8-925e-

0c5b8f279a64","Index":"1","Name":"c74ff476-6fde-11e8-a321-

00ff05338e85.pdf","Description":"Angielska instrukcja

obs\u0142ugi","Type":"UserManual","FilePath":"c74ff476-6fde-11e8-a321-

00ff05338e85.pdf"},{"ID":"e381070a-6fde-11e8-a321-

00ff05338e85","Group":"model","ObjectID":"b2143074-3e52-11e8-925e-

0c5b8f279a64","Index":"2","Name":"e381070a-6fde-11e8-a321-

00ff05338e85.pdf","Description":"Skr\u00f3cona instrukcja

obs\u0142ugi","Type":"UserManual","FilePath":"e381070a-6fde-11e8-a321-00ff05338e85.pdf"}]

Answer in the form of a table:

Page 40: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 40 of 52

Documents Device

Returns the document table for the selected device

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/documents?device={DEVICE_ID}

Device ID is a unique meter symbol that can be found in Manage zones and devices under no. 2

Sample symbol used in the example: 8ee4ab72-42da-11e8-925e-0c5b8f279a64

Reply: [{"ID":"c8060f7c-b683-11e8-abaa-00ff05338e85","Group":"device","ObjectID":"8ee4ab72-42da-11e8-

925e-0c5b8f279a64","Index":"1","Name":"c8060f7c-b683-11e8-abaa-

00ff05338e85.txt","Description":"Example

description","Type":"CatalogSheet","FilePath":"c8060f7c-b683-11e8-abaa-00ff05338e85.txt"}]

Answer in the form of a table:

Location

Location System

Returns data about the location of the system with the given name

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/location?system={SYSTEM_DISPLAYNAME}

System Display Name is the name of the system it can be found in Manage zones and devices under no. 1

Sample System Display Name used in the example: Freecooling

Reply: {"Location":null,"Floor":"","X":null,"Y":null,"SystemID":"100b7dbc-39a1-11e8-925e-

0c5b8f279a64","SystemDisplayName":"Freecooling","DeviceID":"","DeviceDisplayName":"","DeviceTy

pe":"","DeviceMeterType":"","DeviceSerialNumber":""}

Answer in the form of a table:

Page 41: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 41 of 52

Location Device

Returns location data for the device with the given name

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/location?device={DEVICE_DISPLAYNAME}

Device Display Name is the device name you can find in Manage zones and devices under no. 1

Sample Device Display Name used in the example: LECH_Odzysk_freecooling

Reply: {"Location":"","Floor":"B02","X":null,"Y":null,"SystemID":"100b7dbc-39a1-11e8-925e-

0c5b8f279a64","SystemDisplayName":"Freecooling","DeviceID":"8ee4ab72-42da-11e8-925e-

0c5b8f279a64","DeviceDisplayName":"LECH_Odzysk_freecooling","DeviceType":"meter","DeviceMeterT

ype":"Thermal_Energy_Cooling","DeviceSerialNumber":"78558812"}

Answer in the form of a table:

Page 42: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 42 of 52

Location Serial

Returns data regarding the location of the device with the serial number provided

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/location?serial={DEVICE_SERIALNUMBER}

Device Serial Number is the serial number of the device you can find it in Manage zones and devices under

no. 2 Sample Device Serial Number used in the example: 78558812

Reply: {"Location":"","Floor":null,"X":null,"Y":null,"SystemID":"100b7dbc-39a1-11e8-925e-

0c5b8f279a64","SystemDisplayName":null,"DeviceID":"8ee4ab72-42da-11e8-925e-

0c5b8f279a64","DeviceDisplayName":"LECH_Odzysk_freecooling","DeviceType":"meter","DeviceMeterT

ype":"Thermal_Energy_Cooling","DeviceSerialNumber":"78558812"}

Answer in the form of a table:

Location System & Device & Serial

Inactive in this version of the module, prepared for further development.

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/location?system={SYSTEM_DISPLAYNAME}&device={DEVICE_D

ISPLAYNAME}&serial={DEVICE_SERIALNUMBER}

System Display Name jest to nazwa systemu można ją znaleźć w Zarządzaj strefami i urządzeniami pod

nr 1

Przykładowy System Display Name użyty w przykładzie: Freecooling

Device Display Name jest to nazwa urządzenia można ją znaleźć w Zarządzaj strefami i urządzeniami pod

nr 1

Przykładowy Device Display Name użyty w przykładzie: LECH_Odzysk_freecooling

Device Serial Number jest to numer seryjny urządzenia można go znaleźć

w Zarządzaj strefami i urządzeniami pod nr 2

Przykładowy Device Serial Number użyty w przykładzie: 78558812

Reply: []

Odpowiedź w formie tabeli:

Page 43: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 43 of 52

Owner Location

Returns location data for all meters and their parent systems

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/ownerlocation

Reply: {"Location":"","Floor":"","X":"","Y":"","SystemID":"","SystemDisplayName":"","DeviceID":"","De

viceDisplayName":"","DeviceType":"","DeviceMeterType":"","DeviceSerialNumber":""}

Answer in the form of a table:

MENU Grafik

MENU Categories

Returns data for all categories in the menu

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/menucategories

Reply: [{"Project":"","Name":"Menu","Order":1,"Icon":null}]

Answer in the form of a table:

MENU Graphics

Returns the data of all graphics

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/menugraphics

Reply: {"Location":"","Floor":"","X":"","Y":"","SystemID":"","SystemDisplayName":"","DeviceID":"","DeviceDisplayName":"","DeviceType":"","Devi

ceMeterType":"","DeviceSerialNumber":""}

Answer in the form of a table:

Page 44: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 44 of 52

MENU Graphics & Category

Returns data for all graphics in the given category

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/menugraphics?category={categoryID}

Reply: {"Location":"","Floor":"","X":"","Y":"","SystemID":"","SystemDisplayName":"","DeviceID":"","DeviceDisplayName":"","DeviceType":"","Devi

ceMeterType":"","DeviceSerialNumber":""}

Answer in the form of a table:

Models

Returns data for all device models

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/models

Reply: [{"ID":"8f8ff1bd-ddcd-11e9-a7dd-bbf7860c3e8b","Name":"Centrala AHU1 Typ

AF","Description":null,"Manufacturer":"c6cd3c6d-dbb5-11e9-916e-

53c96c4ee9ff","ManufacturerName":"Frapol","ManufacturerShortName":"Frapol","Supplier":"af8070e

e-dbb3-11e9-9cf0-e7e22b2f709c","SupplierName":"Best Delta Partner","SupplierShortName":"Best

Delta Partner","ServiceCompany":"cc32c068-dbb3-11e9-b786-

7fa36a39cacb","ServiceCompanyName":"Best Delta Service","ServiceCompanyShortName":"Best Delta

Service"},{"ID":"cdf26ddd-7478-11e8-8ca6-509a4c85925e","Name":"TT-322-

DC","Description":"Czujnik temperatury kana\u0142owy 150mm\n","Manufacturer":"f4a47ab8-72fc-

11e8-8ca6-509a4c85925e","ManufacturerName":"Delta Controls","ManufacturerShortName":"Delta

Controls","Supplier":"c032acb9-dacd-11e9-a3ba-0fa654899149","SupplierName":"GEO-KAT Sp. z

o.o.","SupplierShortName":"GEO-KAT Sp. z o.o.","ServiceCompany":"c04daaa4-dacd-11e9-a3ef-

d3f76fc62040","ServiceCompanyName":"Polmar Gr\u0119dziak Sp. z

o.o.","ServiceCompanyShortName":"Polmar Gr\u0119dziak Sp. z o.o."},{"ID":"16c0c457-7478-11e8-

8ca6-509a4c85925e","Name":"ACH580-01-017A-4+J400+K465","Description":"Przemiennik

cz\u0119stotliwo\u015bci, 380-400V, 17A, 7.5kW, IP21, filtr RFI C2, BACnet,

Modbus\n","Manufacturer":"1eeafc64-dbb2-11e9-8aa7-

7f538753171e","ManufacturerName":"ABB","ManufacturerShortName":"ABB","Supplier":null,"Supplier

Name":null,"SupplierShortName":null,"ServiceCompany":null,"ServiceCompanyName":null,"ServiceCo

mpanyShortName":null},{"ID":"64a20a6a-7478-11e8-8ca6-

509a4c85925e","Name":"LF24","Description":"Si\u0142ownik przepustnicy 0,8m2, 4Nm, 24VAC\/DC,

on-off, spr\u0119\u017cyna\n","Manufacturer":"2b758291-dbb2-11e9-be52-

8f63681b9558","ManufacturerName":"Belimo","ManufacturerShortName":"Belimo","Supplier":null,"Su

pplierName":null,"SupplierShortName":null,"ServiceCompany":null,"ServiceCompanyName":null,"Ser

viceCompanyShortName":null},{"ID":"0eaeb274-7479-11e8-8ca6-509a4c85925e","Name":"eZNS-T100C-

ND-R-xxx-xxx","Description":"Nastawnik sieciowy, bez LCD, temp, CO2, 1xUI, monta\u017c

podtynkowy CO2\n","Manufacturer":"f4a47ab8-72fc-11e8-8ca6-

509a4c85925e","ManufacturerName":"Delta Controls","ManufacturerShortName":"Delta

Controls","Supplier":null,"SupplierName":null,"SupplierShortName":null,"ServiceCompany":null,"

ServiceCompanyName":null,"ServiceCompanyShortName":null}]

Answer in the form of a table:

Page 45: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 45 of 52

Relationships

Returns data for all device associations

Structure:

http://127.0.0.1/enteliweb/fmmaintenance/api/relationships

Reply: [{"ID":"a8fa1fbd-dbb4-11e9-a6a3-0788216b03eb","Device":"cce636b7-dba7-11e9-b8cd-

ebea3737ce6a","RelatedDevice":"abd2b3d7-7469-11e8-8ca6-509a4c85925e"},{"ID":"a8fa1fbc-dbb4-

11e9-a6a2-3bf14c616197","Device":"abd2b3d7-7469-11e8-8ca6-

509a4c85925e","RelatedDevice":"cce636b7-dba7-11e9-b8cd-ebea3737ce6a"}]

Answer in the form of a table:

Page 46: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 46 of 52

enteliVIZ JSON usage

Searching the meter by name and then displaying the electricit y consumption and

information about the warranty period .

Finding the matching queries, for our example we will use the Location Device query to search and retrieve the

Device ID and based on it we will use the Device Device query to find the warranty period and the counter

value.

1) Opening the HTML5 enteliVIZ editor

2) Creation of a new project called "Example for a module"

Page 47: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 47 of 52

3) Adding TEXT elements in the index.dg5 file

We will add 6 such elements to our example. 3 of them will be responsible for displaying data and the

rest for describing what data has been displayed. We change the data in the "Name:" field

and "Text:" for example, "Enter counter name:", "Guarantees [Months]:" and "Counter value:"

Page 48: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 48 of 52

4) Then we add an input field for the text to enter the device name.

You can give a black rectangle under the input field to make the name more visible.

5) From now on we should have this structure

Under the words "Warranty [Months]:" and "Counter value:" there are two text fields that are

currently empty and will be used as information display at a later stage.

Page 49: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 49 of 52

6) We create a new TEXT element on the side and we call dataflow. This element will store the entire

structure responsible for retrieving elements using JSON queries.

Once we have created the TEXT element named dataflow and it is selected, we press the key

combination Ctrl + L. We will see a dataflow window, this window will be empty and you will have to

complete them with the blocks shown.

Using blocks, we need to create a JSON query and then convert the answer into tables and extract the

data we are interested in.

Creating a query:

The webDocument block is used to take our IP number from the browser, we will only use the host

field.

Green String blocks are used to enter text, if we already have IP we need to enter a query in this block.

The first Location Device query has the structure

http://127.0.0.1/enteliweb/fmmaintenance/api/location?device={DEVICE_DISPLAYNAME}, we cut off

the IP address and DEVICE_DISPLAYNAME and we are left with the following query: / enteliweb /

fmmaintenance / api / location? Device =

We also need DEVICE_DISPLAYNAME, which is to change dynamically soon

Page 50: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 50 of 52

after entering the counter name by the user, we will also use the String block for this purpose, but we

link the output to the TEXT input

The concat block is used to connect the whole address, which we prepared earlier in the

webDocument and String block. To input 0: enter Error! Invalid hyperlink type link. then connect the

triangle

from the field host to input 1, String into which we entered the first query, we connect a triangle

from String to input 2, the last data we need to combine is the name of the meter, we do it

analogously to the Strings we connected previously. As the output parameter, we should get the url.

The red strLoader block loads the page as text and forwards it. We connect the output field of the

concat block to the path field of the strLoader block

The orange jsonParser block replaces the text received from the strLoader block with tables. We

connect the output field of the strLoader block to the input field of the jsonParser block

The orange block tableRowCells searches tables by rows and columns, needs DeviceID to determine

the next parameters. The counters always have a unique name, so

there will be one row in the table, so in the row parameter we give 0 and the column we want to

search is called DeviceID, so in the parameter of columns 0 we enter DeviceID. We connect the output

field of the jsonParser block to the table field of the tableRowCells block. As output we get the value

equal to DeviceID.

The first query is ready, we get a response in the form of an individual device symbol (DeviceID). We

will construct the next query in the same way as the first.

WebDocument block with the IP address, the same as before, we will only use the host field.

If we already have an IP, we need to enter a query in this block. The second Device Device query has

the structure http://127.0.0.1/enteliweb/fmmaintenance/api/devices?device={DEVICE_ID}, we cut off

the IP address and DEVICE_ID and we are left with the following query: / enteliweb / fmmaintenance /

api / devices? Device =

We also need DEVICE_ID, which is to dynamically change as soon as the user enters the name of the

counter, for this we will use the answer we get

from the first Location Device query.

The concat block is used to connect the entire address, which we prepared earlier in the

webDocument and String block. To input 0: enter Error! Invalid hyperlink type link. then connect the

triangle

Page 51: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 51 of 52

from the field host to input 1, String into which we entered the second query we connect a triangle

From String to input 2, the last data we need to combine is DeviceID, we connect the value field of the

tableRowCells block to the input field of the concat block 3. As the output parameter, we should get

the url.

The red strLoader block loads the page as text and forwards it. We connect the output field of the

concat block to the path field of the strLoader block

The orange jsonParser block replaces the text received from the strLoader block with tables. We

connect the output field of the strLoader block to the input field of the jsonParser block

The orange tableRowCells block searches tables by rows and columns, it requires Warranty and

MeterValueEviz5 to determine the next parameters, so we will create two tableRowCells blocks, one

to read Warranty and the other to read MeterValueEviz5. The counters always have a unique name, so

there will be one row in the table, so in the row parameter we give 0 and the column we want to

search is called Warranty in one block and MeterValueEviz5 in the second block, respectively. so in the

parameter of columns 0 we enter just such names. We connect the output field of the jsonParser

block to the table field of both tableRowCells blocks.

As an output, we get a value equal to the warranty period for one block and value

from the counter for the second block.

Then we have to present this data, the green String block will be used for this reason, therefore we

will combine the value field of the first block tableRowCells to the String block of the first and the

value field of the second block tableRowCells to the String block of the second. Then, link the values

to TEXT elements.

Page 52: FM Utrzymanie Ruchu FM Maintenance eWEB FM Mobile

Page 52 of 52

We save our project and we can check if it works.

7) In the graphics section on the left we select our project "Example for a module" and then click index

After entering the name of the meter, information of interest will be shown to you.