Skip to contents

List MUDAB PLC parameters

Usage

mudab_plc_parameters(
  filter = NULL,
  range = NULL,
  orderby = NULL,
  safe = TRUE,
  refresh = FALSE
)

Arguments

filter

Optional filter definition.

range

Optional range specification.

orderby

Optional ordering specification.

safe

Logical; if TRUE (default), apply rate-limiting and cache GET responses to tools::R_user_dir("bunddev", "cache").

refresh

Logical; if TRUE, ignore cached responses and re-fetch from the API (default FALSE).

Value

A tibble with one row per PLC parameter and columns:

metadataid

Integer. Metadata identifier.

PARAMETER

Character. Parameter abbreviation.

PARAMETERGRUPPE

Character. Parameter group code.

STATION_CODE

Character. Station code.

LETZTE_MESSUNG

Character. Year of last measurement.

PRKEY

Character. Unique key (station + parameter).

STATION_NAME

Character. Station name.

ANZ_MESSWERTE

Integer. Number of measured values.

SUBCM_CODE

Character. Sub-compartment code.

SUBCM_NAME

Character. Sub-compartment name.

Details

Returns parameters measured at PLC stations. API documentation: https://mudab.api.bund.dev.

Examples

if (FALSE) { # \dontrun{
mudab_plc_parameters(range = list(from = 0, count = 5))
} # }