meraki-socket-indoor-location-emitter

Node.js server to provide IndoorLocation from Cisco Meraki. Works with socketIndoorLocationProviders libraries on iOS, Android and JS.

Installation

Node.js is required.

• Clone the repository
• Go to this folder, and install the modules

  npm i
  

configurator

A configurator tool is provided to create the configuration file required to finally run the Meraki listener. The configuration file contains the necessary informations to project the coordinates received from Meraki onto the Mapwize map.

The configurator is split in 3 steps described below.

Extract data from Meraki

TO BE WRITTEN

Upload Meraki data into Mapwize

We first upload the Meraki floor plans and beacons into a Mapwize venue. This step creates all required layers with a name that starts with Meraki - in Mapwize. All these layers do not have floor configured, you will then need to manually edit each layer for updating their floor properties. As some alignment problems can be observed, you will also have to check that each layer image perfectly overlays the Mapwize layers for a better accuracy. Once everything is correctly aligned, you will have to launch again the script with the --update parameter to automatically update the floor of each beacon.

• Upload

  ./meraki-configurator/uploadToMapwize.js --merakiFloorPlansConfig [FILEPATH_FOR_FLOORPLANS_JSON] --merakiBeaconsConfig [FILEPATH_FOR_BEACONS_XML] --mapwizeUser [YOUR_MAPWIZE_EMAIL] --mapwizePwd [YOUR_MAPWIZE_PWD] --mapwizeApiKey [YOUR_MAPWIZE_API_KEY] --mapwizeOrganizationId [YOUR_MAPWIZE_ORGANIZATIONID] --mapwizeVenueId [YOUR_MAPWIZE_VENUEID]
  

• Update

  ./meraki-configurator/uploadToMapwize.js --merakiFloorPlansConfig [FILEPATH_FOR_FLOORPLANS_JSON] --merakiBeaconsConfig [FILEPATH_FOR_BEACONS_XML] --mapwizeUser [YOUR_MAPWIZE_EMAIL] --mapwizePwd [YOUR_MAPWIZE_PWD] --mapwizeApiKey [YOUR_MAPWIZE_API_KEY] --mapwizeOrganizationId [YOUR_MAPWIZE_ORGANIZATIONID] --mapwizeVenueId [YOUR_MAPWIZE_VENUEID] --update
  

Generate the configuration file

Once everything is correctly imported, updated (floors) and aligned in the Mapwize venue, use the command below to generate the JSON configuration file that will be used later by the listener.

./meraki-configurator/configureFromMapwize --merakiFloorPlansConfig [FILEPATH_FOR_FLOORPLANS_JSON] --mapwizeUser [YOUR_MAPWIZE_EMAIL] --mapwizePwd [YOUR_MAPWIZE_PWD] --mapwizeApiKey [YOUR_MAPWIZE_API_KEY] --mapwizeOrganizationId [YOUR_MAPWIZE_ORGANIZATIONID] --mapwizeVenueId [YOUR_MAPWIZE_VENUEID] --output [OUTPUT_PATH_FOR_LISTENER_CONFIGURATION]

meraki-listener

NodeJS server to react on Meraki notifications. Each notification will be received and processed into an indorLocation object.

The computed indoorLocation will be saved in a redis database with the IP address as userId to be used by the emitter.

Thanks to redis, we will be notified each time a key value has been changed.

To do so, redis notifications have to be enabled with the command described below.

redis-cli config set notify-keyspace-events K$

Use

• We first need to correctly set the configuration parameters
  • Directly in the config/all.js file
  • Via environment variables
    • PORT: port used by the server
    • SECRET: secret defined in the Meraki dashboard to authenticate the POST query (required)
    • VALIDATOR: token defined by Meraki to identify the source (required)
    • FLOOR_PLANS: serialized Meraki JSON floor plans (required)
    • REDIS_HOST: redis host (required)
    • REDIS_PORT: redis port
    • REDIS_AUTH: redis password (required if set)
    • REDIS_MERAKI_NOTIF_TTL: redis key TTL
• Start the server

  npm run start-listener
  

Notes

To correctly serialize the Meraki configuration, one can execute the command described below:

export FLOOR_PLANS=$(node -e 'var json = require("FILEPATH"); console.log(JSON.stringify(json));')

If you want to put this variable into your clipboard instead, please execute the command below:

node -e 'var json = require("FILEPATH"); console.log(JSON.stringify(json));' | pbcopy

An example of a valid JSON Meraki floor plans configuration can be found at meraki-listener/test/floor-plans.json.

meraki-emitter

NodeJS server to react on socket indoor location providers. Each socket connection will lead to a redis subscription that will help to only get the indoorLocation objects when the location of a user has been changed. These objects will be sent to the providers via a socket channel.

Use

• We first need to correctly set the configuration parameters
  • Directly in the config/all.js file
  • Via environment variables
    • PORT: port used by the server
    • REDIS_HOST: redis host (required)
    • REDIS_PORT: redis port
    • REDIS_AUTH: redis password (required if set)
• Start the server

  npm run start-emitter