All Classes Interface Summary Class Summary Enum Summary Exception Summary
| Class |
Description |
| AbstractMenuItemVisitor<T> |
Abstract version of the interface MenuItemVisitor, it implements all the methods by defaulting the behaviour to
the anyItem() method.
|
| AckStatus |
An enumeration that represents all the possible status / error return codes from the remote.
|
| ActionMenuItem |
ActionMenuItem represents a menu item that is a one shot action, in that when triggered it
just runs the callback on the embedded side.
|
| ActionMenuItemBuilder |
Constructs an ActionMenuItemBuilder using the standard builder pattern.
|
| AnalogMenuItem |
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.
|
| AnalogMenuItemBuilder |
Constructs an AnalogMenuItem using the standard builder pattern.
|
| ApiPlatform |
Provides a list of the support platforms as an enumeration.
|
| AuthStatus |
the authentication states that a RemoteMenuController can be in.
|
| BooleanMenuItem |
A menu item that can only hold boolean values (true or false).
|
| BooleanMenuItem.BooleanNaming |
|
| BooleanMenuItemBuilder |
Constructs a BooleanMenuItemBuilder using the standard builder pattern.
|
| BooleanMenuState |
An implementation of menu state for booleans.
|
| BootItemMenuCommand<T extends MenuItem,V> |
|
| CommandFactory |
These static helper methods are the preferred way to create command message that can be sent and received from
a remote connection.
|
| ConnectionChangeListener |
Use this interface to subscribe to connection change events, such as when the underlying connector
disconnects or reconnects with hardware.
|
| ConnectorFactory |
|
| CorrelationId |
A correlation ID that allows events sent from the client or server to be linked via
this ID.
|
| DialogMode |
|
| EditableTextMenuItem |
An implementation of menu item that can store text strings.
|
| EditableTextMenuItemBuilder |
Constructs a EditableTextMenuItemBuilder using the standard builder pattern.
|
| EditItemType |
|
| EnumMenuItem |
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.
|
| EnumMenuItemBuilder |
Constructs a BooleanMenuItemBuilder using the standard builder pattern.
|
| FloatMenuItem |
FloatMenuItem represents a menu item that uses a floating point value.
|
| FloatMenuItemBuilder |
Constructs a FloatMenuItem using the standard builder pattern.
|
| FloatMenuState |
An implementation of menu state for Strings.
|
| IntegerMenuState |
An implementation of menu state for integer values.
|
| MenuAcknowledgementCommand |
|
| MenuActionBootCommand |
|
| MenuAnalogBootCommand |
|
| MenuBooleanBootCommand |
|
| MenuBootstrapCommand |
|
| MenuBootstrapCommand.BootType |
|
| MenuButtonType |
|
| MenuChangeCommand |
|
| MenuChangeCommand.ChangeType |
|
| MenuCommand |
Classes extending from MenuCommand can be sent and received on a connector.
|
| MenuCommandProtocol |
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.
|
| MenuCommandType |
Enumeration of the types of messages that can be sent to and from the server.
|
| MenuDialogCommand |
|
| MenuEnumBootCommand |
|
| MenuFloatBootCommand |
|
| MenuHeartbeatCommand |
|
| MenuItem<T> |
The base class for all menu items, has the most basic operations available on it that are needed by pretty much
all menu items.
|
| MenuItemBuilder<T extends MenuItemBuilder> |
|
| MenuItemHelper |
A helper class for dealing with MenuItem objects.
|
| MenuItemVisitor |
An implementation of the visitor pattern for TcMenu.
|
| MenuJoinCommand |
|
| MenuPairingCommand |
|
| MenuRuntimeListBootCommand |
|
| MenuState<T> |
The base class of menu state, stores the value, if it's active and changed.
|
| MenuSubBootCommand |
|
| MenuTextBootCommand |
|
| MenuTree |
Menu tree holds all the menu items for a specific remote connection or session.
|
| MenuTree.MoveType |
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.
|
| NamedDaemonThreadFactory |
|
| PairingHelper |
|
| PairingHelper.PairingState |
|
| ProtocolUtil |
A few general helper method to get the version and platform information to and from messages.
|
| RemoteConnector |
This is the base interface implemented by all remote connectors, it provides the means to both send and receive
menu commands.
|
| RemoteConnectorListener |
This is the low level, communication listener interface that you implement in order to know when commands have
been received from the remote device.
|
| RemoteControllerListener |
This interface is implemented when you wish to receive update events from a RemoteMenuController.
|
| RemoteInformation |
Represents the remote connection details, such as name and version.
|
| RemoteMenuController |
This class manages a single remote connection to an Arduino.
|
| Rs232ControllerBuilder |
Creates an instance of a RS232 based controller to a given port, and connects it with the selected menu.
|
| Rs232RemoteConnector |
This is the R232 connector that can talk to a tcMenu library application running
on an embedded Arduino.
|
| RuntimeListMenuItem |
|
| RuntimeListMenuItemBuilder |
Constructs a FloatMenuItem using the standard builder pattern.
|
| SocketBasedConnector |
A remote connector that will communicate using a client socket.
|
| SocketControllerBuilder |
Creates an instance of a socket based controller to a given port, and connects it with the selected menu.
|
| StreamRemoteConnector |
Stream remote connector is the base class for all stream implementations, such as Socket and RS232.
|
| StreamRemoteConnector.ReadMode |
|
| StreamRemoteConnector.StreamState |
|
| StringListMenuState |
An implementation of menu state for lists of string.
|
| StringMenuState |
An implementation of menu state for Strings.
|
| SubMenuItem |
SubMenuItem represents a menu item that has children.
|
| SubMenuItemBuilder |
Constructs a SubMenuItemBuilder using the standard builder pattern.
|
| TagValMenuCommandProtocol |
A protocol implementation that uses tag value pair notation with a few special text items
in order to create messages that can be transmitted.
|
| TagValMenuFields |
Field names are used to represent the possible field names that can be sent to a remote menu.
|
| TagValTextParser |
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.
|
| TcProtocolException |
An exception that indicates a problem during protocol conversion
|
| UdpControllerBuilder |
Creates an instance of a RS232 based controller to a given port, and connects it with the selected menu.
|
| UdpRemoteConnector |
EXPERIMENTAL: DO NOT USE AT THE MOMENT
|