BACnet.Protocol.FaultParameters (bacstack v0.0.1)

View Source

BACnet has various different types of fault parameters. Each of them is represented by a different module.

Consult the module BACnet.Protocol.FaultAlgorithms for details about each fault's algorithm.

Summary

Types

fault_parameter()

Possible BACnet fault parameters.

Functions

encode(fault_params, opts \\ [])
parse(fault_values_tag)
valid?(t)

Validates whether the given fault parameter is in form valid.

Types

fault_parameter()

@type fault_parameter() ::
  BACnet.Protocol.FaultParameters.None.t()
  | BACnet.Protocol.FaultParameters.FaultCharacterString.t()
  | BACnet.Protocol.FaultParameters.FaultExtended.t()
  | BACnet.Protocol.FaultParameters.FaultLifeSafety.t()
  | BACnet.Protocol.FaultParameters.FaultState.t()
  | BACnet.Protocol.FaultParameters.FaultStatusFlags.t()

Possible BACnet fault parameters.

Functions

encode(fault_params, opts \\ [])

@spec encode(fault_parameter(), Keyword.t()) ::
  {:ok, BACnet.Protocol.ApplicationTags.encoding()} | {:error, term()}

parse(fault_values_tag)

@spec parse(binary()) :: {:ok, fault_parameter()} | {:error, term()}

valid?(t)

@spec valid?(fault_parameter()) :: boolean()

Validates whether the given fault parameter is in form valid.

It only validates the struct is valid as per type specification.