Package net.solarnetwork.node.io.bacnet

Interface BacnetNetwork

All Superinterfaces:
net.solarnetwork.service.Identifiable
public interface BacnetNetwork extends net.solarnetwork.service.Identifiable
High level BACnet entry point API.

This API aims to simplify accessing BACnet devices without having any direct dependency on any specific BACnet implementation. A BacnetNetwork is a service that provides the entry point into the underlying BACnet network. It is expected that implementations of this API are configured with appropriate Identifiable properties and registered at runtime so that clients wishing to interact with BACnet are able to request a suitably configured service.

Version:
1.0
Author:
matt

  • Field Summary

    Fields inherited from interface net.solarnetwork.service.Identifiable

    GROUP_UID_PROPERTY, UID_PROPERTY

  • Method Summary

    Modifier and Type
    Method
    Description
    BacnetConnection
    createConnection()
    Create a connection to a specific BACnet.
    void
    setCachePolicy(Collection<BacnetDeviceObjectPropertyRef> refs, long cacheMs)
    Set the property cache policy for a set of properties.

    Methods inherited from interface net.solarnetwork.service.Identifiable

    getDisplayName, getGroupUid, getUid

  • Method Details

    • setCachePolicy

      void setCachePolicy(Collection<BacnetDeviceObjectPropertyRef> refs, long cacheMs)
      Set the property cache policy for a set of properties.
      Parameters:
      refs - the references
      cacheMs - the maximum length of time to cache the property values

    • createConnection

      BacnetConnection createConnection()
      Create a connection to a specific BACnet.

      The returned connection will not be opened and must be closed when finished being used.

      Returns:
      a new connection, or null if a connection cannot be created, such as from lack of required configuration
      Throws:
      IllegalArgumentException - if busName is invalid