Novant

Documentation

Search /
Sign in

Source Maps

Retrieves the source maps defined in this project. A source map is the point template for a piece of equipment - it defines the points a source exposes, and is shared by every source bound to it.

GET /v1/source-maps
curl https://api.novant.io/v1/source-maps \
  -u ak_sample_123: \
  --compressed

Parameters

source_map_ids

An allowlist to filter source maps by ID. Ids are formatted as a comma-separated list, i.e.: "sm.1,sm.4".

Returns

Returns the source maps in this project, each with its full point list.

{
  "source_maps": [
    {
      "id": "sm.1",
      "name": "ECB-600",
      "type": "bacnet",
      "vendor": "Distech",
      "model": "ECB-600",
      "desc": "Rooftop unit controller",
      "num_bound": 12,
      "points": [
        {
          "id": 1,
          "name": "Discharge Air Temperature",
          "type": "discharge_air_temp_sensor",
          "addr": "ai.1",
          "kind": "num",
          "unit": "°F",
          "writable": false
        },
        {
          "id": 2,
          "name": "Cooling",
          "type": "generic",
          "addr": "av.3",
          "kind": "num",
          "unit": "%",
          "writable": true
        },
        ...
      ]
    },
    ...
  ]
}

The type field on the map is the protocol it targets - bacnet, jasper, modbus, opc, or mqtt. The vendor, model, and desc fields are optional and describe the equipment the map was built for.

num_bound is the number of sources in this project currently bound to the map. A map with num_bound of 0 is defined but unused.

Points are always included. Because a source map is a point template, reading one without its points is rarely useful - use source_map_ids to narrow the response when a project has many maps.

Point Fields

Field Description
id Point number, unique within this map.
name Display name for the point.
type Point type, or generic if not classified.
addr Protocol address of the point on the device.
kind Value kind: num, bool, or enum.
writable Whether this point can be commanded once a source is bound.
unit Unit of measure, when applicable.
enum Comma-separated enum state names, for enum points.
desc Description of the point, when specified.
schedule occupied, standby, or unoccupied.
mode heating, cooling, warmup, or cooldown.
limit min or max.
modifier alarm, differential, effective, offset, runtime, or static.

Optional fields are omitted when not set.

These mirror the fields returned by the Points API, with two exceptions: ontology and enum_states are not included, since both are resolved against the source a point is bound to and a map point has no source.

writable describes the point definition, so it is the same whether or not a source is bound - it answers whether binding a source to this map would make the point commandable.