Start Free Trial

Platform Documentation

Maps

The Map page places device pins on an image of a physical space, such as a floor plan, site layout, rack diagram, or piece of equipment. Each pin shows a live reading and changes color when an alert fires.

A map is an image overlay. You upload an image and place device pins on it. A NEQTO.ai map is not a geographic latitude and longitude map. The platform stores pin positions as percentages of the image, so they stay in place when you zoom or resize the screen.
Maps and Systems serve different purposes. The Map page places individual device readings from an application on one image per map. Systems organizes devices into named, nested groups such as sites, machines, or fleets. Each System can have its own image map for placing its members. See the Systems page.
Diagram of an uploaded floor-plan image used as a map background. Each device attribute, such as a temperature reading, appears as a pin at an X/Y position. Live values arrive over the websocket and update each pin in real time. Active alerts change the colors of the matching pins.
A map combines an uploaded image with device pins and live readings.

Quick start

Use these steps if you are already familiar with NEQTO.ai.

  • 1
    Open an application and go to Map. In the left sidebar, click Add map. Enter a title and upload a PNG, JPEG, or WebP image.
  • 2
    Click Add device, then click a spot on the image to choose where the pin goes.
  • 3
    Select a Device, the Attribute to show, and a Category icon. You can also add a text label and one or more click-charts. Click Save.
  • 4
    The pin appears with its live value. Click any pin to open its details in the right-hand panel. Use Edit position to fine-tune placement later.
UI and API terms. A map pin shows one Attribute from one Device. The API calls an Attribute a data type and an Endpoint a data source. The Map page uses only the UI terms.

The Map page layout

The Map page is inside an application. The page is titled Map and described as “Real-time device monitoring and floor plan visualization.” On a desktop, it has three panels.

The Map page in a three-panel desktop layout. Left: a filter sidebar with a Map Selection dropdown, an Add map button, Categories checkboxes, a Status Filter, and a Status Legend. Center: the floor-plan image with device pins overlaid, plus zoom and full-screen controls. Right: a device panel showing the selected pin's current reading and history charts.
Desktop layout: filter sidebar, the floor plan with pins, and the device panel.
Panel What’s there
Filter sidebar (left) The Map Selection dropdown to switch maps, the Add map button, category filters, a status filter, and the status legend.
Map (center) The floor-plan image with pins on top. Use the controls to zoom in, zoom out, or enter full screen. Click a pin to select it.
Device (right) The selected pin’s current reading and any click-charts. The panel is empty until you select a pin.

On a phone, the three panels become Filters, Map, and Device tabs. Tapping a pin opens a sheet with Show device info and the edit and delete actions.

Creating and organizing maps

An application can have several maps, such as one per floor or area. Use the Map Selection dropdown to switch between them.

The Create Map dialog. It has a Map title field and a Map setting section with an Upload image button, a 'Map image is required.' warning when none is set, and a preview thumbnail with a Clear button once an image is chosen. Cancel and Save buttons sit at the bottom.
Enter a title and upload an image. Add devices after you create the map.

Create a map

  • 1
    Click Add map in the sidebar to open the Create Map dialog.
  • 2
    Enter a Map title (up to 255 characters).
  • 3
    Click Upload image and choose a PNG, JPEG, or WebP image. Click Save.
A map requires an image. The create and edit dialog controls only the title and image. Add devices from the map after you create it. Until you choose an image, the dialog shows “Map image is required.” and disables Save.
The filter sidebar's top section showing a Map Selection dropdown listing the application's maps in alphabetical order, with an Add map button beside the heading.
Use the Map Selection dropdown to switch maps. The list sorts maps alphabetically by title.

Switching, editing, and deleting

  • Switch maps with the Map Selection dropdown. The page stores your choice in the URL as a mapId query parameter, so you can share a link to the selected map.
  • Edit a map by clicking the pencil button labeled Edit floor map on the map toolbar. You can change the title or replace the floor image.
  • Delete a map by clicking the trash button in the edit dialog and confirming the deletion. Deleting the map also removes its stored image.
Map limit. An application can have up to 15 maps. If you try to create another, the platform returns “The map has reached its maximum number.”

Placing devices on the Map

Each pin links one attribute of one device to a spot on the image. You place pins by clicking the map, then filling in a short form.

The map in placement mode after clicking Add device: a hint reads 'Click the map to choose where to place the device. Right-click or Esc to cancel,' and a ghost pin icon follows the cursor over the floor-plan image.
Click Add device, then click the image to choose where the pin lands.
  • 1
    Click Add device. The cursor shows a ghost pin. Click the spot on the image where you want to place the device. Right-click or press Esc to cancel.
  • 2
    In the dialog, choose a Device from the searchable list. Then choose the Attribute to display. The list does not show devices that are already pinned to this map.
  • 3
    Select a Category to set the pin’s icon. Add an optional label and any click-charts, then click Save.
The Add device dialog with searchable Device, Attribute data-point, and Category fields. The Attribute field fills in after choosing a device, and the Category field includes an icon preview. A View label toggle reveals a label field, a Place value toggle adds the reading, and a label-position field includes a live preview. For numeric attributes, the Charts when clicking this device section lets you enable and preview one or more history charts.
The Add device dialog: device, attribute, category icon, optional label, and optional click-charts.
One pin per device, per map. Each pin shows one attribute of one device. Once a device is pinned to a map, it no longer appears in the Device list for that map. You cannot add the same device to the same map again, even for a different attribute. You can add the device to another map to show it on another floor.

Category icons

The Category sets the pin’s icon but does not change its data. The available categories are:

Category Icon
Air Flow Wind
Temperature Thermometer
Humidity Droplet
CO2 Tree
Acceleration 3D move
Door Open door
Brightness Sun
Motion Custom motion artwork
Occupancy Person
Other Circle

The default category for a new pin is Temperature.

Pin labels

Turn on View label to show text next to the pin. You can enter a fixed label, turn on Place value to show the live reading, or show both. Use Label position to place the text in the center or at the top, bottom, left, or right of the pin. The dialog shows a live preview.

Click-charts for numeric attributes

For a numeric attribute, you can add one or more history charts under Charts when clicking this device. The charts appear in the right-hand device panel when you select the pin. For each chart, choose its type, color, time window, and Y-axis bounds. The time window can be a live relative window or a daily rotation. The dialog shows a live preview. These options do not appear for text or state attributes.

Reading the Map

After you place the pins, their values update live. Their colors change when alerts fire.

A floor-plan map with several device pins. Each pin is a category icon in a circular badge. One pin shows a value label beneath it; another pin is colored red to indicate a critical alert, while normal pins stay in their default state.
Pins update live. Their color reflects alert status.

Status colors

A pin’s color reflects the most severe active alert on its device or attribute. The Status Legend in the sidebar identifies each color:

State Pin color
Normal, no active alert Default / info blue
Warning Yellow
Alert / Critical Red

The map ignores completed or resolved alerts. A pin returns to normal when its alert clears.

The device panel

The right-hand device panel for a selected pin. It shows the device name, the current reading with its unit and a timestamp, and below it any configured click-charts rendered as history graphs, each able to be double-clicked to enlarge.
Selecting a pin opens its current reading and click-charts here.

Click a pin to select it. The device panel shows its current reading, including the value, unit, and arrival time in your timezone. It also shows any click-charts. If no pin is selected, the panel prompts you to select a device on the map. When a map has pins, the first pin is selected by default.

Temperature unit conversion is automatic. If an attribute converts between Celsius and Fahrenheit, the pin value, unit, and chart show the converted reading. The label also shows “(converted to °F)” or “(converted to °C).”

Filtering what you see

The filter sidebar showing a Categories section with a checkbox per category present on the map, a Status Filter section with a 'Show Alerts Only' toggle, and a Status Legend listing Normal, Warning, and Alert / Critical.
Filter by category, or show only pins that currently have an alert.
  • Categories lists each category present on the map; uncheck one to hide those pins.
  • Show Alerts Only hides pins that do not have an active alert.

Zoom and full screen

The map has Zoom in, Zoom out, and Full screen controls. Pin positions are stored as percentages of the image, so they remain in place when you zoom or resize the screen.

Editing pins

Adding, moving, editing, and removing pins requires edit permission for the application. Without that permission, the map is view-only.

A pin in Edit position mode: the hint reads 'Drag the pin to move it. Press Esc to cancel,' the selected pin is being dragged to a new spot, and a small toolbar offers Save and Cancel.
In Edit position mode, drag the pin and click Save to store its new position.
Action What it does
Edit position Drag the pin to a new spot, then Save. Only that pin’s coordinates change. Press Esc or click Cancel to discard the change.
Edit Reopen the device dialog to change the attribute, category, label, or click-charts for that pin.
Delete Confirm “Remove device from map?” to remove the pin. This does not delete the device, and you can add it to the map again later.

On a desktop, these actions appear in a menu on the selected pin. On a phone, they appear in the pin’s bottom sheet.

Maps on dashboards

You can show a map as a dashboard widget. The widget mirrors the map created on the Map page.

The dashboard widget editor's Import map panel. It has an Application map dropdown that lists the application's maps, and a Map setting block with a Window section holding Information and Filter toggles to show or hide the map's info and filter windows. When no maps exist it shows a 'Create a map' button that links to the Map page.
On a dashboard, Import map mirrors an existing map as a widget.
Create maps on the Map page. A dashboard can only mirror an existing map. When editing a dashboard, use Import map and select a map from the Application map dropdown. The selected map supplies the pins and layout. If the application has no maps, the panel shows “No maps in this application yet. Create one on the Map page, then return here to import it.” and a Create a map button.
  • Under Map setting, the widget has a Window section with Information and Filter toggles to show or hide the map’s information and filter windows on the dashboard.
  • A widget created as a map widget cannot be changed into another widget type afterward.
  • The Map page appears in an application’s navigation only when its route is enabled in the application sidebar.

Limits and other details

Use this table as a quick reference.

Limit Value
Maps per application 15
Floor image types PNG, JPEG, WebP
Map title length 255 characters
Categories (pin icons) 10 (Air Flow, Temperature, Humidity, CO2, Acceleration, Door, Brightness, Motion, Occupancy, Other)
Pins per device, per map 1. A pinned device is hidden from the picker.

Start Free Trial