DSPortAdapter
.
An enumeration of all available adapters can be accessed through the member function EnumerateAllAdapters
. This enables an application to be adapter independent. There are also facilities to get a system appropriate default adapter/port combination.
Get an instance of the default 1-Wire adapter. The adapter will be ready to use if no exceptions are thrown.
try
{
DSPortAdapter adapter = OneWireAccessProvider.getDefaultAdapter();
System.out.println("Adapter: " + adapter.getAdapterName() + " Port: " + adapter.getPortName());
// use the adapter ...
}
catch(Exception e)
{
System.out.println("Default adapter not present: " + e);
}
Enumerate through the available adapters and ports.
DSPortAdapter adapter;
String port;
// get the adapters
for (Enumeration adapter_enum = OneWireAccessProvider.enumerateAllAdapters();
adapter_enum.hasMoreElements(); )
{
// cast the enum as a DSPortAdapter
adapter = ( DSPortAdapter ) adapter_enum.nextElement();
System.out.print("Adapter: " + adapter.getAdapterName() + " with ports: ");
// get the ports
for (Enumeration port_enum = adapter.getPortNames();
port_enum.hasMoreElements(); )
{
// cast the enum as a String
port = ( String ) port_enum.nextElement();
System.out.print(port + " ");
}
System.out.println();
}
Display the default adapter name and port without getting an instance of the adapter.
System.out.println("Default Adapter: " +
OneWireAccessProvider.getProperty("onewire.adapter.default"));
System.out.println("Default Port: " +
OneWireAccessProvider.getProperty("onewire.port.default"));
Static Public Member Functions | |
static String | getVersion () |
Returns a version string, representing the release number on official releases, or release number and release date on incrememental releases. | |
static void | main (String[] args) |
Main method returns current version info, and default adapter setting. | |
static Enumeration | enumerateAllAdapters () |
Gets an Enumeration of all 1-Wire adapter types supported. | |
static DSPortAdapter | getAdapter (String adapterName, String portName) throws OneWireIOException, OneWireException |
Finds, opens, and verifies the specified adapter on the indicated port. | |
static DSPortAdapter | getDefaultAdapter () throws OneWireIOException, OneWireException |
Finds, opens, and verifies the default adapter and port. | |
static String | getProperty (String propName) |
Gets the specfied onewire property. | |
static void | setUseOverridingAdapter (DSPortAdapter adapter) |
Sets an overriding adapter. | |
static void | clearUseOverridingAdapter () |
Clears the overriding adapter. |
static String getVersion | ( | ) | [static] |
Returns a version string, representing the release number on official releases, or release number and release date on incrememental releases.
static void main | ( | String[] | args | ) | [static] |
Main method returns current version info, and default adapter setting.
args | cmd-line arguments, ignored for now. |
static Enumeration enumerateAllAdapters | ( | ) | [static] |
Gets an Enumeration
of all 1-Wire adapter types supported.
Using this enumeration with the port enumeration for each adapter, a search can be done to find all available hardware adapters.
Enumeration
of DSPortAdapters
in the system static DSPortAdapter getAdapter | ( | String | adapterName, | |
String | portName | |||
) | throws OneWireIOException, OneWireException [static] |
Finds, opens, and verifies the specified adapter on the indicated port.
adapterName | string name of the adapter (match to result of call to getAdapterName() method in DSPortAdapter) | |
portName | string name of the port used in the method selectPort() in DSPortAdapter |
DSPortAdapter
if adapter presentOneWireIOException | when communcation with the adapter fails | |
OneWireException | when the port or adapter not present |
static DSPortAdapter getDefaultAdapter | ( | ) | throws OneWireIOException, OneWireException [static] |
Finds, opens, and verifies the default adapter and port.
Looks for the default adapter/port in the following locations:
DSPortAdapter
if default adapter presentOneWireIOException | when communcation with the adapter fails | |
OneWireException | when the port or adapter not present |
static String getProperty | ( | String | propName | ) | [static] |
Gets the specfied onewire property.
Looks for the property in the following locations:
propName | string name of the property to read |
String
representing the property value or null
if it could not be found (onewire.adapter.default
and onewire.port.default
may return a 'smart' default even if property not present) static void setUseOverridingAdapter | ( | DSPortAdapter | adapter | ) | [static] |
Sets an overriding adapter.
This adapter will be returned from getAdapter and getDefaultAdapter despite what was requested.
adapter | adapter to be the override |
static void clearUseOverridingAdapter | ( | ) | [static] |
Clears the overriding adapter.
The operation of getAdapter and getDefaultAdapter will be returned to normal.