Class ModbusControlConfig

java.lang.Object
net.solarnetwork.node.control.modbus.ModbusControlConfig

public class ModbusControlConfig extends Object
Overall configuration for a Modbus Control.
Since:
3.1
Version:
1.0
Author:
matt
  • Constructor Details

    • ModbusControlConfig

      public ModbusControlConfig()
  • Method Details

    • toSettingValues

      public List<net.solarnetwork.node.settings.SettingValueBean> toSettingValues(String providerId)
      Generate a list of setting values from this instance.
      Parameters:
      providerId - the setting provider key to use
      Returns:
      the list of setting values, never null
    • populateFromSetting

      public boolean populateFromSetting(net.solarnetwork.node.domain.Setting setting)
      Populate a setting as a configuration value, if possible.
      Parameters:
      setting - the setting to try to handle
      Returns:
      true if the setting was handled as a configuration value
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getKey

      public String getKey()
      Get the instance key.
      Returns:
      the key
    • setKey

      public void setKey(String key)
      Set the instance ID.
      Parameters:
      key - the key to set
    • getModbusNetworkName

      public String getModbusNetworkName()
      Get the modbus network name.
      Returns:
      the modbusNetworkName
    • setModbusNetworkName

      public void setModbusNetworkName(String modbusNetworkName)
      Set the modbus network name.
      Parameters:
      modbusNetworkName - the modbusNetworkName to set
    • getUnitId

      public Integer getUnitId()
      Get the unit ID.
      Returns:
      the unitId
    • setUnitId

      public void setUnitId(Integer unitId)
      Set the unit ID.
      Parameters:
      unitId - the unitId to set
    • getSampleCacheMs

      public Long getSampleCacheMs()
      Get the sample cache milliseconds.
      Returns:
      the sampleCacheMs
    • setSampleCacheMs

      public void setSampleCacheMs(Long sampleCacheMs)
      Set the sample cache milliseconds.
      Parameters:
      sampleCacheMs - the sampleCacheMs to set
    • getWordOrderKey

      public char getWordOrderKey()
      Get the word order as a key value.
      Returns:
      the word order as a key; if getWordOrder() is null then ModbusWordOrder.MostToLeastSignificant will be returned
    • setWordOrderKey

      public void setWordOrderKey(char key)
      Set the word order as a key value.
      Parameters:
      key - the word order key to set; if key is not valid then ModbusWordOrder.MostToLeastSignificant will be set
    • getWordOrder

      public net.solarnetwork.node.io.modbus.ModbusWordOrder getWordOrder()
      Get the word order.
      Returns:
      the wordOrder
    • setWordOrder

      public void setWordOrder(net.solarnetwork.node.io.modbus.ModbusWordOrder wordOrder)
      Set the word order.
      Parameters:
      wordOrder - the wordOrder to set
    • getPropertyConfigs

      public List<ModbusWritePropertyConfig> getPropertyConfigs()
      Get the property configurations.
      Returns:
      the configurations, never null