Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

We now have a simplified way of installing the LIPI indoor positioning software using our new CLI Tool. This is a comprehensive document and is divided into 5 parts as shown below.

Please note that you will still need to involve someone who has access to the LIPI server, has experience with SSH and Linux, and preferably has access to CMX GUI. More details regarding prerequisites are discussed in the Part V of this documentLet us make sure that our system is ready for our positioning system by checking these prerequisites beforehand and complying with them.

Note: If you are planning to install a LIPI that does not have internet connection, please refer to https://mazemap.atlassian.net/l/c/1eY8xdGE

PREREQUISITES for the LIPI Installation

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.

    • Enable the API server

      Code Block
      cmxos apiserver enable
      cmxos apiserver restart
    • CMX GUI user for MazeMap with Full Read Only privileges set up on CMX.

    • CMX CLI API user with full Read and API 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:

      Code Block
      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.

Image Added


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

Now we are ready to Install the LIPI

Table of Contents
maxLevel1

...

Action

Command

Comment

Start LIPI server

sudo systemctl start lipi


Stop LIPI server

sudo systemctl stop lipi


Restart LIPI server

sudo systemctl restart lipi


Status of LIPI server

sudo systemctl status lipi


Check the lipi log

journalctl -u lipi -n 200 -f


Create a new command line user in CMX

cmxos apiserver user add [the_username] [the_password]


Update lipi

Download the new lipi 

Make sure that the file is executable by typing:
chmod +x upgrade.sh
Then run the command:
sudo ./upgrade.sh


open and update the config file

sudo nano config.json


view the config file

cat config.json


Move a file from one location to another

mv <start location> <end location> 
e.g. mv /home/cygate/config.json /srv/

In the example the config file is located in /home/cygate and we are moving it to /srv/. We are replacing the old file with the new file.

V. Prerequisites for the LIPI Installation

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.

    • Enable the API server

      Code Block
      cmxos apiserver enable
      cmxos apiserver restart
    • CMX GUI user for MazeMap with Full Read Only privileges set up on CMX.

    • CMX CLI API user with full Read and API 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:

      Code Block
      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.

Image Removed

Dependencies

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

...

.

...

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/

...