Differences

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

--- vrm_portal:getting_started [2016-09-23 10:39] – created mvader
+++ vrm_portal:getting_started [2022-12-21 03:28] (current) – [Getting started with VRM] guy_stewart
@@ Line 3: / Line 3: @@
 ====== Getting started with VRM ======
-There are two separate steps that need to be taken. First, you need to create a VRM user account. And after that the installation, called 'site' needs to be paired with that user account. It is possible to pair one site to multiple user accounts.
+To connect your system to the VRM Portal, there are two separate steps that need to be taken. First, you need to create a VRM user account. And then secondly, the installation, needs to be paired with that user account.
+A single user can have access to several installations, and it is also possible that each installation can have several linked users.
 ===== Requirements =====
@@ Line 9: / Line 11: @@
   - A computer connected to the Internet
   - The VRM Portal ID, which uniquely identifies your system.
-      - Color Control GX: the VRM Portal ID can be found in the menu Settings → VRM Logger. It looks like this: be300d83ff04. For more information, see [[:vrm_portal:troubleshooting_ccgx_vrm_connectivity|Troubleshooting VRM Portal Connectivity for a CCGX]].
+      - GX device menu (Cerbo GX with GX touch display): the VRM Portal ID can be found in the menu Settings → VRM Logger. It looks like this: be300d83ff04. For more information, see [[:vrm_portal:troubleshooting_ccgx_vrm_connectivity|Troubleshooting VRM Portal Connectivity for a CCGX]].
+      - Venus GX & Cerbo GX: the VRM Portal ID is printed on a label on the side. For more information, see [[:vrm_portal:troubleshooting_ccgx_vrm_connectivity|Troubleshooting VRM Portal Connectivity for a CCGX]].
+      - [[https://www.victronenergy.com/live/venus-os:start|A GX Device]]
       - VGR, VGR2 and VER: the VRM Portal ID is the IMEI number. It is written on a label on the back of the modem, and on a label on the outside of the carton. It can also be requested by sending a text message to the modem with the command 'GSM'. For more information, see [[https://www.victronenergy.com/upload/documents/Manual-Troubleshooting-VGR-connectivity-EN.pdf|Troubleshooting VRM Portal Connectivity for a VGR]].
-  - The gateway, be it a Color Control GX, VGR, VGR2 or VER, needs to have had a successful connection to the VRM Portal.
+      - [[https://www.victronenergy.com/panel-systems-remote-monitoring/ve-direct-lorawan|LoRaWan Device]]
-Note: it is recommended, especially when working with SIM cards, to first configure and test the internet connection in your office, before installing it on location. It is not necessary to connect any equipment, such as a Multi or BMV battery monitor: applying power to a stand-alone Color Control or Victron Global Remote will do, as they also connect to the VRM Portal when there are no products connected.
+The system needs to have had a successful connection to the VRM Portal, before adding the installation to your user account on the VRM Portal.
-===== Creating a VRM user account =====
+Note: it is recommended, especially when working with SIM cards, to first configure and test the internet connection in your office, before installing it on location. It is not necessary to connect any equipment, such as a Multi or BMV battery monitor: applying power to a stand-alone GX device or Victron Global Remote will do, as they also connect to the VRM Portal when there are no products connected.
+===== Step 1. Create a user account =====
 . Go to [[https://vrm.victronenergy.com|https://vrm.victronenergy.com]]
-. Click ‘Sign up for Free’:
+. Click ‘Register for Free’:
-{{  :vrm_portal:welcome_screen_vrm.png?nolink&  }}
+{{  :vrm_portal:started-1.png?nolink&  }}
 . Complete all the requested information:
-{{  :vrm_portal:acc_create.png?nolink&  }}
+{{  :vrm_portal:started-2.png?nolink&  }}
 . You will now receive a confirmation email with a link to activate your account.
-Account creation is now finished, click add site to continue pairing a site to this user account.
+Account creation is now finished, click add installation to continue pairing an installation to this user account.
-===== Pairing a site to a user account =====
+===== Step 2. Add an installation to the user account =====
-Note: make sure that the VGR/VER/CCGX has already started communicating with the VRM Site. Otherwise it is not possible to pair and add a site to a user account. If the VGR/VER/CCGX has not started communicating with the VRM site yet, this error screen will appear:
+Note: make sure that the system has already started communicating with the VRM Portal. Or, in case it is an off-grid installation where a SDcard or USB-Stick is used, first upload the data file.
-{{  :vrm_portal:image004.png?nolink&  }}
+Adding an installation is only possible __after__ the VRM Portal has received the first data transmission of your system.
-. Enter the IMEI or MAC Address number for one of the VGR, VER or CCGX products.
+Steps to add an installation:
-{{  :vrm_portal:add_site.png?nolink&  }}
+. Select the product you want to add.
-. Click next and your device is now paired with your VRM user account. In case you are the first user to add this site to your account, you will automatically have Admin rights for this site. Any subsequent users that add this site to their account will become a normal user, that cannot change any settings. An Admin user can assign Admin rights to other users on the Settings page.
+{{  :vrm_portal:started-3.png?nolink&  }}
-. The first page will be as the screen below. If the CCGX/VGR/VER is not yet installed there will no data shown.
+. Enter the IMEI or MAC Address number for one of the VGR, VER or GX device products.
-{{:vrm_portal:first_site_live.png?nolink&}}
+{{  :vrm_portal:started-4.png?nolink&  }}
-. Once more than one site is linked to your VRM user account, you will see all of them on a map. When multiple sites are close together, they will be grouped into one balloon. The color of the balloon will be red when one or more sites grouped in that balloon has a problem.
+. Click 'Add' and your device is now paired with your VRM user account.
-{{  :vrm_portal:map_screen.png?nolink&  }}
+In case you are the first user to add this installation to your account, you will automatically have Admin rights for this installation. Any subsequent users that add this installation to their account will become a normal user, that cannot change any settings. An Admin user can assign Admin rights to other users on the Settings page.
-===== Configure the site =====
+When a "Installation could not be found" error is shown, read the requirements above, and double check the internet connection of the system.
-In the Settings tab, only visible for sites at which you have admin rights, go through the following settings:
+. The first page will be as the screen below. If there is no data yet, please check the [[vrm_portal:faq|FAQ]]
-**General**
+{{:vrm_portal:started-5.png?nolink&}}
-  * GSM Number: useful to save the GSM number of the sim card of a Victron Global Remote. The only function of this field is to keep it in a safe place, nothing else.
+. Once more than one installation is linked to your VRM user account, you will see all of them on a map. When multiple installations are close together, they will be grouped into one balloon. The colour of the balloon will be red when one or more installation grouped in that balloon has a problem.
-  * Generator: enable when there is a AC generator connected to the system. In case of a Quattro, the VRM Portal will assume that the generator is connected to AC input 1.
-  * Mains: enable when there is Mains (utility grid or shore) available to the system. In case of a Quattro, the VRM Portal will assume that this is connected to AC input 2.
-  * Use VE.Bus SOC: Enable this for systems in which the Multi . The website will then use battery state of charge as reported by the Multi or Quattro. Note that you need to configure the battery capacity in VEConfigure. More information in the [[:vrm_portal:faq?&#in_systems_with_a_bmv_the_vebus_state_of_charge_is_hidden_why|VRM FAQ]]
-  * Has DC System: Enable this for boats, vehicles and other installations with DC loads and chargers other than the Multi and MPPT chargers. Not applicable for most Off-grid installations. The difference between the DC current measured by the Multi and by the BMV will be attributed to a 'dc system'. It can be an alternator, pumps, DC fridge, etcetera. Note that the value shown will always be an approximation.
-The Generator and Mains settings are used to translate power and voltages reported by the Multi and Quattro to 'Genset' or 'Mains'. Instead of AC input 1 and AC input 2.
+{{  :vrm_portal:started-6.png?nolink&  }}
-**Tags**
+===== Step 3. Configure the installation =====
-  * Useful for accounts that have many sites. For example a hybrid generator rental company with four depots: North, South, West and East. Add the tag of the right depot to all sites. Then in the sites overview you can filter on these tags.
+In the Settings tab, only visible for installations at which you have admin rights, go through the following settings:
-**Site summary**
+**General**
-  * Configure the data that you want to see on the home page, that shows a summary of all sites in your account. Only useful for accounts with multiple sites.
+  * GSM Number: useful to save the GSM number of the sim card of a Victron Global Remote. The only function of this field is to keep it in a safe place, nothing else.
+  * Description: Name / description of the installation
-**Set location**
+**Tags**
-  * Set the location of the site by dragging the cursor to the right place. This automatically sets the timezone that is used for all x-axes on the graphs as well.
+  * Useful for accounts that have many installations. For example a hybrid generator rental company with four depots: North, South, West and East. Add the tag of the right depot to all installations. Then in the installation overview you can filter on these tags.
-**Advanced tab setup**
+**Set location**
+  * Set the location of the installation by dragging the cursor to the right place. This automatically sets the timezone that is used for all x-axes on the graphs as well.
-  * Select which widgets you want to see on the advanced tab.
+==== Users ====
-**Users**
+  * Configure which users are admin and which not. Admins can change settings on all installations for which they have admin rights.
+  * Invite new users to this installation.
-  * Configure which users are admin and which not. Admins can change settings on all sites for which they have admin rights.
+{{:vrm_portal:vrm-users.jpg|}}
-  * Invite new users to this site.
 **Alarm rules**
@@ Line 92: / Line 97: @@
 ===== More tips and tricks =====
-  * Use the Invite a user function to pair this site to other user accounts as well. It is also possible to invite users that do not yet have a VRM user account. They will automatically be directed to the account creation page.
+  * Use the Invite a user function to pair this installation to other user accounts as well. It is also possible to invite users that do not yet have a VRM user account. They will automatically be directed to the account creation page.
-  * To see a list of all connected products and their firmware version numbers, go to the Settings tab, and then the System overview section.
+  * To see a list of all connected products and their firmware version numbers, go to the Settings tab, and then the Device List section.
-  * The screensaver enables you to quickly see what state the site you're currently viewing is in. Configure the screensaver in your profile settings to automatically show up after a period of inactivity, or press the "s" key twice while viewing a site.
+  * The screensaver enables you to quickly see what state the installation you're currently viewing is in. Configure the screensaver in your profile settings to automatically show up after a period of inactivity, or press the "s" key twice while viewing an installation.
   * Check and if necessary alter the default alarm monitoring setup to your needs. [[:vrm_portal:alarms|VRM Portal alarms and monitoring]].
-  * When you have many sites, it is possible to switch to a table view:
+  * Adding tags to a installation is done in the 'Settings' page. In the example below, one tag is added to this installation with the name: 'tag name'. You can add tags by typing the tag name and clicking 'save'.
-{{  :vrm_portal:tableview.png?nolink&  }}
-  * In the screenshot above, on the left, there is a filter. Use it to filter. Adding tags to a site is done in the 'Settings' page. In the example below, two tags are added to this installation, 'yachts' and 'electric yachts'.
-{{  :vrm_portal:tag_setup.png?nolink&  }}
-  * Do not forget to install the VRM app on your phone. It is available for free in both the Apple store and the Google Play store for Android. For Android, it is also possible to download the APK files on our [[https://www.victronenergy.com/support-and-downloads/software|software and downloads page]]. {{  :vrm_portal:iphone_vrm_app_web.png?direct&  }}
+{{  :vrm_portal:started-7.png?nolink&  }}
-  * See the [[:vrm_portal:faq|VRM Portal - Frequently asked questions]] section for more information.
-  * New - Documentation for [[:vrm_portal:vrm_world|VRM World]]
-  * We maintain a [[:vrm_portal:change_log|change log for VRM]]
+  * Do not forget to install the VRM app on your phone. It is available for free in both the Apple store and the Google Play store for Android. For Android, it is also possible to download the APK files on our [[https://www.victronenergy.com/support-and-downloads/software|software and downloads page]]. {{  :vrm_portal:started-8.png?direct&  }}
-===== Increased security when logging into your VRM site =====
-See [[https://www.victronenergy.com/live/vrm_portal:two-step-verification]]
-===== DISQUS =====
-~~DISQUS~~