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

View Source

This module represents the BACnet Create Object service.

The Create Object service is used to dynamically create an object in the remote device.

Service Description (ASHRAE 135):

The CreateObject service is used by a client BACnet-user to create a new instance of an object. This service may be used to create instances of both standard and vendor specific objects. The standard object types supported by this service shall be specified in the PICS. The properties of standard objects created with this service may be initialized in two ways: initial values may be provided as part of the CreateObject service request or values may be written to the newly created object using the BACnet WriteProperty services. The initialization of non-standard objects is a local matter. The behavior of objects created by this service that are not supplied, or only partially supplied, with initial property values is dependent upon the device and is a local matter.

Summary

Types

t()

Functions

from_apdu(request)

Converts the given Confirmed Service Request into a Create Object 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 Confirmed Service request for the given Create Object Service.

Types

t()

@type t() :: %BACnet.Protocol.Services.CreateObject{
  initial_values: [BACnet.Protocol.PropertyValue.t()],
  object_specifier:
    BACnet.Protocol.ObjectIdentifier.t()
    | BACnet.Protocol.Constants.object_type()
}

Functions

from_apdu(request)

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

Converts the given Confirmed Service Request into a Create Object Service.

get_name()

@spec get_name() :: atom()

Get the service name atom.

is_confirmed()

@spec is_confirmed() :: true

Whether the service is of type confirmed or unconfirmed.

to_apdu(service, request_data)

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

Get the Confirmed Service request for the given Create Object Service.

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