Skip to content

Sensors & Tags

Two catalogs that subscriptions build on: sensors (the devices that produce data) and tags (the event-type vocabulary). In the sidebar they are Sensors and Event Types. Each organization keeps its own of both, and each can reach beyond the organization: a sensor you make public can serve other organizations' subscriptions, and every organization's event types together are what any app can subscribe to.

Both pages follow the portal's shared list and record conventions. See Working with lists and Opening a record.

Sensors

The Sensors page needs sensors:read. Registering and editing sensors needs sensors:write, and decommissioning needs sensors:delete, which is a separate permission.

Which sensors the list shows

The scope filter in the table's header decides whose sensors you're looking at:

Scope Rows
My organization (default) Your organization's sensors, public or private.
Public sensors Sensors that other organizations have made public. Your own public sensors are not included.
All visible sensors Both of the above.

When the scope includes other organizations' sensors, an Organization column names each sensor's owner. Inactive sensors are listed. Decommissioned sensors never are. Search matches a sensor's name, description, type, ID, coordinates and last-seen time, and on your own organization's sensors its metadata too. The connection config is never searched, and neither is another organization's metadata. Changing the scope keeps your search.

Show map opens a map beside the table. It plots every sensor that matches the current search and scope, not only the rows loaded so far. Select a pin to open that sensor, or expand the map to fill the screen. For a very large set the map stops early and shows how many sensors it plotted out of the total.

Registering a sensor

Create sensor needs sensors:write. The dialog has three groups of fields and a live map preview:

  • Details: Name (required), Sensor type, Description, Active, and Share with other organizations, which is unticked by default, so a new sensor starts private.
  • Location & coverage: Latitude and Longitude (both required) set the sensor's pin on the map. Coverage geometry (GeoJSON) is a GeoJSON polygon of the area the sensor observes. Leave it as {} to use the sensor's location instead.
  • Connection: Connection config (JSON) says where and how the platform reaches the device, such as its stream URL. A stream_url or camera_url in it must be a URL the platform can use: printable ASCII characters only, no backslash (\), not ending in a colon (:), and with a host. See What connectionConfig may hold for the full rule. It never holds a username or password: the dialog refuses a login written into it, as a key such as username or inside a URL as user:pass@. If the device asks for a login, tick This sensor needs a login to connect under Device login and enter its Username and Password instead. See Device logins. Metadata (JSON) is free-form and isn't used for matching.

Subscriptions match the area of view, not the pin

A subscription matches a sensor when the sensor's area of view (its coverage geometry) overlaps a requested region. Where the sensor itself stands is not consulted: a camera on a corner that watches a street is matched by a request for that street. An inactive sensor is not matched. See Subscriptions & Events.

The sensor dialog

Click a sensor's row or its Open button, or select its pin on the map. The same dialog opens from the Request Builder's map pins, and platform administrators get it from System Admin → All Sensors.

The header shows the sensor's status (Active, Inactive or Decommissioned), whether it is Public or Private, its owning organization, when it was created and when it was last seen. The sections listed down the left side depend on what you're allowed to see:

  • Details is always there. It holds the sensor's type, description and visibility, with its history below.
  • Location & coverage shows the coordinates and the coverage geometry, next to the map.
  • Connection holds the connection config, whether a device login is saved, and the metadata. It appears only for your own organization's sensors. Another organization's sensor has no Connection section at all.

Editing needs both things: the sensor belongs to your organization, and your role grants sensors:write. Then every field is an input, and a save bar appears as soon as something changes. When editing, you can replace the coverage geometry but not clear it. Anyone else on the Sensors page, including every member looking at another organization's public sensor, sees the same dialog with values only.

Visibility is the Share with other organizations checkbox in Details, saved with Save changes like any other field. When a save would make the sensor public, the portal first asks Make this sensor public? and saves only after you choose Make sensor public. Making a sensor private again saves without asking. Readers see the Public or Private badge instead, with a sentence saying what it means.

Decommission sensor sits at the foot of Details, for your own organization's sensors when your role grants sensors:delete. To confirm, you type the sensor's name. Decommissioning is permanent: a decommissioned sensor can't be recommissioned, it leaves the list, and subscriptions stop being served by it. That includes other organizations' subscriptions if the sensor was public.

A subscription created after a change sees the sensor as it is then. Subscriptions that already exist pick up a sensor being published, made private, moved, deactivated or decommissioned at the platform's hourly re-check.

Device logins

Some devices ask for a username and password before they share their stream. That login is the sensor's Device login, and it lives in the Connection section, never in the connection config. Once saved, it can't be viewed in Dory by anyone: not by you, not by anyone else in your organization, and not by Dory's administrators. You can only replace it or remove it.

What the Connection section shows depends on who you are:

Who What they see
Your organization, with sensors:write A Device login block: Login reads Saved or No login, with the buttons below.
Your organization, with sensors:read only Device login: Saved or No login, as plain text with no controls.
Another organization No Connection section, so nothing says whether the sensor has a login.
A platform administrator in System Admin → All Sensors No Connection section.

With sensors:write, the buttons stage a change that Save changes sends, like any other field:

  • Replace login shows empty Username and Password fields for the new login. Keep current login puts the saved one back.
  • Remove login shows "The saved login will be removed when you save." Undo keeps the login.
  • Add login, on a sensor without one, shows the same two fields. Don't add a login closes them.

When you create a sensor, the same block offers This sensor needs a login to connect. Tick it if the device asks for a username and password, and enter both. Both are required, each is at most 256 characters, and a username can't contain a colon (:).

A camera with a login needs a stream URL the platform can use. If the stream URL saved in a camera's connection config isn't usable, saving the camera with a login is refused, with the reason under Connection config (JSON), so a login can't be added until the URL is fixed. Correct the URL first, or in the same save.

The platform uses the saved login to sign in to the device for the processors that read it, and never hands the login to a processor. For a camera, it starts using a new login within about 2 minutes, and without a saved login it can't sign in to a camera that requires one. Any sensor type can hold a login, but today the platform signs in only to cameras.

Changing a device's password

Change the password on the device first. Then open the sensor, choose Replace login, enter the new username and password, and choose Save changes. Until the new login is in use, the platform can't sign in to the device, so processors may briefly lose its stream. Replacing or removing a login changes this sensor only.

What publishing a sensor grants other organizations

Making a sensor public lets it serve other organizations' subscriptions. It does not give them control of it or the means to reach it.

Other organizations can Other organizations cannot
Have their subscriptions served by it. When a subscription's regions overlap the sensor's area of view, the subscription receives the sensor's events for the event types it requests, through the lens it names. See its connection config, its metadata or whether it has a device login, in the portal or through the API.
Find it on their Sensors page under Public sensors or All visible sensors, named with your organization, and open its dialog. They see its type, status, location, area of view, description and when it was last seen. Edit it, change its visibility, or decommission it.

To serve those subscriptions, the platform runs processors on your sensor using the templates in each subscriber's lens, and those may be another organization's templates. A processor is given the sensor's connection config so that it can reach the device, which is what that field is for. It is never given the device login: for a camera, the platform signs in to the camera itself and gives the processor a stream address on the platform instead of the camera's own. A template version runs only after a Dory administrator has approved it.

Making a sensor private again

New subscriptions stop matching the sensor straight away, and existing subscriptions in other organizations drop it at the next hourly re-check. Events already delivered can't be recalled.

Tags

Tags are managed on the Event Types page. It needs tags:read. Creating and editing event types needs tags:write, and deleting one needs tags:delete. A tag is an event type: a kind of event that processors emit and subscriptions request, such as person. Event types can be nested under a parent.

The event types list

The scope filter in the table's header offers This organization (the default) and All organizations. All organizations lists every organization's event types, with an Organization column naming each owner. In that scope every event type opens read-only, and Create event type isn't offered: you create event types only in your own organization.

The list shows each event type's Name, Slug, Category, Parent event type, Created date and Description. Search matches a name, slug or parent.

Creating and editing an event type

Create event type, or opening one of your organization's event types with tags:write, shows these fields:

  • Name (required).
  • Slug (required): the identifier subscriptions and processors use for this event type. The dialog shows the value it will be saved as. If another event type in your organization already uses the slug, the dialog says so under the field.
  • Category: Object or Activity.
  • Parent event type: a searchable picker over your organization's event types, or None for a top-level type. When editing, the picker leaves out the event type itself and everything beneath it, so a loop can't be made.
  • Description.

Delete event type sits inside the dialog, below the fields, for members with tags:delete. Its child event types move to the top level, and deleting can't be undone.

How event types reach subscriptions

The slug is what a subscription requests. The event types any app may subscribe to are the slugs of every organization's event types together. That is the list the platform publishes to apps, and a subscribe request naming an event type outside it is refused, with the unknown types named. Because the check is by slug, the same slug means the same event type whichever organization defined it.

An event type becomes useful once a template emits it. Event types are picked in two places:

  • Publishing a template version: the processor template's publishing flow offers your organization's event types, and you tick the ones the processor emits. See the Template developer guide.
  • The Request Builder: you pick from every organization's event types.

Both pickers search as you type. A subscription can ask for an event type that no template in its lens emits. The request is accepted, and the subscription's coverage report marks that type as not covered.

Where this fits

Sensors define where events can come from, and event types define what kinds of events exist. A lens decides how sensor data becomes those events, and a subscription combines event types, regions and a lens. See Subscriptions & Events.