Package crackers.kobots.mqtt.homeassistant

Class KobotLight

  • All Implemented Interfaces:
    crackers.kobots.mqtt.homeassistant.KobotHAEntity , kotlin.Comparable 
    
public class KobotLight
extends CommandEntity

    Describes a "simple" light. This conforms to the Home Assistant MQTT light spec and allows for a list of "effects" that can be selected via MQTT.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final String getComponent() The Home Assistant classification of the device (e.g.
      String getIcon() The icon HA will use to display this entity.
      <Error class: unknown class> discovery() A generic configuration for the device, which can be used to generate the discovery message because there are too many "base" configuration parameters to be able to handle them cleanly, so just dump it on the child class to figure it out.
      String currentState() Generate the MQTT state message for this device.
      Unit handleCommand(String payload) Handle the MQTT command message for this device.

      • Methods inherited from class crackers.kobots.mqtt.homeassistant.CommandEntity

        getCommandTopic, start

      • Methods inherited from class crackers.kobots.mqtt.homeassistant.AbstractKobotEntity

        getDeviceIdentifier, getName, getStatusTopic, getUniqueId, remove, sendCurrentState

      • Methods inherited from class crackers.kobots.mqtt.homeassistant.KobotHAEntity

        compareTo

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getComponent

         final String getComponent()

        The Home Assistant classification of the device (e.g. light, switch, etc.)

      • getIcon

         String getIcon()

        The icon HA will use to display this entity.

      • discovery

         <Error class: unknown class> discovery()

        A generic configuration for the device, which can be used to generate the discovery message because there are too many "base" configuration parameters to be able to handle them cleanly, so just dump it on the child class to figure it out.