CLIProtocol (JControlLab 0.0.1 API)

java.lang.Object
- org.dajlab.jcontrollab.core.CLIProtocol

```
public class CLIProtocol
extends Object
```
Communication protocol with the Dacta interface.

Author:

Erik Amzallag.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static byte`	`CLOSE` CLOSE message.
`protected static int`	`CYCLE_TIME_OFF` CYCLE_TIME_OFF message.
`protected static int`	`CYCLE_TIME_ON` CYCLE_TIME_ON message.
`protected static int`	`DELAY` DELAY to wait between HELLO messages.
`protected static byte`	`HELLO` HELLO message.
`protected static String`	`KNOCK_KNCOK` KNOCK_KNCOK message.
`protected static short`	`NOP` NOP message.
`protected static int`	`OUTPUT_MULTIPLE_BACKWARD_DIRECTION` OUTPUT_MULTIPLE_BACKWARD message.
`protected static int`	`OUTPUT_MULTIPLE_FLASHING` OUTPUT_MULTIPLE_FLASHING message.
`protected static int`	`OUTPUT_MULTIPLE_FORWARD_DIRECTION` OUTPUT_MULTIPLE_FORWARD message.
`protected static int`	`OUTPUT_MULTIPLE_OFF` OUTPUT_MULTIPLE_OFF message.
`protected static int`	`OUTPUT_MULTIPLE_OFF_BREAK` OUTPUT_MULTIPLE_OFF_BREAK message.
`protected static int`	`OUTPUT_MULTIPLE_ON` OUTPUT_MULTIPLE_ON message.
`protected static int`	`OUTPUT_MULTIPLE_ON_TIME` OUTPUT_MULTIPLE_ON_TIME message.
`protected static int`	`OUTPUT_MULTIPLE_POWER` OUTPUT_MULTIPLE_POWER message.
`protected static int`	`OUTPUT_MULTIPLE_POWER0` OUTPUT_MULTIPLE_POWER0 message.
`protected static int`	`OUTPUT_MULTIPLE_REVERSE_DIRECTION` OUTPUT_MULTIPLE_REVERSE_DIRECTION message.
`protected static int`	`OUTPUT_SINGLE_BACKWARD_DIRECTION` OUTPUT_SINGLE_BACKWARD message.
`protected static int`	`OUTPUT_SINGLE_FORWARD_DIRECTION` OUTPUT_SINGLE_FORWARD message.
`protected static int`	`OUTPUT_SINGLE_OFF` OUTPUT_SINGLE_OFF message.
`protected static int`	`OUTPUT_SINGLE_ON_BACKWARD` OUTPUT_SINGLE_ON_BACKWARD message.
`protected static int`	`OUTPUT_SINGLE_ON_CURRENT_DIRECTION` OUTPUT_SINGLE_ON message.
`protected static int`	`OUTPUT_SINGLE_ON_FORWARD` OUTPUT_SINGLE_ON_FORWARD message.
`protected static int`	`OUTPUT_SINGLE_REVERSE_DIRECTION` OUTPUT_SINGLE_REVERSE_DIRECTION message.

Constructor Summary

Constructors
Constructor and Description

CLIProtocol()

Constructors
Constructor and Description
`CLIProtocol()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static byte[]`	`encodeCycle(char[] outputs, int cycleOn, int cycleOff)` Encode a cycle message for multiple outputs.
`protected static byte[]`	`encodeCycle(char output, int cycleOn, int cycleOff)` Encode a cycle message.
`protected static byte[]`	`encodeMode(char[] outputs, int mode)` Encode a message for multiple outputs.
`protected static byte`	`encodeMode(char output, int mode)` Encode a simple message.
`protected static byte[]`	`encodeModeDuration(char[] outputs, int time)` Encode a message of type ON with a duration.
`protected static byte[]`	`encodeModeDuration(char output, int time)` Encode a message of type ON with a duration.
`protected static byte[]`	`encodeModePower(char[] outputs, short power)` Encode a message for multiple outputs with power.
`protected static byte[]`	`encodeModePower(char output, short power)` Encode a simple message with power.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NOP
```
protected static final short NOP
```
    NOP message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_SINGLE_ON_BACKWARD
```
protected static final int OUTPUT_SINGLE_ON_BACKWARD
```
    OUTPUT_SINGLE_ON_BACKWARD message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_SINGLE_ON_FORWARD
```
protected static final int OUTPUT_SINGLE_ON_FORWARD
```
    OUTPUT_SINGLE_ON_FORWARD message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_SINGLE_REVERSE_DIRECTION
```
protected static final int OUTPUT_SINGLE_REVERSE_DIRECTION
```
    OUTPUT_SINGLE_REVERSE_DIRECTION message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_SINGLE_ON_CURRENT_DIRECTION
```
protected static final int OUTPUT_SINGLE_ON_CURRENT_DIRECTION
```
    OUTPUT_SINGLE_ON message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_SINGLE_OFF
```
protected static final int OUTPUT_SINGLE_OFF
```
    OUTPUT_SINGLE_OFF message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_SINGLE_BACKWARD_DIRECTION
```
protected static final int OUTPUT_SINGLE_BACKWARD_DIRECTION
```
    OUTPUT_SINGLE_BACKWARD message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_SINGLE_FORWARD_DIRECTION
```
protected static final int OUTPUT_SINGLE_FORWARD_DIRECTION
```
    OUTPUT_SINGLE_FORWARD message.
    
    See Also:
    
    Constant Field Values
  - CLOSE
```
protected static final byte CLOSE
```
    CLOSE message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_OFF_BREAK
```
protected static final int OUTPUT_MULTIPLE_OFF_BREAK
```
    OUTPUT_MULTIPLE_OFF_BREAK message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_FLASHING
```
protected static final int OUTPUT_MULTIPLE_FLASHING
```
    OUTPUT_MULTIPLE_FLASHING message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_OFF
```
protected static final int OUTPUT_MULTIPLE_OFF
```
    OUTPUT_MULTIPLE_OFF message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_ON
```
protected static final int OUTPUT_MULTIPLE_ON
```
    OUTPUT_MULTIPLE_ON message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_POWER0
```
protected static final int OUTPUT_MULTIPLE_POWER0
```
    OUTPUT_MULTIPLE_POWER0 message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_FORWARD_DIRECTION
```
protected static final int OUTPUT_MULTIPLE_FORWARD_DIRECTION
```
    OUTPUT_MULTIPLE_FORWARD message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_BACKWARD_DIRECTION
```
protected static final int OUTPUT_MULTIPLE_BACKWARD_DIRECTION
```
    OUTPUT_MULTIPLE_BACKWARD message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_REVERSE_DIRECTION
```
protected static final int OUTPUT_MULTIPLE_REVERSE_DIRECTION
```
    OUTPUT_MULTIPLE_REVERSE_DIRECTION message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_POWER
```
protected static final int OUTPUT_MULTIPLE_POWER
```
    OUTPUT_MULTIPLE_POWER message.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_MULTIPLE_ON_TIME
```
protected static final int OUTPUT_MULTIPLE_ON_TIME
```
    OUTPUT_MULTIPLE_ON_TIME message.
    
    See Also:
    
    Constant Field Values
  - CYCLE_TIME_OFF
```
protected static final int CYCLE_TIME_OFF
```
    CYCLE_TIME_OFF message.
    
    See Also:
    
    Constant Field Values
  - CYCLE_TIME_ON
```
protected static final int CYCLE_TIME_ON
```
    CYCLE_TIME_ON message.
    
    See Also:
    
    Constant Field Values
  - HELLO
```
protected static final byte HELLO
```
    HELLO message.
    
    See Also:
    
    Constant Field Values
  - DELAY
```
protected static final int DELAY
```
    DELAY to wait between HELLO messages.
    
    See Also:
    
    Constant Field Values
  - KNOCK_KNCOK
```
protected static final String KNOCK_KNCOK
```
    KNOCK_KNCOK message.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CLIProtocol
```
public CLIProtocol()
```
- Method Detail
  - encodeMode
```
protected static byte encodeMode(char output,
                                 int mode)
```
    Encode a simple message.
    
    Parameters:
    
    output - an output port
    
    mode - a mode
    
    Returns:
    
    the encoded message
  - encodeModePower
```
protected static byte[] encodeModePower(char output,
                                        short power)
```
    Encode a simple message with power.
    
    Parameters:
    
    output - an output port
    
    power - a power
    
    Returns:
    
    the encoded message
  - encodeModeDuration
```
protected static byte[] encodeModeDuration(char output,
                                           int time)
```
    Encode a message of type ON with a duration.
    
    Parameters:
    
    output - an ouput port
    
    time - time to on
    
    Returns:
    
    the encoded message
  - encodeModeDuration
```
protected static byte[] encodeModeDuration(char[] outputs,
                                           int time)
```
    Encode a message of type ON with a duration.
    
    Parameters:
    
    outputs - outputs array
    
    time - time to on
    
    Returns:
    
    the encoded message
  - encodeMode
```
protected static byte[] encodeMode(char[] outputs,
                                   int mode)
```
    Encode a message for multiple outputs.
    
    Parameters:
    
    outputs - outputs array
    
    mode - mode
    
    Returns:
    
    the encoded message
  - encodeModePower
```
protected static byte[] encodeModePower(char[] outputs,
                                        short power)
```
    Encode a message for multiple outputs with power.
    
    Parameters:
    
    outputs - outputs array
    
    power - power
    
    Returns:
    
    the encoded message
  - encodeCycle
```
protected static byte[] encodeCycle(char output,
                                    int cycleOn,
                                    int cycleOff)
```
    Encode a cycle message.
    
    Parameters:
    
    output - output port
    
    cycleOn - time the output is on (in 1/10 seconds)
    
    cycleOff - time the output is off (in 1/10 seconds)
    
    Returns:
    
    the encoded message
  - encodeCycle
```
protected static byte[] encodeCycle(char[] outputs,
                                    int cycleOn,
                                    int cycleOff)
```
    Encode a cycle message for multiple outputs.
    
    Parameters:
    
    outputs - outputs array
    
    cycleOn - time the output is on (in 1/10 seconds)
    
    cycleOff - time the output is off (in 1/10 seconds)
    
    Returns:
    
    the encoded message

Class CLIProtocol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOP

OUTPUT_SINGLE_ON_BACKWARD

OUTPUT_SINGLE_ON_FORWARD

OUTPUT_SINGLE_REVERSE_DIRECTION

OUTPUT_SINGLE_ON_CURRENT_DIRECTION

OUTPUT_SINGLE_OFF

OUTPUT_SINGLE_BACKWARD_DIRECTION

OUTPUT_SINGLE_FORWARD_DIRECTION

CLOSE

OUTPUT_MULTIPLE_OFF_BREAK

OUTPUT_MULTIPLE_FLASHING

OUTPUT_MULTIPLE_OFF

OUTPUT_MULTIPLE_ON

OUTPUT_MULTIPLE_POWER0

OUTPUT_MULTIPLE_FORWARD_DIRECTION

OUTPUT_MULTIPLE_BACKWARD_DIRECTION

OUTPUT_MULTIPLE_REVERSE_DIRECTION

OUTPUT_MULTIPLE_POWER

OUTPUT_MULTIPLE_ON_TIME

CYCLE_TIME_OFF

CYCLE_TIME_ON

HELLO

DELAY

KNOCK_KNCOK

Constructor Detail

CLIProtocol

Method Detail

encodeMode

encodeModePower

encodeModeDuration

encodeModeDuration

encodeMode

encodeModePower

encodeCycle

encodeCycle