stella.ow

Interface OneWireDriver

All Superinterfaces:

Driver, Initializable

All Known Implementing Classes:

PythonClient, ServerClient

public interface OneWireDriver
extends Driver

The specialisation for one-wire drivers. We might have different implementations, currently only the PythonClient is working.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID The invalid string.
static int	OK Return code on issue for okay.
static String	VALID The valid string.

Method Summary

Modifier and Type	Method and Description
int	issue(String address, String command) Issues the command to the driver and returns the result as an int.
String	retrieve(String address) Issues the command to the driver and returns the result as a string.

Methods inherited from interface io.Driver

close, getDriverName, isOpen, open

Methods inherited from interface util.Initializable

init

Field Detail

OK

static final int OK

Return code on issue for okay.

See Also:

Constant Field Values

INVALID

static final String INVALID

The invalid string.

See Also:

Constant Field Values

VALID

static final String VALID

The valid string.

See Also:

Constant Field Values

Method Detail

retrieve

String retrieve(String address)

Issues the command to the driver and returns the result as a string. The command should be used for reading the one-wire devices. Note that a command that might be meaningful on one driver will return nonsense (i.e. null) on another, thus the client must issue its command to the right driver.

Parameters:

address - The path to the one-wire sensor.

issue

int issue(String address,
          String command)

Issues the command to the driver and returns the result as an int. The command should be used for putting commands onto the one-wire devices. Note that a command that might be meaningful on one driver will return nonsense (i.e. null) on another, thus the client must issue its command to the right driver.

Parameters:

address - The path to the one-wire sensor.

command - The command to send to the one-wire sensor.