knxex v0.1.0

View Source KNXex.EtsProject (knxex v0.1.0)

KNX ETS project.

Link to this section Summary

Types

completion_status()

KNX completion status.

medium()

KNX medium type. Twisted Pair, IP, Radio Frequency, or Powerline.

t()

Represents a KNX ETS project.

Functions

new(project_path, name \\ "")

Returns a new empty ETS project struct.

Link to this section Types

Link to this type

completion_status()

View Source 
@type completion_status() ::
  :unknown
  | :editing
  | :finished_design
  | :finished_commissioning
  | :tested
  | :accepted
  | :locked

KNX completion status.

Link to this type

medium()

View Source 
@type medium() :: :tp | :ip | :rf | :pl | :unknown

KNX medium type. Twisted Pair, IP, Radio Frequency, or Powerline.

Link to this type

t()

View Source 
@type t() :: %KNXex.EtsProject{
  bus_access_legacy_mode: boolean(),
  comment: String.t(),
  completion_status: completion_status(),
  contract_number: String.t() | nil,
  group_addresses: %{
    optional(id_or_address :: String.t()) =>
      KNXex.EtsProject.GroupAddressInfo.t()
  },
  last_modified: NaiveDateTime.t() | nil,
  locations: nil,
  name: String.t(),
  project_end: NaiveDateTime.t() | nil,
  project_number: String.t() | nil,
  project_path: binary(),
  project_start: NaiveDateTime.t() | nil,
  topology: %{
    optional(address :: non_neg_integer()) => KNXex.EtsProject.Topology.Area.t()
  },
  unassigned_devices: [KNXex.EtsProject.Topology.Device.t()]
}

Represents a KNX ETS project.

Locations is currently not supported and ignored.

group_addresses is keyed by the ID or the group address in x/y/z notation, depending on the parser setting :group_addresses_key.

Link to this section Functions

Link to this function

new(project_path, name \\ "")

View Source

Returns a new empty ETS project struct.