PiParameter#

class fews_py_wrapper.models.PiParameter(*, id, name=None, shortName=None, parameterType, unit, displayUnit=None, usesDatum=False, parameterGroup=None, parameterGroupName=None, attributes=<factory>)[source]#

Typed FEWS PI time-series parameter entry.

Parameters:

  • id (str)

  • name (str | None)

  • shortName (str | None)

  • parameterType (str)

  • unit (str)

  • displayUnit (str | None)

  • usesDatum (bool)

  • parameterGroup (str | None)

  • parameterGroupName (str | None)

  • attributes (list[PiLocationAttribute])

id: str#
name: str | None#
short_name: str | None#
parameter_type: str#
unit: str#
display_unit: str | None#
uses_datum: bool#
parameter_group: str | None#
parameter_group_name: str | None#
attributes: list[PiLocationAttribute]#
validate_parameter_type()[source]#
Return type:

PiParameter

model_config = {'extra': 'forbid', 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].