How to update to the new and improved LIPI v 4.x

Owned by Ellen Røyneberg (Unlicensed)
Last updated: 20 Mar, 2020 by Yehonathan Quartey

MazeMap has released a new and improved LIPI indoor positioning software called LIPI 4.x. The process of updating to the newest LIPI version is simple and straightforward if you have access to the correct services, and your existing LIPI server is connected to the internet. (If your LIPI server is not connected to the internet, please follow the steps in this installation guide.) You will need to involve someone with access to the LIPI server and that preferably has experience with SSH and Linux when performing this update.

 

For this update MazeMap has implemented a new tool that will:

  • download and update the LIPI for you;

  • make sure to use the current configuration running in your LIPI; and,

  • create a copy of the last working version so that you are able to go back to that version if there are any issues during the install.

This guide will explain what needs to be done Step-by-step to install the LIPI.

 

Time needed: 30 minutes.

Pre-Installation checks

Requirements for the LIPI server

  • Can be virtual or physical, does not matter.

    • No OVA currently available, one of the supported OSes needs to be installed.

    • Supported Operating systems: Newest stable Ubuntu or Debian.

    • Server/Virtual Machine(VM) specs: Tested to work with single Core VM with 3.5 GB Ram and 7 GB HDD.

Requirements for the network

  • Open port 443 from LIPI server to CMX (https for API).

    • Open port 443 from all wireless clients to LIPI (https for position requests).

    • Traffic from Wireless Clients to LIPI must not pass through NAT.

Requirements for the CMX 

  • CMX set up with Location services activated and sufficient licenses.

    • Building maps, with correct map scaling and a minimum of 3 GPS markers per floor need to be set up on Cisco Prime, exported and imported into CMX.

      • GPS markers should use coordinates created using MazeMaps own map. MazeMap provides a tool for generating these. You can find the POI inspector-tool here: https://debug.mazemap.com/

    • Access points must be placed correctly (within a meter of actual location) in the maps in Cisco Prime.

    • A CMX GUI user for MazeMap with Full Read Only privileges set up on CMX (MSE is not supported at the moment).

    • A CMX CLI API user with full Read access. Both CMX GUI and CLI users should have the same username/password

      • To create a CMX CLI user ssh into your CMX and run the following command: cmxos apiserver user add
        You will be asked to type in a username and password for the user - use the same username and password as you used for the GUI user.

    • Enable the apiserver on the CMX

      • To do so, ssh into the cmx and run the command:

        • cmxos apiserver enable

        • cmxos apiserver restart

 



Dependencies

In order to upgrade the LIPI you will need the following:

  • SSH access to the LIPI server.

  • Access to CMX GUI (browser) and CLI (terminal).

  • A device that is connected to the WiFi network that is used for positioning purposes. This requires you being on site at the campus and using public wifi network

  • Pre-installed java in the server openjdk-8-jre-headless

  • Access to Map Editor in MazeMap https://admin.mazemap.com/

  • LIPI 4.0.2 software update tool that can be downloaded from here: https://storage.mazemap.com/lipi/latest/lipi

Update an existing LIPI configuration:

  1. SSH into the LIPI server

  2. Download and install the script by typing:

    wget -O lipi https://storage.mazemap.com/lipi/latest/lipi chmod +x lipi;./lipi --setup


    You will get the following question:

    Mazemap API key (leave blank and hit <enter> for offline installation):

     

  3. To get your API Key do the following steps:

    1. Go to Map Editor and navigate to the Indoor positioning menu.

       

    2. Click on LIPI Configuration

       

    3. Expand a LIPI configuration and click on generate. You can then copy this key and past it into your SSH.

       

  4. When you have pasted in the API key from the question in 3, you will get a new question

    Installation folder:


    We recommend you to name the folder lipi-install


    After this is done, it is worth mentioning that the LIPI will send a status report to MazeMap on a regular basis. The information that is sent to the MazeMap is the same information that you get when typeing


    You should get the following message, this means that you ave successfully installed the tool we use to install and set up the LIPI correct.

     

  5. To download the LIPI do the following:

     

  6. You will get the following questions. Press Enter for question number 1 and 2. Press y for question 3.


    You should get the message:

     

  7. Run the following command to get a status:


    You should get the message:

     

  8. Test and verify that the LIPI is running.

    1. Open a browser and go to https://debug.mazemap.com/lipi/

    2. Click on “Refresh List” and your LIPI should show up in the list.

    3. Click on the blue “Test”-button associated to your LIPI.

    4. If all tests are green and says “PASSED” it means your LIPI is working as expected without any issues. You can now go to use.mazemap.com and test that the blue dot is working as it did prior to the update.

    5. If one or more of the tests says “FAILED” contact MazeMap support at support@mazemap.com and describe the problem. Please take a screenshot of the tests and attach it to the email. Also click on the blue button on the bottom of the page that says “Send results to MazeMap”.

 

Assistance:

If you need any help while doing the upgrade, you are welcome to send a mail to support@mazemap.com. If needed we can also schedule a meeting and go through the update together with you.

Good luck!