OmayaDocumentation

People, assets and space — how to run the platform, what every number means, and how to build on it.

Guides

Task by task — set up your spaces, calibrate a radar, add a sensor Omaya has never seen, write a rule that pages someone. Plus every page in the admin menu, what it is for, and what has to be true before it shows you anything.

Reference

What every number on every screen actually counts, and what it does not. Occupancy sources, peaks versus last readings, the report glossary, every rule metric and every webhook event.

Integrate

Read occupancy, be told when it changes, or push counts from your own systems. Four routes in and out, and how to pick the one that is least work.

Hardware

Where to mount a gateway, how to aim a radar, what it takes to get occupancy out of doorway counters, and the checks worth doing before you leave site.

Start here

New to Omaya, or handed an instance someone else set up, read these four in order:

Signing in — including why the login asks for an organisation, and why your menu is not the same as your colleague's. Then the dashboard you land on, tile by tile.
How Omaya fits together — four diagrams that explain most of the platform.
Occupancy: which number is which — ten minutes well spent. Almost every misunderstanding of this platform starts with one of two numbers being read as the other.
The menu, page by page — every item in the admin menu, what it is for, and what has to be true before it shows you anything.

Depending on what you are here to do

You are	Start at
Running a building on Omaya	Signing in, then the menu tour
Setting an instance up from scratch	Setting up a site, then floor plans and positioning
Reading a report and unsure what a column means	The report glossary
Building something on top of Omaya	Choosing an integration route
On site with a drill	What to install where

Several reference pages are read out of the platform's own code — the webhook events from the event catalog, the rule metrics from the list the rule builder reads, the device matrix from the device configuration, and the report glossary from the "What this report is" panel at the foot of each report. They cannot fall behind the code, because they are read out of it.

These docs are served by the Omaya instance you are reading them from, so they describe the version this instance is running — not a newer one you have not been upgraded to yet.