Differences

This shows you the differences between two versions of the page.

--- suppliers:hvac.io:vigilia:installation [2020/10/04 01:51] – old revision restored (2020/09/23 18:50) 173.249.2.13
+++ suppliers:hvac.io:vigilia:installation [2020/10/04 01:52] – old revision restored (2020/10/02 09:00) 173.249.2.13
@@ Line 1: / Line 1: @@
-====== Installation ======
+====== Vigilia Installation ======
-For self-hosted version only. To use the HVAC.IO servers instead, [[https://hvac.io/registration|create an account]] and jump to [[#Loggers]].
+//**For self-hosted version only.** To use the HVAC.IO servers instead, [[https://hvac.io/registration|create an account]] and jump to [[#Loggers]].//
 The installation is separated in 3 main components:
@@ Line 14: / Line 14: @@
 Once this is done, you might want to take a look at [[#Adding Vigilia as a Service]]
 ===== Database =====
-For the time being, Vigilia only supports [[http://www.tokutek.com/tokumx-for-mongodb/|TokuMX]].
+For the time being, Vigilia only supports [[https://www.percona.com/software/mongo-database/percona-tokumx|TokuMX]].
 It is a fork of MongoDB, which features mind boggling increase in performance and reduction in the database size.
 (The choice was not made lightly; we tried many databases before settling with this one.)
@@ Line 26: / Line 26: @@
 Download and install by following the instructions on this [[https://www.percona.com/downloads/percona-tokumx-community-edition|page]].
+Once the database is installed, make sure everything works as intended by running the command
+**mongo** in the shell.
+The command should be recognized AND it should connect successfully.
+{{:suppliers:hvac.io:vigilia:installation:tokumx-shell.png?|}}
 ===== Vigilia Server =====
@@ Line 55: / Line 62: @@
 <code> java -jar vigilia-server.jar <port number> </code>
-(where <port number> is the port you want to use.)
+(where <port number> is the port you want to use. If you don't know which one to take, use 47900.)
 After a few seconds, the server should be up and running.
@@ Line 62: / Line 69: @@
-Obviously, if you want the application to start automatically when your server boot up, you should make sure to [[#Adding Vigilia as a Service|create a service]], or configure your web server (like Tomcat) to use vigilia-server.jar.
+If you want the application to start automatically when your server boot up, you should make sure to [[#Adding Vigilia as a Service|create a service]], or configure your web server (like Tomcat) to use vigilia-server.jar.
 ===== Loggers =====
-Wacnet...
+Loggers are software able to scan a BACnet network and send the data back to a Vigilia server.
+The only publicly available logger is Wacnet (min version 1.8).
+To start logging a network, **begin by running Wacnet**.
+Then go and configure a few things in the **[[http://localhost:47800/vigilia/configs|Vigilia Configs]]** page :
+==== Step 1: Connect to a Vigilia server ====
+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-adrress>/api/v1
+</code>
+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
+  * Logging key: asdi34h5ha
+Make sure Wacnet has access to the project :
+{{:suppliers:hvac.io:vigilia:installation:logger-step2.png?800}}
+==== 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|}}
 ===== Adding Vigilia as a Service =====