Skip to contents

Create blueprints in the telemetry API

Usage

telem_create_blueprints(data, dry_run = FALSE, verbosity = 0)

Arguments

data

A tibble with columns: model, version, manufacturer. Optional columns: type (see telem_blueprint_types()), weight, battery, metadata, project_id.

dry_run

Logical. If TRUE, prints the request without sending it.

verbosity

Integer. How much information to print (0 = silent, 1 = headers, 2 = headers + body, 3 = full).

Value

A tibble of created blueprints with their assigned IDs.

Details

A blueprint is the make and model a device is an instance of, so it has to exist before the devices referencing it. The API holds a unique index on (project_id, type, model, version, manufacturer), so that tuple is the natural key to look for before creating — see telem_read_blueprints().

project_id is filled server-side from the token when it is absent, which scopes the blueprint to that project. The globally shared blueprints carry a NULL project_id instead, so they cannot be created this way.

Examples

if (FALSE) { # \dontrun{
telem_create_blueprints(tibble::tibble(
  manufacturer = "Vectronic",
  type = "Collar",
  model = "Survey GPS",
  version = "2026"
))
} # }