Package net.solarnetwork.node.service

Interface NodeControlProvider

All Superinterfaces:
net.solarnetwork.service.Identifiable
public interface NodeControlProvider extends net.solarnetwork.service.Identifiable
API for control providers to implement. For many control providers that implement a single control, the Identifiable.getUid() will return the control ID of that control.
Version:
2.0
Author:
matt

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EVENT_TOPIC_CONTROL_INFO_CAPTURED
    An Event topic for when a NodeControlInfo has been read, sampled, or in some way captured by a NodeControlProvider.
    static final String
    EVENT_TOPIC_CONTROL_INFO_CHANGED
    An Event topic for when a NodeControlInfo has in some way been changed.

    Fields inherited from interface net.solarnetwork.service.Identifiable

    GROUP_UID_PROPERTY, UID_PROPERTY

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getAvailableControlIds()
    Get a list of available controls this provider supports.
    net.solarnetwork.domain.NodeControlInfo
    getCurrentControlInfo(String controlId)
    Get the current instantaneous component value for the given component ID.

    Methods inherited from interface net.solarnetwork.service.Identifiable

    getDisplayName, getGroupUid, getUid

  • Field Details

    • EVENT_TOPIC_CONTROL_INFO_CAPTURED

      static final String EVENT_TOPIC_CONTROL_INFO_CAPTURED
      An Event topic for when a NodeControlInfo has been read, sampled, or in some way captured by a NodeControlProvider. If the NodeControlInfo also implements NodeDatum then the DatumEvents.DATUM_PROPERTY event property will be populated with the instance. Otherwise, the properties of the event shall be any of the JavaBean properties of the NodeControlInfo supported by events (i.e. any simple Java property such as numbers and strings) with enum values provided as strings.
      Since:
      1.2
      See Also:

    • EVENT_TOPIC_CONTROL_INFO_CHANGED

      static final String EVENT_TOPIC_CONTROL_INFO_CHANGED
      An Event topic for when a NodeControlInfo has in some way been changed. If the NodeControlInfo also implements NodeDatum then the DatumEvents.DATUM_PROPERTY event property will be populated with the instance. Otherwise, the properties of the event shall be any of the JavaBean properties of the NodeControlInfo supported by events (i.e. any simple Java property such as numbers and strings) with enum values provided as strings.
      Since:
      1.3
      See Also:

  • Method Details

    • getAvailableControlIds

      List<String> getAvailableControlIds()
      Get a list of available controls this provider supports.
      Returns:
      the components

    • getCurrentControlInfo

      net.solarnetwork.domain.NodeControlInfo getCurrentControlInfo(String controlId)
      Get the current instantaneous component value for the given component ID.
      Parameters:
      controlId - the ID of the control to get the info for
      Returns:
      the current value