All Classes
Class
Description
Abstract version of the interface MenuItemVisitor, it implements all the methods by defaulting the behaviour to
the anyItem() method.
An enumeration that represents all the possible status / error return codes from the remote.
ActionMenuItem represents a menu item that is a one shot action, in that when triggered it
just runs the callback on the embedded side.
Constructs an ActionMenuItemBuilder using the standard builder pattern.
Represents an analog (numeric) menu item, it is always a zero based integer when retrieved from storage, but it can
have an offset and divisor, so therefore is able to represent decimal values.
Constructs an AnalogMenuItem using the standard builder pattern.
Provides a list of the support platforms as an enumeration.
the authentication states that a RemoteMenuController can be in.
A menu item that can only hold boolean values (true or false).
Constructs a BooleanMenuItemBuilder using the standard builder pattern.
An implementation of menu state for booleans.
These static helper methods are the preferred way to create command message that can be sent and received from
a remote connection.
Use this interface to subscribe to connection change events, such as when the underlying connector
disconnects or reconnects with hardware.
A correlation ID that allows events sent from the client or server to be linked via
this ID.
An implementation of menu state for integer values.
This is a custom menu item that can be created by the designer, but does not directly represent a different item
in the API.
Constructs a BooleanMenuItemBuilder using the standard builder pattern.
A menu item that corresponds to the large number type on the device.
Constructs a EditableTextMenuItemBuilder using the standard builder pattern.
An implementation of menu item that can store text strings.
Constructs a EditableTextMenuItemBuilder using the standard builder pattern.
A menu item implementation that represents one of a known set of choices, the choices are stored as an integer
value, but each choice has a string representation as well.
Constructs a BooleanMenuItemBuilder using the standard builder pattern.
FloatMenuItem represents a menu item that uses a floating point value.
Constructs a FloatMenuItem using the standard builder pattern.
An implementation of menu state for Strings.
An implementation of menu state for integer values.
a local identifier holder object that holds the name and UUID
Classes extending from MenuCommand can be sent and received on a connector.
This is a low level part of the API that most people don't need to deal, implementations will translate
commands to and from a given protocol.
Enumeration of the types of messages that can be sent to and from the server.
The base class for all menu items, has the most basic operations available on it that are needed by pretty much
all menu items.
A helper class for dealing with MenuItem objects.
An implementation of the visitor pattern for TcMenu.
The base class of menu state, stores the value, if it's active and changed.
Menu tree holds all the menu items for a specific remote connection or session.
Some operations support moving items up or down in the tree, when they do they use this enumeration to
describe the direction of the move.
An implementation of menu state for integer values.
A few general helper method to get the version and platform information to and from messages.
This is the base interface implemented by all remote connectors, it provides the means to both send and receive
menu commands.
This is the low level, communication listener interface that you implement in order to know when commands have
been received from the remote device.
This interface is implemented when you wish to receive update events from a RemoteMenuController.
Represents the remote connection details, such as name and version.
This class manages a single remote connection to an Arduino.
A menu item that represents a colour in the RGB domain with optional Alpha channel.
Constructs a FloatMenuItem using the standard builder pattern.
Represents a more configurable and more extensible version of enum that should be used when the number of choices is
larger, the choices are in eeprom, or you need more control at runtime of the choices.
A remote connector that will communicate using a client socket.
Creates an instance of a socket based controller to a given port, and connects it with the selected menu.
Stream remote connector is the base class for all stream implementations, such as Socket and RS232.
An implementation of menu state for lists of string.
An implementation of menu state for Strings.
SubMenuItem represents a menu item that has children.
Constructs a SubMenuItemBuilder using the standard builder pattern.
A protocol implementation that uses tag value pair notation with a few special text items
in order to create messages that can be transmitted.
Field names are used to represent the possible field names that can be sent to a remote menu.
This is the parser implementation that understands tag value format and can convert the tags back into
a series of tags and values suitable for the protocol to decode messages.
An exception that indicates a problem during protocol conversion