1-Wire API for .NET Version 4.00
|
Inherits com::dalsemi::onewire::container::OneWireContainer, and com::dalsemi::onewire::container::PotentiometerContainer.
Public Member Functions | |
OneWireContainer2C () | |
Default constructor. | |
OneWireContainer2C (DSPortAdapter sourceAdapter, byte[] newAddress) | |
Creates a container with a provided adapter object and the address of the 1-Wire device. | |
OneWireContainer2C (DSPortAdapter sourceAdapter, long newAddress) | |
Creates a container with a provided adapter object and the address of this 1-Wire device. | |
OneWireContainer2C (DSPortAdapter sourceAdapter, String newAddress) | |
Creates a container with a provided adapter object and the address of this 1-Wire device. | |
String | getName () |
Retrieves the Maxim Integrated Products part number of this 1-Wire device as a string. | |
String | getAlternateNames () |
Retrieves the alternate Maxim Integrated Products part numbers or names. | |
String | getDescription () |
Retrieves a short description of the function of this 1-Wire Device. | |
int | getMaxSpeed () |
Gets the maximum speed this 1-Wire device can communicate at. | |
boolean | isLinear (byte[] state) |
Queries to see if this Potentiometer One Wire Device has linear potentiometer element(s) or logarithmic potentiometer element(s). | |
boolean | wiperSettingsAreVolatile (byte[] state) |
Queries to see if this 1-Wire Potentiometer device's wiper settings are volatile or non-volatile. | |
int | numberOfPotentiometers (byte[] state) |
Queries to see how many potentiometers this Potentiometer One Wire Device has. | |
int | numberOfWiperSettings (byte[] state) |
Queries to find the number of wiper settings that any wiper on this Potentiometer One Wire Device can have. | |
int | potentiometerResistance (byte[] state) |
Queries to find the resistance value of the potentiometer. | |
int | getCurrentWiperNumber (byte[] state) |
Gets the currently selected wiper number. | |
void | setCurrentWiperNumber (int wiper_number, byte[] state) |
Sets the currently selected wiper number. | |
boolean | isChargePumpOn (byte[] state) |
Determines if this device's charge pump is enabled. | |
void | setChargePump (boolean charge_pump_on, byte[] state) |
Sets this device's charge pump. | |
int | getWiperPosition () throws OneWireIOException, OneWireException |
Gets the current wiper position of this device. | |
boolean | setWiperPosition (int position) throws OneWireIOException, OneWireException |
Sets the wiper position for the potentiometer. | |
int | increment (boolean reselect) throws OneWireIOException, OneWireException |
Increments the wiper position. | |
int | decrement (boolean reselect) throws OneWireIOException, OneWireException |
Decrements the wiper position. | |
int | increment () throws OneWireIOException, OneWireException |
Increments the wiper position after selecting the part. | |
int | decrement () throws OneWireIOException, OneWireException |
Decrements the wiper position after selecting the part. | |
byte[] | readDevice () throws OneWireIOException, OneWireException |
Retrieves the 1-Wire device sensor state. | |
void | writeDevice (byte[] state) throws OneWireIOException, OneWireException |
Writes the 1-Wire device sensor state that have been changed by the 'set' methods. |
1-Wire® container that encapsulates the functionality of the 1-Wire family type 2C (hex), Maxim Integrated Products part number: DS2890, 1-Wire Digital Potentiometer.
http://pdfserv.maxim-ic.com/arpdf/DS2890.pdf
OneWireContainer2C | ( | DSPortAdapter | sourceAdapter, |
byte[] | newAddress | ||
) |
Creates a container with a provided adapter object and the address of the 1-Wire device.
sourceAdapter | adapter object required to communicate with this 1-Wire device |
newAddress | address of this 1-Wire device |
OneWireContainer2C | ( | DSPortAdapter | sourceAdapter, |
long | newAddress | ||
) |
Creates a container with a provided adapter object and the address of this 1-Wire device.
sourceAdapter | adapter object required to communicate with this 1-Wire device |
newAddress | address of this 1-Wire device |
OneWireContainer2C | ( | DSPortAdapter | sourceAdapter, |
String | newAddress | ||
) |
Creates a container with a provided adapter object and the address of this 1-Wire device.
sourceAdapter | adapter object required to communicate with this 1-Wire device |
newAddress | address of this 1-Wire device |
int decrement | ( | boolean | reselect | ) | throws OneWireIOException, OneWireException |
Decrements the wiper position.
reselect | increment/decrement can be called without resetting the part if the last call was an increment/decrement. true if you want to select the part (you must call with true after any other one-wire method) |
OneWireIOException | Data was not written correctly |
OneWireException | Could not find device |
Implements PotentiometerContainer.
int decrement | ( | ) | throws OneWireIOException, OneWireException |
Decrements the wiper position after selecting the part.
OneWireIOException | Data was not written correctly |
OneWireException | Counld not find device |
Implements PotentiometerContainer.
String getAlternateNames | ( | ) |
Retrieves the alternate Maxim Integrated Products part numbers or names.
A family of MicroLan devices may have more than one part number depending on packaging.
Reimplemented from OneWireContainer.
int getCurrentWiperNumber | ( | byte[] | state | ) |
Gets the currently selected wiper number.
All wiper actions affect this wiper. The number of wipers is the same as numberOfPotentiometers()
.
state | state buffer of this 1-Wire Potentiometer device (returned by readDevice() ) |
Implements PotentiometerContainer.
String getDescription | ( | ) |
Retrieves a short description of the function of this 1-Wire Device.
Reimplemented from OneWireContainer.
int getMaxSpeed | ( | ) |
Gets the maximum speed this 1-Wire device can communicate at.
Reimplemented from OneWireContainer.
String getName | ( | ) |
Retrieves the Maxim Integrated Products part number of this 1-Wire device as a string.
For example 'DS2890'.
Reimplemented from OneWireContainer.
int getWiperPosition | ( | ) | throws OneWireIOException, OneWireException |
Gets the current wiper position of this device.
The wiper position is between 0 and 255, and describes the voltage output. The output lies between RH and RL.
OneWireIOException | Data was not written correctly |
OneWireException | Could not find device |
Implements PotentiometerContainer.
int increment | ( | boolean | reselect | ) | throws OneWireIOException, OneWireException |
Increments the wiper position.
reselect | increment/decrement can be called without resetting the part if the last call was an increment/decrement. true if you want to select the part (you must call with true after any other one-wire method) |
OneWireIOException | Data was not written correctly |
OneWireException | Could not find device |
Implements PotentiometerContainer.
int increment | ( | ) | throws OneWireIOException, OneWireException |
Increments the wiper position after selecting the part.
OneWireIOException | Data was not written correctly |
OneWireException | Could not find device |
Implements PotentiometerContainer.
boolean isChargePumpOn | ( | byte[] | state | ) |
Determines if this device's charge pump is enabled.
state | state buffer of this Potentiometer One Wire Device (returned by readDevice() ) |
true
if it is enabled; false
if not Implements PotentiometerContainer.
boolean isLinear | ( | byte[] | state | ) |
Queries to see if this Potentiometer One Wire Device has linear potentiometer element(s) or logarithmic potentiometer element(s).
state | state buffer of the Potentiometer One Wire Device (returned by readDevice() ) |
true
if this device has linear potentiometer element(s); false
if this device has logarithmic potentiometer element(s) Implements PotentiometerContainer.
int numberOfPotentiometers | ( | byte[] | state | ) |
Queries to see how many potentiometers this Potentiometer One Wire Device has.
state | state buffer of this 1-Wire Potentiometer device (returned by readDevice() ) |
Implements PotentiometerContainer.
int numberOfWiperSettings | ( | byte[] | state | ) |
Queries to find the number of wiper settings that any wiper on this Potentiometer One Wire Device can have.
state | state buffer of this 1-Wire Potentiometer device (returned by readDevice() ) |
Implements PotentiometerContainer.
int potentiometerResistance | ( | byte[] | state | ) |
Queries to find the resistance value of the potentiometer.
state | state buffer of this 1-Wire Potentiometer device (returned by readDevice() ) |
Implements PotentiometerContainer.
byte [] readDevice | ( | ) | throws OneWireIOException, OneWireException |
Retrieves the 1-Wire device sensor state.
This state is returned as a byte array. Pass this byte array to the static query and set methods. If the device state needs to be changed then call the writeDevice
to finalize the one or more change.
OneWireIOException | Data was not read correctly |
OneWireException | Could not find device |
Implements OneWireSensor.
void setChargePump | ( | boolean | charge_pump_on, |
byte[] | state | ||
) |
Sets this device's charge pump.
This decreases the wiper's resistance, but increases the power consumption by the part. Vdd must be connected to use the charge pump (see the DS2890 datasheet for more information at www.dalsemi.com)
charge_pump_on | true if you want to enable the charge pump |
state | state buffer of this Potentiometer One Wire Device (returned by readDevice() ) |
true
if the operation was successful; false
if there was an error Implements PotentiometerContainer.
void setCurrentWiperNumber | ( | int | wiper_number, |
byte[] | state | ||
) |
Sets the currently selected wiper number.
All wiper actions affect this wiper. The number of wipers is the same as numberOfPotentiometers()
.
wiper_number | wiper number to select for communication. Valid choices are 0 to 3 |
state | state buffer of this 1-Wire Potentiometer device (returned by readDevice() ) |
Implements PotentiometerContainer.
boolean setWiperPosition | ( | int | position | ) | throws OneWireIOException, OneWireException |
Sets the wiper position for the potentiometer.
position | the position to set the wiper. This value will be cast to a byte, only the 8 least significant bits matter. |
true
if the operation was successful; false
otherwise OneWireIOException | Data was not written correctly |
OneWireException | Could not find device |
Implements PotentiometerContainer.
boolean wiperSettingsAreVolatile | ( | byte[] | state | ) |
Queries to see if this 1-Wire Potentiometer device's wiper settings are volatile or non-volatile.
state | state buffer of the 1-Wire Potentiometer device (returned by readDevice() ) |
true
if the wiper settings are volatile; false
if the wiper settings are non-volatile Implements PotentiometerContainer.
void writeDevice | ( | byte[] | state | ) | throws OneWireIOException, OneWireException |
Writes the 1-Wire device sensor state that have been changed by the 'set' methods.
It knows which registers have changed by looking at the bitmap fields appended to the state data.
state | byte array of clock register page contents |
OneWireIOException | Data was not written correctly |
OneWireException | Could not find device |
Implements OneWireSensor.