Class AddressableLEDSim

    • Constructor Detail

      • AddressableLEDSim

        public AddressableLEDSim()
        Constructs for the first addressable LED.
      • AddressableLEDSim

        public AddressableLEDSim​(AddressableLED addressableLED)
        Constructs from an AddressableLED object.
        Parameters:
        addressableLED - AddressableLED to simulate
    • Method Detail

      • createForChannel

        public static AddressableLEDSim createForChannel​(int pwmChannel)
        Creates an AddressableLEDSim for a PWM channel.
        Parameters:
        pwmChannel - PWM channel
        Returns:
        Simulated object
        Throws:
        NoSuchElementException - if no AddressableLED is configured for that channel
      • createForIndex

        public static AddressableLEDSim createForIndex​(int index)
        Creates an AddressableLEDSim for a simulated index. The index is incremented for each simulated AddressableLED.
        Parameters:
        index - simulator index
        Returns:
        Simulated object
      • registerInitializedCallback

        public CallbackStore registerInitializedCallback​(NotifyCallback callback,
                                                         boolean initialNotify)
        Register a callback on the Initialized property.
        Parameters:
        callback - the callback that will be called whenever the Initialized property is changed
        initialNotify - if true, the callback will be run on the initial value
        Returns:
        the CallbackStore object associated with this callback. Save a reference to this object so GC doesn't cancel the callback.
      • getInitialized

        public boolean getInitialized()
        Check if initialized.
        Returns:
        true if initialized
      • setInitialized

        public void setInitialized​(boolean initialized)
        Change the Initialized value of the LED strip.
        Parameters:
        initialized - the new value
      • registerOutputPortCallback

        public CallbackStore registerOutputPortCallback​(NotifyCallback callback,
                                                        boolean initialNotify)
        Register a callback on the output port.
        Parameters:
        callback - the callback that will be called whenever the output port is changed
        initialNotify - if true, the callback will be run on the initial value
        Returns:
        the CallbackStore object associated with this callback. Save a reference to this object so GC doesn't cancel the callback.
      • getOutputPort

        public int getOutputPort()
        Get the output port.
        Returns:
        the output port
      • setOutputPort

        public void setOutputPort​(int outputPort)
        Change the output port.
        Parameters:
        outputPort - the new output port
      • registerLengthCallback

        public CallbackStore registerLengthCallback​(NotifyCallback callback,
                                                    boolean initialNotify)
        Register a callback on the length.
        Parameters:
        callback - the callback that will be called whenever the length is changed
        initialNotify - if true, the callback will be run on the initial value
        Returns:
        the CallbackStore object associated with this callback. Save a reference to this object so GC doesn't cancel the callback.
      • getLength

        public int getLength()
        Get the length of the LED strip.
        Returns:
        the length
      • setLength

        public void setLength​(int length)
        Change the length of the LED strip.
        Parameters:
        length - the new value
      • registerRunningCallback

        public CallbackStore registerRunningCallback​(NotifyCallback callback,
                                                     boolean initialNotify)
        Register a callback on whether the LEDs are running.
        Parameters:
        callback - the callback that will be called whenever the LED state is changed
        initialNotify - if true, the callback will be run on the initial value
        Returns:
        the CallbackStore object associated with this callback. Save a reference to this object so GC doesn't cancel the callback.
      • getRunning

        public boolean getRunning()
        Check if the LEDs are running.
        Returns:
        true if they are
      • setRunning

        public void setRunning​(boolean running)
        Change whether the LEDs are active.
        Parameters:
        running - the new value
      • registerDataCallback

        public CallbackStore registerDataCallback​(ConstBufferCallback callback)
        Register a callback on the LED data.
        Parameters:
        callback - the callback that will be called whenever the LED data is changed
        Returns:
        the CallbackStore object associated with this callback. Save a reference to this object so GC doesn't cancel the callback.
      • getData

        public byte[] getData()
        Get the LED data.
        Returns:
        the LED data
      • setData

        public void setData​(byte[] data)
        Change the LED data.
        Parameters:
        data - the new data
      • resetData

        public void resetData()
        Reset all simulation data for this LED object.