Concepts

Term	Meaning
Company	Your organisation in Kealink, with its own portal, people, machines and settings. Also called a tenant.
Portal	Your company's website for Kealink, on app.kealink.co.nz or on your own address.
Machine	One thing that sends readings. Each machine has its own machine id and password, and reports on a fixed interval, 30 seconds unless set otherwise.
Machine id	26 lowercase letters and digits, such as 01j9x4n7k2b3q8r5t6v7w8x9y0. It is the machine's MQTT username and appears in its topic and API address.
Reading	One measurement a machine sends, such as spindle temperature. Each has a key, a label, a unit, a kind and optional limits. The API calls a reading a point.
Key	The name a reading has in the data the machine sends: lowercase letters, digits and _, up to 40 characters, such as spindle_temp. Capitals in what the machine sends do not matter.
Kind	Number, On and off (sent as true/false or 1/0), or Text (up to 200 characters, such as a program name).
Value	One reading at one time.
Dashboard	Your own arrangement of widgets: values, gauges, charts, machine cards and more.
Alert	Opens when a reading goes past its limit or a machine stops reporting, and closes when it recovers.
API key	A key that lets other software read one company's data. It cannot send data.

Machine status

The status describes the connection, not what the machine is doing. An idle machine with its power on still reports.

Status	Meaning	In the API
Reporting	A reading arrived within the last two intervals	online
Late	Nothing for more than two intervals	stale
Not reporting	Nothing for more than three intervals. Opens an alert.	offline
Waiting for first reading	Added, and nothing has arrived yet	offline with lastSeenAt null

A machine reporting every 30 seconds is late after about a minute of silence, and not reporting after about a minute and a half.

A message whose keys match none of the machine's readings does not count as a reading.