BACnet.Protocol.Services.UtcTimeSynchronization (bacstack v0.0.1)

View Source

This module represents the BACnet UTC Time Synchronization service.

The UTC Time Synchronization service is used to send the correct UTC date and time onto the BACnet network or to a single recipient.

Service Description (ASHRAE 135):

The UTCTimeSynchronization service is used by a requesting BACnet-user to notify one or more remote devices of the correct Universal Time Coordinated (UTC). This service may be broadcast, multicast, or addressed to a single recipient. Its purpose is to notify recipients of the correct UTC so that devices may synchronize their internal clocks with one another.

Summary

Types

t()

Functions

from_apdu(request)

Converts the given Unconfirmed Service Request into an UTC Time Synchronization Service.

get_name()

Get the service name atom.

is_confirmed()

Whether the service is of type confirmed or unconfirmed.

to_apdu(service, request_data)

Get the Unconfirmed Service request for the given UTC Time Synchronization Service.

Types

t()

@type t() :: %BACnet.Protocol.Services.UtcTimeSynchronization{
  date: BACnet.Protocol.BACnetDate.t(),
  time: BACnet.Protocol.BACnetTime.t()
}

Functions

from_apdu(request)

@spec from_apdu(BACnet.Protocol.APDU.UnconfirmedServiceRequest.t()) ::
  {:ok, t()} | {:error, term()}

Converts the given Unconfirmed Service Request into an UTC Time Synchronization Service.

get_name()

@spec get_name() :: atom()

Get the service name atom.

is_confirmed()

@spec is_confirmed() :: false

Whether the service is of type confirmed or unconfirmed.

to_apdu(service, request_data)

@spec to_apdu(t(), Keyword.t()) ::
  {:ok, BACnet.Protocol.APDU.UnconfirmedServiceRequest.t()} | {:error, term()}

Get the Unconfirmed Service request for the given UTC Time Synchronization Service.

See the BACnet.Protocol.Services.Protocol function documentation for more information.