×

Live3 · docs

Concepts

The core ideas the product is built around.

Before you dive into the screens and tasks, it helps to know the handful of ideas Live3 is built around. Everything else in the docs refers back to these.

This section is explanation: it tells you what things are and how they relate. For "what does this screen show" see the Interface guide, and for "how do I do X" see the How-to guides.

Organizations

An organization is the top-level container in Live3. Everything else, stations, users and API keys, belongs to exactly one organization.

Why it matters

  • Data is scoped to the organization. Users only ever see the stations their organization owns.
  • Billing and access are managed per organization.
  • API keys are owned by the organization, not by individuals, see API access.

Key terms

TermMeaning
OrganizationThe account that owns stations, users and keys.
MemberA user who belongs to the organization.
AdminA member who can manage other members and settings.

Stations & parameters

A station is a physical unit deployed in the field. Each station reports one or more parameters, the individual measurements it takes (for example wind speed, temperature, or a sensor reading).

Stations

  • Every station belongs to one organization.
  • A station has an identifier, a location, and a set of parameters it reports.
  • Access can be granted per station, so a user may see some stations but not others.

Parameters

A parameter is a single measured value a station reports over time. Each parameter has a code, a human-readable name, and a unit.

FieldMeaning
CodeThe machine identifier used in the API.
NameThe human-readable label shown in the UI.
UnitThe unit the value is reported in.

Users, roles & permissions

A user is an individual who can sign in to Live3. Users belong to an organization, and what each user can do is determined by their role and the stations they've been granted access to.

Roles

Live3 has two roles: admin and user. A role is a bundle of permissions; it decides what a person is allowed to do.

RoleCan do
AdminManage members and their roles, stations, settings and API keys.
UserAccess the stations they have been assigned, and their data.

Station access

A role says what a user can do; station access says where they can do it. A user typically only sees the stations they have been assigned.