HVAC Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Recording a Project ======

This guide will show you how to start recording a BACnet network on a Vigilia server.


===== Server Side =====


First, make sure you are logged in into [[https://vigilia.hvac.io/user|your account]]. 
(You might need to create one.)

==== Create an Organization ====


Organizations can have multiple members and contain many projects. 
A member will see all the organization projects.

Most will not need more than a single organization, so you can just use your own enterprise name.

Go to your [[https://vigilia.hvac.io/user|user]] page.
Click on the "Create organization" button and create it.

Once the organization is created, click on its link.

{{:suppliers:hvac.io:vigilia:installation:org-link.png|}}

==== Create a Project ====

Projects are what contains the recorded data.
Inside a project, **all BACnet device IDs must be unique**.

In your organization page, click on "Create project" and create it.

Next, click on the configuration button.

{{:suppliers:hvac.io:vigilia:installation:project-config.png|}}

This will bring you to a page with the **project-id** and the **logger-key**. 
You will need both to configure the logger(s).


===== Client Side (Loggers) =====

Loggers are software able to scan a BACnet network and send the data back to a Vigilia server.

The only publicly available logger is [[https://hvac.io/docs/wacnet|Wacnet]] (min version 1.8).

To start logging a network, **begin by running Wacnet**.

Make sure you can see the devices on your network by checking the **[[http://localhost:47800/vigilia/configs|Explorer]]** tab.

Here's an example of a network with a single device:

{{:suppliers:hvac.io:vigilia:wacnet-explorer-tab-device.png|}}

Then, go and configure a few things in the **[[http://localhost:47800/vigilia/configs|Vigilia Configs]]** page :
==== Step 1: Connect to a Vigilia server ====

** Skip this step if you are using HVAC.IO's servers. **

The first thing to configure is a Vigilia API URL. This will tell Wacnet where it should send its data.

It should have the following form:

<code>
http://<vigilia-IP-or-address>/api/v1
</code>

If you are using a port other than 80 or 443, you need to include it into the URL:

<code>
http://<vigilia-IP-or-address:47900>/api/v1
</code>
(Where 47900 is your port number)

Make sure Wacnet can see the provided URL!




{{:suppliers:hvac.io:vigilia:installation:logger-step1.png|}}

==== Step 2: Project credentials ====

You have to provide a **project ID** and a **logging key/password**. 
Both are available through the project configurations on the Vigilia server.

Here's an example :
  * Project-id : 5371147be4b0222b740851a2
  * Logger key: asdi34h5ha

Make sure Wacnet has access to the project :

{{:suppliers:hvac.io:vigilia:installation:logger-step2.png?800}}


==== Step 3: Start Logging ====

When Wacnet starts, it searches for Vigilia configurations. If it finds some, **it will start logging automatically**.

To start the logging without restarting Wacnet, expand the details part of the page and click on "Start".

{{:suppliers:hvac.io:vigilia:installation:logger-step-start.png?500|}}

Depending on the size of your network, Wacnet will start scanning the devices after a few seconds.

After a few minutes, you can validate that every runs smoothly by checking the time taken to scan your network. See "Last scan duration", just above the start/stop buttons. After at least one scan, you should be able to load your project on the Vigilia server and see the scanned devices.