Module com.thecoderscorner.tcmenu.javaapi
Package com.thecoderscorner.menu.remote

Class RemoteMenuController

  • public class RemoteMenuController
extends java.lang.Object
    This class manages a single remote connection to an Arduino. It is responsible for check if the connection is still alive, and sending heartbeat messages to keep the connection alive too. This class abstracts the connectivity part away from the business logic. The remote connection is then handled by the RemoteConnector. Normally, one creates a whole remote stack using one the builders, such as Rs232ControllerBuilder.

    • Constructor Detail

      • RemoteMenuController

        public RemoteMenuController​(RemoteConnector connector,
                            MenuTree managedMenu,
                            java.util.concurrent.ScheduledExecutorService executor,
                            java.lang.String localName,
                            java.util.UUID ourUUID,
                            java.time.Clock clock)

    • Method Detail

      • start

        public void start()
        starts the remote connection such that it will attempt to establish connectivity

      • stop

        public void stop()
        attempt to stop the underlying connector

      • sendCommand

        protected void sendCommand​(MenuCommand command)
        Use to send commands directly. Should not be used outside of this class, instead prefer the helper methods to send each type of item.
        Parameters:
        command - a command to send to the remote side.

      • sendDialogAction

        public CorrelationId sendDialogAction​(MenuButtonType buttonType)
        Send a dialog update
        Parameters:
        buttonType -

      • sendDeltaUpdate

        public CorrelationId sendDeltaUpdate​(MenuItem item,
                                     int deltaChange)
        Send a delta change for the given menuitem
        Parameters:
        item - the item to change
        deltaChange - the amount to change by

      • sendAbsoluteUpdate

        public CorrelationId sendAbsoluteUpdate​(MenuItem item,
                                        java.lang.Object newValue)
        Send an asbolute change for the given item
        Parameters:
        item - the item
        newValue - the absolute change

      • getRemotePartyInfo

        public RemoteInformation getRemotePartyInfo()
        get the name of the device that we've connected to.
        Returns:
        the connected remote device

      • getConnector

        public RemoteConnector getConnector()
        get the underlying connectivity, rarely needed
        Returns:
        underlying connector

      • isTreeFullyPopulated

        public boolean isTreeFullyPopulated()
        Check if all the menu items from the remote device are available locally yet.
        Returns:
        true if the populated, otherwise false.

      • addListener

        public void addListener​(RemoteControllerListener listener)
        register for events when the tree becomes fully populated, a menu item changes or there's a change in connectivity.
        Parameters:
        listener - your listener to register for events

      • getManagedMenu

        public MenuTree getManagedMenu()