BACnet.Protocol.Services.UtcTimeSynchronization (bacstack v0.1.0-dev.1)

Copy Markdown 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.

Service Procedure (ASHRAE 135)

Since this is an unconfirmed service, no response primitives are expected. A device receiving a UTCTimeSynchronization service indication shall update its local representation of time and date by subtracting the value of the 'UTC_Offset' property of the Device object from the 'Time' parameter and taking the 'Daylight_Savings_Status' property of the Device object into account as appropriate to the locality. This change shall be reflected in the Local_Time and Local_Date properties of the Device object. No restrictions on the use of this service exist when it is invoked at the request of an operator. Otherwise, the initiation of this service by a device is controlled by the value of the UTC_Time_Synchronization_Recipients property in the Device object. When the UTC_Time_Synchronization_Recipients list is of length zero, a device may not automatically send a UTCTimeSynchronization request. When UTC_Time_Synchronization_Recipients list is of length one or more, a device may automatically send a UTCTimeSynchronization request but only to the devices or addresses contained in the UTC_Time_Synchronization_Recipients list.

Summary

Types

t()

Parameters for the UTC Time Synchronization service (unconfirmed).

Functions

confirmed?()

Whether the service is of type confirmed or unconfirmed.

from_apdu(request)

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

get_name()

Get the service name atom.

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()
}

Parameters for the UTC Time Synchronization service (unconfirmed).

Broadcasts the current UTC date and time so devices can synchronize clocks across time zones.

Functions

confirmed?()

@spec confirmed?() :: false

Whether the service is of type confirmed or unconfirmed.

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.

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.