Differences

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

--- vrm_portal:start [2014-11-13 00:50] – mvader
+++ vrm_portal:start [2024-03-28 01:32] (current) – guy_stewart
@@ Line 1: / Line 1: @@
-====== Getting started with VRM ======
+===== VRM Portal documentation ======
-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.
+The [[https://www.victronenergy.com/media/pg/VRM_Portal_manual/en/introduction.html|VRM manual for end-users and installers is now available here.]]
-===== Requirements =====
-  - A computer connected to the Internet
+Documentation for developers:
-  - The VRM Portal ID, which uniquely identifies your system.
+  * [[vrm_portal:change_log|VRM Portal change log]]
-      - 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|Trouble shooting VRM Portal Connectivity for a CCGX]].
+  * [[https://vrmapi.victronenergy.com/v2/docs|VRM JSON API v2]]
-      - 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 [[http://www.victronenergy.com/upload/documents/Manual-Troubleshooting-VGR-connectivity-EN.pdf|Trouble shooting VRM Portal Connectivity for a VGR]].
+  * [[vrm_portal:dealers]]
-  - The gateway, be it a Color Control GX, VGR, VGR2 or VER, needs to have had a successful connection to the VRM Portal.
-Note: it is possible, and especially when working with SIM cards it is recommended, 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.
-===== Creating a VRM user account =====
-. Go to [[https://vrm.victronenergy.com|https://vrm.victronenergy.com]]
-. Click ‘Sign up for Free’:
-{{  :vrm_portal:welcome_screen_vrm.png?nolink&  }}
-. Complete all the requested information:
-{{  :vrm_portal:acc_create.png?nolink&  }}
-. Account creation is now finished, click add site to continue pairing a site to this user account.
-===== Pairing a site to a 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:
-{{  :vrm_portal:image004.png?nolink&  }}
-. Enter the IMEI or MAC Address number for one of the VGR, VER or CCGX products.
-{{  :vrm_portal:add_site.png?nolink&  }}
-. 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.
-. The first page will be as the screen below. If the CCGX/VGR/VER is not yet installed there will no data shown. {{:vrm_portal:first_site_live.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.
-{{  :vrm_portal:map_screen.png?nolink&  }}
-===== 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.
-  * To see a list of all connected products and their firmware version numbers, go to the Settings tab, and then the System overview section.
-  * 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: {{  :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 below example, 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 [[http://www.victronenergy.com/support-and-downloads/software/|software and downloads page]]. {{ :vrm_portal:iphone_vrm_app_web.png?direct |}}
-  * See the [[:vrm_portal:faq|VRM Portal - Frequently asked questions]] section for more information.