com.sitewhere.spi.device.communication

Interface ICommandExecutionEncoder<T>

Type Parameters:

T - format for encoded command. Must be compatible with the ICommandDeliveryProvider that will deliver the command.

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface ICommandExecutionEncoder<T>
extends ITenantLifecycleComponent

Encodes an IDeviceCommandExecution into a format that can be transmitted.

Method Summary

Modifier and Type	Method and Description
T	encode(IDeviceCommandExecution command, IDeviceNestingContext nested, IDeviceAssignment assignment) Encodes a command execution.
T	encodeSystemCommand(ISystemCommand command, IDeviceNestingContext nested, IDeviceAssignment assignment) Encodes a SiteWhere system command.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

encode

T encode(IDeviceCommandExecution command,
         IDeviceNestingContext nested,
         IDeviceAssignment assignment)
  throws SiteWhereException

Encodes a command execution.

Parameters:

command -

nested -

assignment -

Returns:

Throws:

SiteWhereException

encodeSystemCommand

T encodeSystemCommand(ISystemCommand command,
                      IDeviceNestingContext nested,
                      IDeviceAssignment assignment)
               throws SiteWhereException

Encodes a SiteWhere system command.

Parameters:

command -

nested -

assignment -

Returns:

Throws:

SiteWhereException