Sync to GitHub

Author: CI

README.md

@@ -4,12 +4,6 @@ BACstack is a low-level Elixir implementation for the ASHRAE standard 135, BACne
 This implementation supports ASHRAE 135-xxxx and BACnet/IPv4. Support for other transport layers (such as BACnet/SC)
 can be straight forward added on top of it.
 
-BACnet/Ethernet is a tested transport (but not supported on Windows),
-but rarely seen in commercial devices since BACnet/IPv4 is the better and superior choice.
-BACnet/IPv4 is the most mature transport and also most widely supported one in general (next to MS/TP).
-BACnet/MS/TP is an experimental transport that requires [circuits_uart](https://hex.pm/packages/circuits_uart)
-and an USB RS485 adapter (or any serial device/tty supported by circuits_uart).
-
 <!-- TODO: Update year in ASHRAE 135-xxxx -->
 
 As this is a low-level implementation, users of this library are required to do the heavy-lifting of the BACnet stack,
@@ -18,6 +12,12 @@ such as automatically replying to Who-Is services, applying hard application tim
 <!--If you're looking for a high level Elixir abstraction on top of this library, check out [BACnex].
 BACnex is a high level abstraction on top of this library, that offers the high level features of a regular BACnet stack.-->
 
+Currently implemented transport layers:
+- BACnet/Ethernet: Rarely seen in commercial devices since BACnet/IPv4 is the better and superior choice
+- BACnet/IPv4: The most mature transport and also most widely supported one in general (next to MS/TP)
+- BACnet/MS/TP: An experimental transport that requires [circuits_uart](https://hex.pm/packages/circuits_uart)
+  and an USB RS485 adapter (or any serial device/tty supported by circuits_uart)
+
 ## Installation
 
 While v0.0.1 has been released to [Hex](https://hex.pm/packages/bacstack) to provide a minimal BACnet client featureset,

lib/bacnet/protocol/object_types/device.ex

@@ -47,6 +47,7 @@ defmodule BACnet.Protocol.ObjectTypes.Device do
   alias BACnet.Protocol.Device.ServicesSupported
   alias BACnet.Protocol.ObjectIdentifier
   alias BACnet.Protocol.ObjectsMacro
+  alias BACnet.Protocol.ObjectsUtility.Internal
   alias BACnet.Protocol.Recipient
 
   require Constants
@@ -164,33 +165,14 @@ defmodule BACnet.Protocol.ObjectTypes.Device do
     # Properties for when the device is capable of tracking date and time
     field(:local_date, BACnetDate.t(),
       readonly: true,
-      init_fun: &BACnetDate.utc_today/0,
-      annotation: [
-        # Maybe we want to use DateTime.now/1 with the correct TimeZone? (the configured default)
-        # We use DateTime instead of Date so when shifting the time, we get the correct date
-        on_read_function:
-          &update_property(
-            &1,
-            :local_date,
-            BACnetDate.from_date(
-              DateTime.to_date(DateTime.add(DateTime.utc_now(), -(&1[:utc_offset] || 0), :minute))
-            )
-          )
-      ]
+      init_fun: &Internal.init_fun_local_date/0,
+      annotation: [on_read_function: &update_local_date/1]
     )
 
     field(:local_time, BACnetTime.t(),
       readonly: true,
-      init_fun: &BACnetTime.utc_now/0,
-      annotation: [
-        # Maybe we want to use DateTime.now/1 with the correct TimeZone? (the configured default)
-        on_read_function:
-          &update_property(
-            &1,
-            :local_time,
-            BACnetTime.from_time(Time.add(Time.utc_now(), -(&1[:utc_offset] || 0), :minute))
-          )
-      ]
+      init_fun: &Internal.init_fun_local_time/0,
+      annotation: [on_read_function: &update_local_time/1]
     )
 
     # Properties for COV reporting service
@@ -344,6 +326,29 @@ defmodule BACnet.Protocol.ObjectTypes.Device do
 
   defp map_vendor_to_name(_id), do: ""
 
+  @spec update_local_date(t()) :: {:ok, t()} | {:error, term()}
+  defp update_local_date(%__MODULE__{} = obj) do
+    # Maybe we want to use DateTime.now/1 with the correct TimeZone? (the configured default)
+    # We use DateTime instead of Date so when shifting the time, we get the correct date
+    update_property(
+      obj,
+      :local_date,
+      BACnetDate.from_date(
+        DateTime.to_date(DateTime.add(DateTime.utc_now(), -(obj[:utc_offset] || 0), :minute))
+      )
+    )
+  end
+
+  @spec update_local_time(t()) :: {:ok, t()} | {:error, term()}
+  defp update_local_time(%__MODULE__{} = obj) do
+    # Maybe we want to use DateTime.now/1 with the correct TimeZone? (the configured default)
+    update_property(
+      obj,
+      :local_time,
+      BACnetTime.from_time(Time.add(Time.utc_now(), -(obj[:utc_offset] || 0), :minute))
+    )
+  end
+
   @spec inhibit_object_check(t()) :: {:ok, t()}
   defp inhibit_object_check(obj) do
     # Only patch vendor name if empty

lib/bacnet/protocol/objects_utility/internal.ex

@@ -1,11 +1,38 @@
 defmodule BACnet.Protocol.ObjectsUtility.Internal do
   @moduledoc false
 
-  alias BACnet.Protocol
   alias BACnet.Protocol.BACnetArray
+  alias BACnet.Protocol.BACnetDate
+  alias BACnet.Protocol.BACnetTime
+  alias BACnet.Protocol.DailySchedule
 
+  @spec init_fun_schedule_weekly_schedule() :: BACnetArray.t(DailySchedule.t())
   def init_fun_schedule_weekly_schedule() do
-    BACnetArray.new(7, %Protocol.DailySchedule{schedule: []})
+    BACnetArray.new(7, %DailySchedule{schedule: []})
+  end
+
+  @spec init_fun_local_date() :: BACnetDate.t()
+  def init_fun_local_date() do
+    BACnetDate.from_date(
+      DateTime.to_date(
+        DateTime.now!(
+          Application.get_env(:bacstack, :default_timezone, "Etc/UTC"),
+          Calendar.get_time_zone_database()
+        )
+      )
+    )
+  end
+
+  @spec init_fun_local_time() :: BACnetTime.t()
+  def init_fun_local_time() do
+    BACnetTime.from_time(
+      DateTime.to_time(
+        DateTime.now!(
+          Application.get_env(:bacstack, :default_timezone, "Etc/UTC"),
+          Calendar.get_time_zone_database()
+        )
+      )
+    )
   end
 
   defmodule ReadPropertyAckTransformOptions do

lib/bacnet/stack/client.ex

@@ -510,6 +510,12 @@ defmodule BACnet.Stack.Client do
       including  replies sent to requests that were never meant for that request.
     - `max_apdu_length: pos_integer()` - Optional. The maximum APDU length
       the remote BACnet device supports (defaults to the transport max APDU length).
+      Limited by the transport max (extended) APDU length.
+      If the transport supports an extended APDU length, you need to make sure
+      the transport uses it, if it needs to be explicitely enabled.
+      For calculation, always the NPDU length is used, as it expresses how many
+      bytes for the APDU can actually be used without constraining the transport's
+      actual maximum transmission unit.
     - `max_segments: pos_integer()` - Optional. Maximum amount of segments the
       remote BACnet device can accept (defaults to 2).
     - `segmentation_supported: Constants.segmentation()` - Optional. Which kind
@@ -1902,11 +1908,21 @@ defmodule BACnet.Stack.Client do
       # Catch any errors when trying to encode the APDU
       bin = EncoderProtocol.encode(apdu)
 
-      # 50 is the minimum APDU size each device needs to support
       max_apdu_len =
         case Keyword.fetch(opts, :max_apdu_length) do
-          {:ok, val} -> min(max(val, 50), trans_mod.max_npdu_length())
-          _error -> trans_mod.max_npdu_length()
+          {:ok, val} ->
+            max_npdu =
+              if function_exported?(trans_mod, :max_ext_npdu_length, 0) do
+                trans_mod.max_ext_npdu_length()
+              else
+                trans_mod.max_npdu_length()
+              end
+
+            # 50 is the minimum APDU size each device needs to support
+            min(max(val, 50), max_npdu)
+
+          _error ->
+            trans_mod.max_npdu_length()
         end
 
       {bin, max_apdu_len}

lib/bacnet/stack/transport/mstp_transport.ex

@@ -16,6 +16,9 @@ if Code.ensure_loaded?(Circuits.UART) do
     ```
     As defined by `t:BACnet.Stack.TransportBehaviour.transport_cb_frame/0`.
 
+    Note: Currently `max_apdu_length/0` and `max_npdu_length/0` always return the max APDU as per 135-2012
+    and not the higher possible APDU as per 135-2016.
+
     It uses `Circuits.UART` to handle RS485 for us in active mode.
     If you want to use this transport, you'll have to add [`:circuits_uart`](https://hex.pm/packages/circuits_uart)
     to your `mix.exs` as dependency! It is an optional dependency and thus
@@ -375,6 +378,13 @@ if Code.ensure_loaded?(Circuits.UART) do
     @spec max_apdu_length() :: pos_integer()
     def max_apdu_length(), do: @max_apdu
 
+    @doc """
+    Get the maximum extended APDU length for this transport,
+    if the transport also supports a higher (extended) APDU.
+    """
+    @spec max_ext_apdu_length() :: pos_integer()
+    def max_ext_apdu_length(), do: @max_apdu_extended
+
     @doc """
     Get the maximum NPDU length for this transport.
 
@@ -388,6 +398,20 @@ if Code.ensure_loaded?(Circuits.UART) do
     @spec max_npdu_length() :: pos_integer()
     def max_npdu_length(), do: @max_apdu
 
+    @doc """
+    Get the maximum extended NPDU length for this transport,
+    if the transport also supports a higher (extended) NPDU.
+
+    The NPDU length contains the maximum transmittable size
+    of the NPDU, including the APDU, without violating
+    the maximum transmission unit of the underlying transport.
+
+    Any necessary transport header (i.e. BVLL, LLC) must have
+    been taken into account when calculating this number.
+    """
+    @spec max_ext_npdu_length() :: pos_integer()
+    def max_ext_npdu_length(), do: @max_apdu_extended
+
     @doc """
     Opens/starts the Transport module. A process is started, that is linked to the caller process.