1-Wire API for .NET Version 4.00
|
Inherits com::dalsemi::onewire::container::OneWireContainer24, and com::dalsemi::onewire::container::ClockContainer.
Public Member Functions | |
OneWireContainer27 () | |
Create an empty container that is not complete until after a call to setupContainer . | |
OneWireContainer27 (DSPortAdapter sourceAdapter, byte[] newAddress) | |
Create a container with the provided adapter instance and the address of the iButton or 1-Wire device. | |
OneWireContainer27 (DSPortAdapter sourceAdapter, long newAddress) | |
Create a container with the provided adapter instance and the address of the iButton or 1-Wire device. | |
OneWireContainer27 (DSPortAdapter sourceAdapter, String newAddress) | |
Create a container with the provided adapter instance and the address of the iButton or 1-Wire device. | |
String | getName () |
Get the Maxim Integrated Products part number of the iButton or 1-Wire Device as a string. | |
String | getAlternateNames () |
Get the alternate Maxim Integrated Products part numbers or names. | |
String | getDescription () |
Get a short description of the function of this iButton or 1-Wire Device type. | |
long | getInterruptInterval (byte[] state) |
Returns the interval, in seconds, that the device will interrupt on. | |
boolean | isInterruptEnabled (byte[] state) |
Checks to see if interrupt mode is turned on. | |
void | setInterruptInterval (byte intervalValue, byte[] state) |
Sets the interval at which interrupting will occur. | |
void | setInterruptEnable (boolean iEnable, byte[] state) |
Enables or disables hardware interrupting. | |
Static Public Attributes | |
static final byte | INTERRUPT_INTERVAL_1 = (byte)0x00 |
Passed to setInterruptInterval to set the interrupt interval to 1 second. | |
static final byte | INTERRUPT_INTERVAL_4 = (byte)0x01 |
Passed to setInterruptInterval to set the interrupt interval to 4 seconds. | |
static final byte | INTERRUPT_INTERVAL_32 = (byte)0x02 |
Passed to setInterruptInterval to set the interrupt interval to 32 seconds. | |
static final byte | INTERRUPT_INTERVAL_64 = (byte)0x03 |
Passed to setInterruptInterval to set the interrupt interval to 64 seconds. | |
static final byte | INTERRUPT_INTERVAL_2048 = (byte)0x04 |
Passed to setInterruptInterval to set the interrupt interval to 2048 seconds. | |
static final byte | INTERRUPT_INTERVAL_4096 = (byte)0x05 |
Passed to setInterruptInterval to set the interrupt interval to 1 seconds. | |
static final byte | INTERRUPT_INTERVAL_65536 = (byte)0x06 |
Passed to setInterruptInterval to set the interrupt interval to 65536 seconds. | |
static final byte | INTERRUPT_INTERVAL_131072 = (byte)0x07 |
Passed to setInterruptInterval to set the interrupt interval to 131072 seconds. |
1-Wire container for Real-Time Clock with Interrupt, DS2417. The DS2417 is similar to the DS2415 with the addition of a hardware interrupt pin. This container encapsulates the functionality of the iButton family type 27 (hex)
The clock methods can be organized into the following categories. Note that methods that are implemented for the ClockContainer interface are marked with (*):
See the usage example in ClockContainer for clock specific operations.
http://pdfserv.maxim-ic.com/arpdf/DS2417.pdf
Create an empty container that is not complete until after a call to setupContainer
.
This is one of the methods to construct a container. The others are through creating a OneWireContainer with parameters.
OneWireContainer27 | ( | DSPortAdapter | sourceAdapter, |
byte[] | newAddress | ||
) |
Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.
sourceAdapter | adapter instance used to communicate with this iButton |
newAddress | Address of this 1-Wire device |
OneWireContainer27 | ( | DSPortAdapter | sourceAdapter, |
long | newAddress | ||
) |
Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.
sourceAdapter | adapter instance used to communicate with this 1-Wire device |
newAddress | Address of this 1-Wire device |
OneWireContainer27 | ( | DSPortAdapter | sourceAdapter, |
String | newAddress | ||
) |
Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.
sourceAdapter | adapter instance used to communicate with this 1-Wire device |
newAddress | Address of this 1-Wire device |
String getAlternateNames | ( | ) |
Get the alternate Maxim Integrated Products part numbers or names.
A 'family' of 1-Wire Network devices may have more than one part number depending on packaging. There can also be nicknames such as 'Crypto iButton'.
Reimplemented from OneWireContainer24.
String getDescription | ( | ) |
Get a short description of the function of this iButton or 1-Wire Device type.
Reimplemented from OneWireContainer24.
long getInterruptInterval | ( | byte[] | state | ) |
Returns the interval, in seconds, that the device will interrupt on.
state | current state of the device returned from readDevice() |
String getName | ( | ) |
Get the Maxim Integrated Products part number of the iButton or 1-Wire Device as a string.
For example 'DS1992'.
Reimplemented from OneWireContainer24.
boolean isInterruptEnabled | ( | byte[] | state | ) |
Checks to see if interrupt mode is turned on.
If so, pulses will be generated at an interval selected by setInterruptInterval.
state | current state of the device returned from readDevice() |
void setInterruptEnable | ( | boolean | iEnable, |
byte[] | state | ||
) |
Enables or disables hardware interrupting.
If enabled, the device sends an interrupt at intervals defined by using the setInterruptInterval function.
runEnable | true to enable interval interrupts. |
state | current state of the device returned from readDevice() |
void setInterruptInterval | ( | byte | intervalValue, |
byte[] | state | ||
) |
Sets the interval at which interrupting will occur.
Note that this feature must be enabled first using setInterruptEnable(true,state).
The method writeDevice(byte[])
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice(byte[])
.
intervalValue | One of the following variables should be passed, representing different time intervals to interrupt at: INTERRUPT_INTERVAL_1 1 second INTERRUPT_INTERVAL_4 4 seconds INTERRUPT_INTERVAL_32 32 seconds INTERRUPT_INTERVAL_32 64 seconds INTERRUPT_INTERVAL_64 2048 seconds INTERRUPT_INTERVAL_2048 4096 seconds INTERRUPT_INTERVAL_4096 65536 seconds INTERRUPT_INTERVAL_131072 131072 seconds |
state | current state of the device returned from readDevice() |
final byte INTERRUPT_INTERVAL_1 = (byte)0x00 [static] |
Passed to setInterruptInterval to set the interrupt interval to 1 second.
final byte INTERRUPT_INTERVAL_131072 = (byte)0x07 [static] |
Passed to setInterruptInterval to set the interrupt interval to 131072 seconds.
final byte INTERRUPT_INTERVAL_2048 = (byte)0x04 [static] |
Passed to setInterruptInterval to set the interrupt interval to 2048 seconds.
final byte INTERRUPT_INTERVAL_32 = (byte)0x02 [static] |
Passed to setInterruptInterval to set the interrupt interval to 32 seconds.
final byte INTERRUPT_INTERVAL_4 = (byte)0x01 [static] |
Passed to setInterruptInterval to set the interrupt interval to 4 seconds.
final byte INTERRUPT_INTERVAL_4096 = (byte)0x05 [static] |
Passed to setInterruptInterval to set the interrupt interval to 1 seconds.
final byte INTERRUPT_INTERVAL_64 = (byte)0x03 [static] |
Passed to setInterruptInterval to set the interrupt interval to 64 seconds.
final byte INTERRUPT_INTERVAL_65536 = (byte)0x06 [static] |
Passed to setInterruptInterval to set the interrupt interval to 65536 seconds.