Microsoft (R) Windows Script Host Version 5.6
Copyright (C) Microsoft Corporation 1996-2001. All rights reserved.
found: public abstract class com.dalsemi.onewire.adapter.DSPortAdapter extends java.lang.Object {
class is abstract
Class added:com.dalsemi.onewire.adapter.DSPortAdapter
found: public class com.dalsemi.onewire.adapter.MulticastListener extends java.lang.Object implements java.lang.Runnable {
Class added:com.dalsemi.onewire.adapter.MulticastListener
found: public class com.dalsemi.onewire.adapter.NetAdapter extends com.dalsemi.onewire.adapter.DSPortAdapter implements com.dalsemi.onewire.adapter.NetAdapterConstants {
Class added:com.dalsemi.onewire.adapter.NetAdapter
found: public static final class com.dalsemi.onewire.adapter.NetAdapterConstants. Connection extends java.lang.Object
class is public interface abstract
found: public static final class com.dalsemi.onewire.adapter.NetAdapterConstants. Connection extends java.lang.Object
found: private class com.dalsemi.onewire.adapter.NetAdapterHost. SocketHandler extends java.lang.Object implements java.lang.Runnable
found: public class com.dalsemi.onewire.adapter.NetAdapterHost extends java.lang.Object implements java.lang.Runnable, com.dalsemi.onewire.adapter.NetAdapterConstants {
Class added:com.dalsemi.onewire.adapter.NetAdapterHost
found: public class com.dalsemi.onewire.adapter.OneWireIOException extends com.dalsemi.onewire.OneWireException {
found: public class com.dalsemi.onewire.adapter.TMEXAdapter extends com.dalsemi.onewire.adapter.DSPortAdapter {
Class added:com.dalsemi.onewire.adapter.TMEXAdapter
found: class com.dalsemi.onewire.application.file.MemoryCache extends java.lang.Object {
found: public class com.dalsemi.onewire.application.file.OWFile extends java.lang.Object {
Class added:com.dalsemi.onewire.application.file.OWFile
found: public class com.dalsemi.onewire.application.file.OWFileDescriptor extends java.lang.Object {
Class added:com.dalsemi.onewire.application.file.OWFileDescriptor
found: public class com.dalsemi.onewire.application.file.OWFileInputStream extends java.io.InputStream {
Class added:com.dalsemi.onewire.application.file.OWFileInputStream
found: public class com.dalsemi.onewire.application.file.OWFileNotFoundException extends java.io.IOException {
found: public class com.dalsemi.onewire.application.file.OWFileOutputStream extends java.io.OutputStream {
Class added:com.dalsemi.onewire.application.file.OWFileOutputStream
found: public class com.dalsemi.onewire.application.file.OWSyncFailedException extends java.io.IOException {
found: public abstract class com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor extends java.lang.Object implements java.lang.Runnable {
class is abstract
Class added:com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
found: public class com.dalsemi.onewire.application.monitor.DeviceMonitor extends com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor {
Class added:com.dalsemi.onewire.application.monitor.DeviceMonitor
found: public class com.dalsemi.onewire.application.monitor.DeviceMonitorEvent extends java.util.EventObject {
class is public interface abstract
found: public class com.dalsemi.onewire.application.monitor.DeviceMonitorException extends java.lang.Exception {
found: public class com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor extends com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor {
Class added:com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor
found: public class com.dalsemi.onewire.application.sha.SHADebit extends com.dalsemi.onewire.application.sha.SHATransaction {
Class added:com.dalsemi.onewire.application.sha.SHADebit
found: public class com.dalsemi.onewire.application.sha.SHADebitUnsigned extends com.dalsemi.onewire.application.sha.SHATransaction {
Class added:com.dalsemi.onewire.application.sha.SHADebitUnsigned
found: public class com.dalsemi.onewire.application.sha.SHAiButtonCopr extends java.lang.Object {
Class added:com.dalsemi.onewire.application.sha.SHAiButtonCopr
found: public class com.dalsemi.onewire.application.sha.SHAiButtonCoprVM extends com.dalsemi.onewire.application.sha.SHAiButtonCopr {
Class added:com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
found: public abstract class com.dalsemi.onewire.application.sha.SHAiButtonUser extends java.lang.Object {
class is abstract
Class added:com.dalsemi.onewire.application.sha.SHAiButtonUser
found: public class com.dalsemi.onewire.application.sha.SHAiButtonUser18 extends com.dalsemi.onewire.application.sha.SHAiButtonUser {
Class added:com.dalsemi.onewire.application.sha.SHAiButtonUser18
found: public class com.dalsemi.onewire.application.sha.SHAiButtonUser33 extends com.dalsemi.onewire.application.sha.SHAiButtonUser {
Class added:com.dalsemi.onewire.application.sha.SHAiButtonUser33
found: public class com.dalsemi.onewire.application.sha.SHASoftAuth extends com.dalsemi.onewire.application.sha.SHATransaction {
Class added:com.dalsemi.onewire.application.sha.SHASoftAuth
found: public abstract class com.dalsemi.onewire.application.sha.SHATransaction extends java.lang.Object {
class is abstract
Class added:com.dalsemi.onewire.application.sha.SHATransaction
found: public class com.dalsemi.onewire.application.tag.Contact extends com.dalsemi.onewire.application.tag.TaggedDevice implements com.dalsemi.onewire.application.tag.TaggedSensor {
Class added:com.dalsemi.onewire.application.tag.Contact
found: public class com.dalsemi.onewire.application.tag.D2A extends com.dalsemi.onewire.application.tag.TaggedDevice implements com.dalsemi.onewire.application.tag.TaggedActuator {
Class added:com.dalsemi.onewire.application.tag.D2A
found: public class com.dalsemi.onewire.application.tag.Event extends com.dalsemi.onewire.application.tag.TaggedDevice implements com.dalsemi.onewire.application.tag.TaggedSensor {
found: public class com.dalsemi.onewire.application.tag.Humidity extends com.dalsemi.onewire.application.tag.TaggedDevice implements com.dalsemi.onewire.application.tag.TaggedSensor {
Class added:com.dalsemi.onewire.application.tag.Humidity
found: public class com.dalsemi.onewire.application.tag.Level extends com.dalsemi.onewire.application.tag.TaggedDevice implements com.dalsemi.onewire.application.tag.TaggedSensor {
Class added:com.dalsemi.onewire.application.tag.Level
found: public class com.dalsemi.onewire.application.tag.SAXParser extends java.lang.Object implements org.xml.sax.Parser {
Class added:com.dalsemi.onewire.application.tag.SAXParser
found: public class com.dalsemi.onewire.application.tag.Switch extends com.dalsemi.onewire.application.tag.TaggedDevice implements com.dalsemi.onewire.application.tag.TaggedActuator {
Class added:com.dalsemi.onewire.application.tag.Switch
class is public interface abstract
found: public class com.dalsemi.onewire.application.tag.TaggedDevice extends java.lang.Object {
Class added:com.dalsemi.onewire.application.tag.TaggedDevice
class is public interface abstract
found: class com.dalsemi.onewire.application.tag.TAGHandler extends java.lang.Object implements org.xml.sax.ErrorHandler, org.xml.sax.DocumentHandler {
found: public class com.dalsemi.onewire.application.tag.TAGParser extends java.lang.Object {
Class added:com.dalsemi.onewire.application.tag.TAGParser
found: public class com.dalsemi.onewire.application.tag.Thermal extends com.dalsemi.onewire.application.tag.TaggedDevice implements com.dalsemi.onewire.application.tag.TaggedSensor {
Class added:com.dalsemi.onewire.application.tag.Thermal
found: public class com.dalsemi.onewire.application.tag.XML extends java.lang.Object {
Class added:com.dalsemi.onewire.application.tag.XML
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.ADContainer
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.ClockContainer
found: public class com.dalsemi.onewire.container.CommandAPDU extends java.lang.Object {
Class added:com.dalsemi.onewire.container.CommandAPDU
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.HumidityContainer
found: class com.dalsemi.onewire.container.JibComm. BlockDataFragmenter extends java.lang.Object
found: public class com.dalsemi.onewire.container.JibComm extends java.lang.Object {
Class added:com.dalsemi.onewire.container.JibComm
found: class com.dalsemi.onewire.container.JibComm. BlockDataFragmenter extends java.lang.Object
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.MemoryBank
found: class com.dalsemi.onewire.container.MemoryBankAD extends java.lang.Object implements com.dalsemi.onewire.container.PagedMemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankAppReg extends java.lang.Object implements com.dalsemi.onewire.container.OTPMemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankEE extends java.lang.Object implements com.dalsemi.onewire.container.PagedMemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankEEPROM extends java.lang.Object implements com.dalsemi.onewire.container.OTPMemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankEEPROMblock extends java.lang.Object implements com.dalsemi.onewire.container.OTPMemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankEEPROMstatus extends java.lang.Object implements com.dalsemi.onewire.container.MemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankEPROM extends java.lang.Object implements com.dalsemi.onewire.container.OTPMemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankNV extends java.lang.Object implements com.dalsemi.onewire.container.PagedMemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankNVCRC extends com.dalsemi.onewire.container.MemoryBankNV {
found: class com.dalsemi.onewire.container.MemoryBankNVCRCPW extends com.dalsemi.onewire.container.MemoryBankNVCRC {
found: class com.dalsemi.onewire.container.MemoryBankSBM extends java.lang.Object implements com.dalsemi.onewire.container.MemoryBank {
found: class com.dalsemi.onewire.container.MemoryBankScratch extends java.lang.Object implements com.dalsemi.onewire.container.PagedMemoryBank, com.dalsemi.onewire.container.ScratchPad {
found: class com.dalsemi.onewire.container.MemoryBankScratchCRC extends com.dalsemi.onewire.container.MemoryBankScratchEx {
found: class com.dalsemi.onewire.container.MemoryBankScratchCRCPW extends com.dalsemi.onewire.container.MemoryBankScratchEx {
found: class com.dalsemi.onewire.container.MemoryBankScratchEE extends com.dalsemi.onewire.container.MemoryBankScratch {
found: class com.dalsemi.onewire.container.MemoryBankScratchEx extends com.dalsemi.onewire.container.MemoryBankScratch {
found: class com.dalsemi.onewire.container.MemoryBankScratchSHA extends com.dalsemi.onewire.container.MemoryBankScratchCRC {
found: class com.dalsemi.onewire.container.MemoryBankScratchSHAEE extends com.dalsemi.onewire.container.MemoryBankScratchEx {
found: class com.dalsemi.onewire.container.MemoryBankSHAEE extends java.lang.Object implements com.dalsemi.onewire.container.PagedMemoryBank {
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.MissionContainer
found: public class com.dalsemi.onewire.container.OneWireContainer extends java.lang.Object {
Class added:com.dalsemi.onewire.container.OneWireContainer
found: public class com.dalsemi.onewire.container.OneWireContainer01 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer01
found: public class com.dalsemi.onewire.container.OneWireContainer02 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer02
found: public class com.dalsemi.onewire.container.OneWireContainer04 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.ClockContainer {
OneWireContainer04 implements ClockContainer
Class added:com.dalsemi.onewire.container.OneWireContainer04
found: public class com.dalsemi.onewire.container.OneWireContainer05 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.SwitchContainer {
OneWireContainer05 implements SwitchContainer
Class added:com.dalsemi.onewire.container.OneWireContainer05
found: public class com.dalsemi.onewire.container.OneWireContainer06 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer06
found: public class com.dalsemi.onewire.container.OneWireContainer08 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer08
found: public class com.dalsemi.onewire.container.OneWireContainer09 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer09
found: public class com.dalsemi.onewire.container.OneWireContainer0A extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer0A
found: public class com.dalsemi.onewire.container.OneWireContainer0B extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer0B
found: public class com.dalsemi.onewire.container.OneWireContainer0C extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer0C
found: public class com.dalsemi.onewire.container.OneWireContainer0F extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer0F
found: public class com.dalsemi.onewire.container.OneWireContainer10 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.TemperatureContainer {
OneWireContainer10 implements TemperatureContainer
Class added:com.dalsemi.onewire.container.OneWireContainer10
found: public class com.dalsemi.onewire.container.OneWireContainer12 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.SwitchContainer {
OneWireContainer12 implements SwitchContainer
Class added:com.dalsemi.onewire.container.OneWireContainer12
found: public class com.dalsemi.onewire.container.OneWireContainer13 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer13
found: public class com.dalsemi.onewire.container.OneWireContainer14 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer14
found: public class com.dalsemi.onewire.container.OneWireContainer16 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer16
found: public class com.dalsemi.onewire.container.OneWireContainer18 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer18
found: public class com.dalsemi.onewire.container.OneWireContainer1A extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer1A
found: public class com.dalsemi.onewire.container.OneWireContainer1D extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer1D
found: public class com.dalsemi.onewire.container.OneWireContainer1F extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.SwitchContainer {
OneWireContainer1F implements SwitchContainer
Class added:com.dalsemi.onewire.container.OneWireContainer1F
found: public class com.dalsemi.onewire.container.OneWireContainer20 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.ADContainer {
OneWireContainer20 implements ADContainer
Class added:com.dalsemi.onewire.container.OneWireContainer20
found: public class com.dalsemi.onewire.container.OneWireContainer21 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.TemperatureContainer, com.dalsemi.onewire.container.ClockContainer {
OneWireContainer21 implements TemperatureContainer,com.dalsemi.onewire.container.ClockContainer
Class added:com.dalsemi.onewire.container.OneWireContainer21
found: public class com.dalsemi.onewire.container.OneWireContainer22 extends com.dalsemi.onewire.container.OneWireContainer28 implements com.dalsemi.onewire.container.TemperatureContainer {
OneWireContainer22 implements TemperatureContainer
Class added:com.dalsemi.onewire.container.OneWireContainer22
found: public class com.dalsemi.onewire.container.OneWireContainer23 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer23
found: public class com.dalsemi.onewire.container.OneWireContainer24 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.ClockContainer {
OneWireContainer24 implements ClockContainer
Class added:com.dalsemi.onewire.container.OneWireContainer24
found: public class com.dalsemi.onewire.container.OneWireContainer26 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.ADContainer, com.dalsemi.onewire.container.TemperatureContainer, com.dalsemi.onewire.container.ClockContainer, com.dalsemi.onewire.container.HumidityContainer {
OneWireContainer26 implements ADContainer,com.dalsemi.onewire.container.TemperatureContainer,com.dalsemi.onewire.container.ClockContainer,com.dalsemi.onewire.container.HumidityContainer
Class added:com.dalsemi.onewire.container.OneWireContainer26
found: public class com.dalsemi.onewire.container.OneWireContainer27 extends com.dalsemi.onewire.container.OneWireContainer24 implements com.dalsemi.onewire.container.ClockContainer {
OneWireContainer27 implements ClockContainer
Class added:com.dalsemi.onewire.container.OneWireContainer27
found: public class com.dalsemi.onewire.container.OneWireContainer28 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.TemperatureContainer {
OneWireContainer28 implements TemperatureContainer
Class added:com.dalsemi.onewire.container.OneWireContainer28
found: public class com.dalsemi.onewire.container.OneWireContainer29 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.SwitchContainer {
OneWireContainer29 implements SwitchContainer
Class added:com.dalsemi.onewire.container.OneWireContainer29
found: public class com.dalsemi.onewire.container.OneWireContainer2C extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.PotentiometerContainer {
OneWireContainer2C implements PotentiometerContainer
Class added:com.dalsemi.onewire.container.OneWireContainer2C
found: public class com.dalsemi.onewire.container.OneWireContainer2D extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer2D
found: public class com.dalsemi.onewire.container.OneWireContainer30 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.ADContainer, com.dalsemi.onewire.container.TemperatureContainer {
OneWireContainer30 implements ADContainer,com.dalsemi.onewire.container.TemperatureContainer
Class added:com.dalsemi.onewire.container.OneWireContainer30
found: public class com.dalsemi.onewire.container.OneWireContainer33 extends com.dalsemi.onewire.container.OneWireContainer {
Class added:com.dalsemi.onewire.container.OneWireContainer33
found: public class com.dalsemi.onewire.container.OneWireContainer37 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.PasswordContainer {
OneWireContainer37 implements PasswordContainer
Class added:com.dalsemi.onewire.container.OneWireContainer37
found: public class com.dalsemi.onewire.container.OneWireContainer41 extends com.dalsemi.onewire.container.OneWireContainer implements com.dalsemi.onewire.container.PasswordContainer, com.dalsemi.onewire.container.MissionContainer, com.dalsemi.onewire.container.ClockContainer, com.dalsemi.onewire.container.TemperatureContainer, com.dalsemi.onewire.container.ADContainer, com.dalsemi.onewire.container.HumidityContainer {
OneWireContainer41 implements PasswordContainer,com.dalsemi.onewire.container.MissionContainer,com.dalsemi.onewire.container.ClockContainer,com.dalsemi.onewire.container.TemperatureContainer,com.dalsemi.onewire.container.ADContainer,com.dalsemi.onewire.container.HumidityContainer
Class added:com.dalsemi.onewire.container.OneWireContainer41
class is public interface abstract
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.OTPMemoryBank
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.PagedMemoryBank
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.PasswordContainer
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.PotentiometerContainer
found: public class com.dalsemi.onewire.container.ResponseAPDU extends java.lang.Object {
Class added:com.dalsemi.onewire.container.ResponseAPDU
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.SwitchContainer
class is public interface abstract
class is memory or sensor
Class added:com.dalsemi.onewire.container.TemperatureContainer
found: public class com.dalsemi.onewire.debug.Debug extends java.lang.Object {
Class added:com.dalsemi.onewire.debug.Debug
found: public class com.dalsemi.onewire.OneWireAccessProvider extends java.lang.Object {
Class added:com.dalsemi.onewire.OneWireAccessProvider
found: public class com.dalsemi.onewire.OneWireException extends java.lang.Exception {
found: public class com.dalsemi.onewire.utils.Address extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.Address
found: public class com.dalsemi.onewire.utils.Bit extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.Bit
found: public static class com.dalsemi.onewire.utils.Convert. ConvertException extends java.lang.Exception
found: public class com.dalsemi.onewire.utils.Convert extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.Convert
found: public class com.dalsemi.onewire.utils.CRC16 extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.CRC16
found: public class com.dalsemi.onewire.utils.CRC8 extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.CRC8
found: public final class com.dalsemi.onewire.utils.IOHelper extends java.lang.Object {
found: public class com.dalsemi.onewire.utils.OWPath extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.OWPath
found: public class com.dalsemi.onewire.utils.OWPathElement extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.OWPathElement
found: public class com.dalsemi.onewire.utils.SHA extends java.lang.Object {
Class added:com.dalsemi.onewire.utils.SHA
done loading collection
-------------------------------------------------------------------
creating: owapi\DSPortAdapter.java
======================================
public static final int SPEED_REGULAR
======================================
public static final int SPEED_FLEX
======================================
public static final int SPEED_OVERDRIVE
======================================
public static final int SPEED_HYPERDRIVE
======================================
public static final char LEVEL_NORMAL
======================================
public static final char LEVEL_POWER_DELIVERY
======================================
public static final char LEVEL_BREAK
======================================
public static final char LEVEL_PROGRAM
======================================
public static final int RESET_NOPRESENCE
======================================
public static final int RESET_PRESENCE
======================================
public static final int RESET_ALARM
======================================
public static final int RESET_SHORT
======================================
public static final int CONDITION_NOW
======================================
public static final int CONDITION_AFTER_BIT
======================================
public static final int CONDITION_AFTER_BYTE
======================================
public static final int DELIVERY_HALF_SECOND
======================================
public static final int DELIVERY_ONE_SECOND
======================================
public static final int DELIVERY_TWO_SECONDS
======================================
public static final int DELIVERY_FOUR_SECONDS
======================================
public static final int DELIVERY_SMART_DONE
======================================
public static final int DELIVERY_INFINITE
======================================
public static final int DELIVERY_CURRENT_DETECT
======================================
public static final int DELIVERY_EPROM
======================================
public java.lang.String getAdapterName()
sMethodName=public java.lang.String getAdapterName
sParams=
sThrows=
tempMethodName=public java.lang.String getAdapterName0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String getAdapterName
params=
/**
* Retrieves the name of the port adapter as a string. The 'Adapter'
* is a device that connects to a 'port' that allows one to
* communicate with an iButton or other 1-Wire device. As example
* of this is 'DS9097U'.
*
* @return <code>String</code> representation of the port adapter.
*/
public java.lang.String getAdapterName()
{
return objectInstance.getAdapterName();
}
======================================
public java.lang.String getPortTypeDescription()
sMethodName=public java.lang.String getPortTypeDescription
sParams=
sThrows=
tempMethodName=public java.lang.String getPortTypeDescription0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String getPortTypeDescription
params=
/**
* Retrieves a description of the port required by this port adapter.
* An example of a 'Port' would 'serial communication port'.
*
* @return <code>String</code> description of the port type required.
*/
public java.lang.String getPortTypeDescription()
{
return objectInstance.getPortTypeDescription();
}
======================================
public java.lang.String getClassVersion()
sMethodName=public java.lang.String getClassVersion
sParams=
sThrows=
tempMethodName=public java.lang.String getClassVersion0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String getClassVersion
params=
/**
* Retrieves a version string for this class.
*
* @return version string
*/
public java.lang.String getClassVersion()
{
return objectInstance.getClassVersion();
}
======================================
public java.util.Enumeration getPortNames()
sMethodName=public java.util.Enumeration getPortNames
sParams=
sThrows=
tempMethodName=public java.util.Enumeration getPortNames0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.util.Enumeration getPortNames
params=
/**
* Retrieves a list of the platform appropriate port names for this
* adapter. A port must be selected with the method 'selectPort'
* before any other communication methods can be used. Using
* a communcation method before 'selectPort' will result in
* a <code>OneWireException</code> exception.
*
* @return <code>Enumeration</code> of type <code>String</code> that contains the port
* names
*/
public java.util.Enumeration getPortNames()
{
java.util.Enumeration retEnum = objectInstance.getPortNames();
return retEnum;/*EnumNotUpdated*/
}
======================================
public void registerOneWireContainerClass(int, java.lang.Class) throws com.dalsemi.onewire.OneWireException
sMethodName=public void registerOneWireContainerClass
sParams=int, java.lang.Class
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void registerOneWireContainerClass2
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void registerOneWireContainerClass
params=int,java.lang.Class
/**
* Registers a user provided <code>OneWireContainer</code> class.
* Using this method will override the Dallas Semiconductor provided
* container class when using the getDeviceContainer() method. The
* registered container state is only stored for the current
* instance of <code>DSPortAdapter</code>, and is not statically shared.
* The <code>OneWireContainerClass</code> must extend
* <code>OneWireContainer</code> otherwise a <code>ClassCastException</code>
* will be thrown.
* The older duplicate family will be removed from registration when
* a collision occurs.
* Passing null as a parameter for the <code>OneWireContainerClass</code> will result
* in the removal of any entry associated with the family.
*
* @param family the code of the family type to associate with this class.
* @param OneWireContainerClass User provided class
*
* @throws OneWireException If <code>OneWireContainerClass</code> is not found.
* @throws ClassCastException If user supplied <code>OneWireContainer</code> does not
* extend <code>
*/
public void registerOneWireContainerClass(int a0, java.lang.Class a1)
throws com.dalsemi.onewire.OneWireException
{
objectInstance.registerOneWireContainerClass(a0, a1);
}
======================================
public boolean selectPort(java.lang.String) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean selectPort
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean selectPort1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean selectPort
params=java.lang.String
/**
* Specifies a platform appropriate port name for this adapter. Note that
* even though the port has been selected, it's ownership may be relinquished
* if it is not currently held in a 'exclusive' block. This class will then
* try to re-aquire the port when needed. If the port cannot be re-aquired
* ehen the exception <code>PortInUseException</code> will be thrown.
*
* @param portName name of the target port, retrieved from
* getPortNames()
*
* @return <code>true</code> if the port was aquired, <code>false</code>
* if the port is not available.
*
* @throws OneWireIOException If port does not exist, or unable to communicate with port.
* @throws OneWireException If port does not exist
*/
public boolean selectPort(java.lang.String portName)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.selectPort(portName);
}
======================================
public void freePort() throws com.dalsemi.onewire.OneWireException
sMethodName=public void freePort
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void freePort0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void freePort
params=
/**
* Frees ownership of the selected port, if it is currently owned, back
* to the system. This should only be called if the recently
* selected port does not have an adapter, or at the end of
* your application's use of the port.
*
* @throws OneWireException If port does not exist
*/
public void freePort()
throws com.dalsemi.onewire.OneWireException
{
objectInstance.freePort();
}
======================================
public java.lang.String getPortName() throws com.dalsemi.onewire.OneWireException
sMethodName=public java.lang.String getPortName
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public java.lang.String getPortName0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String getPortName
params=
/**
* Retrieves the name of the selected port as a <code>String</code>.
*
* @return <code>String</code> of selected port
*
* @throws OneWireException if valid port not yet selected
*/
public java.lang.String getPortName()
throws com.dalsemi.onewire.OneWireException
{
return objectInstance.getPortName();
}
======================================
public boolean adapterDetected() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean adapterDetected
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean adapterDetected0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean adapterDetected
params=
/**
* Detects adapter presence on the selected port.
*
* @return <code>true</code> if the adapter is confirmed to be connected to
* the selected port, <code>false</code> if the adapter is not connected.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean adapterDetected()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.adapterDetected();
}
======================================
public java.lang.String getAdapterVersion() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public java.lang.String getAdapterVersion
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public java.lang.String getAdapterVersion0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String getAdapterVersion
params=
/**
* Retrieves the version of the adapter.
*
* @return <code>String</code> of the adapter version. It will return
* "<na>" if the adapter version is not or cannot be known.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public java.lang.String getAdapterVersion()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.getAdapterVersion();
}
======================================
public java.lang.String getAdapterAddress() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public java.lang.String getAdapterAddress
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public java.lang.String getAdapterAddress0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String getAdapterAddress
params=
/**
* Retrieves the address of the adapter, if it has one.
*
* @return <code>String</code> of the adapter address. It will return "<na>" if
* the adapter does not have an address. The address is a string representation of an
* 1-Wire address.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
* @see Address
*/
public java.lang.String getAdapterAddress()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.getAdapterAddress();
}
======================================
public boolean canOverdrive() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean canOverdrive
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean canOverdrive0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean canOverdrive
params=
/**
* Returns whether adapter can physically support overdrive mode.
*
* @return <code>true</code> if this port adapter can do OverDrive,
* <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error with the adapter
* @throws OneWireException on a setup error with the 1-Wire
* adapter
*/
public boolean canOverdrive()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.canOverdrive();
}
======================================
public boolean canHyperdrive() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean canHyperdrive
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean canHyperdrive0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean canHyperdrive
params=
/**
* Returns whether the adapter can physically support hyperdrive mode.
*
* @return <code>true</code> if this port adapter can do HyperDrive,
* <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error with the adapter
* @throws OneWireException on a setup error with the 1-Wire
* adapter
*/
public boolean canHyperdrive()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.canHyperdrive();
}
======================================
public boolean canFlex() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean canFlex
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean canFlex0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean canFlex
params=
/**
* Returns whether the adapter can physically support flex speed mode.
*
* @return <code>true</code> if this port adapter can do flex speed,
* <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error with the adapter
* @throws OneWireException on a setup error with the 1-Wire
* adapter
*/
public boolean canFlex()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.canFlex();
}
======================================
public boolean canProgram() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean canProgram
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean canProgram0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean canProgram
params=
/**
* Returns whether adapter can physically support 12 volt power mode.
*
* @return <code>true</code> if this port adapter can do Program voltage,
* <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error with the adapter
* @throws OneWireException on a setup error with the 1-Wire
* adapter
*/
public boolean canProgram()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.canProgram();
}
======================================
public boolean canDeliverPower() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean canDeliverPower
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean canDeliverPower0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean canDeliverPower
params=
/**
* Returns whether the adapter can physically support strong 5 volt power
* mode.
*
* @return <code>true</code> if this port adapter can do strong 5 volt
* mode, <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error with the adapter
* @throws OneWireException on a setup error with the 1-Wire
* adapter
*/
public boolean canDeliverPower()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.canDeliverPower();
}
======================================
public boolean canDeliverSmartPower() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean canDeliverSmartPower
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean canDeliverSmartPower0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean canDeliverSmartPower
params=
/**
* Returns whether the adapter can physically support "smart" strong 5
* volt power mode. "smart" power delivery is the ability to deliver
* power until it is no longer needed. The current drop it detected
* and power delivery is stopped.
*
* @return <code>true</code> if this port adapter can do "smart" strong
* 5 volt mode, <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error with the adapter
* @throws OneWireException on a setup error with the 1-Wire
* adapter
*/
public boolean canDeliverSmartPower()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.canDeliverSmartPower();
}
======================================
public boolean canBreak() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean canBreak
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean canBreak0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean canBreak
params=
/**
* Returns whether adapter can physically support 0 volt 'break' mode.
*
* @return <code>true</code> if this port adapter can do break,
* <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error with the adapter
* @throws OneWireException on a setup error with the 1-Wire
* adapter
*/
public boolean canBreak()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.canBreak();
}
======================================
public java.util.Enumeration getAllDeviceContainers() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public java.util.Enumeration getAllDeviceContainers
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public java.util.Enumeration getAllDeviceContainers0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.util.Enumeration getAllDeviceContainers
params=
/**
* Returns an enumeration of <code>OneWireContainer</code> objects corresponding
* to all of the iButtons or 1-Wire devices found on the 1-Wire Network.
* If no devices are found, then an empty enumeration will be returned.
* In most cases, all further communication with the device is done
* through the OneWireContainer.
*
* @return <code>Enumeration</code> of <code>OneWireContainer</code> objects
* found on the 1-Wire Network.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public java.util.Enumeration getAllDeviceContainers()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
java.util.Enumeration retEnum = objectInstance.getAllDeviceContainers();
java.util.Vector reRetEnum = new java.util.Vector();
while(retEnum.hasMoreElements())
{
/*Double Check This*/
Object o = retEnum.nextElement();
if(o instanceof com.dalsemi.onewire.container.OneWireContainer01)
o = new OneWireContainer01(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer02)
o = new OneWireContainer02(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer04)
o = new OneWireContainer04(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer05)
o = new OneWireContainer05(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer06)
o = new OneWireContainer06(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer08)
o = new OneWireContainer08(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer09)
o = new OneWireContainer09(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer0A)
o = new OneWireContainer0A(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer0B)
o = new OneWireContainer0B(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer0C)
o = new OneWireContainer0C(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer0F)
o = new OneWireContainer0F(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer10)
o = new OneWireContainer10(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer12)
o = new OneWireContainer12(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer13)
o = new OneWireContainer13(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer14)
o = new OneWireContainer14(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer16)
o = new OneWireContainer16(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer18)
o = new OneWireContainer18(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer1A)
o = new OneWireContainer1A(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer1D)
o = new OneWireContainer1D(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer1F)
o = new OneWireContainer1F(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer20)
o = new OneWireContainer20(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer21)
o = new OneWireContainer21(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer23)
o = new OneWireContainer23(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer26)
o = new OneWireContainer26(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer28)
o = new OneWireContainer28(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer29)
o = new OneWireContainer29(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer2C)
o = new OneWireContainer2C(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer30)
o = new OneWireContainer30(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer33)
o = new OneWireContainer33(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer37)
o = new OneWireContainer37(o);
else if(o instanceof com.dalsemi.onewire.container.OneWireContainer41)
o = new OneWireContainer41(o);
else
o = new OneWireContainer(o);
reRetEnum.addElement(o);
}
return reRetEnum.elements();
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getFirstDeviceContainer() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getFirstDeviceContainer
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public OneWireContainer getFirstDeviceContainer0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public com.dalsemi.onewire.container.OneWireContainer getFirstDeviceContainer
params=
/**
* Returns a <code>OneWireContainer</code> object corresponding to the first iButton
* or 1-Wire device found on the 1-Wire Network. If no devices are found,
* then a <code>null</code> reference will be returned. In most cases, all further
* communication with the device is done through the <code>OneWireContainer</code>.
*
* @return The first <code>OneWireContainer</code> object found on the
* 1-Wire Network, or <code>null</code> if no devices found.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public OneWireContainer getFirstDeviceContainer()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new OneWireContainer(objectInstance.getFirstDeviceContainer());
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getNextDeviceContainer() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getNextDeviceContainer
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public OneWireContainer getNextDeviceContainer0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public com.dalsemi.onewire.container.OneWireContainer getNextDeviceContainer
params=
/**
* Returns a <code>OneWireContainer</code> object corresponding to the next iButton
* or 1-Wire device found. The previous 1-Wire device found is used
* as a starting point in the search. If no devices are found,
* then a <code>null</code> reference will be returned. In most cases, all further
* communication with the device is done through the <code>OneWireContainer</code>.
*
* @return The next <code>OneWireContainer</code> object found on the
* 1-Wire Network, or <code>null</code> if no iButtons found.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public OneWireContainer getNextDeviceContainer()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new OneWireContainer(objectInstance.getNextDeviceContainer());
}
======================================
public boolean findFirstDevice() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean findFirstDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean findFirstDevice0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean findFirstDevice
params=
/**
* Returns <code>true</code> if the first iButton or 1-Wire device
* is found on the 1-Wire Network.
* If no devices are found, then <code>false</code> will be returned.
*
* @return <code>true</code> if an iButton or 1-Wire device is found.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public boolean findFirstDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.findFirstDevice();
}
======================================
public boolean findNextDevice() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean findNextDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean findNextDevice0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean findNextDevice
params=
/**
* Returns <code>true</code> if the next iButton or 1-Wire device
* is found. The previous 1-Wire device found is used
* as a starting point in the search. If no more devices are found
* then <code>false</code> will be returned.
*
* @return <code>true</code> if an iButton or 1-Wire device is found.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public boolean findNextDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.findNextDevice();
}
======================================
public void getAddress(byte[])
sMethodName=public void getAddress
sParams=byte[]
sThrows=
tempMethodName=public void getAddress1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void getAddress
params=byte[]
/**
* Copies the 'current' 1-Wire device address being used by the adapter into
* the array. This address is the last iButton or 1-Wire device found
* in a search (findNextDevice()...).
* This method copies into a user generated array to allow the
* reuse of the buffer. When searching many iButtons on the one
* wire network, this will reduce the memory burn rate.
*
* @param address An array to be filled with the current iButton address.
* @see Address
*/
public void getAddress(ByteArray address)
{
objectInstance.getAddress(address.array);
}
======================================
public long getAddressAsLong()
sMethodName=public long getAddressAsLong
sParams=
sThrows=
tempMethodName=public String getAddressAsLong0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public long getAddressAsLong
params=
/**
* Gets the 'current' 1-Wire device address being used by the adapter as a long.
* This address is the last iButton or 1-Wire device found
* in a search (findNextDevice()...).
*
* @return <code>long</code> representation of the iButton address
* @see Address
*/
public String getAddressAsLong()
{
return ""+objectInstance.getAddressAsLong();
}
======================================
public java.lang.String getAddressAsString()
sMethodName=public java.lang.String getAddressAsString
sParams=
sThrows=
tempMethodName=public java.lang.String getAddressAsString0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String getAddressAsString
params=
/**
* Gets the 'current' 1-Wire device address being used by the adapter as a String.
* This address is the last iButton or 1-Wire device found
* in a search (findNextDevice()...).
*
* @return <code>String</code> representation of the iButton address
* @see Address
*/
public java.lang.String getAddressAsString()
{
return objectInstance.getAddressAsString();
}
======================================
public boolean isPresent(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isPresent
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isPresentFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean isPresent
params=byte[]
/**
* Verifies that the iButton or 1-Wire device specified is present on
* the 1-Wire Network. This does not affect the 'current' device
* state information used in searches (findNextDevice...).
*
* @param address device address to verify is present
*
* @return <code>true</code> if device is present, else
* <code>false</code>.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see Address
*/
public boolean isPresentFromBytes(ByteArray address)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isPresent(address.array);
}
======================================
public boolean isPresent(long) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isPresent
sParams=long
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isPresentFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean isPresent
params=long
/**
* Verifies that the iButton or 1-Wire device specified is present on
* the 1-Wire Network. This does not affect the 'current' device
* state information used in searches (findNextDevice...).
*
* @param address device address to verify is present
*
* @return <code>true</code> if device is present, else
* <code>false</code>.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see Address
*/
public boolean isPresentFromLong(String address)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isPresent(Long.parseLong(address));
}
======================================
public boolean isPresent(java.lang.String) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isPresent
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isPresent1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean isPresent
params=java.lang.String
/**
* Verifies that the iButton or 1-Wire device specified is present on
* the 1-Wire Network. This does not affect the 'current' device
* state information used in searches (findNextDevice...).
*
* @param address device address to verify is present
*
* @return <code>true</code> if device is present, else
* <code>false</code>.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see Address
*/
public boolean isPresent(java.lang.String address)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isPresent(address);
}
======================================
public boolean isAlarming(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isAlarming
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isAlarmingFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean isAlarming
params=byte[]
/**
* Verifies that the iButton or 1-Wire device specified is present
* on the 1-Wire Network and in an alarm state. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* @param address device address to verify is present and alarming
*
* @return <code>true</code> if device is present and alarming, else
* <code>false</code>.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see Address
*/
public boolean isAlarmingFromBytes(ByteArray address)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isAlarming(address.array);
}
======================================
public boolean isAlarming(long) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isAlarming
sParams=long
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isAlarmingFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean isAlarming
params=long
/**
* Verifies that the iButton or 1-Wire device specified is present
* on the 1-Wire Network and in an alarm state. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* @param address device address to verify is present and alarming
*
* @return <code>true</code> if device is present and alarming, else
* <code>false</code>.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see Address
*/
public boolean isAlarmingFromLong(String address)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isAlarming(Long.parseLong(address));
}
======================================
public boolean isAlarming(java.lang.String) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isAlarming
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean isAlarming
params=java.lang.String
/**
* Verifies that the iButton or 1-Wire device specified is present
* on the 1-Wire Network and in an alarm state. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* @param address device address to verify is present and alarming
*
* @return <code>true</code> if device is present and alarming, else
* <code>false</code>.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see Address
*/
public boolean isAlarming(java.lang.String address)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isAlarming(address);
}
======================================
public boolean select(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean select
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean selectFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean select
params=byte[]
/**
* Selects the specified iButton or 1-Wire device by broadcasting its
* address. This operation is refered to a 'MATCH ROM' operation
* in the iButton and 1-Wire device data sheets. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* Warning, this does not verify that the device is currently present
* on the 1-Wire Network (See isPresent).
*
* @param address address of iButton or 1-Wire device to select
*
* @return <code>true</code> if device address was sent, <code>false</code>
* otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see DSPortAdapter#isPresent(byte[])
* @see Address
*/
public boolean selectFromBytes(ByteArray a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.select(a0.array);
}
======================================
public boolean select(long) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean select
sParams=long
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean selectFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean select
params=long
/**
* Selects the specified iButton or 1-Wire device by broadcasting its
* address. This operation is refered to a 'MATCH ROM' operation
* in the iButton and 1-Wire device data sheets. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* Warning, this does not verify that the device is currently present
* on the 1-Wire Network (See isPresent).
*
* @param address address of iButton or 1-Wire device to select
*
* @return <code>true</code> if device address was sent,<code>false</code>
* otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see DSPortAdapter#isPresent(byte[])
* @see Address
*/
public boolean selectFromLong(String a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.select(Long.parseLong(a0));
}
======================================
public boolean select(java.lang.String) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean select
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean select1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean select
params=java.lang.String
/**
* Selects the specified iButton or 1-Wire device by broadcasting its
* address. This operation is refered to a 'MATCH ROM' operation
* in the iButton and 1-Wire device data sheets. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* Warning, this does not verify that the device is currently present
* on the 1-Wire Network (See isPresent).
*
* @param address address of iButton or 1-Wire device to select
*
* @return <code>true</code> if device address was sent,<code>false</code>
* otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see DSPortAdapter#isPresent(byte[])
* @see Address
*/
public boolean select(java.lang.String a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.select(a0);
}
======================================
public void assertSelect(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void assertSelect
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void assertSelectFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void assertSelect
params=byte[]
/**
* Selects the specified iButton or 1-Wire device by broadcasting its
* address. This operation is refered to a 'MATCH ROM' operation
* in the iButton and 1-Wire device data sheets. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* In addition, this method asserts that the select did find some
* devices on the 1-Wire net. If no devices were found, a OneWireException
* is thrown.
*
* Warning, this does not verify that the device is currently present
* on the 1-Wire Network (See isPresent).
*
* @param address address of iButton or 1-Wire device to select
*
* @throws OneWireIOException on a 1-Wire communication error, or if their
* are no devices on the 1-Wire net.
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see DSPortAdapter#isPresent(byte[])
* @see Address
*/
public void assertSelectFromBytes(ByteArray a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.assertSelect(a0.array);
}
======================================
public void assertSelect(long) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void assertSelect
sParams=long
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void assertSelectFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void assertSelect
params=long
/**
* Selects the specified iButton or 1-Wire device by broadcasting its
* address. This operation is refered to a 'MATCH ROM' operation
* in the iButton and 1-Wire device data sheets. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* In addition, this method asserts that the select did find some
* devices on the 1-Wire net. If no devices were found, a OneWireException
* is thrown.
*
* Warning, this does not verify that the device is currently present
* on the 1-Wire Network (See isPresent).
*
* @param address address of iButton or 1-Wire device to select
*
* @return <code>true</code> if device address was sent,<code>false</code>
* otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error, or if their
* are no devices on the 1-Wire net.
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see DSPortAdapter#isPresent(byte[])
* @see Address
*/
public void assertSelectFromLong(String a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.assertSelect(Long.parseLong(a0));
}
======================================
public void assertSelect(java.lang.String) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void assertSelect
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void assertSelect1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void assertSelect
params=java.lang.String
/**
* Selects the specified iButton or 1-Wire device by broadcasting its
* address. This operation is refered to a 'MATCH ROM' operation
* in the iButton and 1-Wire device data sheets. This does not
* affect the 'current' device state information used in searches
* (findNextDevice...).
*
* In addition, this method asserts that the select did find some
* devices on the 1-Wire net. If no devices were found, a OneWireException
* is thrown.
*
* Warning, this does not verify that the device is currently present
* on the 1-Wire Network (See isPresent).
*
* @param address address of iButton or 1-Wire device to select
*
* @throws OneWireIOException on a 1-Wire communication error, or if their
* are no devices on the 1-Wire net.
* @throws OneWireException on a setup error with the 1-Wire adapter
*
* @see DSPortAdapter#isPresent(byte[])
* @see Address
*/
public void assertSelect(java.lang.String a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.assertSelect(a0);
}
======================================
public void setSearchOnlyAlarmingDevices()
sMethodName=public void setSearchOnlyAlarmingDevices
sParams=
sThrows=
tempMethodName=public void setSearchOnlyAlarmingDevices0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void setSearchOnlyAlarmingDevices
params=
/**
* Sets the 1-Wire Network search to find only iButtons and 1-Wire
* devices that are in an 'Alarm' state that signals a need for
* attention. Not all iButton types
* have this feature. Some that do: DS1994, DS1920, DS2407.
* This selective searching can be canceled with the
* 'setSearchAllDevices()' method.
*
* @see #setNoResetSearch
*/
public void setSearchOnlyAlarmingDevices()
{
objectInstance.setSearchOnlyAlarmingDevices();
}
======================================
public void setNoResetSearch()
sMethodName=public void setNoResetSearch
sParams=
sThrows=
tempMethodName=public void setNoResetSearch0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void setNoResetSearch
params=
/**
* Sets the 1-Wire Network search to not perform a 1-Wire
* reset before a search. This feature is chiefly used with
* the DS2409 1-Wire coupler.
* The normal reset before each search can be restored with the
* 'setSearchAllDevices()' method.
*/
public void setNoResetSearch()
{
objectInstance.setNoResetSearch();
}
======================================
public void setSearchAllDevices()
sMethodName=public void setSearchAllDevices
sParams=
sThrows=
tempMethodName=public void setSearchAllDevices0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void setSearchAllDevices
params=
/**
* Sets the 1-Wire Network search to find all iButtons and 1-Wire
* devices whether they are in an 'Alarm' state or not and
* restores the default setting of providing a 1-Wire reset
* command before each search. (see setNoResetSearch() method).
*
* @see #setNoResetSearch
*/
public void setSearchAllDevices()
{
objectInstance.setSearchAllDevices();
}
======================================
public void targetAllFamilies()
sMethodName=public void targetAllFamilies
sParams=
sThrows=
tempMethodName=public void targetAllFamilies0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void targetAllFamilies
params=
/**
* Removes any selectivity during a search for iButtons or 1-Wire devices
* by family type. The unique address for each iButton and 1-Wire device
* contains a family descriptor that indicates the capabilities of the
* device.
* @see #targetFamily
* @see #targetFamily(byte[])
* @see #excludeFamily
* @see #excludeFamily(byte[])
*/
public void targetAllFamilies()
{
objectInstance.targetAllFamilies();
}
======================================
public void targetFamily(int)
sMethodName=public void targetFamily
sParams=int
sThrows=
tempMethodName=public void targetFamily1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void targetFamily
params=int
/**
* Takes an integer to selectively search for this desired family type.
* If this method is used, then no devices of other families will be
* found by any of the search methods.
*
* @param family the code of the family type to target for searches
* @see Address
* @see #targetAllFamilies
*/
public void targetFamily(int family)
{
objectInstance.targetFamily(family);
}
======================================
public void targetFamily(byte[])
sMethodName=public void targetFamily
sParams=byte[]
sThrows=
tempMethodName=public void targetFamilyFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void targetFamily
params=byte[]
/**
* Takes an array of bytes to use for selectively searching for acceptable
* family codes. If used, only devices with family codes in this array
* will be found by any of the search methods.
*
* @param family array of the family types to target for searches
* @see Address
* @see #targetAllFamilies
*/
public void targetFamilyFromBytes(ByteArray family )
{
objectInstance.targetFamily(family .array);
}
======================================
public void excludeFamily(int)
sMethodName=public void excludeFamily
sParams=int
sThrows=
tempMethodName=public void excludeFamily1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void excludeFamily
params=int
/**
* Takes an integer family code to avoid when searching for iButtons.
* or 1-Wire devices.
* If this method is used, then no devices of this family will be
* found by any of the search methods.
*
* @param family the code of the family type NOT to target in searches
* @see Address
* @see #targetAllFamilies
*/
public void excludeFamily(int family)
{
objectInstance.excludeFamily(family);
}
======================================
public void excludeFamily(byte[])
sMethodName=public void excludeFamily
sParams=byte[]
sThrows=
tempMethodName=public void excludeFamilyFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void excludeFamily
params=byte[]
/**
* Takes an array of bytes containing family codes to avoid when finding
* iButtons or 1-Wire devices. If used, then no devices with family
* codes in this array will be found by any of the search methods.
*
* @param family array of family cods NOT to target for searches
* @see Address
* @see #targetAllFamilies
*/
public void excludeFamilyFromBytes(ByteArray family )
{
objectInstance.excludeFamily(family .array);
}
======================================
public boolean beginExclusive(boolean) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean beginExclusive
sParams=boolean
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean beginExclusive1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean beginExclusive
params=boolean
/**
* Gets exclusive use of the 1-Wire to communicate with an iButton or
* 1-Wire Device.
* This method should be used for critical sections of code where a
* sequence of commands must not be interrupted by communication of
* threads with other iButtons, and it is permissible to sustain
* a delay in the special case that another thread has already been
* granted exclusive access and this access has not yet been
* relinquished. <p>
*
* It can be called through the OneWireContainer
* class by the end application if they want to ensure exclusive
* use. If it is not called around several methods then it
* will be called inside each method.
*
* @param blocking <code>true</code> if want to block waiting
* for an excluse access to the adapter
* @return <code>true</code> if blocking was false and a
* exclusive session with the adapter was aquired
*
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public boolean beginExclusive(boolean blocking)
throws com.dalsemi.onewire.OneWireException
{
return objectInstance.beginExclusive(blocking);
}
======================================
public void endExclusive()
sMethodName=public void endExclusive
sParams=
sThrows=
tempMethodName=public void endExclusive0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void endExclusive
params=
/**
* Relinquishes exclusive control of the 1-Wire Network.
* This command dynamically marks the end of a critical section and
* should be used when exclusive control is no longer needed.
*/
public void endExclusive()
{
objectInstance.endExclusive();
}
======================================
public void putBit(boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void putBit
sParams=boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void putBit1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void putBit
params=boolean
/**
* Sends a bit to the 1-Wire Network.
*
* @param bitValue the bit value to send to the 1-Wire Network.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public void putBit(boolean bitValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.putBit(bitValue);
}
======================================
public boolean getBit() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean getBit
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getBit0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean getBit
params=
/**
* Gets a bit from the 1-Wire Network.
*
* @return the bit value recieved from the the 1-Wire Network.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public boolean getBit()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.getBit();
}
======================================
public void putByte(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void putByte
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void putByte1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void putByte
params=int
/**
* Sends a byte to the 1-Wire Network.
*
* @param byteValue the byte value to send to the 1-Wire Network.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public void putByte(int byteValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.putByte(byteValue);
}
======================================
public int getByte() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int getByte
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int getByte0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public int getByte
params=
/**
* Gets a byte from the 1-Wire Network.
*
* @return the byte value received from the the 1-Wire Network.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public int getByte()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.getByte();
}
======================================
public byte getBlock(int)[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte getBlock
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray getBlock1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public byte[] getBlock
params=int
/**
* Gets a block of data from the 1-Wire Network.
*
* @param len length of data bytes to receive
*
* @return the data received from the 1-Wire Network.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public ByteArray getBlock(int len)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(objectInstance.getBlock(len));
}
======================================
public void getBlock(byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void getBlock
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void getBlock2
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void getBlock
params=byte[],int
/**
* Gets a block of data from the 1-Wire Network and write it into
* the provided array.
*
* @param arr array in which to write the received bytes
* @param len length of data bytes to receive
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public void getBlock(ByteArray arr, int len)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.getBlock(arr.array, len);
}
======================================
public void getBlock(byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void getBlock
sParams=byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void getBlock3
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void getBlock
params=byte[],int,int
/**
* Gets a block of data from the 1-Wire Network and write it into
* the provided array.
*
* @param arr array in which to write the received bytes
* @param off offset into the array to start
* @param len length of data bytes to receive
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public void getBlock(ByteArray arr, int off, int len)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.getBlock(arr.array, off, len);
}
======================================
public void dataBlock(byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void dataBlock
sParams=byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void dataBlock3
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void dataBlock
params=byte[],int,int
/**
* Sends a block of data and returns the data received in the same array.
* This method is used when sending a block that contains reads and writes.
* The 'read' portions of the data block need to be pre-loaded with 0xFF's.
* It starts sending data from the index at offset 'off' for length 'len'.
*
* @param dataBlock array of data to transfer to and from the 1-Wire Network.
* @param off offset into the array of data to start
* @param len length of data to send / receive starting at 'off'
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public void dataBlock(ByteArray dataBlock , int off, int len)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.dataBlock(dataBlock .array, off, len);
}
======================================
public int reset() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int reset
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int reset0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public int reset
params=
/**
* Sends a Reset to the 1-Wire Network.
*
* @return the result of the reset. Potential results are:
* <ul>
* <li> 0 (RESET_NOPRESENCE) no devices present on the 1-Wire Network.
* <li> 1 (RESET_PRESENCE) normal presence pulse detected on the 1-Wire
* Network indicating there is a device present.
* <li> 2 (RESET_ALARM) alarming presence pulse detected on the 1-Wire
* Network indicating there is a device present and it is in the
* alarm condition. This is only provided by the DS1994/DS2404
* devices.
* <li> 3 (RESET_SHORT) indicates 1-Wire appears shorted. This can be
* transient conditions in a 1-Wire Network. Not all adapter types
* can detect this condition.
* </ul>
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public int reset()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.reset();
}
======================================
public void setPowerDuration(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setPowerDuration
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setPowerDuration1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void setPowerDuration
params=int
/**
* Sets the duration to supply power to the 1-Wire Network.
* This method takes a time parameter that indicates the program
* pulse length when the method startPowerDelivery().<p>
*
* Note: to avoid getting an exception,
* use the canDeliverPower() and canDeliverSmartPower()
* method to check it's availability. <p>
*
* @param timeFactor
* <ul>
* <li> 0 (DELIVERY_HALF_SECOND) provide power for 1/2 second.
* <li> 1 (DELIVERY_ONE_SECOND) provide power for 1 second.
* <li> 2 (DELIVERY_TWO_SECONDS) provide power for 2 seconds.
* <li> 3 (DELIVERY_FOUR_SECONDS) provide power for 4 seconds.
* <li> 4 (DELIVERY_SMART_DONE) provide power until the
* the device is no longer drawing significant power.
* <li> 5 (DELIVERY_INFINITE) provide power until the
* setPowerNormal() method is called.
* </ul>
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public void setPowerDuration(int timeFactor)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.setPowerDuration(timeFactor);
}
======================================
public boolean startPowerDelivery(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean startPowerDelivery
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean startPowerDelivery1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean startPowerDelivery
params=int
/**
* Sets the 1-Wire Network voltage to supply power to a 1-Wire device.
* This method takes a time parameter that indicates whether the
* power delivery should be done immediately, or after certain
* conditions have been met. <p>
*
* Note: to avoid getting an exception,
* use the canDeliverPower() and canDeliverSmartPower()
* method to check it's availability. <p>
*
* @param changeCondition
* <ul>
* <li> 0 (CONDITION_NOW) operation should occur immediately.
* <li> 1 (CONDITION_AFTER_BIT) operation should be pending
* execution immediately after the next bit is sent.
* <li> 2 (CONDITION_AFTER_BYTE) operation should be pending
* execution immediately after next byte is sent.
* </ul>
*
* @return <code>true</code> if the voltage change was successful,
* <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public boolean startPowerDelivery(int changeCondition)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.startPowerDelivery(changeCondition);
}
======================================
public void setProgramPulseDuration(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setProgramPulseDuration
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setProgramPulseDuration1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void setProgramPulseDuration
params=int
/**
* Sets the duration for providing a program pulse on the
* 1-Wire Network.
* This method takes a time parameter that indicates the program
* pulse length when the method startProgramPulse().<p>
*
* Note: to avoid getting an exception,
* use the canDeliverPower() method to check it's
* availability. <p>
*
* @param timeFactor
* <ul>
* <li> 7 (DELIVERY_EPROM) provide program pulse for 480 microseconds
* <li> 5 (DELIVERY_INFINITE) provide power until the
* setPowerNormal() method is called.
* </ul>
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
*/
public void setProgramPulseDuration(int timeFactor)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.setProgramPulseDuration(timeFactor);
}
======================================
public boolean startProgramPulse(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean startProgramPulse
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean startProgramPulse1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean startProgramPulse
params=int
/**
* Sets the 1-Wire Network voltage to eprom programming level.
* This method takes a time parameter that indicates whether the
* power delivery should be done immediately, or after certain
* conditions have been met. <p>
*
* Note: to avoid getting an exception,
* use the canProgram() method to check it's
* availability. <p>
*
* @param changeCondition
* <ul>
* <li> 0 (CONDITION_NOW) operation should occur immediately.
* <li> 1 (CONDITION_AFTER_BIT) operation should be pending
* execution immediately after the next bit is sent.
* <li> 2 (CONDITION_AFTER_BYTE) operation should be pending
* execution immediately after next byte is sent.
* </ul>
*
* @return <code>true</code> if the voltage change was successful,
* <code>false</code> otherwise.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
* or the adapter does not support this operation
*/
public boolean startProgramPulse(int changeCondition)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.startProgramPulse(changeCondition);
}
======================================
public void startBreak() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void startBreak
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void startBreak0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void startBreak
params=
/**
* Sets the 1-Wire Network voltage to 0 volts. This method is used
* rob all 1-Wire Network devices of parasite power delivery to force
* them into a hard reset.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
* or the adapter does not support this operation
*/
public void startBreak()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.startBreak();
}
======================================
public void setPowerNormal() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setPowerNormal
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setPowerNormal0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void setPowerNormal
params=
/**
* Sets the 1-Wire Network voltage to normal level. This method is used
* to disable 1-Wire conditions created by startPowerDelivery and
* startProgramPulse. This method will automatically be called if
* a communication method is called while an outstanding power
* command is taking place.
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
* or the adapter does not support this operation
*/
public void setPowerNormal()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.setPowerNormal();
}
======================================
public void setSpeed(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setSpeed
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setSpeed1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public void setSpeed
params=int
/**
* Sets the new speed of data
* transfer on the 1-Wire Network. <p>
*
* @param speed
* <ul>
* <li> 0 (SPEED_REGULAR) set to normal communciation speed
* <li> 1 (SPEED_FLEX) set to flexible communciation speed used
* for long lines
* <li> 2 (SPEED_OVERDRIVE) set to normal communciation speed to
* overdrive
* <li> 3 (SPEED_HYPERDRIVE) set to normal communciation speed to
* hyperdrive
* <li> >3 future speeds
* </ul>
*
* @throws OneWireIOException on a 1-Wire communication error
* @throws OneWireException on a setup error with the 1-Wire adapter
* or the adapter does not support this operation
*/
public void setSpeed(int speed)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.setSpeed(speed);
}
======================================
public int getSpeed()
sMethodName=public int getSpeed
sParams=
sThrows=
tempMethodName=public int getSpeed0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public int getSpeed
params=
/**
* Returns the current data transfer speed on the 1-Wire Network. <p>
*
* @return <code>int</code> representing the current 1-Wire speed
* <ul>
* <li> 0 (SPEED_REGULAR) set to normal communication speed
* <li> 1 (SPEED_FLEX) set to flexible communication speed used
* for long lines
* <li> 2 (SPEED_OVERDRIVE) set to normal communication speed to
* overdrive
* <li> 3 (SPEED_HYPERDRIVE) set to normal communication speed to
* hyperdrive
* <li> >3 future speeds
* </ul>
*/
public int getSpeed()
{
return objectInstance.getSpeed();
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer(byte[])
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=byte[]
sThrows=
tempMethodName=public OneWireContainer getDeviceContainerFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=byte[]
/**
* Constructs a <code>OneWireContainer</code> object with a user supplied 1-Wire network address.
*
* @param address device address with which to create a new container
*
* @return The <code>OneWireContainer</code> object
* @see Address
*/
public OneWireContainer getDeviceContainerFromBytes(ByteArray address)
{
return new OneWireContainer(objectInstance.getDeviceContainer(address.array));
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer(long)
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=long
sThrows=
tempMethodName=public OneWireContainer getDeviceContainerFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=long
/**
* Constructs a <code>OneWireContainer</code> object with a user supplied 1-Wire network address.
*
* @param address device address with which to create a new container
*
* @return The <code>OneWireContainer</code> object
* @see Address
*/
public OneWireContainer getDeviceContainerFromLong(String address)
{
return new OneWireContainer(objectInstance.getDeviceContainer(Long.parseLong(address)));
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer(java.lang.String)
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=java.lang.String
sThrows=
tempMethodName=public OneWireContainer getDeviceContainer1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=java.lang.String
/**
* Constructs a <code>OneWireContainer</code> object with a user supplied 1-Wire network address.
*
* @param address device address with which to create a new container
*
* @return The <code>OneWireContainer</code> object
* @see Address
*/
public OneWireContainer getDeviceContainer(java.lang.String address)
{
return new OneWireContainer(objectInstance.getDeviceContainer(address));
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer()
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=
sThrows=
tempMethodName=public OneWireContainer getDeviceContainer0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=
/**
* Constructs a <code>OneWireContainer</code> object with a user supplied 1-Wire network address.
*
* @param address device address with which to create a new container
*
* @return The <code>OneWireContainer</code> object
* @see Address
*/
public OneWireContainer getDeviceContainer()
{
return new OneWireContainer(objectInstance.getDeviceContainer());
}
======================================
public boolean equals(java.lang.Object)
sMethodName=public boolean equals
sParams=java.lang.Object
sThrows=
tempMethodName=public boolean equals1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public boolean equals
params=java.lang.Object
/**
* Returns true if the given object is the same or equivalent
* to this DSPortAdapter.
*
* @param o the Object to compare this DSPortAdapter to
* @return true if the given object is the same or equivalent
* to this DSPortAdapter.
*/
public boolean equals(java.lang.Object o)
{
return objectInstance.equals(o);
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.DSPortAdapter
methodName=public java.lang.String toString
params=
/**
* Returns a string representation of this DSPortAdapter, in the format
* of "<adapter name> <port name>".
*
* @return a string representation of this DSPortAdapter
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
-------------------------------------------------------------------
creating: owapi\MulticastListener.java
======================================
public com.dalsemi.onewire.adapter.MulticastListener(int,java.lang.String,byte[],byte[]) throws java.io.IOException, java.net.UnknownHostException
sMethodName=public com.dalsemi.onewire.adapter.MulticastListener
sParams=int,java.lang.String,byte[],byte[]
sThrows=throws java.io.IOException, java.net.UnknownHostException
tempMethodName=public void createNewInstance4
getMethodDocumentation
className=com.dalsemi.onewire.adapter.MulticastListener
methodName=public void createNewInstance
params=int,java.lang.String,byte[],byte[]
/**
* Creates a multicast listener on the specified multicast port,
* bound to the specified multicast group. Whenever the byte[]
* pattern specified by "expectedMessage" is received, the byte[]
* pattern specifed by "returnMessage" is sent to the sender of
* the "expected message".
*
* @param multicastPort Port to bind this listener to.
* @param multicastGroup Group to bind this listener to.
* @param expectedMessage the message to look for
* @param returnMessage the message to reply with
*/
public void createNewInstance(int multicastPort, java.lang.String multicastGroup, ByteArray expectedMessage, ByteArray returnMessage)
throws java.io.IOException, java.net.UnknownHostException
{
objectInstance = new com.dalsemi.onewire.adapter.MulticastListener(multicastPort, multicastGroup, expectedMessage.array, returnMessage.array);
}
======================================
public void run()
sMethodName=public void run
sParams=
sThrows=
tempMethodName=public void run0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.MulticastListener
methodName=public void run
params=
/**
* Run method waits for Multicast packets with the specified contents
* and replies with the specified message.
*/
public void run()
{
objectInstance.run();
}
======================================
public void stopListener()
sMethodName=public void stopListener
sParams=
sThrows=
tempMethodName=public void stopListener0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.MulticastListener
methodName=public void stopListener
params=
/**
* Waits for datagram listener to finish, with a timeout.
*/
public void stopListener()
{
objectInstance.stopListener();
}
-------------------------------------------------------------------
creating: owapi\NetAdapter.java
superClassName=java.lang.Object
======================================
public void setSecret(java.lang.String)
sMethodName=public void setSecret
sParams=java.lang.String
sThrows=
tempMethodName=public void setSecret1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapter
methodName=public void setSecret
params=java.lang.String
/**
* Sets the shared secret for authenticating this NetAdapter with
* a NetAdapterHost.
*
* @param secret the new secret for authenticating this client.
*/
public void setSecret(java.lang.String secret)
{
((com.dalsemi.onewire.adapter.NetAdapter)objectInstance).setSecret(secret);
}
======================================
public void resetSecret()
sMethodName=public void resetSecret
sParams=
sThrows=
tempMethodName=public void resetSecret0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapter
methodName=public void resetSecret
params=
/**
* Resets the secret to be the default stored in the onewire.properties
* file (if there is one), or the default as defined by NetAdapterConstants.
*/
public void resetSecret()
{
((com.dalsemi.onewire.adapter.NetAdapter)objectInstance).resetSecret();
}
======================================
public void pingHost() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void pingHost
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void pingHost0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapter
methodName=public void pingHost
params=
/**
* Sends a ping to the host, just to keep the connection alive. Although
* it currently is not implemented on the standard NetAdapterHost, this
* command is used as a signal to the NetAdapterSim to simulate some amount
* of time that has run.
*/
public void pingHost()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.adapter.NetAdapter)objectInstance).pingHost();
}
======================================
public boolean selectPort(java.net.Socket) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean selectPort
sParams=java.net.Socket
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean selectPortFromSocket1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapter
methodName=public boolean selectPort
params=java.net.Socket
/**
* New method, unique to NetAdapter. Sets the "port", i.e. the connection
* to the server via an already established socket connection.
*
* @param sock Socket connection to NetAdapterHost
*
* @return <code>true</code> if connection to host was successful
*
* @throws OneWireIOException If port does not exist, or unable to communicate with port.
* @throws OneWireException If port does not exist
*/
public boolean selectPortFromSocket(java.net.Socket sock)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.adapter.NetAdapter)objectInstance).selectPort(sock);
}
-------------------------------------------------------------------
creating: owapi\NetAdapterHost.java
======================================
public com.dalsemi.onewire.adapter.NetAdapterHost(com.dalsemi.onewire.adapter.DSPortAdapter) throws java.io.IOException
sMethodName=public com.dalsemi.onewire.adapter.NetAdapterHost
sParams=com.dalsemi.onewire.adapter.DSPortAdapter
sThrows=throws java.io.IOException
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter
/**
* <P>Creates an instance of a NetAdapterHost which wraps the provided
* adapter. The host listens on the default port as specified by
* NetAdapterConstants.</P>
*
* <P>Note that the secret used for authentication is the value specified
* in the onewire.properties file as "NetAdapter.secret=mySecret".
* To set the secret to another value, use the
* <code>setSecret(String)</code> method.</P>
*
* @param adapter DSPortAdapter that this NetAdapterHost will proxy
* commands to.
*
* @throws IOException if a network error occurs or the listen socket
* cannot be created on the specified port.
*/
public void createNewInstance(DSPortAdapter adapter)
throws java.io.IOException
{
objectInstance = new com.dalsemi.onewire.adapter.NetAdapterHost(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance));
}
======================================
public com.dalsemi.onewire.adapter.NetAdapterHost(com.dalsemi.onewire.adapter.DSPortAdapter,int) throws java.io.IOException
sMethodName=public com.dalsemi.onewire.adapter.NetAdapterHost
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,int
sThrows=throws java.io.IOException
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,int
/**
* <P>Creates a single-threaded instance of a NetAdapterHost which wraps the
* provided adapter. The host listens on the specified port.</P>
*
* <P>Note that the secret used for authentication is the value specified
* in the onewire.properties file as "NetAdapter.secret=mySecret".
* To set the secret to another value, use the
* <code>setSecret(String)</code> method.</P>
*
* @param adapter DSPortAdapter that this NetAdapterHost will proxy
* commands to.
* @param listenPort the TCP/IP port to listen on for incoming connections
*
* @throws IOException if a network error occurs or the listen socket
* cannot be created on the specified port.
*/
public void createNewInstance(DSPortAdapter adapter, int listenPort)
throws java.io.IOException
{
objectInstance = new com.dalsemi.onewire.adapter.NetAdapterHost(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), listenPort);
}
======================================
public com.dalsemi.onewire.adapter.NetAdapterHost(com.dalsemi.onewire.adapter.DSPortAdapter,boolean) throws java.io.IOException
sMethodName=public com.dalsemi.onewire.adapter.NetAdapterHost
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,boolean
sThrows=throws java.io.IOException
tempMethodName=public void createNewInstanceMultithreaded2
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,boolean
/**
* <P>Creates an (optionally multithreaded) instance of a NetAdapterHost
* which wraps the provided adapter. The listen port is set to the
* default port as defined in NetAdapterConstants.</P>
*
* <P>Note that the secret used for authentication is the value specified
* in the onewire.properties file as "NetAdapter.secret=mySecret".
* To set the secret to another value, use the
* <code>setSecret(String)</code> method.</P>
*
* @param adapter DSPortAdapter that this NetAdapterHost will proxy
* commands to.
* @param multiThread if true, multiple TCP/IP connections are allowed
* to interact simulataneously with this adapter.
*
* @throws IOException if a network error occurs or the listen socket
* cannot be created on the specified port.
*/
public void createNewInstanceMultithreaded(DSPortAdapter adapter, boolean multiThread)
throws java.io.IOException
{
objectInstance = new com.dalsemi.onewire.adapter.NetAdapterHost(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), multiThread);
}
======================================
public com.dalsemi.onewire.adapter.NetAdapterHost(com.dalsemi.onewire.adapter.DSPortAdapter,int,boolean) throws java.io.IOException
sMethodName=public com.dalsemi.onewire.adapter.NetAdapterHost
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,int,boolean
sThrows=throws java.io.IOException
tempMethodName=public void createNewInstanceMultithreaded3
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,int,boolean
/**
* <P>Creates an (optionally multi-threaded) instance of a NetAdapterHost which
* wraps the provided adapter. The host listens on the specified port.</P>
*
* <P>Note that the secret used for authentication is the value specified
* in the onewire.properties file as "NetAdapter.secret=mySecret".
* To set the secret to another value, use the
* <code>setSecret(String)</code> method.</P>
*
* @param adapter DSPortAdapter that this NetAdapterHost will proxy
* commands to.
* @param listenPort the TCP/IP port to listen on for incoming connections
* @param multiThread if true, multiple TCP/IP connections are allowed
* to interact simulataneously with this adapter.
*
* @throws IOException if a network error occurs or the listen socket
* cannot be created on the specified port.
*/
public void createNewInstanceMultithreaded(DSPortAdapter adapter, int listenPort, boolean multiThread)
throws java.io.IOException
{
objectInstance = new com.dalsemi.onewire.adapter.NetAdapterHost(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), listenPort, multiThread);
}
======================================
public com.dalsemi.onewire.adapter.NetAdapterHost(com.dalsemi.onewire.adapter.DSPortAdapter,java.net.ServerSocket) throws java.io.IOException
sMethodName=public com.dalsemi.onewire.adapter.NetAdapterHost
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.net.ServerSocket
sThrows=throws java.io.IOException
tempMethodName=public void createNewInstanceFromSocket2
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.net.ServerSocket
/**
* <P>Creates an instance of a NetAdapterHost which wraps the provided
* adapter. The host listens on the default port as specified by
* NetAdapterConstants.</P>
*
* <P>Note that the secret used for authentication is the value specified
* in the onewire.properties file as "NetAdapter.secret=mySecret".
* To set the secret to another value, use the
* <code>setSecret(String)</code> method.</P>
*
* @param adapter DSPortAdapter that this NetAdapterHost will proxy
* commands to.
* @param serverSock the ServerSocket for incoming connections
*
* @throws IOException if a network error occurs or the listen socket
* cannot be created on the specified port.
*/
public void createNewInstanceFromSocket(DSPortAdapter adapter, java.net.ServerSocket serverSock)
throws java.io.IOException
{
objectInstance = new com.dalsemi.onewire.adapter.NetAdapterHost(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), serverSock);
}
======================================
public com.dalsemi.onewire.adapter.NetAdapterHost(com.dalsemi.onewire.adapter.DSPortAdapter,java.net.ServerSocket,boolean) throws java.io.IOException
sMethodName=public com.dalsemi.onewire.adapter.NetAdapterHost
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.net.ServerSocket,boolean
sThrows=throws java.io.IOException
tempMethodName=public void createNewInstanceFromSocketMultithreaded3
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.net.ServerSocket,boolean
/**
* <P>Creates an (optionally multi-threaded) instance of a NetAdapterHost which
* wraps the provided adapter. The host listens on the specified port.</P>
*
* <P>Note that the secret used for authentication is the value specified
* in the onewire.properties file as "NetAdapter.secret=mySecret".
* To set the secret to another value, use the
* <code>setSecret(String)</code> method.</P>
*
* @param adapter DSPortAdapter that this NetAdapterHost will proxy
* commands to.
* @param serverSock the ServerSocket for incoming connections
* @param multiThread if true, multiple TCP/IP connections are allowed
* to interact simulataneously with this adapter.
*
* @throws IOException if a network error occurs or the listen socket
* cannot be created on the specified port.
*/
public void createNewInstanceFromSocketMultithreaded(DSPortAdapter adapter, java.net.ServerSocket serverSock, boolean multiThread)
throws java.io.IOException
{
objectInstance = new com.dalsemi.onewire.adapter.NetAdapterHost(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), serverSock, multiThread);
}
======================================
public void setSecret(java.lang.String)
sMethodName=public void setSecret
sParams=java.lang.String
sThrows=
tempMethodName=public void setSecret1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void setSecret
params=java.lang.String
/**
* Sets the secret used for authenticating incoming client connections.
*
* @param secret The shared secret information used for authenticating
* incoming client connections.
*/
public void setSecret(java.lang.String secret)
{
objectInstance.setSecret(secret);
}
======================================
public void createMulticastListener() throws java.io.IOException, java.net.UnknownHostException
sMethodName=public void createMulticastListener
sParams=
sThrows=throws java.io.IOException, java.net.UnknownHostException
tempMethodName=public void createMulticastListener0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createMulticastListener
params=
/**
* Creates a Multicast Listener to allow NetAdapter clients to discover
* this NetAdapterHost automatically. Uses defaults for Multicast group
* and port.
*/
public void createMulticastListener()
throws java.io.IOException, java.net.UnknownHostException
{
objectInstance.createMulticastListener();
}
======================================
public void createMulticastListener(int) throws java.io.IOException, java.net.UnknownHostException
sMethodName=public void createMulticastListener
sParams=int
sThrows=throws java.io.IOException, java.net.UnknownHostException
tempMethodName=public void createMulticastListener1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createMulticastListener
params=int
/**
* Creates a Multicast Listener to allow NetAdapter clients to discover
* this NetAdapterHost automatically. Uses default for Multicast group.
*
* @param port The port the Multicast socket will receive packets on
*/
public void createMulticastListener(int port)
throws java.io.IOException, java.net.UnknownHostException
{
objectInstance.createMulticastListener(port);
}
======================================
public void createMulticastListener(int, java.lang.String) throws java.io.IOException, java.net.UnknownHostException
sMethodName=public void createMulticastListener
sParams=int, java.lang.String
sThrows=throws java.io.IOException, java.net.UnknownHostException
tempMethodName=public void createMulticastListener2
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void createMulticastListener
params=int,java.lang.String
/**
* Creates a Multicast Listener to allow NetAdapter clients to discover
* this NetAdapterHost automatically.
*
* @param port The port the Multicast socket will receive packets on
* @param group The group the Multicast socket will join
*/
public void createMulticastListener(int port, java.lang.String group)
throws java.io.IOException, java.net.UnknownHostException
{
objectInstance.createMulticastListener(port, group);
}
======================================
public void run()
sMethodName=public void run
sParams=
sThrows=
tempMethodName=public void run0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void run
params=
/**
* Run method for threaded NetAdapterHost. Maintains server socket which
* waits for incoming connections. Whenever a connection is received
* launches it services the socket or (optionally) launches a new thread
* for servicing the socket.
*/
public void run()
{
objectInstance.run();
}
======================================
public void handleConnection(java.net.Socket) throws java.io.IOException
sMethodName=public void handleConnection
sParams=java.net.Socket
sThrows=throws java.io.IOException
tempMethodName=public void handleConnection1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void handleConnection
params=java.net.Socket
/**
* Handles a socket connection. If single-threaded, the connection is
* serviced in the current thread. If multi-threaded, a new thread is
* created for servicing this connection.
*/
public void handleConnection(java.net.Socket sock)
throws java.io.IOException
{
objectInstance.handleConnection(sock);
}
======================================
public void stopHost()
sMethodName=public void stopHost
sParams=
sThrows=
tempMethodName=public void stopHost0
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public void stopHost
params=
/**
* Stops all threads and kills the server socket.
*/
public void stopHost()
{
objectInstance.stopHost();
}
======================================
public static void main(java.lang.String[]) throws java.lang.Exception
sMethodName=public static void main
sParams=java.lang.String[]
sThrows=throws java.lang.Exception
tempMethodName=public static void main1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.NetAdapterHost
methodName=public static void main
params=java.lang.String[]
/**
* A Default Main Method, for launching NetAdapterHost getting the
* default adapter with the OneWireAccessProvider and listening on
* the default port specified by DEFAULT_PORT.
*/
public void main(java.lang.String[] args)
throws java.lang.Exception
{
com.dalsemi.onewire.adapter.NetAdapterHost.main(args);
}
-------------------------------------------------------------------
creating: owapi\TMEXAdapter.java
No COM CLSID for TMEXAdapter
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.adapter.TMEXAdapter(int) throws java.lang.ClassNotFoundException
sMethodName=public com.dalsemi.onewire.adapter.TMEXAdapter
sParams=int
sThrows=throws java.lang.ClassNotFoundException
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.TMEXAdapter
methodName=public void createNewInstance
params=int
/**
* Constructs with a specified port type
*
*
* @param newPortType
* @throws ClassNotFoundException
*/
public void createNewInstance(int newPortType)
throws java.lang.ClassNotFoundException
{
objectInstance = new com.dalsemi.onewire.adapter.TMEXAdapter(newPortType);
}
======================================
public boolean setTMEXPortType(int)
sMethodName=public boolean setTMEXPortType
sParams=int
sThrows=
tempMethodName=public boolean setTMEXPortType1
getMethodDocumentation
className=com.dalsemi.onewire.adapter.TMEXAdapter
methodName=public boolean setTMEXPortType
params=int
/**
* Select the TMEX specified port type (0 to 15) Use this
* method if the constructor with the PortType cannot be used.
*
*
* @param newPortType
* @return true if port type valid. Instance is only usable
* if this returns false.
*/
public boolean setTMEXPortType(int newPortType)
{
return ((com.dalsemi.onewire.adapter.TMEXAdapter)objectInstance).setTMEXPortType(newPortType);
}
-------------------------------------------------------------------
creating: owapi\OWFile.java
======================================
public static final java.lang.String separator
======================================
public static final char separatorChar
======================================
public static final java.lang.String pathSeparator
======================================
public static final char pathSeparatorChar
======================================
public com.dalsemi.onewire.application.file.OWFile(com.dalsemi.onewire.container.OneWireContainer,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.file.OWFile
sParams=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
sThrows=
tempMethodName=public void createNewInstanceFromContainer2
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
/**
* Creates a new <code>OWFile</code> instance by converting the given
* pathname string into an abstract pathname. If the given string is
* the empty string, then the result is the empty abstract pathname.
*
* @param owd OneWireContainer that this Filesystem resides on
* @param pathname A pathname string
* @throws NullPointerException
* If the <code>pathname</code> argument is <code>null</code>
*/
public void createNewInstanceFromContainer(OneWireContainer owd, java.lang.String pathname)
{
objectInstance = new com.dalsemi.onewire.application.file.OWFile(((com.dalsemi.onewire.container.OneWireContainer)owd.objectInstance), pathname);
}
======================================
public com.dalsemi.onewire.application.file.OWFile(com.dalsemi.onewire.container.OneWireContainer[],java.lang.String)
sMethodName=public com.dalsemi.onewire.application.file.OWFile
sParams=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String
sThrows=
tempMethodName=public void createNewInstanceFromContainers2
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String
/**
* Creates a new <code>OWFile</code> instance by converting the given
* pathname string into an abstract pathname. If the given string is
* the empty string, then the result is the empty abstract pathname.
*
* @param owd ordered array of OneWireContainers that this Filesystem
* resides on
* @param pathname A pathname string
* @throws NullPointerException
* If the <code>pathname</code> argument is <code>null</code>
Change the OWFileDescriptor to accept only an array of containers
Change the local ref to be an array
Create a single array in constructors with single passed owc
*/
public void createNewInstanceFromContainers(OneWireContainer[] owd, java.lang.String pathname)
{
com.dalsemi.onewire.container.OneWireContainer[] aMOD0 = new com.dalsemi.onewire.container.OneWireContainer[owd.length];
for(int i=0; i<owd.length; i++)
aMOD0[i] = owd[i].objectInstance;
objectInstance = new com.dalsemi.onewire.application.file.OWFile(aMOD0, pathname);
}
======================================
public com.dalsemi.onewire.application.file.OWFile(com.dalsemi.onewire.container.OneWireContainer,java.lang.String,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.file.OWFile
sParams=com.dalsemi.onewire.container.OneWireContainer,java.lang.String,java.lang.String
sThrows=
tempMethodName=public void createNewInstanceFromContainer3
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String,java.lang.String
/**
* Creates a new <code>OWFile</code> instance from a parent pathname string
* and a child pathname string.
*
* <p> If <code>parent</code> is <code>null</code> then the new
* <code>OWFile</code> instance is created as if by invoking the
* single-argument <code>OWFile</code> constructor on the given
* <code>child</code> pathname string.
*
* <p> Otherwise the <code>parent</code> pathname string is taken to denote
* a directory, and the <code>child</code> pathname string is taken to
* denote either a directory or a file. If the <code>child</code> pathname
* string is absolute then it is converted into a relative pathname in a
* system-dependent way. If <code>parent</code> is the empty string then
* the new <code>OWFile</code> instance is created by converting
* <code>child</code> into an abstract pathname and resolving the result
* against a system-dependent default directory. Otherwise each pathname
* string is converted into an abstract pathname and the child abstract
* pathname is resolved against the parent.
*
* @param owd OneWireContainer that this Filesystem resides on
* @param parent The parent pathname string
* @param child The child pathname string
* @throws NullPointerException
* If <code>child</code> is <code>null</code>
*/
public void createNewInstanceFromContainer(OneWireContainer owd, java.lang.String parent, java.lang.String child)
{
objectInstance = new com.dalsemi.onewire.application.file.OWFile(((com.dalsemi.onewire.container.OneWireContainer)owd.objectInstance), parent, child);
}
======================================
public com.dalsemi.onewire.application.file.OWFile(com.dalsemi.onewire.application.file.OWFile,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.file.OWFile
sParams=com.dalsemi.onewire.application.file.OWFile,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.file.OWFile,java.lang.String
/**
* Creates a new <code>OWFile</code> instance from a parent abstract
* pathname and a child pathname string.
*
* <p> If <code>parent</code> is <code>null</code> then the new
* <code>OWFile</code> instance is created as if by invoking the
* single-argument <code>OWFile</code> constructor on the given
* <code>child</code> pathname string.
*
* <p> Otherwise the <code>parent</code> abstract pathname is taken to
* denote a directory, and the <code>child</code> pathname string is taken
* to denote either a directory or a file. If the <code>child</code>
* pathname string is absolute then it is converted into a relative
* pathname in a system-dependent way. If <code>parent</code> is the empty
* abstract pathname then the new <code>OWFile</code> instance is created by
* converting <code>child</code> into an abstract pathname and resolving
* the result against a system-dependent default directory. Otherwise each
* pathname string is converted into an abstract pathname and the child
* abstract pathname is resolved against the parent.
*
* @param owd OneWireContainer that this Filesystem resides on
* @param parent The parent abstract pathname
* @param child The child pathname string
* @throws NullPointerException
* If <code>child</code> is <code>null</code>
*/
public void createNewInstance(OWFile parent, java.lang.String child)
{
objectInstance = new com.dalsemi.onewire.application.file.OWFile(((com.dalsemi.onewire.application.file.OWFile)parent.objectInstance), child);
}
======================================
public java.lang.String getName()
sMethodName=public java.lang.String getName
sParams=
sThrows=
tempMethodName=public java.lang.String getName0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public java.lang.String getName
params=
/**
* Returns the name of the file or directory denoted by this abstract
* pathname. This is just the last name in the pathname's name
* sequence. If the pathname's name sequence is empty, then the empty
* string is returned.
*
* @return The name of the file or directory denoted by this abstract
* pathname, or the empty string if this pathname's name sequence
* is empty
*/
public java.lang.String getName()
{
return objectInstance.getName();
}
======================================
public java.lang.String getParent()
sMethodName=public java.lang.String getParent
sParams=
sThrows=
tempMethodName=public java.lang.String getParent0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public java.lang.String getParent
params=
/**
* Returns the pathname string of this abstract pathname's parent, or
* <code>null</code> if this pathname does not name a parent directory.
*
* <p> The <em>parent</em> of an abstract pathname consists of the
* pathname's prefix, if any, and each name in the pathname's name
* sequence except for the last. If the name sequence is empty then
* the pathname does not name a parent directory.
*
* @return The pathname string of the parent directory named by this
* abstract pathname, or <code>null</code> if this pathname
* does not name a parent
*/
public java.lang.String getParent()
{
return objectInstance.getParent();
}
======================================
public com.dalsemi.onewire.application.file.OWFile getParentFile()
sMethodName=public com.dalsemi.onewire.application.file.OWFile getParentFile
sParams=
sThrows=
tempMethodName=public OWFile getParentFile0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.application.file.OWFile getParentFile
params=
/**
* Returns the abstract pathname of this abstract pathname's parent,
* or <code>null</code> if this pathname does not name a parent
* directory.
*
* <p> The <em>parent</em> of an abstract pathname consists of the
* pathname's prefix, if any, and each name in the pathname's name
* sequence except for the last. If the name sequence is empty then
* the pathname does not name a parent directory.
*
* @return The abstract pathname of the parent directory named by this
* abstract pathname, or <code>null</code> if this pathname
* does not name a parent
*/
public OWFile getParentFile()
{
return new OWFile(objectInstance.getParentFile());
}
======================================
public java.lang.String getPath()
sMethodName=public java.lang.String getPath
sParams=
sThrows=
tempMethodName=public java.lang.String getPath0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public java.lang.String getPath
params=
/**
* Converts this abstract pathname into a pathname string. The resulting
* string uses the {@link #separator default name-separator character} to
* separate the names in the name sequence.
*
* @return The string form of this abstract pathname
*/
public java.lang.String getPath()
{
return objectInstance.getPath();
}
======================================
public boolean isAbsolute()
sMethodName=public boolean isAbsolute
sParams=
sThrows=
tempMethodName=public boolean isAbsolute0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean isAbsolute
params=
/**
* Tests whether this abstract pathname is absolute. The definition of
* absolute pathname is system dependent. On UNIX systems, a pathname is
* absolute if its prefix is <code>"/"</code>. On Win32 systems, a
* pathname is absolute if its prefix is a drive specifier followed by
* <code>"\\"</code>, or if its prefix is <code>"\\"</code>.
*
* @return <code>true</code> if this abstract pathname is absolute,
* <code>false</code> otherwise
*/
public boolean isAbsolute()
{
return objectInstance.isAbsolute();
}
======================================
public java.lang.String getAbsolutePath()
sMethodName=public java.lang.String getAbsolutePath
sParams=
sThrows=
tempMethodName=public java.lang.String getAbsolutePath0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public java.lang.String getAbsolutePath
params=
/**
* Returns the absolute pathname string of this abstract pathname.
*
* <p> If this abstract pathname is already absolute, then the pathname
* string is simply returned as if by the <code>{@link #getPath}</code>
* method. If this abstract pathname is the empty abstract pathname then
* the pathname string of the current user directory, which is named by the
* system property <code>user.dir</code>, is returned. Otherwise this
* pathname is resolved in a system-dependent way. On UNIX systems, a
* relative pathname is made absolute by resolving it against the current
* user directory. On Win32 systems, a relative pathname is made absolute
* by resolving it against the current directory of the drive named by the
* pathname, if any; if not, it is resolved against the current user
* directory.
*
* @return The absolute pathname string denoting the same file or
* directory as this abstract pathname
*
* @see java.io.File#isAbsolute()
*/
public java.lang.String getAbsolutePath()
{
return objectInstance.getAbsolutePath();
}
======================================
public com.dalsemi.onewire.application.file.OWFile getAbsoluteFile()
sMethodName=public com.dalsemi.onewire.application.file.OWFile getAbsoluteFile
sParams=
sThrows=
tempMethodName=public OWFile getAbsoluteFile0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.application.file.OWFile getAbsoluteFile
params=
/**
* Returns the absolute form of this abstract pathname. Equivalent to
* <code>new File(this.{@link #getAbsolutePath}())</code>.
*
* @return The absolute abstract pathname denoting the same file or
* directory as this abstract pathname
*/
public OWFile getAbsoluteFile()
{
return new OWFile(objectInstance.getAbsoluteFile());
}
======================================
public java.lang.String getCanonicalPath() throws java.io.IOException
sMethodName=public java.lang.String getCanonicalPath
sParams=
sThrows=throws java.io.IOException
tempMethodName=public java.lang.String getCanonicalPath0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public java.lang.String getCanonicalPath
params=
/**
* Returns the canonical pathname string of this abstract pathname.
*
* <p> The precise definition of canonical form is system-dependent, but
* canonical forms are always absolute. Thus if this abstract pathname is
* relative it will be converted to absolute form as if by the <code>{@link
* #getAbsoluteFile}</code> method.
*
* <p> Every pathname that denotes an existing file or directory has a
* unique canonical form. Every pathname that denotes a nonexistent file
* or directory also has a unique canonical form. The canonical form of
* the pathname of a nonexistent file or directory may be different from
* the canonical form of the same pathname after the file or directory is
* created. Similarly, the canonical form of the pathname of an existing
* file or directory may be different from the canonical form of the same
* pathname after the file or directory is deleted.
*
* @return The canonical pathname string denoting the same file or
* directory as this abstract pathname
*
* @throws IOException
* If an I/O error occurs, which is possible because the
* construction of the canonical pathname may require
* filesystem queries
*
* @since JDK1.1
*/
public java.lang.String getCanonicalPath()
throws java.io.IOException
{
return objectInstance.getCanonicalPath();
}
======================================
public com.dalsemi.onewire.application.file.OWFile getCanonicalFile() throws java.io.IOException
sMethodName=public com.dalsemi.onewire.application.file.OWFile getCanonicalFile
sParams=
sThrows=throws java.io.IOException
tempMethodName=public OWFile getCanonicalFile0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.application.file.OWFile getCanonicalFile
params=
/**
* Returns the canonical form of this abstract pathname. Equivalent to
* <code>new File(this.{@link #getCanonicalPath}())</code>.
*
* @return The canonical pathname string denoting the same file or
* directory as this abstract pathname
*
* @throws IOException
* If an I/O error occurs, which is possible because the
* construction of the canonical pathname may require
* filesystem queries
*/
public OWFile getCanonicalFile()
throws java.io.IOException
{
return new OWFile(objectInstance.getCanonicalFile());
}
======================================
public boolean canRead()
sMethodName=public boolean canRead
sParams=
sThrows=
tempMethodName=public boolean canRead0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean canRead
params=
/**
* Tests whether the application can read the file denoted by this
* abstract pathname.
*
* @return <code>true</code> if and only if the file specified by this
* abstract pathname exists <em>and</em> can be read by the
* application; <code>false</code> otherwise
*/
public boolean canRead()
{
return objectInstance.canRead();
}
======================================
public boolean canWrite()
sMethodName=public boolean canWrite
sParams=
sThrows=
tempMethodName=public boolean canWrite0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean canWrite
params=
/**
* Tests whether the application can modify to the file denoted by this
* abstract pathname.
*
* @return <code>true</code> if and only if the Filesystem actually
* contains a file denoted by this abstract pathname <em>and</em>
* the application is allowed to write to the file;
* <code>false</code> otherwise.
*
*/
public boolean canWrite()
{
return objectInstance.canWrite();
}
======================================
public boolean exists()
sMethodName=public boolean exists
sParams=
sThrows=
tempMethodName=public boolean exists0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean exists
params=
/**
* Tests whether the file denoted by this abstract pathname exists.
*
* @return <code>true</code> if and only if the file denoted by this
* abstract pathname exists; <code>false</code> otherwise
*
*/
public boolean exists()
{
return objectInstance.exists();
}
======================================
public boolean isDirectory()
sMethodName=public boolean isDirectory
sParams=
sThrows=
tempMethodName=public boolean isDirectory0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean isDirectory
params=
/**
* Tests whether the file denoted by this abstract pathname is a
* directory.
*
* @return <code>true</code> if and only if the file denoted by this
* abstract pathname exists <em>and</em> is a directory;
* <code>false</code> otherwise
*/
public boolean isDirectory()
{
return objectInstance.isDirectory();
}
======================================
public boolean isFile()
sMethodName=public boolean isFile
sParams=
sThrows=
tempMethodName=public boolean isFile0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean isFile
params=
/**
* Tests whether the file denoted by this abstract pathname is a normal
* file. A file is <em>normal</em> if it is not a directory and, in
* addition, satisfies other system-dependent criteria. Any non-directory
* file created by a Java application is guaranteed to be a normal file.
*
* @return <code>true</code> if and only if the file denoted by this
* abstract pathname exists <em>and</em> is a normal file;
* <code>false</code> otherwise
*/
public boolean isFile()
{
return objectInstance.isFile();
}
======================================
public boolean isHidden()
sMethodName=public boolean isHidden
sParams=
sThrows=
tempMethodName=public boolean isHidden0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean isHidden
params=
/**
* Tests whether the file named by this abstract pathname is a hidden
* file. The exact definition of <em>hidden</em> is system-dependent. On
* UNIX systems, a file is considered to be hidden if its name begins with
* a period character (<code>'.'</code>). On Win32 systems, a file is
* considered to be hidden if it has been marked as such in the filesystem.
*
* @return <code>true</code> if and only if the file denoted by this
* abstract pathname is hidden according to the conventions of the
* underlying platform
*/
public boolean isHidden()
{
return objectInstance.isHidden();
}
======================================
public long lastModified()
sMethodName=public long lastModified
sParams=
sThrows=
tempMethodName=public String lastModified0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public long lastModified
params=
/**
* Returns the time that the file denoted by this abstract pathname was
* last modified.
*
* @return A <code>long</code> value representing the time the file was
* last modified, measured in milliseconds since the epoch
* (00:00:00 GMT, January 1, 1970), or <code>0L</code> if the
* file does not exist or if an I/O error occurs
*/
public String lastModified()
{
return ""+objectInstance.lastModified();
}
======================================
public long length()
sMethodName=public long length
sParams=
sThrows=
tempMethodName=public String length0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public long length
params=
/**
* Returns the length of the file denoted by this abstract pathname.
*
* @return The length, in bytes, of the file denoted by this abstract
* pathname, or <code>0L</code> if the file does not exist
*/
public String length()
{
return ""+objectInstance.length();
}
======================================
public boolean createNewFile() throws java.io.IOException
sMethodName=public boolean createNewFile
sParams=
sThrows=throws java.io.IOException
tempMethodName=public boolean createNewFile0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean createNewFile
params=
/**
* Atomically creates a new, empty file named by this abstract pathname if
* and only if a file with this name does not yet exist. The check for the
* existence of the file and the creation of the file if it does not exist
* are a single operation that is atomic with respect to all other
* filesystem activities that might affect the file.
*
* @return <code>true</code> if the named file does not exist and was
* successfully created; <code>false</code> if the named file
* already exists
*
* @throws IOException
* If an I/O error occurred
*/
public boolean createNewFile()
throws java.io.IOException
{
return objectInstance.createNewFile();
}
======================================
public boolean delete()
sMethodName=public boolean delete
sParams=
sThrows=
tempMethodName=public boolean delete0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean delete
params=
/**
* Deletes the file or directory denoted by this abstract pathname. If
* this pathname denotes a directory, then the directory must be empty in
* order to be deleted.
*
* @return <code>true</code> if and only if the file or directory is
* successfully deleted; <code>false</code> otherwise
*/
public boolean delete()
{
return objectInstance.delete();
}
======================================
public java.lang.String list()[]
sMethodName=public java.lang.String list
sParams=
sThrows=
tempMethodName=public java.lang.String[] list0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public java.lang.String[] list
params=
/**
* Returns an array of strings naming the files and directories in the
* directory denoted by this abstract pathname.
*
* <p> If this abstract pathname does not denote a directory, then this
* method returns <code>null</code>. Otherwise an array of strings is
* returned, one for each file or directory in the directory. Names
* denoting the directory itself and the directory's parent directory are
* not included in the result. Each string is a file name rather than a
* complete path.
*
* <p> There is no guarantee that the name strings in the resulting array
* will appear in any specific order; they are not, in particular,
* guaranteed to appear in alphabetical order.
*
* @return An array of strings naming the files and directories in the
* directory denoted by this abstract pathname. The array will be
* empty if the directory is empty. Returns <code>null</code> if
* this abstract pathname does not denote a directory, or if an
* I/O error occurs.
*/
public java.lang.String[] list()
{
return objectInstance.list();
}
======================================
public com.dalsemi.onewire.application.file.OWFile listFiles()[]
sMethodName=public com.dalsemi.onewire.application.file.OWFile listFiles
sParams=
sThrows=
tempMethodName=public OWFile[] listFiles0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.application.file.OWFile[] listFiles
params=
/**
* Returns an array of abstract pathnames denoting the files in the
* directory denoted by this abstract pathname.
*
* <p> If this abstract pathname does not denote a directory, then this
* method returns <code>null</code>. Otherwise an array of
* <code>OWFile</code> objects is returned, one for each file or directory in
* the directory. Pathnames denoting the directory itself and the
* directory's parent directory are not included in the result. Each
* resulting abstract pathname is constructed from this abstract pathname
* using the <code>{@link #OWFile(String)
* OWFile(OWFile, String)}</code> constructor. Therefore if this pathname
* is absolute then each resulting pathname is absolute; if this pathname
* is relative then each resulting pathname will be relative to the same
* directory.
*
* <p> There is no guarantee that the name strings in the resulting array
* will appear in any specific order; they are not, in particular,
* guaranteed to appear in alphabetical order.
*
* @return An array of abstract pathnames denoting the files and
* directories in the directory denoted by this abstract
* pathname. The array will be empty if the directory is
* empty. Returns <code>null</code> if this abstract pathname
* does not denote a directory, or if an I/O error occurs.
*/
public OWFile[] listFiles()
{
com.dalsemi.onewire.application.file.OWFile[] retArray = objectInstance.listFiles();
OWFile[] reRetArray = new OWFile[retArray.length];
for(int i=0; i<retArray.length; i++)
{
/*Double Check This*/
reRetArray[i] = new OWFile(retArray[i]);
}
return reRetArray;
}
======================================
public boolean mkdir()
sMethodName=public boolean mkdir
sParams=
sThrows=
tempMethodName=public boolean mkdir0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean mkdir
params=
/**
* Creates the directory named by this abstract pathname.
*
* @return <code>true</code> if and only if the directory was
* created; <code>false</code> otherwise
*/
public boolean mkdir()
{
return objectInstance.mkdir();
}
======================================
public boolean mkdirs()
sMethodName=public boolean mkdirs
sParams=
sThrows=
tempMethodName=public boolean mkdirs0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean mkdirs
params=
/**
* Creates the directory named by this abstract pathname, including any
* necessary but nonexistent parent directories. Note that if this
* operation fails it may have succeeded in creating some of the necessary
* parent directories.
*
* @return <code>true</code> if and only if the directory was created,
* along with all necessary parent directories; <code>false</code>
* otherwise
*/
public boolean mkdirs()
{
return objectInstance.mkdirs();
}
======================================
public boolean renameTo(com.dalsemi.onewire.application.file.OWFile)
sMethodName=public boolean renameTo
sParams=com.dalsemi.onewire.application.file.OWFile
sThrows=
tempMethodName=public boolean renameTo1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean renameTo
params=com.dalsemi.onewire.application.file.OWFile
/**
* Renames the file denoted by this abstract pathname.
*
* @param dest The new abstract pathname for the named file
*
* @return <code>true</code> if and only if the renaming succeeded;
* <code>false</code> otherwise
*
* @throws NullPointerException
* If parameter <code>dest</code> is <code>null</code>
*/
public boolean renameTo(OWFile dest)
{
return objectInstance.renameTo(((com.dalsemi.onewire.application.file.OWFile)dest.objectInstance));
}
======================================
public boolean setLastModified(long)
sMethodName=public boolean setLastModified
sParams=long
sThrows=
tempMethodName=public boolean setLastModified1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean setLastModified
params=long
/**
* Sets the last-modified time of the file or directory named by this
* abstract pathname.
*
* <p> All platforms support file-modification times to the nearest second,
* but some provide more precision. The argument will be truncated to fit
* the supported precision. If the operation succeeds and no intervening
* operations on the file take place, then the next invocation of the
* <code>{@link #lastModified}</code> method will return the (possibly
* truncated) <code>time</code> argument that was passed to this method.
*
* @param time The new last-modified time, measured in milliseconds since
* the epoch (00:00:00 GMT, January 1, 1970)
*
* @return <code>true</code> if and only if the operation succeeded;
* <code>false</code> otherwise
*
* @throws IllegalArgumentException If the argument is negative
*/
public boolean setLastModified(String time)
{
return objectInstance.setLastModified(Long.parseLong(time));
}
======================================
public boolean setReadOnly()
sMethodName=public boolean setReadOnly
sParams=
sThrows=
tempMethodName=public boolean setReadOnly0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean setReadOnly
params=
/**
* Marks the file or directory named by this abstract pathname so that
* only read operations are allowed. After invoking this method the file
* or directory is guaranteed not to change until it is either deleted or
* marked to allow write access. Whether or not a read-only file or
* directory may be deleted depends upon the underlying system.
*
* @return <code>true</code> if and only if the operation succeeded;
* <code>false</code> otherwise
*/
public boolean setReadOnly()
{
return objectInstance.setReadOnly();
}
======================================
public static com.dalsemi.onewire.application.file.OWFile listRoots(com.dalsemi.onewire.container.OneWireContainer)[]
sMethodName=public static com.dalsemi.onewire.application.file.OWFile listRoots
sParams=com.dalsemi.onewire.container.OneWireContainer
sThrows=
tempMethodName=public static OWFile[] listRoots1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public static com.dalsemi.onewire.application.file.OWFile[] listRoots
params=com.dalsemi.onewire.container.OneWireContainer
/**
* List the available filesystem roots.
*
* <p> A particular Java platform may support zero or more
* hierarchically-organized Filesystems. Each Filesystem has a
* <code>root</code> directory from which all other files in that file
* system can be reached. Windows platforms, for example, have a root
* directory for each active drive; UNIX platforms have a single root
* directory, namely <code>"/"</code>. The set of available filesystem
* roots is affected by various system-level operations such the insertion
* or ejection of removable media and the disconnecting or unmounting of
* physical or virtual disk drives.
*
* <p> This method returns an array of <code>OWFile</code> objects that
* denote the root directories of the available filesystem roots. It is
* guaranteed that the canonical pathname of any file physically present on
* the local machine will begin with one of the roots returned by this
* method.
*
* <p> The canonical pathname of a file that resides on some other machine
* and is accessed via a remote-filesystem protocol such as SMB or NFS may
* or may not begin with one of the roots returned by this method. If the
* pathname of a remote file is syntactically indistinguishable from the
* pathname of a local file then it will begin with one of the roots
* returned by this method. Thus, for example, <code>OWFile</code> objects
* denoting the root directories of the mapped network drives of a Windows
* platform will be returned by this method, while <code>OWFile</code>
* objects containing UNC pathnames will not be returned by this method.
*
* @param owc OneWireContainer that this Filesystem resides on
*
* @return An array of <code>OWFile</code> objects denoting the available
* filesystem roots, or <code>null</code> if the set of roots
* could not be determined. The array will be empty if there are
* no filesystem roots.
*/
public OWFile[] listRoots(OneWireContainer owc)
{
com.dalsemi.onewire.application.file.OWFile[] retArray = com.dalsemi.onewire.application.file.OWFile.listRoots(((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance));
OWFile[] reRetArray = new OWFile[retArray.length];
for(int i=0; i<retArray.length; i++)
{
/*Double Check This*/
reRetArray[i] = new OWFile(retArray[i]);
}
return reRetArray;
}
======================================
public int compareTo(com.dalsemi.onewire.application.file.OWFile)
sMethodName=public int compareTo
sParams=com.dalsemi.onewire.application.file.OWFile
sThrows=
======================================
public int compareTo(java.lang.Object)
sMethodName=public int compareTo
sParams=java.lang.Object
sThrows=
tempMethodName=public int compareTo1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public int compareTo
params=java.lang.Object
/**
* Compares this abstract pathname to another object. If the other object
* is an abstract pathname, then this function behaves like <code>{@link
* #compareTo(OWFile)}</code>. Otherwise, it throws a
* <code>ClassCastException</code>, since abstract pathnames can only be
* compared to abstract pathnames.
*
* @param o The <code>Object</code> to be compared to this abstract
* pathname
*
* @return If the argument is an abstract pathname, returns zero
* if the argument is equal to this abstract pathname, a value
* less than zero if this abstract pathname is lexicographically
* less than the argument, or a value greater than zero if this
* abstract pathname is lexicographically greater than the
* argument
*
* @throws <code>ClassCastException</code> if the argument is not an
* abstract pathname
*
* @see java.lang.Comparable
*/
public int compareTo(java.lang.Object o)
{
return objectInstance.compareTo(o);
}
======================================
public boolean equals(java.lang.Object)
sMethodName=public boolean equals
sParams=java.lang.Object
sThrows=
tempMethodName=public boolean equals1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public boolean equals
params=java.lang.Object
/**
* Tests this abstract pathname for equality with the given object.
* Returns <code>true</code> if and only if the argument is not
* <code>null</code> and is an abstract pathname that denotes the same file
* or directory as this abstract pathname. Whether or not two abstract
* pathnames are equal depends upon the underlying system. On UNIX
* systems, alphabetic case is significant in comparing pathnames; on Win32
* systems it is not.
*
* @param obj The object to be compared with this abstract pathname
*
* @return <code>true</code> if and only if the objects are the same;
* <code>false</code> otherwise
*/
public boolean equals(java.lang.Object obj)
{
return objectInstance.equals(obj);
}
======================================
public int hashCode()
sMethodName=public int hashCode
sParams=
sThrows=
tempMethodName=public int hashCode0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public int hashCode
params=
/**
* Computes a hash code for this abstract pathname. Because equality of
* abstract pathnames is inherently system-dependent, so is the computation
* of their hash codes. On UNIX systems, the hash code of an abstract
* pathname is equal to the exclusive <em>or</em> of its pathname string
* and the decimal value <code>1234321</code>. On Win32 systems, the hash
* code is equal to the exclusive <em>or</em> of its pathname string,
* convered to lower case, and the decimal value <code>1234321</code>.
*
* @return A hash code for this abstract pathname
*/
public int hashCode()
{
return objectInstance.hashCode();
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public java.lang.String toString
params=
/**
* Returns the pathname string of this abstract pathname. This is just the
* string returned by the <code>{@link #getPath}</code> method.
*
* @return The string form of this abstract pathname
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
======================================
public com.dalsemi.onewire.application.file.OWFileDescriptor getFD() throws java.io.IOException
sMethodName=public com.dalsemi.onewire.application.file.OWFileDescriptor getFD
sParams=
sThrows=throws java.io.IOException
tempMethodName=public OWFileDescriptor getFD0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.application.file.OWFileDescriptor getFD
params=
/**
* Returns the <code>OWFileDescriptor</code>
* object that represents the connection to
* the actual file in the Filesystem being
* used by this <code>OWFileInputStream</code>.
*
* @return the file descriptor object associated with this File.
* @exception IOException if an I/O error occurs.
* @see OWFileDescriptor
*/
public OWFileDescriptor getFD()
throws java.io.IOException
{
return new OWFileDescriptor(objectInstance.getFD());
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getOneWireContainer()
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getOneWireContainer
sParams=
sThrows=
tempMethodName=public OneWireContainer getOneWireContainer0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.container.OneWireContainer getOneWireContainer
params=
/**
* Gets the OneWireContainer that this File resides on. This
* is where the 'filesystem' resides. If this Filesystem
* spans multiple devices then this method returns the
* 'MASTER' device.
*
* @return the OneWireContainer for this Filesystem
*/
public OneWireContainer getOneWireContainer()
{
return new OneWireContainer(objectInstance.getOneWireContainer());
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getOneWireContainers()[]
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getOneWireContainers
sParams=
sThrows=
tempMethodName=public OneWireContainer[] getOneWireContainers0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.container.OneWireContainer[] getOneWireContainers
params=
/**
* Gets the OneWireContainer(s) that this File resides on. This
* is where the 'filesystem' resides. The first device
* is the 'MASTER' device and the other devices are 'SATELLITE'
* devices.
*
* @return the OneWireContainer(s) for this Filesystem
*/
public OneWireContainer[] getOneWireContainers()
{
com.dalsemi.onewire.container.OneWireContainer[] retArray = objectInstance.getOneWireContainers();
OneWireContainer[] reRetArray = new OneWireContainer[retArray.length];
for(int i=0; i<retArray.length; i++)
{
/*Double Check This*/
reRetArray[i] = (new OneWireContainer(null)).setupObject(retArray[i]);
}
return reRetArray;
}
======================================
public void format() throws java.io.IOException
sMethodName=public void format
sParams=
sThrows=throws java.io.IOException
tempMethodName=public void format0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public void format
params=
/**
* Format the Filesystem on the 1-Wire device provided in
* the constructor. This operation is required before any
* file IO is possible. <P>
* <b>WARNING</b> this will remove any files/directories.
* <P>
* @exception IOException if an I/O error occurs.
*/
public void format()
throws java.io.IOException
{
objectInstance.format();
}
======================================
public int getFreeMemory() throws java.io.IOException
sMethodName=public int getFreeMemory
sParams=
sThrows=throws java.io.IOException
tempMethodName=public int getFreeMemory0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public int getFreeMemory
params=
/**
* Gets the number of bytes available on this device for
* file and directory information.
*
* @return number of free bytes in the Filesystem
*
* @exception IOException if an I/O error occurs
*/
public int getFreeMemory()
throws java.io.IOException
{
return objectInstance.getFreeMemory();
}
======================================
public void close() throws java.io.IOException
sMethodName=public void close
sParams=
sThrows=throws java.io.IOException
tempMethodName=public void close0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public void close
params=
/**
* Closes this file and releases any system resources
* associated with this stream. This file may no longer
* be used after this operation.
*
* @exception IOException if an I/O error occurs.
*/
public void close()
throws java.io.IOException
{
objectInstance.close();
}
======================================
public int getPageList()[] throws java.io.IOException
sMethodName=public int getPageList
sParams=
sThrows=throws java.io.IOException
tempMethodName=public int[] getPageList0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public int[] getPageList
params=
/**
* Get's an array of integers that represents the page
* list of the file or directory represented by this
* OWFile.
*
* @return node page list file or directory
*
* @exception IOException if an I/O error occurs.
*/
public int[] getPageList()
throws java.io.IOException
{
return objectInstance.getPageList();
}
======================================
public int getStartPage() throws java.io.IOException
sMethodName=public int getStartPage
sParams=
sThrows=throws java.io.IOException
tempMethodName=public int getStartPage0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public int getStartPage
params=
/**
* Returns an integer which represents the starting memory page
* of the file or directory represented by this OWFile.
*
* @return The starting page of the file or directory.
*
* @exception IOException if the file doesn't exist
*/
public int getStartPage()
throws java.io.IOException
{
return objectInstance.getStartPage();
}
======================================
public com.dalsemi.onewire.container.PagedMemoryBank getMemoryBankForPage(int)
sMethodName=public com.dalsemi.onewire.container.PagedMemoryBank getMemoryBankForPage
sParams=int
sThrows=
tempMethodName=public PagedMemoryBank getMemoryBankForPage1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public com.dalsemi.onewire.container.PagedMemoryBank getMemoryBankForPage
params=int
/**
* Get's the memory bank object for the specified page.
* This is significant if the Filesystem spans memory banks
* on the same or different devices.
*
* @return PagedMemoryBank for the specified page
*/
public PagedMemoryBank getMemoryBankForPage(int page)
{
return new PagedMemoryBank(objectInstance.getMemoryBankForPage(page));
}
======================================
public int getLocalPage(int)
sMethodName=public int getLocalPage
sParams=int
sThrows=
tempMethodName=public int getLocalPage1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFile
methodName=public int getLocalPage
params=int
/**
* Get's the local page number on the memory bank object for
* the specified page.
* This is significant if the Filesystem spans memory banks
* on the same or different devices.
*
* @return local page for the specified Filesystem page
* (memory bank specific)
*/
public int getLocalPage(int page)
{
return objectInstance.getLocalPage(page);
}
-------------------------------------------------------------------
creating: owapi\OWFileDescriptor.java
======================================
public boolean valid()
sMethodName=public boolean valid
sParams=
sThrows=
tempMethodName=public boolean valid0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileDescriptor
methodName=public boolean valid
params=
/**
* Tests if this file descriptor object is valid.
*
* @return <code>true</code> if the file descriptor object represents a
* valid, open file, socket, or other active I/O connection;
* <code>false</code> otherwise.
*/
public boolean valid()
{
return objectInstance.valid();
}
======================================
public void sync() throws com.dalsemi.onewire.application.file.OWSyncFailedException
sMethodName=public void sync
sParams=
sThrows=throws com.dalsemi.onewire.application.file.OWSyncFailedException
tempMethodName=public void sync0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileDescriptor
methodName=public void sync
params=
/**
* Force all system buffers to synchronize with the underlying
* device. This method returns after all modified data and
* attributes of this FileDescriptor have been written to the
* relevant device(s). In particular, if this FileDescriptor
* refers to a physical storage medium, such as a file in a file
* system, sync will not return until all in-memory modified copies
* of buffers associated with this FileDesecriptor have been
* written to the physical medium.
*
* sync is meant to be used by code that requires physical
* storage (such as a file) to be in a known state For
* example, a class that provided a simple transaction facility
* might use sync to ensure that all changes to a file caused
* by a given transaction were recorded on a storage medium.
*
* sync only affects buffers downstream of this FileDescriptor. If
* any in-memory buffering is being done by the application (for
* example, by a BufferedOutputStream object), those buffers must
* be flushed into the OWFileDescriptor (for example, by invoking
* OutputStream.flush) before that data will be affected by sync.
*
* <p>This method may be called multiple times if the source of
* OWSyncFailedException has been rectified (1-Wire device was
* reattached to the network).
*
* @exception OWSyncFailedException
* Thrown when the buffers cannot be flushed,
* or because the system cannot guarantee that all the
* buffers have been synchronized with physical media.
*/
public void sync()
throws com.dalsemi.onewire.application.file.OWSyncFailedException
{
objectInstance.sync();
}
-------------------------------------------------------------------
creating: owapi\OWFileInputStream.java
======================================
public com.dalsemi.onewire.application.file.OWFileInputStream(com.dalsemi.onewire.container.OneWireContainer,java.lang.String) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileInputStream
sParams=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromContainer2
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
/**
* Creates a <code>FileInputStream</code> by
* opening a connection to an actual file,
* the file named by the path name <code>name</code>
* in the Filesystem. A new <code>OWFileDescriptor</code>
* object is created to represent this file
* connection.
* <p>
* First, if there is a security
* manager, its <code>checkRead</code> method
* is called with the <code>name</code> argument
* as its argument.
* <p>
* If the named file does not exist, is a directory rather than a regular
* file, or for some other reason cannot be opened for reading then a
* <code>FileNotFoundException</code> is thrown.
*
* @param owd OneWireContainer that this Filesystem resides on
* @param name the system-dependent file name.
* @exception FileNotFoundException if the file does not exist,
* is a directory rather than a regular file,
* or for some other reason cannot be opened for
* reading.
*/
public void createNewInstanceFromContainer(OneWireContainer owd, java.lang.String name)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
objectInstance = new com.dalsemi.onewire.application.file.OWFileInputStream(((com.dalsemi.onewire.container.OneWireContainer)owd.objectInstance), name);
}
======================================
public com.dalsemi.onewire.application.file.OWFileInputStream(com.dalsemi.onewire.container.OneWireContainer[],java.lang.String) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileInputStream
sParams=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromContainers2
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String
/**
* Creates a <code>FileInputStream</code> by
* opening a connection to an actual file,
* the file named by the path name <code>name</code>
* in the Filesystem. A new <code>OWFileDescriptor</code>
* object is created to represent this file
* connection.
* <p>
* First, if there is a security
* manager, its <code>checkRead</code> method
* is called with the <code>name</code> argument
* as its argument.
* <p>
* If the named file does not exist, is a directory rather than a regular
* file, or for some other reason cannot be opened for reading then a
* <code>FileNotFoundException</code> is thrown.
*
* @param owd array of OneWireContainers that this Filesystem resides on
* @param name the system-dependent file name.
* @exception FileNotFoundException if the file does not exist,
* is a directory rather than a regular file,
* or for some other reason cannot be opened for
* reading.
*/
public void createNewInstanceFromContainers(OneWireContainer[] owd, java.lang.String name)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
com.dalsemi.onewire.container.OneWireContainer[] aMOD0 = new com.dalsemi.onewire.container.OneWireContainer[owd.length];
for(int i=0; i<owd.length; i++)
aMOD0[i] = owd[i].objectInstance;
objectInstance = new com.dalsemi.onewire.application.file.OWFileInputStream(aMOD0, name);
}
======================================
public com.dalsemi.onewire.application.file.OWFileInputStream(com.dalsemi.onewire.application.file.OWFile) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileInputStream
sParams=com.dalsemi.onewire.application.file.OWFile
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromFile1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.file.OWFile
/**
* Creates a <code>OWFileInputStream</code> by
* opening a connection to an actual file,
* the file named by the <code>File</code>
* object <code>file</code> in the Filesystem.
* A new <code>OWFileDescriptor</code> object
* is created to represent this file connection.
* <p>
* If the named file does not exist, is a directory rather than a regular
* file, or for some other reason cannot be opened for reading then a
* <code>FileNotFoundException</code> is thrown.
*
* @param file the file to be opened for reading.
* @exception FileNotFoundException if the file does not exist,
* is a directory rather than a regular file,
* or for some other reason cannot be opened for
* reading.
* @see OWFile#getPath()
*/
public void createNewInstanceFromFile(OWFile a0)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
objectInstance = new com.dalsemi.onewire.application.file.OWFileInputStream(((com.dalsemi.onewire.application.file.OWFile)a0.objectInstance));
}
======================================
public com.dalsemi.onewire.application.file.OWFileInputStream(com.dalsemi.onewire.application.file.OWFileDescriptor)
sMethodName=public com.dalsemi.onewire.application.file.OWFileInputStream
sParams=com.dalsemi.onewire.application.file.OWFileDescriptor
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.file.OWFileDescriptor
/**
* Creates a <code>OWFileInputStream</code> by using the file descriptor
* <code>fdObj</code>, which represents an existing connection to an
* actual file in the Filesystem.
* <p>
* If <code>fdObj</code> is null then a <code>NullPointerException</code>
* is thrown.
*
* @param fdObj the file descriptor to be opened for reading.
*/
public void createNewInstance(OWFileDescriptor fdObj)
{
objectInstance = new com.dalsemi.onewire.application.file.OWFileInputStream(((com.dalsemi.onewire.application.file.OWFileDescriptor)fdObj.objectInstance));
}
======================================
public int read() throws java.io.IOException
sMethodName=public int read
sParams=
sThrows=throws java.io.IOException
tempMethodName=public int read0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public int read
params=
/**
* Reads a byte of data from this input stream. This method blocks
* if no input is yet available.
*
* @return the next byte of data, or <code>-1</code> if the end of the
* file is reached.
* @exception IOException if an I/O error occurs.
*/
public int read()
throws java.io.IOException
{
return objectInstance.read();
}
======================================
public int read(byte[]) throws java.io.IOException
sMethodName=public int read
sParams=byte[]
sThrows=throws java.io.IOException
tempMethodName=public int read1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public int read
params=byte[]
/**
* Reads up to <code>b.length</code> bytes of data from this input
* stream into an array of bytes. This method blocks until some input
* is available.
*
* @param b the buffer into which the data is read.
* @return the total number of bytes read into the buffer, or
* <code>-1</code> if there is no more data because the end of
* the file has been reached.
* @exception IOException if an I/O error occurs.
*/
public int read(ByteArray b )
throws java.io.IOException
{
return objectInstance.read(b .array);
}
======================================
public int read(byte[], int, int) throws java.io.IOException
sMethodName=public int read
sParams=byte[], int, int
sThrows=throws java.io.IOException
tempMethodName=public int read3
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public int read
params=byte[],int,int
/**
* Reads up to <code>len</code> bytes of data from this input stream
* into an array of bytes. This method blocks until some input is
* available.
*
* @param b the buffer into which the data is read.
* @param off the start offset of the data.
* @param len the maximum number of bytes read.
* @return the total number of bytes read into the buffer, or
* <code>-1</code> if there is no more data because the end of
* the file has been reached.
* @exception IOException if an I/O error occurs.
*/
public int read(ByteArray b , int off, int len)
throws java.io.IOException
{
return objectInstance.read(b .array, off, len);
}
======================================
public long skip(long) throws java.io.IOException
sMethodName=public long skip
sParams=long
sThrows=throws java.io.IOException
tempMethodName=public String skip1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public long skip
params=long
/**
* Skips over and discards <code>n</code> bytes of data from the
* input stream. The <code>skip</code> method may, for a variety of
* reasons, end up skipping over some smaller number of bytes,
* possibly <code>0</code>. The actual number of bytes skipped is returned.
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
* @exception IOException if an I/O error occurs.
*/
public String skip(String n)
throws java.io.IOException
{
return ""+objectInstance.skip(Long.parseLong(n));
}
======================================
public int available() throws java.io.IOException
sMethodName=public int available
sParams=
sThrows=throws java.io.IOException
tempMethodName=public int available0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public int available
params=
/**
* Returns the number of bytes that can be read from this file input
* stream without blocking.
*
* @return the number of bytes that can be read from this file input
* stream without blocking.
* @exception IOException if an I/O error occurs.
*/
public int available()
throws java.io.IOException
{
return objectInstance.available();
}
======================================
public void close() throws java.io.IOException
sMethodName=public void close
sParams=
sThrows=throws java.io.IOException
tempMethodName=public void close0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void close
params=
/**
* Closes this file input stream and releases any system resources
* associated with the stream.
*
* @exception IOException if an I/O error occurs.
*/
public void close()
throws java.io.IOException
{
objectInstance.close();
}
======================================
public final com.dalsemi.onewire.application.file.OWFileDescriptor getFD() throws java.io.IOException
sMethodName=public final com.dalsemi.onewire.application.file.OWFileDescriptor getFD
sParams=
sThrows=throws java.io.IOException
tempMethodName=public final OWFileDescriptor getFD0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public final com.dalsemi.onewire.application.file.OWFileDescriptor getFD
params=
/**
* Returns the <code>OWFileDescriptor</code>
* object that represents the connection to
* the actual file in the Filesystem being
* used by this <code>FileInputStream</code>.
*
* @return the file descriptor object associated with this stream.
* @exception IOException if an I/O error occurs.
* @see OWFileDescriptor
*/
public final OWFileDescriptor getFD()
throws java.io.IOException
{
return new OWFileDescriptor(objectInstance.getFD());
}
======================================
public void finalize() throws java.io.IOException
sMethodName=public void finalize
sParams=
sThrows=throws java.io.IOException
tempMethodName=public void finalize0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void finalize
params=
/**
* Ensures that the <code>close</code> method of this file input stream is
* called when there are no more references to it.
*
* @exception IOException if an I/O error occurs.
* @see OWFileInputStream#close()
*/
public void finalize()
throws java.io.IOException
{
objectInstance.finalize();
}
======================================
public void mark(int)
sMethodName=public void mark
sParams=int
sThrows=
tempMethodName=public void mark1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void mark
params=int
/**
* Marks the current position in this input stream. A subsequent call to
* the <code>reset</code> method repositions this stream at the last marked
* position so that subsequent reads re-read the same bytes.
*
* <p> The <code>readlimit</code> arguments tells this input stream to
* allow that many bytes to be read before the mark position gets
* invalidated.
*
* <p> The general contract of <code>mark</code> is that, if the method
* <code>markSupported</code> returns <code>true</code>, the stream somehow
* remembers all the bytes read after the call to <code>mark</code> and
* stands ready to supply those same bytes again if and whenever the method
* <code>reset</code> is called. However, the stream is not required to
* remember any data at all if more than <code>readlimit</code> bytes are
* read from the stream before <code>reset</code> is called.
*
* <p> The <code>mark</code> method of <code>InputStream</code> does
* nothing.
*
* @param readlimit the maximum limit of bytes that can be read before
* the mark position becomes invalid.
* @see java.io.InputStream#reset()
*/
public void mark(int readlimit)
{
objectInstance.mark(readlimit);
}
======================================
public void reset() throws java.io.IOException
sMethodName=public void reset
sParams=
sThrows=throws java.io.IOException
tempMethodName=public void reset0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public void reset
params=
/**
* Repositions this stream to the position at the time the
* <code>mark</code> method was last called on this input stream.
*
* <p> The general contract of <code>reset</code> is:
*
* <p><ul>
*
* <li> If the method <code>markSupported</code> returns
* <code>true</code>, then:
*
* <ul><li> If the method <code>mark</code> has not been called since
* the stream was created, or the number of bytes read from the stream
* since <code>mark</code> was last called is larger than the argument
* to <code>mark</code> at that last call, then an
* <code>IOException</code> might be thrown.
*
* <li> If such an <code>IOException</code> is not thrown, then the
* stream is reset to a state such that all the bytes read since the
* most recent call to <code>mark</code> (or since the start of the
* file, if <code>mark</code> has not been called) will be resupplied
* to subsequent callers of the <code>read</code> method, followed by
* any bytes that otherwise would have been the next input data as of
* the time of the call to <code>reset</code>. </ul>
*
* <li> If the method <code>markSupported</code> returns
* <code>false</code>, then:
*
* <ul><li> The call to <code>reset</code> may throw an
* <code>IOException</code>.
*
* <li> If an <code>IOException</code> is not thrown, then the stream
* is reset to a fixed state that depends on the particular type of the
* input stream and how it was created. The bytes that will be supplied
* to subsequent callers of the <code>read</code> method depend on the
* particular type of the input stream. </ul></ul>
*
* <p> The method <code>reset</code> for class <code>InputStream</code>
* does nothing and always throws an <code>IOException</code>.
*
* @exception IOException if this stream has not been marked or if the
* mark has been invalidated.
* @see java.io.InputStream#mark(int)
* @see java.io.IOException
*/
public void reset()
throws java.io.IOException
{
objectInstance.reset();
}
======================================
public boolean markSupported()
sMethodName=public boolean markSupported
sParams=
sThrows=
tempMethodName=public boolean markSupported0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileInputStream
methodName=public boolean markSupported
params=
/**
* Tests if this input stream supports the <code>mark</code> and
* <code>reset</code> methods. The <code>markSupported</code> method of
* <code>InputStream</code> returns <code>false</code>.
*
* @return <code>true</code> if this true type supports the mark and reset
* method; <code>false</code> otherwise.
* @see java.io.InputStream#mark(int)
* @see java.io.InputStream#reset()
*/
public boolean markSupported()
{
return objectInstance.markSupported();
}
-------------------------------------------------------------------
creating: owapi\OWFileOutputStream.java
======================================
public com.dalsemi.onewire.application.file.OWFileOutputStream(com.dalsemi.onewire.container.OneWireContainer,java.lang.String) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileOutputStream
sParams=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromContainer2
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
/**
* Creates an output file stream to write to the file with the
* specified name. A new <code>OWFileDescriptor</code> object is
* created to represent this file connection.
* <p>
* First, if there is a security manager, its <code>checkWrite</code>
* method is called with <code>name</code> as its argument.
* <p>
* If the file exists but is a directory rather than a regular file, does
* not exist but cannot be created, or cannot be opened for any other
* reason then a <code>FileNotFoundException</code> is thrown.
*
* @param owd OneWireContainer that this Filesystem resides on
* @param name the system-dependent filename
* @exception FileNotFoundException if the file exists but is a directory
* rather than a regular file, does not exist but cannot
* be created, or cannot be opened for any other reason
* @exception SecurityException if a security manager exists and its
* <code>checkWrite</code> method denies write access
* to the file.
*/
public void createNewInstanceFromContainer(OneWireContainer owd, java.lang.String name)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
objectInstance = new com.dalsemi.onewire.application.file.OWFileOutputStream(((com.dalsemi.onewire.container.OneWireContainer)owd.objectInstance), name);
}
======================================
public com.dalsemi.onewire.application.file.OWFileOutputStream(com.dalsemi.onewire.container.OneWireContainer[],java.lang.String) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileOutputStream
sParams=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromContainers2
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String
/**
* Creates an output file stream to write to the file with the
* specified name. A new <code>OWFileDescriptor</code> object is
* created to represent this file connection.
* <p>
* First, if there is a security manager, its <code>checkWrite</code>
* method is called with <code>name</code> as its argument.
* <p>
* If the file exists but is a directory rather than a regular file, does
* not exist but cannot be created, or cannot be opened for any other
* reason then a <code>FileNotFoundException</code> is thrown.
*
* @param owd array of OneWireContainers that this Filesystem resides on
* @param name the system-dependent filename
* @exception FileNotFoundException if the file exists but is a directory
* rather than a regular file, does not exist but cannot
* be created, or cannot be opened for any other reason
* @exception SecurityException if a security manager exists and its
* <code>checkWrite</code> method denies write access
* to the file.
*/
public void createNewInstanceFromContainers(OneWireContainer[] owd, java.lang.String name)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
com.dalsemi.onewire.container.OneWireContainer[] aMOD0 = new com.dalsemi.onewire.container.OneWireContainer[owd.length];
for(int i=0; i<owd.length; i++)
aMOD0[i] = owd[i].objectInstance;
objectInstance = new com.dalsemi.onewire.application.file.OWFileOutputStream(aMOD0, name);
}
======================================
public com.dalsemi.onewire.application.file.OWFileOutputStream(com.dalsemi.onewire.container.OneWireContainer,java.lang.String,boolean) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileOutputStream
sParams=com.dalsemi.onewire.container.OneWireContainer,java.lang.String,boolean
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromContainer3
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String,boolean
/**
* Creates an output file stream to write to the file with the specified
* <code>name</code>. If the second argument is <code>true</code>, then
* bytes will be written to the end of the file rather than the beginning.
* A new <code>OWFileDescriptor</code> object is created to represent this
* file connection.
* <p>
* First, if there is a security manager, its <code>checkWrite</code>
* method is called with <code>name</code> as its argument.
* <p>
* If the file exists but is a directory rather than a regular file, does
* not exist but cannot be created, or cannot be opened for any other
* reason then a <code>FileNotFoundException</code> is thrown.
*
* @param owd OneWireContainer that this Filesystem resides on
* @param name the system-dependent file name
* @param append if <code>true</code>, then bytes will be written
* to the end of the file rather than the beginning
* @exception FileNotFoundException if the file exists but is a directory
* rather than a regular file, does not exist but cannot
* be created, or cannot be opened for any other reason.
* @exception SecurityException if a security manager exists and its
* <code>checkWrite</code> method denies write access
* to the file.
*/
public void createNewInstanceFromContainer(OneWireContainer owd, java.lang.String name, boolean append)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
objectInstance = new com.dalsemi.onewire.application.file.OWFileOutputStream(((com.dalsemi.onewire.container.OneWireContainer)owd.objectInstance), name, append);
}
======================================
public com.dalsemi.onewire.application.file.OWFileOutputStream(com.dalsemi.onewire.container.OneWireContainer[],java.lang.String,boolean) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileOutputStream
sParams=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String,boolean
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromContainers3
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer[],java.lang.String,boolean
/**
* Creates an output file stream to write to the file with the specified
* <code>name</code>. If the second argument is <code>true</code>, then
* bytes will be written to the end of the file rather than the beginning.
* A new <code>OWFileDescriptor</code> object is created to represent this
* file connection.
* <p>
* First, if there is a security manager, its <code>checkWrite</code>
* method is called with <code>name</code> as its argument.
* <p>
* If the file exists but is a directory rather than a regular file, does
* not exist but cannot be created, or cannot be opened for any other
* reason then a <code>FileNotFoundException</code> is thrown.
*
* @param owd array of OneWireContainers that this Filesystem resides on
* @param name the system-dependent file name
* @param append if <code>true</code>, then bytes will be written
* to the end of the file rather than the beginning
* @exception FileNotFoundException if the file exists but is a directory
* rather than a regular file, does not exist but cannot
* be created, or cannot be opened for any other reason.
* @exception SecurityException if a security manager exists and its
* <code>checkWrite</code> method denies write access
* to the file.
*/
public void createNewInstanceFromContainers(OneWireContainer[] owd, java.lang.String name, boolean append)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
com.dalsemi.onewire.container.OneWireContainer[] aMOD0 = new com.dalsemi.onewire.container.OneWireContainer[owd.length];
for(int i=0; i<owd.length; i++)
aMOD0[i] = owd[i].objectInstance;
objectInstance = new com.dalsemi.onewire.application.file.OWFileOutputStream(aMOD0, name, append);
}
======================================
public com.dalsemi.onewire.application.file.OWFileOutputStream(com.dalsemi.onewire.application.file.OWFile) throws com.dalsemi.onewire.application.file.OWFileNotFoundException
sMethodName=public com.dalsemi.onewire.application.file.OWFileOutputStream
sParams=com.dalsemi.onewire.application.file.OWFile
sThrows=throws com.dalsemi.onewire.application.file.OWFileNotFoundException
tempMethodName=public void createNewInstanceFromFile1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.file.OWFile
/**
* Creates a file output stream to write to the file represented by
* the specified <code>File</code> object. A new
* <code>OWFileDescriptor</code> object is created to represent this
* file connection.
* <p>
* First, if there is a security manager, its <code>checkWrite</code>
* method is called with the path represented by the <code>file</code>
* argument as its argument.
* <p>
* If the file exists but is a directory rather than a regular file, does
* not exist but cannot be created, or cannot be opened for any other
* reason then a <code>FileNotFoundException</code> is thrown.
*
* @param file the file to be opened for writing.
* @exception FileNotFoundException if the file exists but is a directory
* rather than a regular file, does not exist but cannot
* be created, or cannot be opened for any other reason
* @exception SecurityException if a security manager exists and its
* <code>checkWrite</code> method denies write access
* to the file.
* @see java.io.File#getPath()
*/
public void createNewInstanceFromFile(OWFile file)
throws com.dalsemi.onewire.application.file.OWFileNotFoundException
{
objectInstance = new com.dalsemi.onewire.application.file.OWFileOutputStream(((com.dalsemi.onewire.application.file.OWFile)file.objectInstance));
}
======================================
public com.dalsemi.onewire.application.file.OWFileOutputStream(com.dalsemi.onewire.application.file.OWFileDescriptor)
sMethodName=public com.dalsemi.onewire.application.file.OWFileOutputStream
sParams=com.dalsemi.onewire.application.file.OWFileDescriptor
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.file.OWFileDescriptor
/**
* Creates an output file stream to write to the specified file
* descriptor, which represents an existing connection to an actual
* file in the Filesystem.
* <p>
* First, if there is a security manager, its <code>checkWrite</code>
* method is called with the file descriptor <code>fdObj</code>
* argument as its argument.
*
* @param fdObj the file descriptor to be opened for writing.
* @exception SecurityException if a security manager exists and its
* <code>checkWrite</code> method denies
* write access to the file descriptor.
*/
public void createNewInstance(OWFileDescriptor fdObj)
{
objectInstance = new com.dalsemi.onewire.application.file.OWFileOutputStream(((com.dalsemi.onewire.application.file.OWFileDescriptor)fdObj.objectInstance));
}
======================================
public void write(int) throws java.io.IOException
sMethodName=public void write
sParams=int
sThrows=throws java.io.IOException
tempMethodName=public void write1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void write
params=int
/**
* Writes the specified byte to this file output stream. Implements
* the <code>write</code> method of <code>OutputStream</code>.
*
* @param b the byte to be written.
* @exception IOException if an I/O error occurs.
*/
public void write(int b)
throws java.io.IOException
{
objectInstance.write(b);
}
======================================
public void write(byte[]) throws java.io.IOException
sMethodName=public void write
sParams=byte[]
sThrows=throws java.io.IOException
tempMethodName=public void writeFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void write
params=byte[]
/**
* Writes <code>b.length</code> bytes from the specified byte array
* to this file output stream.
*
* @param b the data.
* @exception IOException if an I/O error occurs.
*/
public void writeFromBytes(ByteArray b )
throws java.io.IOException
{
objectInstance.write(b .array);
}
======================================
public void write(byte[], int, int) throws java.io.IOException
sMethodName=public void write
sParams=byte[], int, int
sThrows=throws java.io.IOException
tempMethodName=public void writeFromBytes3
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void write
params=byte[],int,int
/**
* Writes <code>len</code> bytes from the specified byte array
* starting at offset <code>off</code> to this file output stream.
*
* @param b the data.
* @param off the start offset in the data.
* @param len the number of bytes to write.
* @exception IOException if an I/O error occurs.
*/
public void writeFromBytes(ByteArray b , int off, int len)
throws java.io.IOException
{
objectInstance.write(b .array, off, len);
}
======================================
public void close() throws java.io.IOException
sMethodName=public void close
sParams=
sThrows=throws java.io.IOException
tempMethodName=public void close0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void close
params=
/**
* Closes this file output stream and releases any system resources
* associated with this stream. This file output stream may no longer
* be used for writing bytes.
*
* @exception IOException if an I/O error occurs.
*/
public void close()
throws java.io.IOException
{
objectInstance.close();
}
======================================
public com.dalsemi.onewire.application.file.OWFileDescriptor getFD() throws java.io.IOException
sMethodName=public com.dalsemi.onewire.application.file.OWFileDescriptor getFD
sParams=
sThrows=throws java.io.IOException
tempMethodName=public OWFileDescriptor getFD0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public com.dalsemi.onewire.application.file.OWFileDescriptor getFD
params=
/**
* Returns the file descriptor associated with this stream.
*
* @return the <code>OWFileDescriptor</code> object that represents
* the connection to the file in the Filesystem being used
* by this <code>FileOutputStream</code> object.
*
* @exception IOException if an I/O error occurs.
* @see OWFileDescriptor
*/
public OWFileDescriptor getFD()
throws java.io.IOException
{
return new OWFileDescriptor(objectInstance.getFD());
}
======================================
public void finalize() throws java.io.IOException
sMethodName=public void finalize
sParams=
sThrows=throws java.io.IOException
tempMethodName=public void finalize0
getMethodDocumentation
className=com.dalsemi.onewire.application.file.OWFileOutputStream
methodName=public void finalize
params=
/**
* Cleans up the connection to the file, and ensures that the
* <code>close</code> method of this file output stream is
* called when there are no more references to this stream.
*
* @exception IOException if an I/O error occurs.
* @see OWFileInputStream#close()
*/
public void finalize()
throws java.io.IOException
{
objectInstance.finalize();
}
-------------------------------------------------------------------
creating: owapi\AbstractDeviceMonitor.java
No COM CLSID for AbstractDeviceMonitor
======================================
public void cleanUpStaleContainerReferences()
sMethodName=public void cleanUpStaleContainerReferences
sParams=
sThrows=
tempMethodName=public void cleanUpStaleContainerReferences0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void cleanUpStaleContainerReferences
params=
/**
* The device monitor will internally cache OneWireContainer objects for each
* 1-Wire device. Use this method to clean up all stale container objects.
* A stale container object is a OneWireContainer object which references a
* 1-Wire device address which has not been seen by a recent search.
* This will be essential in a touch-contact environment which could run
* for some time and needs to conserve memory.
*/
public void cleanUpStaleContainerReferences()
{
objectInstance.cleanUpStaleContainerReferences();
}
======================================
public void cleanUpStalePathReferences()
sMethodName=public void cleanUpStalePathReferences
sParams=
sThrows=
tempMethodName=public void cleanUpStalePathReferences0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void cleanUpStalePathReferences
params=
/**
* The device monitor will internally cache OWPath objects for each
* 1-Wire device. Use this method to clean up all stale OWPath objects.
* A stale path object is a OWPath which references a branching path to a
* 1-Wire device address which has not been seen by a recent search.
* This will be essential in a touch-contact environment which could run
* for some time and needs to conserve memory.
*/
public void cleanUpStalePathReferences()
{
objectInstance.cleanUpStalePathReferences();
}
======================================
public void resetSearch()
sMethodName=public void resetSearch
sParams=
sThrows=
tempMethodName=public void resetSearch0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void resetSearch
params=
/**
* Resets this device monitor. All known devices will be marked as
* "departed" and departure events will be fired.
*/
public void resetSearch()
{
objectInstance.resetSearch();
}
======================================
public int getMaxStateCount()
sMethodName=public int getMaxStateCount
sParams=
sThrows=
tempMethodName=public int getMaxStateCount0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public int getMaxStateCount
params=
/**
* The number of searches that a button should be "missing"
* before it is removed.
*
* @return The number of searches that a button should be "missing"
* before it is removed.
*/
public int getMaxStateCount()
{
return objectInstance.getMaxStateCount();
}
======================================
public void setMaxStateCount(int)
sMethodName=public void setMaxStateCount
sParams=int
sThrows=
tempMethodName=public void setMaxStateCount1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void setMaxStateCount
params=int
/**
* The number of searches that a button should be "missing"
* before it is removed
*
* @param stateCnt The number of searches that a button should be "missing"
* before it is removed.
*/
public void setMaxStateCount(int stateCnt)
{
objectInstance.setMaxStateCount(stateCnt);
}
======================================
public int getMaxErrorCount()
sMethodName=public int getMaxErrorCount
sParams=
sThrows=
tempMethodName=public int getMaxErrorCount0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public int getMaxErrorCount
params=
/**
* Number of searches that an error occurs before listener's are notified
*
* @return Number of searches that an error occurs before listener's
* are notified
*/
public int getMaxErrorCount()
{
return objectInstance.getMaxErrorCount();
}
======================================
public void setMaxErrorCount(int)
sMethodName=public void setMaxErrorCount
sParams=int
sThrows=
tempMethodName=public void setMaxErrorCount1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void setMaxErrorCount
params=int
/**
* Number of searches that an error occurs before listener's are notified
*
* @param errorCnt Number of searches that an error occurs before listener's
* are notified
*/
public void setMaxErrorCount(int errorCnt)
{
objectInstance.setMaxErrorCount(errorCnt);
}
======================================
public com.dalsemi.onewire.adapter.DSPortAdapter getAdapter()
sMethodName=public com.dalsemi.onewire.adapter.DSPortAdapter getAdapter
sParams=
sThrows=
tempMethodName=public DSPortAdapter getAdapter0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public com.dalsemi.onewire.adapter.DSPortAdapter getAdapter
params=
/**
* Returns the DSPortAdapter this device is searching
*
* @param the DSPortAdapter this monitor is searching
*/
public DSPortAdapter getAdapter()
{
return new DSPortAdapter(objectInstance.getAdapter());
}
======================================
public void setAdapter(com.dalsemi.onewire.adapter.DSPortAdapter)
sMethodName=public void setAdapter
sParams=com.dalsemi.onewire.adapter.DSPortAdapter
sThrows=
tempMethodName=public void setAdapter1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void setAdapter
params=com.dalsemi.onewire.adapter.DSPortAdapter
/**
* Sets this monitor to search a new DSPortAdapter
*
* @param the DSPortAdapter this monitor should search
*/
public void setAdapter(DSPortAdapter adapter)
{
objectInstance.setAdapter(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance));
}
======================================
public void search(java.util.Vector, java.util.Vector) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void search
sParams=java.util.Vector, java.util.Vector
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void search2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void search
params=java.util.Vector,java.util.Vector
/**
* Performs a search of the 1-Wire network
*
* @param arrivals A vector of Long objects, represent new arrival addresses.
* @param departures A vector of Long objects, represent departed addresses.
*/
public void search(java.util.Vector arrivals, java.util.Vector departures)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.search(arrivals, departures);
}
======================================
public boolean pauseMonitor(boolean)
sMethodName=public boolean pauseMonitor
sParams=boolean
sThrows=
tempMethodName=public boolean pauseMonitor1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public boolean pauseMonitor
params=boolean
/**
* Pause this monitor
*
* @param blocking if true, this method will block until the monitor is paused.
* @returns true if the monitor was successfully paused.
*/
public boolean pauseMonitor(boolean blocking)
{
return objectInstance.pauseMonitor(blocking);
}
======================================
public boolean resumeMonitor(boolean)
sMethodName=public boolean resumeMonitor
sParams=boolean
sThrows=
tempMethodName=public boolean resumeMonitor1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public boolean resumeMonitor
params=boolean
/**
* Resume this monitor
*
* @param blocking if true, this method will block until the monitor is resumed.
* @returns true if the monitor was successfully resumed.
*/
public boolean resumeMonitor(boolean blocking)
{
return objectInstance.resumeMonitor(blocking);
}
======================================
public boolean isMonitorRunning()
sMethodName=public boolean isMonitorRunning
sParams=
sThrows=
tempMethodName=public boolean isMonitorRunning0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public boolean isMonitorRunning
params=
/**
* Check if this monitor is running.
*
* @return <CODE>true</CODE> if monitor is running
*/
public boolean isMonitorRunning()
{
return objectInstance.isMonitorRunning();
}
======================================
public void killMonitor()
sMethodName=public void killMonitor
sParams=
sThrows=
tempMethodName=public void killMonitor0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void killMonitor
params=
/**
* Kill this monitor. Wait util this
* thread is no longer alive (with timeout).
*/
public void killMonitor()
{
objectInstance.killMonitor();
}
======================================
public void run()
sMethodName=public void run
sParams=
sThrows=
tempMethodName=public void run0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public void run
params=
/**
* Monitor run method that performs a periodic search
* of the entire 1-Wire network. Listeners
* that have registered are notified when changes in the network
* are detected.
*/
public void run()
{
objectInstance.run();
}
======================================
public void addDeviceMonitorEventListener(com.dalsemi.onewire.application.monitor.DeviceMonitorEventListener)
No support: public void addDeviceMonitorEventListener(com.dalsemi.onewire.application.monitor.DeviceMonitorEventListener)
======================================
public com.dalsemi.onewire.utils.OWPath getDevicePath(byte[])
sMethodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
sParams=byte[]
sThrows=
tempMethodName=public OWPath getDevicePathFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
params=byte[]
/**
* Returns the OWPath of the device with the given address.
*
* @param address a byte array representing the address of the device
* @return The OWPath representing the network path to the device.
*/
public OWPath getDevicePathFromBytes(ByteArray address)
{
return new OWPath(objectInstance.getDevicePath(address.array));
}
======================================
public com.dalsemi.onewire.utils.OWPath getDevicePath(java.lang.String)
sMethodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
sParams=java.lang.String
sThrows=
tempMethodName=public OWPath getDevicePathFromString1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
params=java.lang.String
/**
* Returns the OWPath of the device with the given address.
*
* @param address a string representing the address of the device
* @return The OWPath representing the network path to the device.
*/
public OWPath getDevicePathFromString(java.lang.String address)
{
return new OWPath(objectInstance.getDevicePath(address));
}
======================================
public com.dalsemi.onewire.utils.OWPath getDevicePath(long)
sMethodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
sParams=long
sThrows=
tempMethodName=public OWPath getDevicePathFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
params=long
/**
* Returns the OWPath of the device with the given address.
*
* @param address a long representing the address of the device
* @return The OWPath representing the network path to the device.
*/
public OWPath getDevicePathFromLong(String address)
{
return new OWPath(objectInstance.getDevicePath(Long.parseLong(address)));
}
======================================
public com.dalsemi.onewire.utils.OWPath getDevicePath(java.lang.Long)
sMethodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
sParams=java.lang.Long
sThrows=
tempMethodName=public OWPath getDevicePathFromLongObject1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public com.dalsemi.onewire.utils.OWPath getDevicePath
params=java.lang.Long
/**
* Returns the OWPath of the device with the given address.
*
* @param address a Long object representing the address of the device
* @return The OWPath representing the network path to the device.
*/
public OWPath getDevicePathFromLongObject(java.lang.Long address)
{
return new OWPath(objectInstance.getDevicePath(address));
}
======================================
public java.util.Enumeration getAllAddresses()
sMethodName=public java.util.Enumeration getAllAddresses
sParams=
sThrows=
tempMethodName=public java.util.Enumeration getAllAddresses0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public java.util.Enumeration getAllAddresses
params=
/**
* Returns all addresses known by this monitor as an Enumeration of Long
* objects.
*
* @return Enumeration of Long objects
*/
public java.util.Enumeration getAllAddresses()
{
java.util.Enumeration retEnum = objectInstance.getAllAddresses();
return retEnum;/*EnumNotUpdated*/
}
======================================
public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer(com.dalsemi.onewire.adapter.DSPortAdapter, byte[])
sMethodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, byte[]
sThrows=
tempMethodName=public static OneWireContainer getDeviceContainerFromBytes2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
/**
* Returns the OneWireContainer object of the device with the given address.
*
* @param adapter The DSPortAdapter that the device is connected to.
* @param address a byte array representing the address of the device
* @return The specific OneWireContainer object of the device
*/
public OneWireContainer getDeviceContainerFromBytes(DSPortAdapter adapter, ByteArray address)
{
return new OneWireContainer(com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.getDeviceContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), address.array));
}
======================================
public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer(com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.String)
sMethodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.String
sThrows=
tempMethodName=public static OneWireContainer getDeviceContainerFromString2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Returns the OneWireContainer object of the device with the given address.
*
* @param adapter The DSPortAdapter that the device is connected to.
* @param address a String representing the address of the device
* @return The specific OneWireContainer object of the device
*/
public OneWireContainer getDeviceContainerFromString(DSPortAdapter adapter, java.lang.String address)
{
return new OneWireContainer(com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.getDeviceContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), address));
}
======================================
public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer(com.dalsemi.onewire.adapter.DSPortAdapter, long)
sMethodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, long
sThrows=
tempMethodName=public static OneWireContainer getDeviceContainerFromLong2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,long
/**
* Returns the OneWireContainer object of the device with the given address.
*
* @param adapter The DSPortAdapter that the device is connected to.
* @param address a long representing the address of the device
* @return The specific OneWireContainer object of the device
*/
public OneWireContainer getDeviceContainerFromLong(DSPortAdapter adapter, String address)
{
return new OneWireContainer(com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.getDeviceContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), Long.parseLong(address)));
}
======================================
public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer(com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.Long)
sMethodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.Long
sThrows=
tempMethodName=public static OneWireContainer getDeviceContainerFromLongObject2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.Long
/**
* Returns the OneWireContainer object of the device with the given address.
*
* @param adapter The DSPortAdapter that the device is connected to.
* @param address a Long object representing the address of the device
* @return The specific OneWireContainer object of the device
*/
public OneWireContainer getDeviceContainerFromLongObject(DSPortAdapter adapter, java.lang.Long longAddress)
{
return new OneWireContainer(com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.getDeviceContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), longAddress));
}
======================================
public static void putDeviceContainer(byte[], com.dalsemi.onewire.container.OneWireContainer)
sMethodName=public static void putDeviceContainer
sParams=byte[], com.dalsemi.onewire.container.OneWireContainer
sThrows=
tempMethodName=public static void putDeviceContainerFromBytes2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static void putDeviceContainer
params=byte[],com.dalsemi.onewire.container.OneWireContainer
/**
* Sets the OneWireContainer object of the device with the given address.
*
* @param address a byte array object representing the address of the device
* @param owc The specific OneWireContainer object of the device
*/
public void putDeviceContainerFromBytes(ByteArray address, OneWireContainer owc)
{
com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.putDeviceContainer(address.array, ((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance));
}
======================================
public static void putDeviceContainer(java.lang.String, com.dalsemi.onewire.container.OneWireContainer)
sMethodName=public static void putDeviceContainer
sParams=java.lang.String, com.dalsemi.onewire.container.OneWireContainer
sThrows=
tempMethodName=public static void putDeviceContainerFromString2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static void putDeviceContainer
params=java.lang.String,com.dalsemi.onewire.container.OneWireContainer
/**
* Sets the OneWireContainer object of the device with the given address.
*
* @param address a String object representing the address of the device
* @param owc The specific OneWireContainer object of the device
*/
public void putDeviceContainerFromString(java.lang.String address, OneWireContainer owc)
{
com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.putDeviceContainer(address, ((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance));
}
======================================
public static void putDeviceContainer(long, com.dalsemi.onewire.container.OneWireContainer)
sMethodName=public static void putDeviceContainer
sParams=long, com.dalsemi.onewire.container.OneWireContainer
sThrows=
tempMethodName=public static void putDeviceContainerFromLong2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static void putDeviceContainer
params=long,com.dalsemi.onewire.container.OneWireContainer
/**
* Sets the OneWireContainer object of the device with the given address.
*
* @param address a long object representing the address of the device
* @param owc The specific OneWireContainer object of the device
*/
public void putDeviceContainerFromLong(String address, OneWireContainer owc)
{
com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.putDeviceContainer(Long.parseLong(address), ((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance));
}
======================================
public static void putDeviceContainer(java.lang.Long, com.dalsemi.onewire.container.OneWireContainer)
sMethodName=public static void putDeviceContainer
sParams=java.lang.Long, com.dalsemi.onewire.container.OneWireContainer
sThrows=
tempMethodName=public static void putDeviceContainerFromLongObject2
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor
methodName=public static void putDeviceContainer
params=java.lang.Long,com.dalsemi.onewire.container.OneWireContainer
/**
* Sets the OneWireContainer object of the device with the given address.
*
* @param address a Long object representing the address of the device
* @param owc The specific OneWireContainer object of the device
*/
public void putDeviceContainerFromLongObject(java.lang.Long longAddress, OneWireContainer owc)
{
com.dalsemi.onewire.application.monitor.AbstractDeviceMonitor.putDeviceContainer(longAddress, ((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance));
}
-------------------------------------------------------------------
creating: owapi\DeviceMonitor.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.monitor.DeviceMonitor(com.dalsemi.onewire.adapter.DSPortAdapter)
sMethodName=public com.dalsemi.onewire.application.monitor.DeviceMonitor
sParams=com.dalsemi.onewire.adapter.DSPortAdapter
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.DeviceMonitor
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter
/**
* Create a simple monitor that does not search branches
*
* @param the DSPortAdapter this monitor should search
*/
public void createNewInstance(DSPortAdapter adapter)
{
objectInstance = new com.dalsemi.onewire.application.monitor.DeviceMonitor(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance));
}
-------------------------------------------------------------------
creating: owapi\NetworkDeviceMonitor.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor(com.dalsemi.onewire.adapter.DSPortAdapter)
sMethodName=public com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor
sParams=com.dalsemi.onewire.adapter.DSPortAdapter
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter
/**
* Create a complex monitor that does search branches
*
* @param the DSPortAdapter this monitor should search
*/
public void createNewInstance(DSPortAdapter adapter)
{
objectInstance = new com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance));
}
======================================
public void setBranchAutoSearching(boolean)
sMethodName=public void setBranchAutoSearching
sParams=boolean
sThrows=
tempMethodName=public void setBranchAutoSearching1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor
methodName=public void setBranchAutoSearching
params=boolean
/**
* Indicates whether or not branches are automatically traversed. If false,
* new branches must be indicated using the "addBranch" method.
*
* @param enabled if true, all branches are automatically traversed during a
* search operation.
*/
public void setBranchAutoSearching(boolean enabled)
{
((com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor)objectInstance).setBranchAutoSearching(enabled);
}
======================================
public boolean getBranchAutoSearching()
sMethodName=public boolean getBranchAutoSearching
sParams=
sThrows=
tempMethodName=public boolean getBranchAutoSearching0
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor
methodName=public boolean getBranchAutoSearching
params=
/**
* Indicates whether or not branches are automatically traversed. If false,
* new branches must be indicated using the "addBranch" method.
*
* @returns true if all branches are automatically traversed during a
* search operation.
*/
public boolean getBranchAutoSearching()
{
return ((com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor)objectInstance).getBranchAutoSearching();
}
======================================
public void addBranch(com.dalsemi.onewire.utils.OWPath)
sMethodName=public void addBranch
sParams=com.dalsemi.onewire.utils.OWPath
sThrows=
tempMethodName=public void addBranch1
getMethodDocumentation
className=com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor
methodName=public void addBranch
params=com.dalsemi.onewire.utils.OWPath
/**
* Adds a branch for searching. Must be used to traverse branches if
* auto-searching is disabled.
*
* @param path A branch to be searched during the next search routine
*/
public void addBranch(OWPath path)
{
((com.dalsemi.onewire.application.monitor.NetworkDeviceMonitor)objectInstance).addBranch(((com.dalsemi.onewire.utils.OWPath)path.objectInstance));
}
-------------------------------------------------------------------
creating: owapi\SHADebit.java
superClassName=java.lang.Object
======================================
public static final int DEBIT_AMOUNT
======================================
public static final int INITIAL_AMOUNT
======================================
public static final int USER_BALANCE
======================================
public static final int I_FILE_LENGTH
======================================
public static final int I_DATA_TYPE_CODE
======================================
public static final int I_SIGNATURE
======================================
public static final int I_CONVERSION_FACTOR
======================================
public static final int I_BALANCE
======================================
public static final int I_TRANSACTION_ID
======================================
public static final int I_CONTINUATION_PTR
======================================
public static final int I_FILE_CRC16
======================================
public com.dalsemi.onewire.application.sha.SHADebit(com.dalsemi.onewire.application.sha.SHAiButtonCopr)
sMethodName=public com.dalsemi.onewire.application.sha.SHADebit
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr
/**
* SHADebit constructor. <code>copr</code> is the SHAiButtonCopr
* that is used to perform this transaction. After saving a
* reference to the SHA coprocessor, this constructor resets all
* parameters for this type of transaction to their default values.
*
* @param copr The coprocessor used for authentication and data
* signing in this transaction.
*/
public void createNewInstance(SHAiButtonCopr copr)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHADebit(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance));
}
======================================
public com.dalsemi.onewire.application.sha.SHADebit(com.dalsemi.onewire.application.sha.SHAiButtonCopr,int,int)
sMethodName=public com.dalsemi.onewire.application.sha.SHADebit
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,int,int
sThrows=
tempMethodName=public void createNewInstance3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,int,int
/**
* SHADebit constructor. <code>copr</code> is the SHAiButtonCopr
* that is used to perform this transaction. After saving a
* reference to the SHA coprocessor, this constructor resets all
* parameters for this type of transaction to their default values.
*
* @param copr The coprocessor used for authentication and data
* signing in this transaction.
*/
public void createNewInstance(SHAiButtonCopr copr, int initialAmount, int debitAmount)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHADebit(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), initialAmount, debitAmount);
}
======================================
public synchronized boolean verifyUser(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean verifyUser
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean verifyUser1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public synchronized boolean verifyUser
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies user's authentication response. User is "authenticated" if
* and only if the digital signature generated the user iButton matches
* the digital signature generated by the coprocessor after the user's
* unique secret has been recreated on the coprocessor.</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Generate 3-byte "challenge" on coprocessor </li>
* <li> Write challenge to scratchpad of user </li>
* <li> Read account data page with signature </li>
* <li> Attempt to match user's signature with the coprocessor </li>
* </ul></P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @see SHAiButtonCopr#generateChallenge(int,byte[],int)
* @see SHAiButtonCopr#verifyAuthentication(byte[],byte[],byte[],byte[],byte)
* @see SHAiButtonUser#readAccountData(byte[],int,byte[],int,byte[],int)
* @see #getLastError()
*/
public synchronized boolean verifyUser(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHADebit)objectInstance).verifyUser(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public synchronized boolean verifyTransactionData(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean verifyTransactionData
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean verifyTransactionData1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public synchronized boolean verifyTransactionData
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies user's account data. Account data is "verified" if and
* only if the account balance is greater than zero and the digital
* signature matches the signature recreated by the coprocessor.</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Read the account data from user </li>
* <li> Extract account balance </li>
* <li> Debit money from balance </li>
* <li> Insert the new balance </li>
* <li> Reset the digital signature </li>
* <li> Use coprocessor to sign account data </li>
* <li> Insert the new digital signature </li>
* <li> Write the account data to the user </li>
* </ul></P>
*
* <P>If previous steps have been executed, all "Read" commands on
* the user are reading from cached data.</P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @return <code>true</code> if and only if the account balance is
* greater than zero and digital signature matches the signature
* recreated by the coprocessor.
*
* @see SHAiButtonUser#readAccountData(byte[],int)
* @see SHAiButtonCopr#verifySignature(byte[],byte[],byte[])
* @see #getLastError()
*/
public synchronized boolean verifyTransactionData(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHADebit)objectInstance).verifyTransactionData(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public synchronized boolean executeTransaction(com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean executeTransaction
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean executeTransaction2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public synchronized boolean executeTransaction
params=com.dalsemi.onewire.application.sha.SHAiButtonUser,boolean
/**
* <P>Performs the signed debit, subtracting the debit amount from
* the user's balance and storing the new, signed account data on the
* user's iButton. The debit amount can be set using
* <code>transaction.setParameter(SHADebit.DEBIT_AMOUNT, 50)</code>,
* where the value is in units of cents (i.e. for 1 dollar, use 100).</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Read the account data from user </li>
* <li> Extract account balance </li>
* <li> Assert balance greater than debit amount </li>
* <li> Debit money from balance </li>
* <li> Insert the new balance </li>
* <li> Reset the digital signature </li>
* <li> Use coprocessor to sign account data </li>
* <li> Insert the new digital signature </li>
* <li> Write the account data to the user </li>
* </ul></P>
*
* <P>If previous steps have been executed, all "Read" commands on
* the user are reading from cached data.</P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @return <code>true</code> if and only if the user has enough in the
* account balance to perform the requested debit AND a new digital
* signature is successfully created AND the account data has been written
* to the button.
*
* @see SHAiButtonUser#readAccountData(byte[],int)
* @see SHAiButtonUser#writeAccountData(byte[],int)
* @see SHAiButtonCopr#createDataSignature(byte[],byte[],byte[],int)
* @see #getLastError()
*/
public synchronized boolean executeTransaction(SHAiButtonUser user, boolean verifySuccess)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHADebit)objectInstance).executeTransaction(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance), verifySuccess);
}
======================================
public synchronized int getParameter(int)
sMethodName=public synchronized int getParameter
sParams=int
sThrows=
tempMethodName=public synchronized int getParameter1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public synchronized int getParameter
params=int
/**
* <P>Retrieves the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* <LI><code>SHADebit.USER_BALANCE</code></LI>
* </UL>
* </P>
*
* <P>Note that the value of <code>SHADebit.USER_BALANCE</code> will
* be set after calling <code>verifyTransactionData(SHAiButtonUser)</code>
* and after calling <code>executeTransaction(SHAiButtonUser)</code>.</P>
*
* @return The value of the requested parameter.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized int getParameter(int type)
{
return ((com.dalsemi.onewire.application.sha.SHADebit)objectInstance).getParameter(type);
}
======================================
public synchronized boolean setParameter(int, int)
sMethodName=public synchronized boolean setParameter
sParams=int, int
sThrows=
tempMethodName=public synchronized boolean setParameter2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public synchronized boolean setParameter
params=int,int
/**
* <P>Sets the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* </UL>
* </P>
*
* @param type Specifies the parameter type (<code>SHADebit.DEBIT_AMOUNT</code> or
* <code>SHADebit.INITIAL_AMOUNT</code>)
* @return </code>true</code> if a valid parameter type was specified
* and the value of the parameter is positive.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized boolean setParameter(int type, int param)
{
return ((com.dalsemi.onewire.application.sha.SHADebit)objectInstance).setParameter(type, param);
}
======================================
public synchronized void resetParameters()
sMethodName=public synchronized void resetParameters
sParams=
sThrows=
tempMethodName=public synchronized void resetParameters0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebit
methodName=public synchronized void resetParameters
params=
/**
* <p>Resets all transaction parameters to default values</p>
*/
public synchronized void resetParameters()
{
((com.dalsemi.onewire.application.sha.SHADebit)objectInstance).resetParameters();
}
-------------------------------------------------------------------
creating: owapi\SHADebitUnsigned.java
superClassName=java.lang.Object
======================================
public static final int DEBIT_AMOUNT
======================================
public static final int INITIAL_AMOUNT
======================================
public static final int USER_BALANCE
======================================
public com.dalsemi.onewire.application.sha.SHADebitUnsigned(com.dalsemi.onewire.application.sha.SHAiButtonCopr)
sMethodName=public com.dalsemi.onewire.application.sha.SHADebitUnsigned
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr
/**
* SHADebitUnsigned constructor. <code>copr</code> is the SHAiButtonCopr
* that is used to perform this transaction. After saving a
* reference to the SHA coprocessor, this constructor resets all
* parameters for this type of transaction to their default values.
*
* @param copr The coprocessor used for authentication and data
* signing in this transaction.
*/
public void createNewInstance(SHAiButtonCopr copr)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHADebitUnsigned(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance));
}
======================================
public com.dalsemi.onewire.application.sha.SHADebitUnsigned(com.dalsemi.onewire.application.sha.SHAiButtonCopr,int,int)
sMethodName=public com.dalsemi.onewire.application.sha.SHADebitUnsigned
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,int,int
sThrows=
tempMethodName=public void createNewInstance3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,int,int
/**
* SHADebitUnsigned constructor. <code>copr</code> is the SHAiButtonCopr
* that is used to perform this transaction. After saving a
* reference to the SHA coprocessor, this constructor resets all
* parameters for this type of transaction to their default values.
*
* @param copr The coprocessor used for authentication and data
* signing in this transaction.
*/
public void createNewInstance(SHAiButtonCopr copr, int initialAmount, int debitAmount)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHADebitUnsigned(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), initialAmount, debitAmount);
}
======================================
public synchronized boolean verifyUser(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean verifyUser
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean verifyUser1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public synchronized boolean verifyUser
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies user's authentication response. User is "authenticated" if
* and only if the digital signature generated the user iButton matches
* the digital signature generated by the coprocessor after the user's
* unique secret has been recreated on the coprocessor.</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Generate 3-byte "challenge" on coprocessor </li>
* <li> Write challenge to scratchpad of user </li>
* <li> Read account data page with signature </li>
* <li> Attempt to match user's signature with the coprocessor </li>
* </ul></P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @see SHAiButtonCopr#generateChallenge(int,byte[],int)
* @see SHAiButtonCopr#verifyAuthentication(byte[],byte[],byte[],byte[],byte)
* @see SHAiButtonUser#readAccountData(byte[],int,byte[],int,byte[],int)
* @see #getLastError()
*/
public synchronized boolean verifyUser(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHADebitUnsigned)objectInstance).verifyUser(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public synchronized boolean verifyTransactionData(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean verifyTransactionData
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean verifyTransactionData1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public synchronized boolean verifyTransactionData
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies user's account data. Account data is "verified" if and
* only if the account balance is greater than zero. No digital
* signature is checked by this transaction.</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Read the account data from user </li>
* <li> Extract account balance </li>
* <li> Debit money from balance </li>
* <li> Insert the new balance </li>
* <li> Write the account data to the user </li>
* </ul></P>
*
* <P>If previous steps have been executed, all "Read" commands on
* the user are reading from cached data.</P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @return <code>true</code> if and only if the account balance is
* greater than zero.
*
* @see SHAiButtonUser#readAccountData(byte[],int)
* @see #getLastError()
*/
public synchronized boolean verifyTransactionData(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHADebitUnsigned)objectInstance).verifyTransactionData(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public synchronized boolean executeTransaction(com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean executeTransaction
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean executeTransaction2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public synchronized boolean executeTransaction
params=com.dalsemi.onewire.application.sha.SHAiButtonUser,boolean
/**
* <P>Performs the unsigned debit, subtracting the debit amount from
* the user's balance and storing the new, unsigned account data on the
* user's iButton. The debit amount can be set using
* <code>transaction.setParameter(SHADebit.DEBIT_AMOUNT, 50)</code>,
* where the value is in units of cents (i.e. for 1 dollar, use 100).</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Read the account data from user </li>
* <li> Extract account balance </li>
* <li> Assert balance greater than debit amount </li>
* <li> Debit money from balance </li>
* <li> Insert the new balance </li>
* <li> Write the account data to the user </li>
* </ul></P>
*
* <P>If previous steps have been executed, all "Read" commands on
* the user are reading from cached data.</P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @return <code>true</code> if and only if the user has enough in the
* account balance to perform the requested debit AND the account data
* has been written to the button.
*
* @see SHAiButtonUser#readAccountData(byte[],int)
* @see SHAiButtonUser#writeAccountData(byte[],int)
* @see #getLastError()
*/
public synchronized boolean executeTransaction(SHAiButtonUser user, boolean verifySuccess)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHADebitUnsigned)objectInstance).executeTransaction(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance), verifySuccess);
}
======================================
public synchronized int getParameter(int)
sMethodName=public synchronized int getParameter
sParams=int
sThrows=
tempMethodName=public synchronized int getParameter1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public synchronized int getParameter
params=int
/**
* <P>Retrieves the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* <LI><code>SHADebit.USER_BALANCE</code></LI>
* </UL>
* </P>
*
* <P>Note that the value of <code>SHADebit.USER_BALANCE</code> will
* be set after calling <code>verifyTransactionData(SHAiButtonUser)</code>
* and after calling <code>executeTransaction(SHAiButtonUser)</code>.</P>
*
* @return The value of the requested parameter.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized int getParameter(int type)
{
return ((com.dalsemi.onewire.application.sha.SHADebitUnsigned)objectInstance).getParameter(type);
}
======================================
public synchronized boolean setParameter(int, int)
sMethodName=public synchronized boolean setParameter
sParams=int, int
sThrows=
tempMethodName=public synchronized boolean setParameter2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public synchronized boolean setParameter
params=int,int
/**
* <P>Sets the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* </UL>
* </P>
*
* @param type Specifies the parameter type (<code>SHADebit.DEBIT_AMOUNT</code> or
* <code>SHADebit.INITIAL_AMOUNT</code>)
* @return </code>true</code> if a valid parameter type was specified
* and the value of the parameter is positive.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized boolean setParameter(int type, int param)
{
return ((com.dalsemi.onewire.application.sha.SHADebitUnsigned)objectInstance).setParameter(type, param);
}
======================================
public synchronized void resetParameters()
sMethodName=public synchronized void resetParameters
sParams=
sThrows=
tempMethodName=public synchronized void resetParameters0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHADebitUnsigned
methodName=public synchronized void resetParameters
params=
/**
* <p>Resets all transaction parameters to default values</p>
*/
public synchronized void resetParameters()
{
((com.dalsemi.onewire.application.sha.SHADebitUnsigned)objectInstance).resetParameters();
}
-------------------------------------------------------------------
creating: owapi\SHAiButtonCopr.java
======================================
public static final int NO_ERROR
======================================
public static final int WRITE_DATA_PAGE_FAILED
======================================
public static final int WRITE_SCRATCHPAD_FAILED
======================================
public static final int MATCH_SCRATCHPAD_FAILED
======================================
public static final int ERASE_SCRATCHPAD_FAILED
======================================
public static final int COPY_SCRATCHPAD_FAILED
======================================
public static final int SHA_FUNCTION_FAILED
======================================
public static final int BIND_SECRET_FAILED
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCopr(com.dalsemi.onewire.container.OneWireContainer18,java.lang.String,boolean,int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCopr
sParams=com.dalsemi.onewire.container.OneWireContainer18,java.lang.String,boolean,int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstance18
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer18,java.lang.String,boolean,int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[]
/**
* <P>Sets up this coprocessor object based on the provided parameters
* and saves all of these parameters as the contents of the file
* <code>coprFilename</code> stored on <code>owc</code>. Then, the
* system secret and authentication secret are installed on the
* coprocessor button.</P>
*
* <P>For the proper format of the coprocessor data file, see the
* document entitled "Implementing Secured D-Identification and E-Payment
* Applications using SHA iButtons". For the format of TMEX file
* structures, see Application Note 114.</P>
*
* @param l_owc The DS1963S used as a coprocessor.
* @param coprFilename The TMEX filename where coprocessor configuration
* data is stored. Usually, "COPR.0".
* @param l_formatDevice boolean indicating whether or not the TMEX
* filesystem of this device should be formatted before the
* coprocessor data file is stored.
* @param l_signPageNumber page number used for signing user account data.
* (Should be page 8, but page 0 is acceptable if you don't need
* the TMEX directory structure)
* @param l_authPageNumber page number used for recreating user secret.
* @param l_wspcPageNumber page number used for storing user secret and
* recreating authentication MAC.
* @param l_version version of the service provided by this coprocessor.
* @param l_encCode refers to a type of encryption used for user account
* data stored on user buttons.
* @param l_serviceFileExt the file extension used for the service file.
* (An extension of decimal 102 is reserved for Money files).
* @param l_serviceFilename the 4-byte name of the user's account data
* file.
* @param l_providerName the name of the provider of this service
* @param l_bindData the binding data used to finalize secret installation
* on user buttons.
* @param l_bindCode the binding code used to finalize secret installation
* on user buttons.
* @param l_auxData any auxilliary or miscellaneous data to be stored on
* the coprocessor.
* @param l_initialSignature the 20-byte initial MAC placed in user account
* data before generating actual MAC.
* @param l_signingChlg the 3-byte challenge used for signing user
* account data.
* @param l_signingSecret the system signing secret used by the
* service being installed on this coprocessor.
* @param l_authSecret the system authentication secret used by the
* service being installed on this coprocessor.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCopr(OneWireContainer18,String)
*/
public void createNewInstance(OneWireContainer18 l_owc, java.lang.String coprFilename, boolean l_formatDevice, int l_signPageNumber, int l_authPageNumber, int l_wspcPageNumber, int l_version, int l_encCode, byte l_serviceFileExt, ByteArray l_serviceFilename, ByteArray coprFilename0, ByteArray coprFilename1, ByteArray coprFilename2, ByteArray coprFilename3, ByteArray coprFilename4, ByteArray coprFilename5, ByteArray coprFilename6, ByteArray coprFilename7)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCopr(((com.dalsemi.onewire.container.OneWireContainer18)l_owc.objectInstance), coprFilename, l_formatDevice, l_signPageNumber, l_authPageNumber, l_wspcPageNumber, l_version, l_encCode, l_serviceFileExt, l_serviceFilename.array, coprFilename0.array, coprFilename1.array, coprFilename2.array, coprFilename3.array, coprFilename4.array, coprFilename5.array, coprFilename6.array, coprFilename7.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCopr(com.dalsemi.onewire.container.OneWireContainer18,java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCopr
sParams=com.dalsemi.onewire.container.OneWireContainer18,java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer18,java.lang.String
/**
* <P>Sets up this coprocessor object based on the provided parameters
* and saves all of these parameters as the contents of the file
* <code>coprFilename</code> stored on <code>owc</code>. Then, the
* system secret and authentication secret are installed on the
* coprocessor button.</P>
*
* <P>For the proper format of the coprocessor data file, see the
* document entitled "Implementing Secured D-Identification and E-Payment
* Applications using SHA iButtons". For the format of TMEX file
* structures, see Application Note 114.</P>
*
* @param l_owc The DS1963S used as a coprocessor.
* @param coprFilename The TMEX filename where coprocessor configuration
* data is stored. Usually, "COPR.0".
* @param l_formatDevice boolean indicating whether or not the TMEX
* filesystem of this device should be formatted before the
* coprocessor data file is stored.
* @param l_signPageNumber page number used for signing user account data.
* (Should be page 8, but page 0 is acceptable if you don't need
* the TMEX directory structure)
* @param l_authPageNumber page number used for recreating user secret.
* @param l_wspcPageNumber page number used for storing user secret and
* recreating authentication MAC.
* @param l_version version of the service provided by this coprocessor.
* @param l_encCode refers to a type of encryption used for user account
* data stored on user buttons.
* @param l_serviceFileExt the file extension used for the service file.
* (An extension of decimal 102 is reserved for Money files).
* @param l_serviceFilename the 4-byte name of the user's account data
* file.
* @param l_providerName the name of the provider of this service
* @param l_bindData the binding data used to finalize secret installation
* on user buttons.
* @param l_bindCode the binding code used to finalize secret installation
* on user buttons.
* @param l_auxData any auxilliary or miscellaneous data to be stored on
* the coprocessor.
* @param l_initialSignature the 20-byte initial MAC placed in user account
* data before generating actual MAC.
* @param l_signingChlg the 3-byte challenge used for signing user
* account data.
* @param l_signingSecret the system signing secret used by the
* service being installed on this coprocessor.
* @param l_authSecret the system authentication secret used by the
* service being installed on this coprocessor.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCopr(OneWireContainer18,String)
*/
public void createNewInstance(OneWireContainer18 l_owc, java.lang.String coprFilename)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCopr(((com.dalsemi.onewire.container.OneWireContainer18)l_owc.objectInstance), coprFilename);
}
======================================
public byte getAddress()[]
sMethodName=public byte getAddress
sParams=
sThrows=
tempMethodName=public ByteArray getAddress0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public byte[] getAddress
params=
/**
* <P>Returns the 8 byte address of the OneWireContainer this
* SHAiButton refers to.</P>
*
* @return 8 byte array containing family code, address, and
* crc8 of the OneWire device.
*/
public ByteArray getAddress()
{
return new ByteArray().setupObject(objectInstance.getAddress());
}
======================================
public void getAddress(byte[], int)
sMethodName=public void getAddress
sParams=byte[], int
sThrows=
tempMethodName=public void getAddress2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void getAddress
params=byte[],int
/**
* <P>Copies the 8 byte address of the OneWireContainer into
* the provided array starting at the given offset.</P>
*
* @param data array with at least 8 bytes after offset
* @param offset the index at which copying starts
*/
public void getAddress(ByteArray data, int offset)
{
objectInstance.getAddress(data.array, offset);
}
======================================
public void getAddress(byte[], int, int)
sMethodName=public void getAddress
sParams=byte[], int, int
sThrows=
tempMethodName=public void getAddress3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void getAddress
params=byte[],int,int
/**
* <P>Copies the specified number of bytes from the address
* of the OneWireContainer into the provided array starting
* at the given offset.</P>
*
* @param data array with at least cnt bytes after offset
* @param offset the index at which copying starts
* @param cnt the number of bytes to copy
*/
public void getAddress(ByteArray data, int offset, int cnt)
{
objectInstance.getAddress(data.array, offset, cnt);
}
======================================
public int getAuthenticationPageNumber()
sMethodName=public int getAuthenticationPageNumber
sParams=
sThrows=
tempMethodName=public int getAuthenticationPageNumber0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public int getAuthenticationPageNumber
params=
/**
* <P>Returns the page number used by this coprocessor for storing
* system authentication secret and recreating user's authentication
* secret. The authentication secret stays constant, while the new
* secret is copied on to the secret corresponding to the workspace
* page.</P>
*
* @return page number used for system authentication secret
* @see OneWireContainer18#bindSecretToiButton(int,byte[],byte[],int)
*/
public int getAuthenticationPageNumber()
{
return objectInstance.getAuthenticationPageNumber();
}
======================================
public java.lang.String getAuxilliaryData()
sMethodName=public java.lang.String getAuxilliaryData
sParams=
sThrows=
tempMethodName=public java.lang.String getAuxilliaryData0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public java.lang.String getAuxilliaryData
params=
/**
* <P>Returns a string representing the auxilliary data associated
* with this coprocessor's service.</P>
*
* @return the auxilliary data of this coprocessor's service
*/
public java.lang.String getAuxilliaryData()
{
return objectInstance.getAuxilliaryData();
}
======================================
public byte getBindCode()[]
sMethodName=public byte getBindCode
sParams=
sThrows=
tempMethodName=public ByteArray getBindCode0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public byte[] getBindCode
params=
/**
* <P>Returns 7 byte binding code for finalizing secret installation
* on user buttons. This is copied into the user's scratchpad,
* along with 8 other bytes of binding data (see
* <code>bindSecretToiButton</code>) for finalizing the secret
* and making it unique to the button.</P>
*
* @return the binding code for user's scratchpad
* @see OneWireContainer18#bindSecretToiButton(int,byte[],byte[],int)
*/
public ByteArray getBindCode()
{
return new ByteArray().setupObject(objectInstance.getBindCode());
}
======================================
public void getBindCode(byte[], int)
sMethodName=public void getBindCode
sParams=byte[], int
sThrows=
tempMethodName=public void getBindCode2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void getBindCode
params=byte[],int
/**
* <P>Copies 7 byte binding code for finalizing secret installation
* on user buttons. This is copied into the user's scratchpad,
* along with 8 other bytes of binding data (see
* <code>bindSecretToiButton</code>) for finalizing the secret
* and making it unique to the button.</P>
*
* @param data array for copying the binding code for user's
* scratchpad
* @param offset the index at which to start copying.
* @see OneWireContainer18#bindSecretToiButton(int,byte[],byte[],int)
*/
public void getBindCode(ByteArray data, int offset)
{
objectInstance.getBindCode(data.array, offset);
}
======================================
public byte getBindData()[]
sMethodName=public byte getBindData
sParams=
sThrows=
tempMethodName=public ByteArray getBindData0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public byte[] getBindData
params=
/**
* <P>Returns 32 byte binding data for finalizing secret installation
* on user buttons. This is copied into the user's account data
* page (see <code>bindSecretToiButton</code>) for finalizing the
* secret and making it unique to the button.</P>
*
* @return the binding data for user's data page
* @see OneWireContainer18#bindSecretToiButton(int,byte[],byte[],int)
*/
public ByteArray getBindData()
{
return new ByteArray().setupObject(objectInstance.getBindData());
}
======================================
public void getBindData(byte[], int)
sMethodName=public void getBindData
sParams=byte[], int
sThrows=
tempMethodName=public void getBindData2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void getBindData
params=byte[],int
/**
* <P>Copies 32 byte binding data for finalizing secret installation
* on user buttons. This is then copied into the user's account data
* page (see <code>bindSecretToiButton</code>) for finalizing the
* secret and making it unique to the button.</P>
*
* @param data array for copying the binding data for user's
* data page
* @param offset the index at which to start copying.
* @see OneWireContainer18#bindSecretToiButton(int,byte[],byte[],int)
*/
public void getBindData(ByteArray data, int offset)
{
objectInstance.getBindData(data.array, offset);
}
======================================
public int getEncryptionCode()
sMethodName=public int getEncryptionCode
sParams=
sThrows=
tempMethodName=public int getEncryptionCode0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public int getEncryptionCode
params=
/**
* <P>Returns an integer representing the encryption code for
* this coprocessor. No handling of specific encryption codes
* are in place with this API, but could be added easily at
* the <code>SHATransaction</codE> layer.</P>
*
* @return an integer representing type of encryption for user data.
*/
public int getEncryptionCode()
{
return objectInstance.getEncryptionCode();
}
======================================
public void getFilename(byte[], int)
sMethodName=public void getFilename
sParams=byte[], int
sThrows=
tempMethodName=public void getFilename2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void getFilename
params=byte[],int
/**
* <P>Copies the filename (used for storing account data on user
* buttons) into the specified array starting at the specified
* offset.</P>
*
* @param l_filename the array into which the filename will be
* copied.
* @param offset the starting index for copying the filename.
*/
public void getFilename(ByteArray l_filename, int offset)
{
objectInstance.getFilename(l_filename.array, offset);
}
======================================
public byte getFilenameExt()
sMethodName=public byte getFilenameExt
sParams=
sThrows=
tempMethodName=public byte getFilenameExt0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public byte getFilenameExt
params=
/**
* <P>Returns the extension of the filename used for storing account
* data on user buttons. If the type of this service is an
* e-cash application, the file extension will be decimal 102.</P>
*
* @return proper file extension for user's account data file.
*/
public byte getFilenameExt()
{
return objectInstance.getFilenameExt();
}
======================================
public byte getInitialSignature()[]
sMethodName=public byte getInitialSignature
sParams=
sThrows=
tempMethodName=public ByteArray getInitialSignature0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public byte[] getInitialSignature
params=
/**
* <P>Returns the 20-byte initial signature used by this coprocessor
* for signing account data.</P>
*
* @return 20-byte initial signature.
*/
public ByteArray getInitialSignature()
{
return new ByteArray().setupObject(objectInstance.getInitialSignature());
}
======================================
public void getInitialSignature(byte[], int)
sMethodName=public void getInitialSignature
sParams=byte[], int
sThrows=
tempMethodName=public void getInitialSignature2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void getInitialSignature
params=byte[],int
/**
* <P>Copies the 20-byte initial signature used by this coprocessor
* for signing account data into the specified array starting at the
* specified offset.</P>
*
* @param data arry for copying the 20-byte initial signature.
* @param offset the index at which to start copying.
*/
public void getInitialSignature(ByteArray data, int offset)
{
objectInstance.getInitialSignature(data.array, offset);
}
======================================
public int getLastError()
sMethodName=public int getLastError
sParams=
sThrows=
tempMethodName=public int getLastError0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public int getLastError
params=
/**
* <P>Returns error code matching last error encountered by the
* coprocessor. An error code of zero implies NO_ERROR.</P>
*
* @return the error code, zero for none.
*/
public int getLastError()
{
return objectInstance.getLastError();
}
======================================
public java.lang.String getProviderName()
sMethodName=public java.lang.String getProviderName
sParams=
sThrows=
tempMethodName=public java.lang.String getProviderName0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public java.lang.String getProviderName
params=
/**
* <P>Returns a string representing the Provider name associated
* with this coprocessor's service.</P>
*
* @return the name of the provider's service.
*/
public java.lang.String getProviderName()
{
return objectInstance.getProviderName();
}
======================================
public byte getSigningChallenge()[]
sMethodName=public byte getSigningChallenge
sParams=
sThrows=
tempMethodName=public ByteArray getSigningChallenge0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public byte[] getSigningChallenge
params=
/**
* <P>Returns the 3-byte signing challenge used by this coprocessor
* for data validation.</P>
*
* @return 3-byte challenge
*/
public ByteArray getSigningChallenge()
{
return new ByteArray().setupObject(objectInstance.getSigningChallenge());
}
======================================
public void getSigningChallenge(byte[], int)
sMethodName=public void getSigningChallenge
sParams=byte[], int
sThrows=
tempMethodName=public void getSigningChallenge2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public void getSigningChallenge
params=byte[],int
/**
* <P>Copies the 3-byte signing challenge used by this coprocessor
* for data validation into the specified array starting at
* the specified offset.</P>
*
* @param data the array for copying the 3-byte challenge.
* @param offset the index at which to start copying.
*/
public void getSigningChallenge(ByteArray data, int offset)
{
objectInstance.getSigningChallenge(data.array, offset);
}
======================================
public int getSigningPageNumber()
sMethodName=public int getSigningPageNumber
sParams=
sThrows=
tempMethodName=public int getSigningPageNumber0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public int getSigningPageNumber
params=
/**
* <P>Returns the page number used by this coprocessor for signing
* account data.</P>
*
* @return page number used for signing
*/
public int getSigningPageNumber()
{
return objectInstance.getSigningPageNumber();
}
======================================
public int getVersion()
sMethodName=public int getVersion
sParams=
sThrows=
tempMethodName=public int getVersion0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public int getVersion
params=
/**
* <P>Returns the version number of this service.</P>
*
* @return version number for service.
*/
public int getVersion()
{
return objectInstance.getVersion();
}
======================================
public int getWorkspacePageNumber()
sMethodName=public int getWorkspacePageNumber
sParams=
sThrows=
tempMethodName=public int getWorkspacePageNumber0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public int getWorkspacePageNumber
params=
/**
* <P>Returns the page number used by this coprocessor for regenerating
* the user authentication. This page is the target page for
* <code>bindSecretToiButton</code> when trying to reproduce a user's
* authentication secret.</P>
*
* @return page number used for regenerating user authentication.
* @see OneWireContainer18#bindSecretToiButton(int,byte[],byte[],int)
*/
public int getWorkspacePageNumber()
{
return objectInstance.getWorkspacePageNumber();
}
======================================
public boolean isDS1961Scompatible()
sMethodName=public boolean isDS1961Scompatible
sParams=
sThrows=
tempMethodName=public boolean isDS1961Scompatible0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public boolean isDS1961Scompatible
params=
/**
* <P>Returns a boolean indicating whether or not this coprocessor's
* secret's were formatted for compatibility with the DS1961S.</P>
*
* @return <code>true</code> if this coprocessor can authenticate a
* DS1961S using it's system authentication secret.
* @see #reformatFor1961S(byte[])
*/
public boolean isDS1961Scompatible()
{
return objectInstance.isDS1961Scompatible();
}
======================================
public boolean createDataSignature(byte[], byte[], byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean createDataSignature
sParams=byte[], byte[], byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean createDataSignature4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public boolean createDataSignature
params=byte[],byte[],byte[],int
/**
* <P>Given a 32-byte array for page data and a 32-byte array for
* scratchpad content, this function will create a 20-byte signature
* for the data based on SHA-1. The format of the calculation of the
* data signature is as follows: First 4-bytes of signing secret,
* 32-bytes of accountData, 12 bytes of scratchpad data starting at
* index 8, last 4-bytes of signing secret, 3 bytes of scratchpad data
* starting at index 20, and the rest is padding as specified for
* standard SHA-1. This is all laid out, in detail, in the DS1963S
* data sheet.</P>
*
* <P>The resulting 20-byte signature is copied into
* <code>mac_buffer</code> starting at <code>macStart</code>. If you're
* updating a signature that already exists in the accountData array,
* it is acceptable to call the method like so:
* <code><pre>
* copr.createDataSignature(accountData, spad, accountData, 8);
* </pre></code>
* assuming that the signature starts at index 8 of the accountData
* array.</p>
*
* @param accountData the 32-byte data page for which the signature is
* generated.
* @param signScratchpad the 32-byte scratchpad contents for which the
* signature is generated. This will contain parameters such
* as the user's write cycle counter for the page, the user's
* 1-wire address, and the page number where account data is
* stored.
* @param mac_buffer used to return the 20-byte signature generated
* by signing the page using the coprocessor's system signing
* secret.
* @param macStart the offset into mac_buffer where copying should start.
* @return <code>true</code> if successful, <code>false</code> if an error
* occurred (use <code>getLastError()</code> for more
* information on the type of error)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see OneWireContainer18#SHAFunction(byte,int)
* @see #getLastError()
*/
public boolean createDataSignature(ByteArray accountData, ByteArray signScratchpad, ByteArray mac_buffer, int macStart)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.createDataSignature(accountData.array, signScratchpad.array, mac_buffer.array, macStart);
}
======================================
public boolean createDataSignatureAuth(byte[], byte[], byte[], int, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean createDataSignatureAuth
sParams=byte[], byte[], byte[], int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean createDataSignatureAuth5
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public boolean createDataSignatureAuth
params=byte[],byte[],byte[],int,byte[]
/**
* <p>Creates a data signature, but instead of using the signing secret,
* it uses the authentication secret, bound for a particular button.</p>
*
* <P>fullBindCode can be null if the secret is already bound and in
* the signing page.</p>
*
* @param accountData the 32-byte data page for which the signature is
* generated.
* @param signScratchpad the 32-byte scratchpad contents for which the
* signature is generated. This will contain parameters such
* as the user's write cycle counter for the page, the user's
* 1-wire address, and the page number where account data is
* stored.
* @param mac_buffer used to return the 20-byte signature generated
* by signing the page using the coprocessor's system signing
* secret.
* @param macStart the offset into mac_buffer where copying should start.
* @param fullBindCode used to recreate the user iButton's unique secret
* @return <code>true</code> if successful, <code>false</code> if an error
* occurred (use <code>getLastError()</code> for more
* information on the type of error)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see OneWireContainer18#SHAFunction(byte,int)
* @see #createDataSignature(byte[],byte[],byte[],int)
* @see #getLastError()
*/
public boolean createDataSignatureAuth(ByteArray accountData, ByteArray signScratchpad, ByteArray mac_buffer, int macStart, ByteArray fullBindCode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.createDataSignatureAuth(accountData.array, signScratchpad.array, mac_buffer.array, macStart, fullBindCode.array);
}
======================================
public synchronized boolean generateChallenge(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean generateChallenge
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean generateChallenge3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public synchronized boolean generateChallenge
params=int,byte[],int
/**
* <p>Generates a 3 byte random challenge in the iButton, sufficient to be used
* as a challenge to be answered by a User iButton. The user answers the challenge
* with an authenticated read of it's account data.</p>
*
* <p>The DS1963S will generate 20 bytes of pseudo random data, though only
* 3 bytes are needed for the challenge. Programs can add more 'randomness'
* by selecting different bytes from the 20 bytes of random data using the
* <code>offset</code> parameter.</p>
*
* <p>The random number generator is actually the DS1963S's SHA engine, which requires
* page data to compute a hash. Select a page number with the <code>page_number</code>
* parameter.</p>
*
* @param offset offset into the 20 random bytes to draw random data from
* (must be in range 0-16)
* @param ch buffer for the challenge to be returned (must be of length 3 or more)
* @param start the starting index into array <code>ch</code> to begin copying
* the challenge bytes.
*
* @return <code>true</code> if successful, <code>false</code> if an error
* occurred (use <code>getLastError()</code> for more
* information on the type of error)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see SHAiButtonUser#readAccountData(byte[],int,byte[],int,byte[],int)
* @see #getLastError()
*/
public synchronized boolean generateChallenge(int offset, ByteArray ch, int start)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.generateChallenge(offset, ch.array, start);
}
======================================
public boolean verifyAuthentication(byte[], byte[], byte[], byte[], byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean verifyAuthentication
sParams=byte[], byte[], byte[], byte[], byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean verifyAuthentication5
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public boolean verifyAuthentication
params=byte[],byte[],byte[],byte[],byte
/**
* <p>Determines if a <code>SHAiButtonUser</code> belongs to the system
* defined by this Coprocessor iButton.See the usage example in this
* class for initializing a Coprocessor iButton.</p>
*
* <p>The first step in user authentication is to recreate the user's
* unique secret on the coprocessor button using
* <code>bindSecretToiButton(int,byte[],byte[],int)</code>. Then the
* coprocessor signs the pageData to produce a MAC. If the MAC matches
* that produced by the user, the user belongs to the system.</p>
*
* <p>The TMEX formatted page with the user's account data is in the
* 32-byte parameter <code>pageData</code>. If the verification
* is successful, the data data signature must still be verified with
* the <code>verifySignature()</code> method.</p>
*
* <p>Failure of this method does not necessarily mean that
* the User iButton does not belong to the system. It is possible that
* a communication disruption here could cause a CRC error that
* would be indistinguishable from a failed authentication. However,
* repeated attempts should reveal whether it was truly a communication
* problem or a User iButton that does not belong to the system.</p>
*
* @param fullBindCode 15-byte binding code used to recreate user iButtons
* unique secret in the coprocessor.
* @param pageData 32-byte buffer containing the data page holding the user's
* account data.
* @param scratchpad the 32-byte scratchpad contents for which the
* signature is generated. This will contain parameters such
* as the user's write cycle counter for the page, the user's
* 1-wire address, and the page number where account data is
* stored.
* @param verify_mac the 20-byte buffer containing the user's authentication
* response to the coprocessor's challenge.
*
* @return <code>true</code> if the operation was successful and the user's
* MAC matches that generated by the coprocessor.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #generateChallenge(int,byte[],int)
* @see #verifySignature(byte[],byte[],byte[])
* @see OneWireContainer18#bindSecretToiButton(int,byte[],byte[],int)
* @see OneWireContainer18#SHAFunction(byte,int)
* @see OneWireContainer18#matchScratchPad(byte[])
* @see #getLastError()
*/
public boolean verifyAuthentication(ByteArray fullBindCode, ByteArray pageData, ByteArray scratchpad, ByteArray verify_mac, byte authCmd)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.verifyAuthentication(fullBindCode.array, pageData.array, scratchpad.array, verify_mac.array, authCmd);
}
======================================
public boolean verifySignature(byte[], byte[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean verifySignature
sParams=byte[], byte[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean verifySignature3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public boolean verifySignature
params=byte[],byte[],byte[]
/**
* <P>Verifies a User iButton's signed data on this Coprocessor iButton.
* The Coprocessor must recreate the signature based on the data in the
* file and the contents of the given scratchpad, and then match that
* with the signature passed in verify_mac.</P>
*
* @param pageData the full 32 byte TMEX file from the User iButton
* (from <code>verifyAuthentication</code>) with the
* @param scratchpad the 32-byte scratchpad contents for which the
* signature is generated. This will contain parameters such
* as the user's write cycle counter for the page, the user's
* 1-wire address, and the page number where account data is
* stored.
* @param verify_mac the 20-byte buffer containing the signature the user
* had stored with the account data file.
*
* @return <code>true<code> if the data file is valid, <code>false</code>
* if an error occurred (use <code>getLastError()</code> for more
* information on the type of error)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #verifyAuthentication(byte[],byte[],byte[],byte[],byte)
* @see #getLastError()
*/
public boolean verifySignature(ByteArray pageData, ByteArray scratchpad, ByteArray verify_mac)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.verifySignature(pageData.array, scratchpad.array, verify_mac.array);
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public java.lang.String toString
params=
/**
* Returns a string representing the 1-Wire address of this SHAiButton.
*
* @return a string containing the 8-byte address of this 1-Wire device.
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
======================================
public static byte reformatFor1961S(byte[])[]
sMethodName=public static byte reformatFor1961S
sParams=byte[]
sThrows=
tempMethodName=public static ByteArray reformatFor1961S1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCopr
methodName=public static byte[] reformatFor1961S
params=byte[]
/**
* <P>Static method that reformats the inputted authentication secret
* so it is compatible with the DS1961S. This means that for every
* group of 47 bytes in the secret, bytes at indices 32-35 and indices
* 44-46 are all set to 0xFF. Check the format for secret generation
* in the DS1961S data sheet to verify format of digest buffer.</P>
*
* <P>Note that if a coprocessor button uses this formatted secret,
* this function should be called for all user buttons including the
* DS1963S and DS1961S to ensure compatibility</P>
*
* @param auth_secret the authentication secret to be reformatted.
*
* @return a reformatted authentication secret, with the appropriate
* padding for DS1961S interaction.
*/
public ByteArray reformatFor1961S(ByteArray auth_secret)
{
return new ByteArray().setupObject(com.dalsemi.onewire.application.sha.SHAiButtonCopr.reformatFor1961S(auth_secret.array));
}
-------------------------------------------------------------------
creating: owapi\SHAiButtonCoprVM.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
sParams=byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromContainer16
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public void createNewInstance
params=byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[]
/**
* <P>Sets up this simulated coprocessor based on the provided parameters.
* Then, the system secret and authentication secret are installed on the
* simulated coprocessor iButton.</P>
*
* <P>For the proper format of the coprocessor data file, see the
* document entitled "Implementing Secured D-Identification and E-Payment
* Applications using SHA iButtons". For the format of TMEX file
* structures, see Application Note 114.</P>
*
* @param RomID The address for the simulated coprocessor.
* @param l_signPageNumber page number used for signing user account data.
* (Should be page 8, but page 0 is acceptable if you don't need
* the TMEX directory structure)
* @param l_authPageNumber page number used for recreating user secret.
* @param l_wspcPageNumber page number used for storing user secret and
* recreating authentication MAC.
* @param l_version version of the service provided by this coprocessor.
* @param l_encCode refers to a type of encryption used for user account
* data stored on user buttons.
* @param l_serviceFileExt the file extension used for the service file.
* (An extension of decimal 102 is reserved for Money files).
* @param l_serviceFilename the 4-byte name of the user's account data
* file.
* @param l_providerName the name of the provider of this service
* @param l_bindData the binding data used to finalize secret installation
* on user buttons.
* @param l_bindCode the binding code used to finalize secret installation
* on user buttons.
* @param l_auxData any auxilliary or miscellaneous data to be stored on
* the coprocessor.
* @param l_initialSignature the 20-byte initial MAC placed in user account
* data before generating actual MAC.
* @param l_signingChlg the 3-byte challenge used for signing user
* account data.
* @param l_signingSecret the system signing secret used by the
* service being installed on this coprocessor.
* @param l_authSecret the system authentication secret used by the
* service being installed on this coprocessor.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCoprVM(String)
* @see #SHAiButtonCoprVM(String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer,String)
* @see #SHAiButtonCoprVM(OneWireContainer,String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer18,String,byte[],byte[])
*/
public void createNewInstanceFromContainer(ByteArray RomID, int l_signPageNumber, int l_authPageNumber, int l_wspcPageNumber, int l_version, int l_encCode, byte l_serviceFileExt, ByteArray l_serviceFilename, ByteArray l_providerName, ByteArray l_bindData, ByteArray l_signPageNumber0, ByteArray l_signPageNumber1, ByteArray l_signPageNumber2, ByteArray l_signPageNumber3, ByteArray l_signPageNumber4, ByteArray l_signPageNumber5)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(RomID.array, l_signPageNumber, l_authPageNumber, l_wspcPageNumber, l_version, l_encCode, l_serviceFileExt, l_serviceFilename.array, l_providerName.array, l_bindData.array, l_signPageNumber0.array, l_signPageNumber1.array, l_signPageNumber2.array, l_signPageNumber3.array, l_signPageNumber4.array, l_signPageNumber5.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromContainer1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public void createNewInstance
params=java.lang.String
/**
* <p>Loads a simulated DS1963S coprocessor device from disk. The given
* file name is loaded to get all the parameters of the coprocessor.
* It is assumed that the secrets were stored in the file when
* the simulated coprocessor's data was saved to disk.</p>
*
* @param filename The filename of the simulated coprocessor's data file ("shaCopr.dat")
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCoprVM(String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer,String)
* @see #SHAiButtonCoprVM(OneWireContainer,String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer18,String,byte[],byte[])
* @see #SHAiButtonCoprVM(byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[])
*
*/
public void createNewInstanceFromContainer(java.lang.String filename)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(filename);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(java.lang.String,byte[],byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
sParams=java.lang.String,byte[],byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromContainer3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public void createNewInstance
params=java.lang.String,byte[],byte[]
/**
* <p>Loads a simulated DS1963S coprocessor device from disk. The given
* file name is loaded to get all the parameters of the coprocessor.
* After it is loaded, the given secrets are installed.</p>
*
* @param filename The filename of the simulated coprocessor's data file ("shaCopr.dat")
* @param sign_secret The system data signing secret.
* @param auth_secret The system device authentication secret.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCoprVM(String)
* @see #SHAiButtonCoprVM(OneWireContainer,String)
* @see #SHAiButtonCoprVM(OneWireContainer,String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer18,String,byte[],byte[])
* @see #SHAiButtonCoprVM(byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[])
*/
public void createNewInstanceFromContainer(java.lang.String filename, ByteArray sign_secret, ByteArray auth_secret)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(filename, sign_secret.array, auth_secret.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(com.dalsemi.onewire.container.OneWireContainer,java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
sParams=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromContainer2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
/**
* <p>Loads a simulated DS1963S coprocessor device from any 1-Wire memory device
* supported by the 1-Wire File I/O API. The given file name is loaded to get
* all the parameters of the coprocessor. It is assumed that the secrets were
* stored in the file when the simulated coprocessor's data was saved to disk.</p>
*
* @param owc 1-Wire memory device with valid TMEX file system
* @param filename The filename of the simulated coprocessor's data file ("shaCopr.dat")
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCoprVM(String)
* @see #SHAiButtonCoprVM(String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer,String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer18,String,byte[],byte[])
* @see #SHAiButtonCoprVM(byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[])
*/
public void createNewInstanceFromContainer(OneWireContainer owc, java.lang.String filename)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance), filename);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(com.dalsemi.onewire.container.OneWireContainer,java.lang.String,byte[],byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
sParams=com.dalsemi.onewire.container.OneWireContainer,java.lang.String,byte[],byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromContainer4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String,byte[],byte[]
/**
* <p>Loads a simulated DS1963S coprocessor device from any 1-Wire
* memory device supported by the 1-Wire File I/O API. The given
* file name is loaded to get all the parameters of the coprocessor.
* After it is loaded, the given secrets are installed.</p>
*
* @param owc 1-Wire memory device with valid TMEX file system
* @param filename The filename of the simulated coprocessor's data file ("shaCopr.dat")
* @param sign_secret The system data signing secret.
* @param auth_secret The system device authentication secret.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCoprVM(String)
* @see #SHAiButtonCoprVM(String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer,String)
* @see #SHAiButtonCoprVM(OneWireContainer18,String,byte[],byte[])
* @see #SHAiButtonCoprVM(byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[])
*/
public void createNewInstanceFromContainer(OneWireContainer owc, java.lang.String filename, ByteArray sign_secret, ByteArray auth_secret)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance), filename, sign_secret.array, auth_secret.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(com.dalsemi.onewire.container.OneWireContainer18,java.lang.String,byte[],byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
sParams=com.dalsemi.onewire.container.OneWireContainer18,java.lang.String,byte[],byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstance4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer18,java.lang.String,byte[],byte[]
/**
* <p>Simulates a specific DS1963S coprocessor device. First, the given
* TMEX file name is loaded of the container to get all the parameters of
* the coprocessor. Then (since secrets are not readable off the iButton,
* they must be provided) the secrets are installed on the virtual
* coprocessor.</p>
*
* @param owc The coprocessor button this VM will simulate.
* @param filename The TMEX filename of the coprocessor service file ("COPR.0")
* @param sign_secret The system data signing secret.
* @param auth_secret The system device authentication secret.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonCoprVM(String)
* @see #SHAiButtonCoprVM(String,byte[],byte[])
* @see #SHAiButtonCoprVM(OneWireContainer,String)
* @see #SHAiButtonCoprVM(OneWireContainer,String,byte[],byte[])
* @see #SHAiButtonCoprVM(byte[],int,int,int,int,int,byte,byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[],byte[])
*/
public void createNewInstance(OneWireContainer18 owc, java.lang.String filename, ByteArray sign_secret, ByteArray auth_secret)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonCoprVM(((com.dalsemi.onewire.container.OneWireContainer18)owc.objectInstance), filename, sign_secret.array, auth_secret.array);
}
======================================
public boolean save(java.lang.String, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean save
sParams=java.lang.String, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean save2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public boolean save
params=java.lang.String,boolean
/**
* <p>Saves simulated coprocessor configuration info to an (almost)
* standard-format to a hard drive file.</p>
*
* @param filename The filename of the simulated coprocessor's data
* file ("shaCopr.dat")
* @param saveSecretData If <code>true</true>, the raw secret information
* is also written to the file
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @return <code>true</code> if the info was successfully saved
*/
public boolean save(java.lang.String filename, boolean saveSecretData)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonCoprVM)objectInstance).save(filename, saveSecretData);
}
======================================
public boolean save(com.dalsemi.onewire.container.OneWireContainer, java.lang.String, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean save
sParams=com.dalsemi.onewire.container.OneWireContainer, java.lang.String, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean save3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public boolean save
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String,boolean
/**
* <p>Saves simulated coprocessor configuration info to an (almost)
* standard-format to a 1-Wire Memory Device's TMEX file.</p>
*
* @param owc 1-Wire Memory Device with valid TMEX file structure.
* @param filename The TMEX filename of the simulated coprocessor's data
* file ("COPR.2")
* @param saveSecretData If <code>true</true>, the raw secret information
* is also written to the file.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @return <code>true</code> if the info was successfully saved
*/
public boolean save(OneWireContainer owc, java.lang.String filename, boolean saveSecretData)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonCoprVM)objectInstance).save(((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance), filename, saveSecretData);
}
======================================
public boolean load(java.lang.String)
sMethodName=public boolean load
sParams=java.lang.String
sThrows=
tempMethodName=public boolean loadFromContainer1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public boolean load
params=java.lang.String
/**
* <p>Loads coprocessor configuration information from an (almost) standard
* service file on hard drive. If secret information was saved, this routine
* automatically loads it.</P>
*
* @param filename The filename of the simulated coprocessor's data
* file ("shaCopr.dat")
*
* @return <code>true</code> if the info was successfully loaded
*/
public boolean loadFromContainer(java.lang.String filename)
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonCoprVM)objectInstance).load(filename);
}
======================================
public boolean load(com.dalsemi.onewire.container.OneWireContainer, java.lang.String)
sMethodName=public boolean load
sParams=com.dalsemi.onewire.container.OneWireContainer, java.lang.String
sThrows=
tempMethodName=public boolean loadFromContainer2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public boolean load
params=com.dalsemi.onewire.container.OneWireContainer,java.lang.String
/**
* <p>Loads coprocessor configuration information from an (almost) standard
* service TMEX file on 1-Wire memory device. If secret information was saved,
* this routine automatically loads it.</P>
*
* @param owc 1-Wire memory device with valid TMEX file structure
* @param filename The TMEX filename of the simulated coprocessor's data
* file ("COPR.2")
*
* @return <code>true</code> if the info was successfully loaded
*/
public boolean loadFromContainer(OneWireContainer owc, java.lang.String filename)
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonCoprVM)objectInstance).load(((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance), filename);
}
======================================
public boolean load(com.dalsemi.onewire.container.OneWireContainer18, java.lang.String)
sMethodName=public boolean load
sParams=com.dalsemi.onewire.container.OneWireContainer18, java.lang.String
sThrows=
tempMethodName=public boolean load2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public boolean load
params=com.dalsemi.onewire.container.OneWireContainer18,java.lang.String
/**
* <p>Loads coprocessor configuration information from a standard TMEX
* service file on a DS1963S.</P>
*
* @param owc DS1963S set up as a valid coprocessor
* @param filename The TMEX filename of the coprocessor's data
* file ("COPR.0")
*
* @return <code>true</code> if the info was successfully loaded
*/
public boolean load(OneWireContainer18 owc, java.lang.String filename)
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonCoprVM)objectInstance).load(((com.dalsemi.onewire.container.OneWireContainer18)owc.objectInstance), filename);
}
======================================
public synchronized boolean bindSecretToiButton(int, byte[], byte[], int)
sMethodName=public synchronized boolean bindSecretToiButton
sParams=int, byte[], byte[], int
sThrows=
tempMethodName=public synchronized boolean bindSecretToiButton4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public synchronized boolean bindSecretToiButton
params=int,byte[],byte[],int
/**
* <p>Binds an installed secret to this virtual DS1963S by using
* well-known binding data and this DS1963S's (unique?)
* address. This makes the secret unique
* for this iButton. Coprocessor iButtons use this method
* to recreate the iButton's secret to verify authentication.
* Roving iButtons use this method to finalize their secret keys.</p>
*
* <p>Note that unlike in the <code>installMasterSecret()</code> method,
* the page number does not need to be equivalent to the <code>secret_number</code>
* modulo 8. The new secret (installed secret + binding code) is generated
* from this page but can be copied into another secret. User iButtons should
* bind to the same page the secret was installed on. Coprocessor iButtons
* must copy to a new secret to preserve the general system authentication
* secret.</p>
*
* <p>The binding should be either 7 bytes long or 15 bytes long.
* A 15-length <code>byte</code> array is unaltered and placed in the scratchpad
* for the binding. A 7-length <code>byte</code> array is combined with the page
* number and DS1963S unique address and then placed in the scratchpad.
* Coprocessors should use a pre-formatted 15-length <code>byte</code> array.
* User iButtons should let the method format for them (i.e.
* use the 7-length <code>byte</code> array option).</p>
*
* @param page the page number that has the master secret already installed
* @param bind_data 32 bytes of binding data used to bind the iButton to the system
* @param bind_code the 7-byte or 15-byte binding code
* @param secret_number secret number to copy the resulting secret to
*
* @return <code>true</code> if successful
*
* @see #installMasterSecret(int,byte[],int)
*/
public synchronized boolean bindSecretToiButton(int pageNum, ByteArray bindData, ByteArray bindCode, int secretNum)
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonCoprVM)objectInstance).bindSecretToiButton(pageNum, bindData.array, bindCode.array, secretNum);
}
======================================
public boolean installMasterSecret(int, byte[], int)
sMethodName=public boolean installMasterSecret
sParams=int, byte[], int
sThrows=
tempMethodName=public boolean installMasterSecret3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonCoprVM
methodName=public boolean installMasterSecret
params=int,byte[],int
/**
* <p>Installs a secret on this virtual DS1963S. The secret is written in partial phrases
* of 47 bytes (32 bytes to a memory page, 15 bytes to the scratchpad) and
* is cumulative until the entire secret is processed. Secrets are associated
* with a page number. See the datasheet for more information on this
* association.</p>
*
* <p>In most cases, <code>page</code> should be equal to <code>secret_number</code>
* or <code>secret_number+8</code>, based on the association of secrets and page numbers.
* A secret is 8 bytes and there are 8 secrets. These 8 secrets are associated with the
* first 16 pages of memory.</p>
*
* <p>On TINI, this method will be slightly faster if the secret's length is divisible by 47.
* However, since secret key generation is a part of initialization, it is probably
* not necessary.</p>
*
* @param page the page number used to write the partial secrets to
* @param secret the entire secret to be installed
* @param secret_number the secret 'page' to use (0 - 7)
*
* @return <code>true</code> if successful
*
* @see #bindSecretToiButton(int,byte[],byte[],int)
*/
public boolean installMasterSecret(int pageNum, ByteArray secret, int secretNum)
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonCoprVM)objectInstance).installMasterSecret(pageNum, secret.array, secretNum);
}
-------------------------------------------------------------------
creating: owapi\SHAiButtonUser.java
======================================
public int getAccountPageNumber()
sMethodName=public int getAccountPageNumber
sParams=
sThrows=
tempMethodName=public int getAccountPageNumber0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public int getAccountPageNumber
params=
/**
* <P>Returns the page number of the first memory page where account
* data is stored.</P>
*
* @return page number where account data is stored.
*/
public int getAccountPageNumber()
{
return objectInstance.getAccountPageNumber();
}
======================================
public java.lang.String getAccountFilename()
sMethodName=public java.lang.String getAccountFilename
sParams=
sThrows=
tempMethodName=public java.lang.String getAccountFilename0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public java.lang.String getAccountFilename
params=
/**
* <P>Returns the TMEX filename of the user's account data file.</P>
*
* @return filename of user's account data file
*/
public java.lang.String getAccountFilename()
{
return objectInstance.getAccountFilename();
}
======================================
public byte getAddress()[]
sMethodName=public byte getAddress
sParams=
sThrows=
tempMethodName=public ByteArray getAddress0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public byte[] getAddress
params=
/**
*<P>Returns the 8 byte address of the OneWireContainer this
* SHAiButton refers to.</P>
*
* @return 8 byte array containing family code, address, and
* crc8 of the OneWire device.
*/
public ByteArray getAddress()
{
return new ByteArray().setupObject(objectInstance.getAddress());
}
======================================
public void getAddress(byte[], int)
sMethodName=public void getAddress
sParams=byte[], int
sThrows=
tempMethodName=public void getAddress2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public void getAddress
params=byte[],int
/**
* <P>Copies the 8 byte address of the OneWireContainer into
* the provided array starting at the given offset.</P>
*
* @param data array with at least 8 bytes after offset
* @param offset the index at which copying starts
*/
public void getAddress(ByteArray data, int offset)
{
objectInstance.getAddress(data.array, offset);
}
======================================
public void getAddress(byte[], int, int)
sMethodName=public void getAddress
sParams=byte[], int, int
sThrows=
tempMethodName=public void getAddress3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public void getAddress
params=byte[],int,int
/**
* <P>Copies the specified number of bytes from the address
* of the OneWireContainer into the provided array starting
* at the given offset.</P>
*
* @param data array with at least cnt bytes after offset
* @param offset the index at which copying starts
* @param cnt the number of bytes to copy
*/
public void getAddress(ByteArray data, int offset, int cnt)
{
objectInstance.getAddress(data.array, offset, cnt);
}
======================================
public void setForceOverdrive(boolean)
sMethodName=public void setForceOverdrive
sParams=boolean
sThrows=
tempMethodName=public void setForceOverdrive1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public void setForceOverdrive
params=boolean
/**
* Sets whether or not the container should be forced into
* overdrive.
*
* @param value if true, the container will be forced to overdrive
*/
public void setForceOverdrive(boolean value)
{
objectInstance.setForceOverdrive(value);
}
======================================
public boolean getForceOverdrive()
sMethodName=public boolean getForceOverdrive
sParams=
sThrows=
tempMethodName=public boolean getForceOverdrive0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public boolean getForceOverdrive
params=
/**
* Reports whether or not the container is forced into
* overdrive.
*
* @return if true, the container will be forced to overdrive
*/
public boolean getForceOverdrive()
{
return objectInstance.getForceOverdrive();
}
======================================
public boolean setiButtonUser(com.dalsemi.onewire.adapter.DSPortAdapter, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean setiButtonUser
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean setiButtonUser2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public boolean setiButtonUser
params=com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
/**
* <P>Modifies this SHA iButton so that it refers to another device.
* If this object already has an appropriate instance of OneWireContainer,
* that instance is updated with the new address.</P>
*
* @param adapter The adapter that the device can be found on.
* @param address The address of the 1-Wire device
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer18</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean setiButtonUser(DSPortAdapter adapter, ByteArray address)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.setiButtonUser(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), address.array);
}
======================================
public boolean setiButtonUser(byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean setiButtonUser
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean setiButtonUser1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public boolean setiButtonUser
params=byte[]
/**
* <P>Modifies this SHA iButton so that it refers to another device.
* If this object already has an appropriate instance of OneWireContainer,
* that instance is updated with the new address.</P>
*
* @param adapter The adapter that the device can be found on.
* @param address The address of the 1-Wire device
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer18</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean setiButtonUser(ByteArray adapter)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.setiButtonUser(adapter.array);
}
======================================
public int getWriteCycleCounter() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getWriteCycleCounter
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getWriteCycleCounter0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public int getWriteCycleCounter
params=
/**
* <P>Returns the value of the write cycle counter for the
* page where the account data is stored. If the write
* cycle counter has ever been retrieved, this returns the
* cached value. Otherwise, this method reads the value
* from the part.</P>
*
* <P>For devices that do not support write cycle counters,
* this method always returns -1.</P>
*
* @return the value of the write cycle counter for the
* account data page.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public int getWriteCycleCounter()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.getWriteCycleCounter();
}
======================================
public boolean hasWriteCycleCounter()
sMethodName=public boolean hasWriteCycleCounter
sParams=
sThrows=
tempMethodName=public boolean hasWriteCycleCounter0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public boolean hasWriteCycleCounter
params=
/**
* <P>Returns <code>true</code> if this buttons account data is stored
* on a page that has a write cycle counter.</P>
*
* @return <code>true</code> if account page has write cycle counter.
*/
public boolean hasWriteCycleCounter()
{
return objectInstance.hasWriteCycleCounter();
}
======================================
public void getFullBindCode(byte[], int)
sMethodName=public void getFullBindCode
sParams=byte[], int
sThrows=
tempMethodName=public void getFullBindCode2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public void getFullBindCode
params=byte[],int
/**
* <P>This function creates the full 15-byte binding data for the
* coprocessor to use to recreate this user's secret on the copr's
* workspace page. This function is located in the SHAiButtonUser
* class to support binding codes for user buttons who use alternate
* techniques (such as the DS1961S) for secret computation.</P>
*
* @param bindCode the 7-byte binding code from coprocessor's service file
* @param fullBindCode the 15-byte full binding code to to be copied into
* the coprocessor's scratchpad. There should be 15
* bytes available starting from the offset.
* @param offset the offset into fullBindCode where copying should begin.
*
*/
public void getFullBindCode(ByteArray l_fullBindCode, int offset)
{
objectInstance.getFullBindCode(l_fullBindCode.array, offset);
}
======================================
public byte getAuthorizationCommand()
sMethodName=public byte getAuthorizationCommand
sParams=
sThrows=
tempMethodName=public byte getAuthorizationCommand0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public byte getAuthorizationCommand
params=
/**
* <P>Returns a byte representing the appropriate authorization command
* for the coprocessor to use to authenticate this user. For a DS1961S,
* the authentication command is AUTH_HOST, but for a DS1963S, the
* authentication command is VALIDATE_PAGE.</P>
*
* @return byte indicating appropriate command for authenticating user
*
*/
public byte getAuthorizationCommand()
{
return objectInstance.getAuthorizationCommand();
}
======================================
public boolean writeAccountData(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean writeAccountData
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean writeAccountData2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public boolean writeAccountData
params=byte[],int
/**
* <P>Writes the account data to the SHAiButton. First, this function
* asserts that the account page number is known. The account data is
* copied from dataBuffer starting at the offset. If there are less
* than 32 bytes available to copy, this function only copies the bytes
* that are available.</P>
*
* @param dataBuffer the buffer to copy the account data from
* @param offset the index into the buffer where copying should begin
* @return whether or not the data write succeeded
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean writeAccountData(ByteArray dataBuffer, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.writeAccountData(dataBuffer.array, offset);
}
======================================
public boolean readAccountData(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean readAccountData
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean readAccountData2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public boolean readAccountData
params=byte[],int
/**
* <P>Reads the account data off the SHAiButton using a standard READ
* command. First, this function asserts that the account page number is
* known as well as the length of the account file. The 32 byte account
* data page is copied into dataBuffer starting at the given offset.</P>
*
* @param dataBuffer the buffer to copy the account data into
* @param offset the index into the buffer where copying should begin
* @return whether or not the read was successful
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean readAccountData(ByteArray dataBuffer, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.readAccountData(dataBuffer.array, offset);
}
======================================
public int readAccountData(byte[], int, byte[], int, byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int readAccountData
sParams=byte[], int, byte[], int, byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int readAccountData6
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public int readAccountData
params=byte[],int,byte[],int,byte[],int
/**
* <P>Reads the account data off the SHAiButton using a READ_AUTHENTICATE
* command. First, this function asserts that the account page number is
* known as well as the length of the account file. Then it copies the
* 3 byte challenge to the scratchpad before sending the command for
* READ_AUTHENTICATE. The 32 byte account data page is copied into
* dataBuffer starting at dataStart.</P>
*
* <P>In addition to the account data, this function also returns a
* calculated MAC. The MAC requires 20 bytes after the start index.
* The return value is the write cycle counter value for the account
* data page<p>
*
* @param chlg the buffer containing a 3-byte random challenge.
* @param chlgStart the index into the buffer where the 3 byte
* challenge begins.
* @param dataBuffer the buffer to copy the account data into
* @param dataStart the index into the buffer where copying should begin
* @param mac the buffer to copy the resulting Message Authentication Code
* @param macStart the index into the mac buffer to start copying
*
* @return the value of the write cycle counter for the page
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public int readAccountData(ByteArray chlg, int chlgStart, ByteArray dataBuffer, int dataStart, ByteArray mac, int macStart)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.readAccountData(chlg.array, chlgStart, dataBuffer.array, dataStart, mac.array, macStart);
}
======================================
public boolean refreshDevice() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean refreshDevice
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean refreshDevice0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public boolean refreshDevice
params=
/**
* Refreshes eeprom SHA devices in case of weakly-programmed bits on
* the account page.
*
* @return true if the refresh was successful
*/
public boolean refreshDevice()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.refreshDevice();
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser
methodName=public java.lang.String toString
params=
/**
* <P>Returns a string representing this SHAiButton.</P>
*
* @return a string containing the 8-byte address of this 1-Wire device.
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
-------------------------------------------------------------------
creating: owapi\SHAiButtonUser18.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser18(com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer18,boolean,byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser18
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer18,boolean,byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstance4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer18,boolean,byte[]
/**
* <P>Initialize a DS1963S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* @param copr The SHAiButtonCopr to which the user object is tied. This
* Coprocessor contains the necessary binding code and service
* filename, necessary for both locating a user and recreating his
* unique secret.
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser18(SHAiButtonCopr,OneWireContainer18)
* @see #SHAiButtonUser18(SHAiButtonCopr)
*/
public void createNewInstance(SHAiButtonCopr copr, OneWireContainer18 owc, boolean formatDevice, ByteArray authSecret)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser18(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), ((com.dalsemi.onewire.container.OneWireContainer18)owc.objectInstance), formatDevice, authSecret.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser18(byte[],byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer18,boolean,byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser18
sParams=byte[],byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer18,boolean,byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromCoprocessor7
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public void createNewInstance
params=byte[],byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer18,boolean,byte[]
/**
* <P>Initialize a DS1963S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* @param coprBindData The Coprocessor Bind Data, used to create a unique
* secret for this user token.
* @param coprBindCode The Coprocessor Bind Code without the user-specific
* information, used to create a unique secret for this user token.
* @param fileName The file name for the account info.
* @param fileNameExt The file extenstion for the account info
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser18(SHAiButtonCopr,OneWireContainer18)
* @see #SHAiButtonUser18(SHAiButtonCopr)
*/
public void createNewInstanceFromCoprocessor(ByteArray coprBindData, ByteArray coprBindCode, ByteArray fileName, int fileNameExt, OneWireContainer18 owc, boolean formatDevice, ByteArray authSecret)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser18(coprBindData.array, coprBindCode.array, fileName.array, fileNameExt, ((com.dalsemi.onewire.container.OneWireContainer18)owc.objectInstance), formatDevice, authSecret.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser18(com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer18) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser18
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer18
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer18
/**
* <P>Initialize a DS1963S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* @param copr The SHAiButtonCopr to which the user object is tied. This
* Coprocessor contains the necessary binding code and service
* filename, necessary for both locating a user and recreating his
* unique secret.
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser18(SHAiButtonCopr,OneWireContainer18)
* @see #SHAiButtonUser18(SHAiButtonCopr)
*/
public void createNewInstance(SHAiButtonCopr copr, OneWireContainer18 owc)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser18(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), ((com.dalsemi.onewire.container.OneWireContainer18)owc.objectInstance));
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser18(byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer18) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser18
sParams=byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer18
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromCoprocessor4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public void createNewInstance
params=byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer18
/**
* <P>Initialize a DS1963S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* @param coprBindData The Coprocessor Bind Data, used to create a unique
* secret for this user token.
* @param coprBindCode The Coprocessor Bind Code without the user-specific
* information, used to create a unique secret for this user token.
* @param fileName The file name for the account info.
* @param fileNameExt The file extenstion for the account info
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser18(SHAiButtonCopr,OneWireContainer18)
* @see #SHAiButtonUser18(SHAiButtonCopr)
*/
public void createNewInstanceFromCoprocessor(ByteArray coprBindData, ByteArray coprBindCode, int fileName, OneWireContainer18 fileNameExt)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser18(coprBindData.array, coprBindCode.array, fileName, ((com.dalsemi.onewire.container.OneWireContainer18)fileNameExt.objectInstance));
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser18(com.dalsemi.onewire.application.sha.SHAiButtonCopr)
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser18
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr
/**
* <P>Initialize a DS1963S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* @param copr The SHAiButtonCopr to which the user object is tied. This
* Coprocessor contains the necessary binding code and service
* filename, necessary for both locating a user and recreating his
* unique secret.
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser18(SHAiButtonCopr,OneWireContainer18)
* @see #SHAiButtonUser18(SHAiButtonCopr)
*/
public void createNewInstance(SHAiButtonCopr copr)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser18(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance));
}
======================================
public synchronized boolean setiButton18(com.dalsemi.onewire.container.OneWireContainer18) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean setiButton18
sParams=com.dalsemi.onewire.container.OneWireContainer18
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean setiButton18FromCoprocessor1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized boolean setiButton18
params=com.dalsemi.onewire.container.OneWireContainer18
/**
* <P>Modifies this SHA iButton so that it refers to another DS1963S
* container. This function only copies the reference to the
* OneWireContainer, copes the reference to it's 1-Wire address, and
* then asserts that the iButton contains a valid acccount info file
* associated with the system.</P>
*
* @param owc The <code>OneWireContainer18</code> this object will refer to.
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer18</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean setiButton18FromCoprocessor(OneWireContainer18 owc)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).setiButton18(((com.dalsemi.onewire.container.OneWireContainer18)owc.objectInstance));
}
======================================
public synchronized boolean setiButtonUser(com.dalsemi.onewire.adapter.DSPortAdapter, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean setiButtonUser
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean setiButtonUserFromCoprocessor2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized boolean setiButtonUser
params=com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
/**
* <P>Modifies this SHA iButton so that it refers to another 1963S.
* If this object already has an appropriate instance of OneWireContainer,
* that instance is updated with the new address.</P>
*
* @param adapter The adapter that the device can be found on.
* @param address The address of the 1-Wire device
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer18</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean setiButtonUserFromCoprocessor(DSPortAdapter adapter, ByteArray address)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).setiButtonUser(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), address.array);
}
======================================
public synchronized boolean setiButtonUser(byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean setiButtonUser
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean setiButtonUserFromCoprocessor1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized boolean setiButtonUser
params=byte[]
/**
* <P>Modifies this SHA iButton so that it refers to another 1963S.
* If this object already has an appropriate instance of OneWireContainer,
* that instance is updated with the new address.</P>
*
* @param adapter The adapter that the device can be found on.
* @param address The address of the 1-Wire device
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer18</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean setiButtonUserFromCoprocessor(ByteArray adapter)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).setiButtonUser(adapter.array);
}
======================================
public synchronized int getWriteCycleCounter() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized int getWriteCycleCounter
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized int getWriteCycleCounter0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized int getWriteCycleCounter
params=
/**
* <P>Returns the value of the write cycle counter for the
* page where the account data is stored. If the write
* cycle counter has ever been retrieved, this returns the
* cached value. Otherwise, this method reads the value
* from the part.</P>
*
* @return the value of the write cycle counter for the
* account data page.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized int getWriteCycleCounter()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).getWriteCycleCounter();
}
======================================
public synchronized boolean hasWriteCycleCounter()
sMethodName=public synchronized boolean hasWriteCycleCounter
sParams=
sThrows=
tempMethodName=public synchronized boolean hasWriteCycleCounter0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized boolean hasWriteCycleCounter
params=
/**
* Returns <code>true</code> if this buttons account data is stored
* on a page that has a write cycle counter.
*
* @return <code>true</code> if account page has write cycle counter.
*/
public synchronized boolean hasWriteCycleCounter()
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).hasWriteCycleCounter();
}
======================================
public synchronized boolean writeAccountData(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean writeAccountData
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean writeAccountDataFromCoprocessor2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized boolean writeAccountData
params=byte[],int
/**
* <P>Writes the account data to the SHAiButton. First, this function
* asserts that the account page number is known. The account data is
* copied from dataBuffer starting at the offset. If there are less
* than 32 bytes available to copy, this function only copies the bytes
* that are available.</P>
*
* @param dataBuffer the buffer to copy the account data from
* @param offset the index into the buffer where copying should begin
* @return whether or not the data write succeeded
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean writeAccountDataFromCoprocessor(ByteArray dataBuffer, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).writeAccountData(dataBuffer.array, offset);
}
======================================
public synchronized boolean readAccountData(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean readAccountData
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean readAccountDataFromCoprocessor2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized boolean readAccountData
params=byte[],int
/**
* <P>Reads the account data off the SHAiButton using a standard READ
* command. First, this function asserts that the account page number is
* known as well as the length of the account file. The 32 byte account
* data page is copied into dataBuffer starting at the given offset.</P>
*
* @param dataBuffer the buffer to copy the account data into
* @param offset the index into the buffer where copying should begin
*
* @return whether or not the read was successful
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean readAccountDataFromCoprocessor(ByteArray dataBuffer, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).readAccountData(dataBuffer.array, offset);
}
======================================
public synchronized int readAccountData(byte[], int, byte[], int, byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized int readAccountData
sParams=byte[], int, byte[], int, byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized int readAccountDataFromCoprocessor6
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser18
methodName=public synchronized int readAccountData
params=byte[],int,byte[],int,byte[],int
/**
* <P>Reads the account data off the SHAiButton using a READ_AUTHENTICATE
* command. First, this function asserts that the account page number is
* known as well as the length of the account file. Then it copies the
* 3 byte challenge to the scratchpad before sending the command for
* READ_AUTHENTICATE. The 32 byte account data page is copied into
* dataBuffer starting at dataStart.</P>
*
* <P>In addition to the account data, this function also returns a
* calculated MAC. The MAC requires 20 bytes after the start index.
* The return value is the write cycle counter value for the account
* data page<p>
*
* @param chlg the buffer containing a 3-byte random challenge.
* @param chlgStart the index into the buffer where the 3 byte
* challenge begins.
* @param dataBuffer the buffer to copy the account data into
* @param dataStart the index into the buffer where copying should begin
* @param mac the buffer to copy the resulting Message Authentication Code
* @param macStart the index into the mac buffer to start copying
*
* @return the value of the write cycle counter for the page
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized int readAccountDataFromCoprocessor(ByteArray chlg, int chlgStart, ByteArray dataBuffer, int dataStart, ByteArray mac, int macStart)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser18)objectInstance).readAccountData(chlg.array, chlgStart, dataBuffer.array, dataStart, mac.array, macStart);
}
-------------------------------------------------------------------
creating: owapi\SHAiButtonUser33.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser33(com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer33,boolean,byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser33
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer33,boolean,byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstance4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer33,boolean,byte[]
/**
* <P>Initialize a DS1961S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* <P>Note: With this constructor, the master secret is installed and bound
* to the iButton, so the final secret is none by the object. For that
* reason, a hardware coprocessor is not necessary for generating the
* write-authorization MAC.</P>
*
* @param copr The SHAiButtonCopr to which the user object is tied. This
* Coprocessor contains the necessary binding code and service
* filename, necessary for both locating a user and recreating his
* unique secret.
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr,OneWireContainer33)
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr)
*/
public void createNewInstance(SHAiButtonCopr copr, OneWireContainer33 owc, boolean formatDevice, ByteArray authSecret)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser33(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), ((com.dalsemi.onewire.container.OneWireContainer33)owc.objectInstance), formatDevice, authSecret.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser33(byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer33,boolean,byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser33
sParams=byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer33,boolean,byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromCoprocessor6
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public void createNewInstance
params=byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer33,boolean,byte[]
/**
* <P>Initialize a DS1961S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* <P>Note: With this constructor, the master secret is installed and bound
* to the iButton, so the final secret is none by the object. For that
* reason, a hardware coprocessor is not necessary for generating the
* write-authorization MAC.</P>
*
* @param coprBindCode The Coprocessor Bind Code without the information.
* @param fileName The file name from the Coprocessor.
* @param fileNameExt The file extenstion from the Coprocessor
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr,OneWireContainer33)
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr)
*/
public void createNewInstanceFromCoprocessor(ByteArray coprBindCode, ByteArray fileName, int fileNameExt, OneWireContainer33 owc, boolean formatDevice, ByteArray authSecret)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser33(coprBindCode.array, fileName.array, fileNameExt, ((com.dalsemi.onewire.container.OneWireContainer33)owc.objectInstance), formatDevice, authSecret.array);
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser33(com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer33) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser33
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer33
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstance3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.container.OneWireContainer33
/**
* <P>Creates a valid SHAiButtonUser object. If the service file,
* whose name is taken from the <code>SHAiButtonCopr</code>, is not
* found on the user iButton, a OneWireException is thrown with the
* message "Invalid SHA user".</P>
*
* <P>Note: The same coprocessor can be used for write-authorization as
* authentication if you're transaction system is using unsigned transaction
* data.</P>
*
* @param copr The SHAiButtonCopr to which the user object is tied. This
* Coprocessor contains the necessary binding code and service
* filename, necessary for both locating a user and recreating his
* unique secret.
* @param authCopr The SHAiButtonCopr used to generate the write-authorization
* MAC for the copy-scratchpad command of the DS1961S.
* @param owc The DS1961S iButton that this object will refer to.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser33(SHAiButtonCopr,OneWireContainer33,boolean,byte[])
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr)
*/
public void createNewInstance(SHAiButtonCopr copr, SHAiButtonCopr authCopr, OneWireContainer33 owc)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser33(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), ((com.dalsemi.onewire.application.sha.SHAiButtonCopr)authCopr.objectInstance), ((com.dalsemi.onewire.container.OneWireContainer33)owc.objectInstance));
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser33(byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer33) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser33
sParams=byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer33
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void createNewInstanceFromCoprocessor4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public void createNewInstance
params=byte[],byte[],int,com.dalsemi.onewire.container.OneWireContainer33
/**
* <P>Initialize a DS1961S as a fresh user iButton for a given SHA service.
* This constructor not only creates the service file for the user iButton
* using the TMEX file structure, but it also installs the master
* authentication secret and binds it to the iButton (making it unique for
* a particular button). Optionally, the device can be formatted before
* the service file is installed.</P>
*
* <P>Note: With this constructor, the master secret is installed and bound
* to the iButton, so the final secret is none by the object. For that
* reason, a hardware coprocessor is not necessary for generating the
* write-authorization MAC.</P>
*
* @param coprBindCode The Coprocessor Bind Code without the information.
* @param fileName The file name from the Coprocessor.
* @param fileNameExt The file extenstion from the Coprocessor
* @param owc The DS1963S iButton that this object will refer to.
* @param formatDevice If <code>true</code>, the TMEX filesystem will be
* formatted before the account service file is created.
* @param authSecret The master authentication secret for the systm.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr,OneWireContainer33)
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr)
*/
public void createNewInstanceFromCoprocessor(ByteArray coprBindCode, ByteArray fileName, int fileNameExt, OneWireContainer33 owc)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser33(coprBindCode.array, fileName.array, fileNameExt, ((com.dalsemi.onewire.container.OneWireContainer33)owc.objectInstance));
}
======================================
public com.dalsemi.onewire.application.sha.SHAiButtonUser33(com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.application.sha.SHAiButtonCopr)
sMethodName=public com.dalsemi.onewire.application.sha.SHAiButtonUser33
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.application.sha.SHAiButtonCopr
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,com.dalsemi.onewire.application.sha.SHAiButtonCopr
/**
* <P>Creates a valid SHAiButtonUser object. If the service file,
* whose name is taken from the <code>SHAiButtonCopr</code>, is not
* found on the user iButton, a OneWireException is thrown with the
* message "Invalid SHA user".</P>
*
* <P>Note: The same coprocessor can be used for write-authorization as
* authentication if you're transaction system is using unsigned transaction
* data.</P>
*
* @param copr The SHAiButtonCopr to which the user object is tied. This
* Coprocessor contains the necessary binding code and service
* filename, necessary for both locating a user and recreating his
* unique secret.
* @param authCopr The SHAiButtonCopr used to generate the write-authorization
* MAC for the copy-scratchpad command of the DS1961S.
* @param owc The DS1961S iButton that this object will refer to.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAiButtonUser33(SHAiButtonCopr,OneWireContainer33,boolean,byte[])
* @see #SHAiButtonUser33(SHAiButtonCopr,SHAiButtonCopr)
*/
public void createNewInstance(SHAiButtonCopr copr, SHAiButtonCopr authCopr)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHAiButtonUser33(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), ((com.dalsemi.onewire.application.sha.SHAiButtonCopr)authCopr.objectInstance));
}
======================================
public synchronized boolean setiButton33(com.dalsemi.onewire.container.OneWireContainer33) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean setiButton33
sParams=com.dalsemi.onewire.container.OneWireContainer33
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean setiButton33FromCoprocessor1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized boolean setiButton33
params=com.dalsemi.onewire.container.OneWireContainer33
/**
* <P>Modifies this SHA iButton so that it refers to another DS1961S
* container. This function only copies the reference to the
* OneWireContainer, copes the reference to it's 1-Wire address, and
* then asserts that the iButton contains a valid acccount info file
* associated with the system.</P>
*
* @param owc The <code>OneWireContainer33</code> this object will refer to.
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer33</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean setiButton33FromCoprocessor(OneWireContainer33 owc)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).setiButton33(((com.dalsemi.onewire.container.OneWireContainer33)owc.objectInstance));
}
======================================
public synchronized boolean setiButtonUser(com.dalsemi.onewire.adapter.DSPortAdapter, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean setiButtonUser
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean setiButtonUserFromCoprocessor2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized boolean setiButtonUser
params=com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
/**
* <P>Modifies this SHA iButton so that it refers to another 1963S.
* If this object already has an appropriate instance of OneWireContainer,
* that instance is updated with the new address.</P>
*
* @param adapter The adapter that the device can be found on.
* @param address The address of the 1-Wire device
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer18</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean setiButtonUserFromCoprocessor(DSPortAdapter adapter, ByteArray address)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).setiButtonUser(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), address.array);
}
======================================
public synchronized boolean setiButtonUser(byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean setiButtonUser
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean setiButtonUserFromCoprocessor1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized boolean setiButtonUser
params=byte[]
/**
* <P>Modifies this SHA iButton so that it refers to another 1963S.
* If this object already has an appropriate instance of OneWireContainer,
* that instance is updated with the new address.</P>
*
* @param adapter The adapter that the device can be found on.
* @param address The address of the 1-Wire device
*
* @return <code>true</code> if a valid account service file exists on
* this <code>OneWireContainer18</code>.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean setiButtonUserFromCoprocessor(ByteArray adapter)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).setiButtonUser(adapter.array);
}
======================================
public synchronized int getWriteCycleCounter() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized int getWriteCycleCounter
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized int getWriteCycleCounter0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized int getWriteCycleCounter
params=
/**
* <P>Returns the value of the write cycle counter for the
* page where the account data is stored. If the write
* cycle counter has ever been retrieved, this returns the
* cached value. Otherwise, this method reads the value
* from the part.</P>
*
* <P>Since the DS1961S has no "write cycle counters", this function
* always returns -1.</P>
*
* @return the value of the write cycle counter for the
* account data page.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized int getWriteCycleCounter()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).getWriteCycleCounter();
}
======================================
public synchronized boolean hasWriteCycleCounter()
sMethodName=public synchronized boolean hasWriteCycleCounter
sParams=
sThrows=
tempMethodName=public synchronized boolean hasWriteCycleCounter0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized boolean hasWriteCycleCounter
params=
/**
* <P>Returns <code>true</code> if this buttons account data is stored
* on a page that has a write cycle counter.</P>
*
* <P>Since the DS1961S has no "write cycle counters", this function
* always returns false.</P>
*
* @return <code>true</code> if account page has write cycle counter.
*/
public synchronized boolean hasWriteCycleCounter()
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).hasWriteCycleCounter();
}
======================================
public synchronized boolean writeAccountData(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean writeAccountData
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean writeAccountDataFromCoprocessor2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized boolean writeAccountData
params=byte[],int
/**
* <P>Writes the account data to the SHAiButton. First, this function
* asserts that the account page number is known. The account data is
* copied from dataBuffer starting at the offset. If there are less
* than 32 bytes available to copy, this function only copies the bytes
* that are available.</P>
*
* <P>Note that for the DS1961S user button, an authorization MAC must
* be generated for the copy-scratchpad command. Since the scratchpad
* is only 8 bytes long, this must be done 4 times to write a page of
* data. So, this function only writes (in 8 byte blocks) the bytes
* that have changed.</P>
*
* @param dataBuffer the buffer to copy the account data from
* @param offset the index into the buffer where copying should begin
* @return whether or not the data write succeeded
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public synchronized boolean writeAccountDataFromCoprocessor(ByteArray dataBuffer, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).writeAccountData(dataBuffer.array, offset);
}
======================================
public synchronized boolean readAccountData(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean readAccountData
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean readAccountDataFromCoprocessor2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized boolean readAccountData
params=byte[],int
/**
* <P>Reads the account data off the SHAiButton using a standard READ
* command. First, this function asserts that the account page number is
* known as well as the length of the account file. The 32 byte account
* data page is copied into dataBuffer starting at the given offset.</P>
*
* @param dataBuffer the buffer to copy the account data into
* @param offset the index into the buffer where copying should begin
* @return whether or not the read was successful
*/
public synchronized boolean readAccountDataFromCoprocessor(ByteArray dataBuffer, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).readAccountData(dataBuffer.array, offset);
}
======================================
public synchronized int readAccountData(byte[], int, byte[], int, byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized int readAccountData
sParams=byte[], int, byte[], int, byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized int readAccountDataFromCoprocessor6
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHAiButtonUser33
methodName=public synchronized int readAccountData
params=byte[],int,byte[],int,byte[],int
/**
* <P>Reads the account data off the SHAiButton using a READ_AUTHENTICATE
* command. First, this function asserts that the account page number is
* known as well as the length of the account file. Then it copies the
* 3 byte challenge to the scratchpad before sending the command for
* READ_AUTHENTICATE. The 32 byte account data page is copied into
* dataBuffer starting at dataStart.</P>
*
* <P>In addition to the account data, this function also returns a
* calculated MAC. The MAC requires 20 bytes after the start index.
* The return value is the write cycle counter value for the account
* data page<p>
*
* @param chlg the buffer containing a 3-byte random challenge.
* @param chlgStart the index into the buffer where the 3 byte
* challenge begins.
* @param dataBuffer the buffer to copy the account data into
* @param dataStart the index into the buffer where copying should begin
* @param mac the buffer to copy the resulting Message Authentication Code
* @param macStart the index into the mac buffer to start copying
*
* @return the value of the write cycle counter for the page
*/
public synchronized int readAccountDataFromCoprocessor(ByteArray chlg, int chlgStart, ByteArray dataBuffer, int dataStart, ByteArray mac, int macStart)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHAiButtonUser33)objectInstance).readAccountData(chlg.array, chlgStart, dataBuffer.array, dataStart, mac.array, macStart);
}
-------------------------------------------------------------------
creating: owapi\SHASoftAuth.java
No COM CLSID for SHASoftAuth
superClassName=java.lang.Object
======================================
public static final int VERIFICATION_DATA
======================================
public static final int I_FILE_LENGTH
======================================
public static final int I_DATA_TYPE_CODE
======================================
public static final int I_SIGNATURE
======================================
public static final int I_VERDATA
======================================
public static final int I_CONTINUATION_PTR
======================================
public static final int I_FILE_CRC16
======================================
public com.dalsemi.onewire.application.sha.SHASoftAuth(com.dalsemi.onewire.application.sha.SHAiButtonCopr)
sMethodName=public com.dalsemi.onewire.application.sha.SHASoftAuth
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr
/**
* SHADebit constructor. <code>copr</code> is the SHAiButtonCopr
* that is used to perform this transaction. After saving a
* reference to the SHA coprocessor, this constructor resets all
* parameters for this type of transaction to their default values.
*
* @param copr The coprocessor used for authentication and data
* signing in this transaction.
*/
public void createNewInstance(SHAiButtonCopr copr)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHASoftAuth(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance));
}
======================================
public com.dalsemi.onewire.application.sha.SHASoftAuth(com.dalsemi.onewire.application.sha.SHAiButtonCopr,byte[],int)
sMethodName=public com.dalsemi.onewire.application.sha.SHASoftAuth
sParams=com.dalsemi.onewire.application.sha.SHAiButtonCopr,byte[],int
sThrows=
tempMethodName=public void createNewInstance3
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public void createNewInstance
params=com.dalsemi.onewire.application.sha.SHAiButtonCopr,byte[],int
/**
* SHADebit constructor. <code>copr</code> is the SHAiButtonCopr
* that is used to perform this transaction. After saving a
* reference to the SHA coprocessor, this constructor resets all
* parameters for this type of transaction to their default values.
*
* @param copr The coprocessor used for authentication and data
* signing in this transaction.
* @param extra_data The 7 bytes of extra data to be used instead
* of the balance.
* @param len The len, 7 or less of the data. It is 0 padded.
*/
public void createNewInstance(SHAiButtonCopr copr, ByteArray extra_data, int len)
{
objectInstance = new com.dalsemi.onewire.application.sha.SHASoftAuth(((com.dalsemi.onewire.application.sha.SHAiButtonCopr)copr.objectInstance), extra_data.array, len);
}
======================================
public synchronized boolean verifyUser(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean verifyUser
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean verifyUser1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized boolean verifyUser
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies user's authentication response. User is "authenticated" if
* and only if the digital signature generated the user iButton matches
* the digital signature generated by the coprocessor after the user's
* unique secret has been recreated on the coprocessor.</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Generate 3-byte "challenge" on coprocessor </li>
* <li> Write challenge to scratchpad of user </li>
* <li> Read account data page with signature </li>
* <li> Attempt to match user's signature with the coprocessor </li>
* </ul></P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @see SHAiButtonCopr#generateChallenge(int,byte[],int)
* @see SHAiButtonCopr#verifyAuthentication(byte[],byte[],byte[],byte[],byte)
* @see SHAiButtonUser#readAccountData(byte[],int,byte[],int,byte[],int)
* @see #getLastError()
*/
public synchronized boolean verifyUser(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).verifyUser(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public synchronized boolean verifyTransactionData(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean verifyTransactionData
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean verifyTransactionData1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized boolean verifyTransactionData
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies user's account data. Account data is "verified" if the
* digital signature matches the signature recreated by the
* coprocessor.</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Read the account data from user </li>
* <li> Get verification data </li>
* <li> Reset the digital signature </li>
* <li> Use coprocessor to sign account data </li>
* <li> Insert the new digital signature </li>
* <li> Write the account data to the user </li>
* </ul></P>
*
* <P>If previous steps have been executed, all "Read" commands on
* the user are reading from cached data.</P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
*
* @return <code>true</code> if and only if the account balance is
* greater than zero and digital signature matches the signature
* recreated by the coprocessor.
*
* @see SHAiButtonUser#readAccountData(byte[],int)
* @see SHAiButtonCopr#verifySignature(byte[],byte[],byte[])
* @see #getLastError()
*/
public synchronized boolean verifyTransactionData(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).verifyTransactionData(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public synchronized boolean executeTransaction(com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized boolean executeTransaction
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized boolean executeTransaction2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized boolean executeTransaction
params=com.dalsemi.onewire.application.sha.SHAiButtonUser,boolean
/**
* <P>Performs the signed debit, subtracting the debit amount from
* the user's balance and storing the new, signed account data on the
* user's iButton. The debit amount can be set using
* <code>transaction.setParameter(SHADebit.DEBIT_AMOUNT, 50)</code>,
* where the value is in units of cents (i.e. for 1 dollar, use 100).</P>
*
* <P><B>Flow of action: </B>
* <ul>
* <li> Read the account data from user </li>
* <li> Extract account balance </li>
* <li> Reset the digital signature </li>
* <li> Use coprocessor to sign account data </li>
* <li> Insert the new digital signature </li>
* <li> Write the account data to the user </li>
* </ul></P>
*
* <P>If previous steps have been executed, all "Read" commands on
* the user are reading from cached data.</P>
*
* @param user SHAiButtonUser upon which the transaction occurs.
* @param verifySuccess A boolean to let this method know if verification
* was successful.
*
* @return <code>true</code> if and only if the user has enough in the
* account balance to perform the requested debit AND a new digital
* signature is successfully created AND the account data has been written
* to the button.
*
* @see SHAiButtonUser#readAccountData(byte[],int)
* @see SHAiButtonUser#writeAccountData(byte[],int)
* @see SHAiButtonCopr#createDataSignature(byte[],byte[],byte[],int)
* @see #getLastError()
*/
public synchronized boolean executeTransaction(SHAiButtonUser user, boolean verifySuccess)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).executeTransaction(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance), verifySuccess);
}
======================================
public synchronized int getParameter(int)
sMethodName=public synchronized int getParameter
sParams=int
sThrows=
tempMethodName=public synchronized int getParameter1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized int getParameter
params=int
/**
* <P>Retrieves the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* <LI><code>SHADebit.USER_BALANCE</code></LI>
* </UL>
* </P>
*
* <P>Note that the value of <code>SHADebit.USER_BALANCE</code> will
* be set after calling <code>verifyTransactionData(SHAiButtonUser)</code>
* and after calling <code>executeTransaction(SHAiButtonUser)</code>.</P>
*
* @return The value of the requested parameter.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized int getParameter(int type)
{
return ((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).getParameter(type);
}
======================================
public synchronized int getParameter(int, byte[], int, int)
sMethodName=public synchronized int getParameter
sParams=int, byte[], int, int
sThrows=
tempMethodName=public synchronized int getParameter4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized int getParameter
params=int,byte[],int,int
/**
* <P>Retrieves the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* <LI><code>SHADebit.USER_BALANCE</code></LI>
* </UL>
* </P>
*
* <P>Note that the value of <code>SHADebit.USER_BALANCE</code> will
* be set after calling <code>verifyTransactionData(SHAiButtonUser)</code>
* and after calling <code>executeTransaction(SHAiButtonUser)</code>.</P>
*
* @return The value of the requested parameter.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized int getParameter(int type, ByteArray data, int offset, int len)
{
return ((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).getParameter(type, data.array, offset, len);
}
======================================
public synchronized boolean setParameter(int, byte[], int, int)
sMethodName=public synchronized boolean setParameter
sParams=int, byte[], int, int
sThrows=
tempMethodName=public synchronized boolean setParameter4
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized boolean setParameter
params=int,byte[],int,int
/**
* <P>Sets the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* </UL>
* </P>
*
* @param type Specifies the parameter type (<code>SHADebit.DEBIT_AMOUNT</code> or
* <code>SHADebit.INITIAL_AMOUNT</code>)
* @return </code>true</code> if a valid parameter type was specified
* and the value of the parameter is positive.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized boolean setParameter(int type, ByteArray data, int offset, int len)
{
return ((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).setParameter(type, data.array, offset, len);
}
======================================
public synchronized boolean setParameter(int, int)
sMethodName=public synchronized boolean setParameter
sParams=int, int
sThrows=
tempMethodName=public synchronized boolean setParameter2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized boolean setParameter
params=int,int
/**
* <P>Sets the value of a particular parameter for this
* debit transaction.</P>
*
* <P><B>Valid Parameters</B>
* <UL>
* <LI><code>SHADebit.DEBIT_AMOUNT</code></LI>
* <LI><code>SHADebit.INITIAL_AMOUNT</code></LI>
* </UL>
* </P>
*
* @param type Specifies the parameter type (<code>SHADebit.DEBIT_AMOUNT</code> or
* <code>SHADebit.INITIAL_AMOUNT</code>)
* @return </code>true</code> if a valid parameter type was specified
* and the value of the parameter is positive.
*
* @throws IllegalArgumentException if an invalid parameter type
* is requested.
*/
public synchronized boolean setParameter(int type, int data)
{
return ((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).setParameter(type, data);
}
======================================
public synchronized void resetParameters()
sMethodName=public synchronized void resetParameters
sParams=
sThrows=
tempMethodName=public synchronized void resetParameters0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHASoftAuth
methodName=public synchronized void resetParameters
params=
/**
* <p>Resets all transaction parameters to default values</p>
*/
public synchronized void resetParameters()
{
((com.dalsemi.onewire.application.sha.SHASoftAuth)objectInstance).resetParameters();
}
-------------------------------------------------------------------
creating: owapi\SHATransaction.java
======================================
public static final int NO_ERROR
======================================
public static final int SHA_FUNCTION_FAILED
======================================
public static final int MATCH_SCRATCHPAD_FAILED
======================================
public static final int COPR_WRITE_DATAPAGE_FAILED
======================================
public static final int COPR_WRITE_SCRATCHPAD_FAILED
======================================
public static final int COPR_BIND_SECRET_FAILED
======================================
public static final int COPR_COMPUTE_CHALLENGE_FAILED
======================================
public static final int COPROCESSOR_FAILURE
======================================
public static final int USER_READ_AUTH_FAILED
======================================
public static final int USER_WRITE_DATA_FAILED
======================================
public static final int USER_BAD_ACCOUNT_DATA
======================================
public static final int USER_DATA_NOT_UPDATED
======================================
public int getLastError()
sMethodName=public int getLastError
sParams=
sThrows=
tempMethodName=public int getLastError0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public int getLastError
params=
/**
* <P>Returns the error code for the last error in the transaction
* process.</P>
*/
public int getLastError()
{
return objectInstance.getLastError();
}
======================================
public int getLastCoprError()
sMethodName=public int getLastCoprError
sParams=
sThrows=
tempMethodName=public int getLastCoprError0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public int getLastCoprError
params=
/**
* <P>Returns the error code for the last error in the transaction
* process.</P>
*/
public int getLastCoprError()
{
return objectInstance.getLastCoprError();
}
======================================
public boolean setupTransactionData(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean setupTransactionData
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean setupTransactionData1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public boolean setupTransactionData
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Setups initial transaction data on SHAiButtonUser. This step
* creates the account data file, signs it with the coprocessor,
* and writes it to the iButton.</P>
*/
public boolean setupTransactionData(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.setupTransactionData(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public boolean verifyUser(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean verifyUser
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean verifyUser1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public boolean verifyUser
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies that SHAiButtonUser is a valid user of this service.
* This step writes a three byte challenge to the SHAiButtonUser
* before doing an authenticated read of the account data. The
* returned MAC is verified using the system authentication secret
* on the coprocessor. If the MAC matches that generated by the
* coprocessor, this function returns true.</P>
*/
public boolean verifyUser(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.verifyUser(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public boolean verifyTransactionData(com.dalsemi.onewire.application.sha.SHAiButtonUser) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean verifyTransactionData
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean verifyTransactionData1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public boolean verifyTransactionData
params=com.dalsemi.onewire.application.sha.SHAiButtonUser
/**
* <P>Verifies account data is valid for this service. The user's
* account data is recreated on the coprocessor and signed using
* the system signing secret. If the recreated signature matches
* the signature in the account data, the account data is valid.</P>
*/
public boolean verifyTransactionData(SHAiButtonUser user)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.verifyTransactionData(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance));
}
======================================
public boolean executeTransaction(com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean executeTransaction
sParams=com.dalsemi.onewire.application.sha.SHAiButtonUser, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean executeTransaction2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public boolean executeTransaction
params=com.dalsemi.onewire.application.sha.SHAiButtonUser,boolean
/**
* <P>Performs the transaction. For any given transaction type,
* this step would involve updating any necessary account data,
* signing the account data using the coprocessor's system signing
* secret, and writing the updated account data to the user
* iButton</P>
*/
public boolean executeTransaction(SHAiButtonUser user, boolean verifySuccess)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return objectInstance.executeTransaction(((com.dalsemi.onewire.application.sha.SHAiButtonUser)user.objectInstance), verifySuccess);
}
======================================
public boolean setParameter(int, int)
sMethodName=public boolean setParameter
sParams=int, int
sThrows=
tempMethodName=public boolean setParameter2
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public boolean setParameter
params=int,int
/**
* <P>Sets a particular parameter for this transaction. Parameters
* are specified in the class documentation for the specific type of
* transaction that is being peformed.</P>
*/
public boolean setParameter(int type, int param)
{
return objectInstance.setParameter(type, param);
}
======================================
public int getParameter(int)
sMethodName=public int getParameter
sParams=int
sThrows=
tempMethodName=public int getParameter1
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public int getParameter
params=int
/**
* <P>Retrieves the value of a particular parameter for this
* transaction. Parameters are specified in the class documentation
* for the specific type of transaction that is being peformed.</P>
*/
public int getParameter(int type)
{
return objectInstance.getParameter(type);
}
======================================
public void resetParameters()
sMethodName=public void resetParameters
sParams=
sThrows=
tempMethodName=public void resetParameters0
getMethodDocumentation
className=com.dalsemi.onewire.application.sha.SHATransaction
methodName=public void resetParameters
params=
/**
* <P>Resets the value of all parameters for this transaction.
* Parameters are specified in the class documentation for the
* specific type of transaction that is being peformed.</P>
*/
public void resetParameters()
{
objectInstance.resetParameters();
}
-------------------------------------------------------------------
creating: owapi\Contact.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.tag.Contact(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.tag.Contact
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Contact
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Creates an object for the device with the supplied address and device type connected
* to the supplied port adapter.
* @param adapter The adapter serving the sensor.
* @param NetAddress The 1-Wire network address of the sensor.
* @param netAddress
*/
public void createNewInstance(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance = new com.dalsemi.onewire.application.tag.Contact(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public java.lang.String readSensor() throws com.dalsemi.onewire.OneWireException
sMethodName=public java.lang.String readSensor
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public java.lang.String readSensor0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Contact
methodName=public java.lang.String readSensor
params=
/**
* The readSensor method returns the "max" string if the Sensor is
* present or the "min" string if the Sensor is not present.
* @param--none.
*
* @return The "max" string if sensor is present or "min" string if not.
*/
public java.lang.String readSensor()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.application.tag.Contact)objectInstance).readSensor();
}
-------------------------------------------------------------------
creating: owapi\D2A.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.tag.D2A(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.tag.D2A
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.D2A
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Creates an object for the device with the supplied address connected
* to the supplied port adapter.
* @param adapter The adapter serving the actuator.
* @param netAddress The 1-Wire network address of the actuator.
*/
public void createNewInstance(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance = new com.dalsemi.onewire.application.tag.D2A(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public java.util.Vector getSelections()
sMethodName=public java.util.Vector getSelections
sParams=
sThrows=
tempMethodName=public java.util.Vector getSelections0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.D2A
methodName=public java.util.Vector getSelections
params=
/**
* Get the possible selection states of this actuator
*
* @return Vector of Strings representing selection states.
*/
public java.util.Vector getSelections()
{
return ((com.dalsemi.onewire.application.tag.D2A)objectInstance).getSelections();
}
======================================
public void setSelection(java.lang.String) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setSelection
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setSelection1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.D2A
methodName=public void setSelection
params=java.lang.String
/**
* Set the selection of this actuator
*
* @param The selection string.
*
* @throws OneWireException
*
*/
public void setSelection(java.lang.String selection)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.application.tag.D2A)objectInstance).setSelection(selection);
}
======================================
public void initActuator() throws com.dalsemi.onewire.OneWireException
sMethodName=public void initActuator
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void initActuator0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.D2A
methodName=public void initActuator
params=
/**
* Initializes the actuator
* @param Init The initialization string.
*
* @throws OneWireException
*
*/
public void initActuator()
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.application.tag.D2A)objectInstance).initActuator();
}
-------------------------------------------------------------------
creating: owapi\Humidity.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.tag.Humidity(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.tag.Humidity
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Humidity
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Creates an object for the device with the supplied address and device type connected
* to the supplied port adapter.
* @param adapter The adapter serving the sensor.
* @param netAddress The 1-Wire network address of the sensor.
*/
public void createNewInstance(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance = new com.dalsemi.onewire.application.tag.Humidity(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public java.lang.String readSensor() throws com.dalsemi.onewire.OneWireException
sMethodName=public java.lang.String readSensor
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public java.lang.String readSensor0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Humidity
methodName=public java.lang.String readSensor
params=
/**
* The readSensor method returns a relative humidity reading
* in %RH
*
* @param--none.
*
* @return String humidity in %RH
*/
public java.lang.String readSensor()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.application.tag.Humidity)objectInstance).readSensor();
}
-------------------------------------------------------------------
creating: owapi\Level.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.tag.Level(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.tag.Level
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Level
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Creates an object for the device with the supplied address and device type connected
* to the supplied port adapter.
* @param adapter The adapter serving the sensor.
* @param netAddress The 1-Wire network address of the sensor.
*
*/
public void createNewInstance(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance = new com.dalsemi.onewire.application.tag.Level(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public java.lang.String readSensor() throws com.dalsemi.onewire.OneWireException
sMethodName=public java.lang.String readSensor
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public java.lang.String readSensor0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Level
methodName=public java.lang.String readSensor
params=
/**
* The readSensor method returns the <max> or <min> string of the Sensor (in
* this case, a switch). The elements <max> and <min> represent conducting
* and non-conducting states of the switch, respectively.
*
* @param--none.
*
* @return String The <max> string is associated with the conducting switch state,
* and the <min> string is associated with the non-conducting state
* of the 1-Wire switch.
*/
public java.lang.String readSensor()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.application.tag.Level)objectInstance).readSensor();
}
-------------------------------------------------------------------
creating: owapi\SAXParser.java
======================================
public void setLocale(java.util.Locale) throws org.xml.sax.SAXException
sMethodName=public void setLocale
sParams=java.util.Locale
sThrows=throws org.xml.sax.SAXException
tempMethodName=public void setLocale1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.SAXParser
methodName=public void setLocale
params=java.util.Locale
/**
* Set the locale for errors and warnings.
*
* @param locale The locale to use.
* @throws SAXException If the <var>locale</var> is not supported.
*/
public void setLocale(java.util.Locale locale)
throws org.xml.sax.SAXException
{
objectInstance.setLocale(locale);
}
======================================
public void setEntityResolver(org.xml.sax.EntityResolver)
sMethodName=public void setEntityResolver
sParams=org.xml.sax.EntityResolver
sThrows=
tempMethodName=public void setEntityResolver1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.SAXParser
methodName=public void setEntityResolver
params=org.xml.sax.EntityResolver
/**
* Register a custom entity resolver.
*
* If one is not registered, the parser will resolve system identifiers in an
* implementation dependent way.
*
* @param resolver The entity resolver to use.
*/
public void setEntityResolver(org.xml.sax.EntityResolver resolver)
{
objectInstance.setEntityResolver(resolver);
}
======================================
public void setDTDHandler(org.xml.sax.DTDHandler)
sMethodName=public void setDTDHandler
sParams=org.xml.sax.DTDHandler
sThrows=
tempMethodName=public void setDTDHandler1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.SAXParser
methodName=public void setDTDHandler
params=org.xml.sax.DTDHandler
/**
* Register a DTD event handler.
*
* If one is not registered, all DTD events reported by the parser will be ignored.
*
* @param handler The DTD handler to use.
*/
public void setDTDHandler(org.xml.sax.DTDHandler handler)
{
objectInstance.setDTDHandler(handler);
}
======================================
public void setDocumentHandler(org.xml.sax.DocumentHandler)
sMethodName=public void setDocumentHandler
sParams=org.xml.sax.DocumentHandler
sThrows=
tempMethodName=public void setDocumentHandler1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.SAXParser
methodName=public void setDocumentHandler
params=org.xml.sax.DocumentHandler
/**
* Register a document event handler.
*
* If one is not registered, all document events reported by the parser will be ignored.
*
* @param handler The document handler to use.
*/
public void setDocumentHandler(org.xml.sax.DocumentHandler handler)
{
objectInstance.setDocumentHandler(handler);
}
======================================
public void setErrorHandler(org.xml.sax.ErrorHandler)
sMethodName=public void setErrorHandler
sParams=org.xml.sax.ErrorHandler
sThrows=
tempMethodName=public void setErrorHandler1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.SAXParser
methodName=public void setErrorHandler
params=org.xml.sax.ErrorHandler
/**
* Register an error event handler.
*
* If one is not registered, all error events except for <code>fatalError</code>
* are ignored. A <code>fatalError</code> thorws a {@link org.xml.sax.SAXException}.
*
* @param handler The error handler to use.
*/
public void setErrorHandler(org.xml.sax.ErrorHandler handler)
{
objectInstance.setErrorHandler(handler);
}
======================================
public void parse(org.xml.sax.InputSource) throws org.xml.sax.SAXException, java.io.IOException
sMethodName=public void parse
sParams=org.xml.sax.InputSource
sThrows=throws org.xml.sax.SAXException, java.io.IOException
tempMethodName=public void parseFromInputSource1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.SAXParser
methodName=public void parse
params=org.xml.sax.InputSource
/**
* Parse an XML document.
*
* @param source Source of the document to parse.
*
* @param inputSource
* @throws SAXException Any SAX exception, possibly wrapping another exception.
* @throws IOException If an I/O error occurred while reading the document.
*/
public void parseFromInputSource(org.xml.sax.InputSource inputSource)
throws org.xml.sax.SAXException, java.io.IOException
{
objectInstance.parse(inputSource);
}
======================================
public void parse(java.lang.String) throws org.xml.sax.SAXException, java.io.IOException
sMethodName=public void parse
sParams=java.lang.String
sThrows=throws org.xml.sax.SAXException, java.io.IOException
tempMethodName=public void parse1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.SAXParser
methodName=public void parse
params=java.lang.String
/**
* Parse an XML document specified by system identifier or URL.
*
* @param systemID The system ID or URL of the document to parse.
* @throws SAXException Any SAX exception, possibly wrapping another exception.
* @throws IOException If an I/O error occurred while reading the document.
*/
public void parse(java.lang.String systemID)
throws org.xml.sax.SAXException, java.io.IOException
{
objectInstance.parse(systemID);
}
-------------------------------------------------------------------
creating: owapi\Switch.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.tag.Switch(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.tag.Switch
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Switch
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Creates an object for the device with the supplied address connected
* to the supplied port adapter.
* @param adapter The adapter serving the actuator.
* @param netAddress The 1-Wire network address of the actuator.
*/
public void createNewInstance(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance = new com.dalsemi.onewire.application.tag.Switch(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public java.util.Vector getSelections()
sMethodName=public java.util.Vector getSelections
sParams=
sThrows=
tempMethodName=public java.util.Vector getSelections0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Switch
methodName=public java.util.Vector getSelections
params=
/**
* Get the possible selection states of this actuator
*
* @return Vector of Strings representing selection states.
*/
public java.util.Vector getSelections()
{
return ((com.dalsemi.onewire.application.tag.Switch)objectInstance).getSelections();
}
======================================
public void setSelection(java.lang.String) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setSelection
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setSelection1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Switch
methodName=public void setSelection
params=java.lang.String
/**
* Set the selection of this actuator
*
* @param The selection string.
*
* @throws OneWireException
*
*/
public void setSelection(java.lang.String selection)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.application.tag.Switch)objectInstance).setSelection(selection);
}
======================================
public void initActuator() throws com.dalsemi.onewire.OneWireException
sMethodName=public void initActuator
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void initActuator0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Switch
methodName=public void initActuator
params=
/**
* Initializes the actuator
* @param Init The initialization string.
*
* @throws OneWireException
*
*/
public void initActuator()
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.application.tag.Switch)objectInstance).initActuator();
}
-------------------------------------------------------------------
creating: owapi\TaggedDevice.java
======================================
public com.dalsemi.onewire.container.OneWireContainer DeviceContainer
======================================
public java.lang.String DeviceType
======================================
public java.lang.String label
======================================
public java.lang.Integer channel
======================================
public java.lang.String max
======================================
public java.lang.String min
======================================
public java.lang.Boolean state
======================================
public java.lang.String init
======================================
public java.lang.String clusterName
======================================
public java.util.Vector branchVector
======================================
public com.dalsemi.onewire.application.tag.TaggedDevice(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.tag.TaggedDevice
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Creates an object for the device with the supplied address and device type connected
* to the supplied port adapter.
* @param adapter The adapter serving the sensor.
* @param NetAddress The 1-Wire network address of the sensor.
* @param netAddress
*/
public void createNewInstance(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance = new com.dalsemi.onewire.application.tag.TaggedDevice(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public void setDeviceContainer(com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.String)
sMethodName=public void setDeviceContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.String
sThrows=
tempMethodName=public void setDeviceContainer2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setDeviceContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Sets the 1-Wire Container for the tagged device.
*/
public void setDeviceContainer(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance.setDeviceContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public void setDeviceType(java.lang.String)
sMethodName=public void setDeviceType
sParams=java.lang.String
sThrows=
tempMethodName=public void setDeviceType1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setDeviceType
params=java.lang.String
/**
* Sets the device type for the tagged device.
*
* @param tType
*/
public void setDeviceType(java.lang.String tType)
{
objectInstance.setDeviceType(tType);
}
======================================
public void setLabel(java.lang.String)
sMethodName=public void setLabel
sParams=java.lang.String
sThrows=
tempMethodName=public void setLabel1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setLabel
params=java.lang.String
/**
* Sets the label for the tagged device.
*
* @param Label
*/
public void setLabel(java.lang.String Label)
{
objectInstance.setLabel(Label);
}
======================================
public void setChannelFromString(java.lang.String)
sMethodName=public void setChannelFromString
sParams=java.lang.String
sThrows=
tempMethodName=public void setChannelFromString1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setChannelFromString
params=java.lang.String
/**
* Sets the channel for the tagged device from a String.
*
* @param Channel
*/
public void setChannelFromString(java.lang.String Channel)
{
objectInstance.setChannelFromString(Channel);
}
======================================
public void setChannel(int)
sMethodName=public void setChannel
sParams=int
sThrows=
tempMethodName=public void setChannel1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setChannel
params=int
/**
* Sets the channel for the tagged device from an int.
*
* @param Channel
*/
public void setChannel(int Channel)
{
objectInstance.setChannel(Channel);
}
======================================
public void setInit(java.lang.String)
sMethodName=public void setInit
sParams=java.lang.String
sThrows=
tempMethodName=public void setInit1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setInit
params=java.lang.String
/**
* Sets the init (initialization String) for the
* tagged device.
*
* @param init
*/
public void setInit(java.lang.String Init)
{
objectInstance.setInit(Init);
}
======================================
public void setClusterName(java.lang.String)
sMethodName=public void setClusterName
sParams=java.lang.String
sThrows=
tempMethodName=public void setClusterName1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setClusterName
params=java.lang.String
/**
* Sets the cluster name for the tagged device.
*
* @param cluster
*/
public void setClusterName(java.lang.String cluster)
{
objectInstance.setClusterName(cluster);
}
======================================
public void setBranches(java.util.Vector)
sMethodName=public void setBranches
sParams=java.util.Vector
sThrows=
tempMethodName=public void setBranches1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setBranches
params=java.util.Vector
/**
* Sets the vector of branches to get to the tagged device.
*
* @param branches
*/
public void setBranches(java.util.Vector branches)
{
objectInstance.setBranches(branches);
}
======================================
public void setOWPath(com.dalsemi.onewire.utils.OWPath)
sMethodName=public void setOWPath
sParams=com.dalsemi.onewire.utils.OWPath
sThrows=
tempMethodName=public void setOWPath1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setOWPath
params=com.dalsemi.onewire.utils.OWPath
/**
* Sets the OWPath for the tagged device. An
* OWPath is a description of how to
* physically get to a 1-Wire device through a
* set of nested 1-Wire switches.
*
* @param branchOWPath
*/
public void setOWPath(OWPath branchOWPath)
{
objectInstance.setOWPath(((com.dalsemi.onewire.utils.OWPath)branchOWPath.objectInstance));
}
======================================
public void setOWPath(com.dalsemi.onewire.adapter.DSPortAdapter, java.util.Vector)
sMethodName=public void setOWPath
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, java.util.Vector
sThrows=
tempMethodName=public void setOWPath2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public void setOWPath
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.util.Vector
/**
* Sets the OWPath for the tagged device. An
* OWPath is a description of how to
* physically get to a 1-Wire device through a
* set of nested 1-Wire switches.
*
* @param adapter
* @param Branches
*/
public void setOWPath(DSPortAdapter adapter, java.util.Vector Branches)
{
objectInstance.setOWPath(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), Branches);
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer()
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
sParams=
sThrows=
tempMethodName=public OneWireContainer getDeviceContainer0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public com.dalsemi.onewire.container.OneWireContainer getDeviceContainer
params=
/**
* Gets the 1-Wire Container for the tagged device.
*
* @return The 1-Wire container for the tagged device.
*/
public OneWireContainer getDeviceContainer()
{
return new OneWireContainer(objectInstance.getDeviceContainer());
}
======================================
public java.lang.String getDeviceType()
sMethodName=public java.lang.String getDeviceType
sParams=
sThrows=
tempMethodName=public java.lang.String getDeviceType0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String getDeviceType
params=
/**
* Gets the device type for the tagged device.
*
* @return The device type for the tagged device.
*/
public java.lang.String getDeviceType()
{
return objectInstance.getDeviceType();
}
======================================
public java.lang.String getLabel()
sMethodName=public java.lang.String getLabel
sParams=
sThrows=
tempMethodName=public java.lang.String getLabel0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String getLabel
params=
/**
* Gets the label for the tagged device.
*
* @return The label for the tagged device.
*/
public java.lang.String getLabel()
{
return objectInstance.getLabel();
}
======================================
public java.lang.String getChannelAsString()
sMethodName=public java.lang.String getChannelAsString
sParams=
sThrows=
tempMethodName=public java.lang.String getChannelAsString0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String getChannelAsString
params=
/**
* Gets the channel for the tagged device as a String.
*
* @return The channel for the tagged device as a String.
*/
public java.lang.String getChannelAsString()
{
return objectInstance.getChannelAsString();
}
======================================
public int getChannel()
sMethodName=public int getChannel
sParams=
sThrows=
tempMethodName=public int getChannel0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public int getChannel
params=
/**
* Gets the channel for the tagged device as an int.
*
* @return The channel for the tagged device as an int.
*/
public int getChannel()
{
return objectInstance.getChannel();
}
======================================
public java.lang.String getInit()
sMethodName=public java.lang.String getInit
sParams=
sThrows=
tempMethodName=public java.lang.String getInit0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String getInit
params=
/**
* Gets the init (Initialization String) for the
* tagged device.
*
* @return String init (Initialization String)
*/
public java.lang.String getInit()
{
return objectInstance.getInit();
}
======================================
public java.lang.String getMax()
sMethodName=public java.lang.String getMax
sParams=
sThrows=
tempMethodName=public java.lang.String getMax0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String getMax
params=
/**
* Gets the max string for the tagged device.
*
* @return String Gets the max string
*/
public java.lang.String getMax()
{
return objectInstance.getMax();
}
======================================
public java.lang.String getMin()
sMethodName=public java.lang.String getMin
sParams=
sThrows=
tempMethodName=public java.lang.String getMin0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String getMin
params=
/**
* Gets the min string for the tagged device.
*
* @return String Gets the min string
*/
public java.lang.String getMin()
{
return objectInstance.getMin();
}
======================================
public java.lang.String getClusterName()
sMethodName=public java.lang.String getClusterName
sParams=
sThrows=
tempMethodName=public java.lang.String getClusterName0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String getClusterName
params=
/**
* Gets the cluster name for the tagged device.
*
* @return The cluster name for the tagged device.
*/
public java.lang.String getClusterName()
{
return objectInstance.getClusterName();
}
======================================
public java.util.Vector getBranches()
sMethodName=public java.util.Vector getBranches
sParams=
sThrows=
tempMethodName=public java.util.Vector getBranches0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.util.Vector getBranches
params=
/**
* Gets a vector of branches (to get to) the tagged device.
*
* @return The vector of branches to get to the tagged device.
*/
public java.util.Vector getBranches()
{
return objectInstance.getBranches();
}
======================================
public com.dalsemi.onewire.utils.OWPath getOWPath()
sMethodName=public com.dalsemi.onewire.utils.OWPath getOWPath
sParams=
sThrows=
tempMethodName=public OWPath getOWPath0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public com.dalsemi.onewire.utils.OWPath getOWPath
params=
/**
* Gets the OWPath for the tagged device. An
* OWPath is a description of how to
* physically get to a 1-Wire device through a
* set of nested 1-Wire switches.
*
* @return The OWPath for the tagged device.
*/
public OWPath getOWPath()
{
return new OWPath(objectInstance.getOWPath());
}
======================================
public boolean equals(java.lang.Object)
sMethodName=public boolean equals
sParams=java.lang.Object
sThrows=
tempMethodName=public boolean equals1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public boolean equals
params=java.lang.Object
No documentation available for method
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public boolean equals
params=java.lang.Object
methodMatcher=/boolean equals *\((.*Object.*)\)/
/**
* No documentation available for method
*/
public boolean equals(java.lang.Object o)
{
return objectInstance.equals(o);
}
======================================
public int hashCode()
sMethodName=public int hashCode
sParams=
sThrows=
tempMethodName=public int hashCode0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public int hashCode
params=
No documentation available for method
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public int hashCode
params=
methodMatcher=/int hashCode *\((.*.*)\)/
/**
* No documentation available for method
*/
public int hashCode()
{
return objectInstance.hashCode();
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String toString
params=
No documentation available for method
className=com.dalsemi.onewire.application.tag.TaggedDevice
methodName=public java.lang.String toString
params=
methodMatcher=/String toString *\((.*.*)\)/
/**
* No documentation available for method
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
-------------------------------------------------------------------
creating: owapi\TAGParser.java
======================================
public com.dalsemi.onewire.application.tag.TAGParser(com.dalsemi.onewire.adapter.DSPortAdapter)
sMethodName=public com.dalsemi.onewire.application.tag.TAGParser
sParams=com.dalsemi.onewire.adapter.DSPortAdapter
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TAGParser
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter
/**
* Construct the tag parser.
*
* @param adapter What port adapter will serve the devices created.
*/
public void createNewInstance(DSPortAdapter adapter)
{
objectInstance = new com.dalsemi.onewire.application.tag.TAGParser(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance));
}
======================================
public java.util.Vector parse(java.io.InputStream) throws org.xml.sax.SAXException, java.io.IOException
sMethodName=public java.util.Vector parse
sParams=java.io.InputStream
sThrows=throws org.xml.sax.SAXException, java.io.IOException
tempMethodName=public java.util.Vector parse1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TAGParser
methodName=public java.util.Vector parse
params=java.io.InputStream
/**
* Returns the vector of TaggedDevice objects described in the TAG file.
*
* @param in The XML document to parse.
*
* @return Vector of TaggedDevice objects.
* @throws SAXException If a parse error occurs parsing <var>in</var>.
* @throws IOException If an I/O error occurs while reading <var>in</var>.
*/
public java.util.Vector parse(java.io.InputStream in)
throws org.xml.sax.SAXException, java.io.IOException
{
return objectInstance.parse(in);
}
======================================
public java.util.Vector getBranches()
sMethodName=public java.util.Vector getBranches
sParams=
sThrows=
tempMethodName=public java.util.Vector getBranches0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TAGParser
methodName=public java.util.Vector getBranches
params=
/**
* Returns the vector of Branch TaggedDevice objects described in the TAG file.
* The XML should already be parsed before calling this method.
*
* @param in The XML document to parse.
*
* @return Vector of Branch TaggedDevice objects.
*/
public java.util.Vector getBranches()
{
return objectInstance.getBranches();
}
======================================
public java.util.Vector getOWPaths()
sMethodName=public java.util.Vector getOWPaths
sParams=
sThrows=
tempMethodName=public java.util.Vector getOWPaths0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.TAGParser
methodName=public java.util.Vector getOWPaths
params=
/**
* Returns the vector of OWPath objects discovered through parsing
* the XML file. The XML file should already be parsed before calling
* this method.
*
* @param no parameters.
*
* @return Vector of OWPath objects.
*/
public java.util.Vector getOWPaths()
{
return objectInstance.getOWPaths();
}
-------------------------------------------------------------------
creating: owapi\Thermal.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.application.tag.Thermal(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String)
sMethodName=public com.dalsemi.onewire.application.tag.Thermal
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Thermal
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Creates an object for the device with the supplied address and device type connected
* to the supplied port adapter.
* @param adapter The adapter serving the sensor.
* @param netAddress The 1-Wire network address of the sensor.
*/
public void createNewInstance(DSPortAdapter adapter, java.lang.String netAddress)
{
objectInstance = new com.dalsemi.onewire.application.tag.Thermal(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), netAddress);
}
======================================
public java.lang.String readSensor() throws com.dalsemi.onewire.OneWireException
sMethodName=public java.lang.String readSensor
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public java.lang.String readSensor0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.Thermal
methodName=public java.lang.String readSensor
params=
/**
* The readSensor method returns a temperature in degrees Celsius
*
* @param--none.
*
* @return String temperature in degrees Celsius
*/
public java.lang.String readSensor()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.application.tag.Thermal)objectInstance).readSensor();
}
-------------------------------------------------------------------
creating: owapi\XML.java
======================================
public static com.dalsemi.onewire.application.tag.SAXParser createSAXParser()
sMethodName=public static com.dalsemi.onewire.application.tag.SAXParser createSAXParser
sParams=
sThrows=
tempMethodName=public static SAXParser createSAXParser0
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.XML
methodName=public static com.dalsemi.onewire.application.tag.SAXParser createSAXParser
params=
/**
* Create a SAX parser.
*
* @return A new SAX parser.
*/
public SAXParser createSAXParser()
{
return new SAXParser(com.dalsemi.onewire.application.tag.XML.createSAXParser());
}
======================================
public static java.lang.String escape(java.lang.String)
sMethodName=public static java.lang.String escape
sParams=java.lang.String
sThrows=
tempMethodName=public static java.lang.String escape1
getMethodDocumentation
className=com.dalsemi.onewire.application.tag.XML
methodName=public static java.lang.String escape
params=java.lang.String
parameterList=String source
a0=>source
/**
* Escape special characters in the given string.
*
* This method takes a string and escapes special characters so it can be used as
* the text content of an element or as an attribute value. For example, the
* ampersand & becomes &amp;.
*
* @param source The string to escape
* @return The escaped string.
*/
public java.lang.String escape(java.lang.String source)
{
return com.dalsemi.onewire.application.tag.XML.escape(source);
}
-------------------------------------------------------------------
creating: owapi\ADContainer.java
No COM CLSID for ADContainer
======================================
public static final int ALARM_HIGH
======================================
public static final int ALARM_LOW
======================================
public int getNumberADChannels()
sMethodName=public int getNumberADChannels
sParams=
sThrows=
tempMethodName=public int getNumberADChannels0
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public int getNumberADChannels
params=
/**
* Gets the number of channels supported by this A/D.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberADChannels()</code> - 1)].
*
* @return the number of channels
*/
public int getNumberADChannels();
======================================
public boolean hasADAlarms()
sMethodName=public boolean hasADAlarms
sParams=
sThrows=
tempMethodName=public boolean hasADAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public boolean hasADAlarms
params=
/**
* Checks to see if this A/D measuring device has high/low
* alarms.
*
* @return true if this device has high/low trip alarms
*/
public boolean hasADAlarms();
======================================
public double getADRanges(int)[]
sMethodName=public double getADRanges
sParams=int
sThrows=
tempMethodName=public double[] getADRanges1
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public double[] getADRanges
params=int
/**
* Gets an array of available ranges for the specified
* A/D channel.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
*
* @return array indicating the available ranges starting
* from the largest range to the smallest range
*
* @see #getNumberADChannels()
*/
public double[] getADRanges(int channel);
======================================
public double getADResolutions(int, double)[]
sMethodName=public double getADResolutions
sParams=int, double
sThrows=
tempMethodName=public double[] getADResolutions2
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public double[] getADResolutions
params=int,double
/**
* Gets an array of available resolutions based
* on the specified range on the specified A/D channel.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param range A/D range setting from the <code>getADRanges(int)</code> method
*
* @return array indicating the available resolutions on this
* <code>channel</code> for this <code>range</code>
*
* @see #getNumberADChannels()
* @see #getADRanges(int)
*/
public double[] getADResolutions(int channel, double range);
======================================
public boolean canADMultiChannelRead()
sMethodName=public boolean canADMultiChannelRead
sParams=
sThrows=
tempMethodName=public boolean canADMultiChannelRead0
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public boolean canADMultiChannelRead
params=
/**
* Checks to see if this A/D supports doing multiple voltage
* conversions at the same time.
*
* @return true if the device can do multi-channel voltage reads
*
* @see #doADConvert(boolean[],byte[])
*/
public boolean canADMultiChannelRead();
======================================
public void doADConvert(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvert2
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public void doADConvert
params=int,byte[]
/**
* Performs a voltage conversion on one specified channel.
* Use the method <code>getADVoltage(int,byte[])</code> to read
* the result of this conversion, using the same <code>channel</code>
* argument as this method uses.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see OneWireSensor#readDevice()
* @see #getADVoltage(int,byte[])
*/
public void doADConvert(int a0, ByteArray a1)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public void doADConvert(boolean[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=boolean[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvertMulti2
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public void doADConvert
params=boolean[],byte[]
/**
* Performs voltage conversion on one or more specified
* channels. The method <code>getADVoltage(byte[])</code> can be used to read the result
* of the conversion(s). This A/D must support multi-channel read,
* reported by <code>canADMultiChannelRead()</code>, if more then 1 channel is specified.
*
* @param doConvert array of size <code>getNumberADChannels()</code> representing
* which channels should perform conversions
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see OneWireSensor#readDevice()
* @see #getADVoltage(byte[])
* @see #canADMultiChannelRead()
*/
public void doADConvertMulti(boolean[] a0, ByteArray a1)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public double getADVoltage(byte[])[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double[] getADVoltage1
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public double[] getADVoltage
params=byte[]
/**
* Reads the value of the voltages after a <code>doADConvert(boolean[],byte[])</code>
* method call. This A/D device must support multi-channel reading, reported by
* <code>canADMultiChannelRead()</code>, if more than 1 channel conversion was attempted
* by <code>doADConvert()</code>.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return array with the voltage values for all channels
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see #doADConvert(boolean[],byte[])
*/
public double[] getADVoltage(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public double getADVoltage(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double getADVoltage2
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public double getADVoltage
params=int,byte[]
/**
* Reads the value of the voltages after a <code>doADConvert(int,byte[])</code>
* method call. If more than one channel has been read it is more
* efficient to use the <code>getADVoltage(byte[])</code> method that
* returns all channel voltage values.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the voltage value for the specified channel
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see #doADConvert(int,byte[])
* @see #getADVoltage(byte[])
*/
public double getADVoltage(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public double getADAlarm(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getADAlarm
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getADAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public double getADAlarm
params=int,int,byte[]
/**
* Reads the value of the specified A/D alarm on the specified channel.
* Not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the alarm value in volts
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#readDevice()
* @see #hasADAlarms()
*/
public double getADAlarm(int a0, int a1, ByteArray a2)
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean getADAlarmEnable(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getADAlarmEnable
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getADAlarmEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public boolean getADAlarmEnable
params=int,int,byte[]
/**
* Checks to see if the specified alarm on the specified channel is enabled.
* Not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if specified alarm is enabled
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#readDevice()
* @see #hasADAlarms()
*/
public boolean getADAlarmEnable(int a0, int a1, ByteArray a2)
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean hasADAlarmed(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean hasADAlarmed
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean hasADAlarmed3
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public boolean hasADAlarmed
params=int,int,byte[]
/**
* Checks the state of the specified alarm on the specified channel.
* Not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if specified alarm occurred
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#readDevice()
* @see #hasADAlarms()
* @see #getADAlarmEnable(int,int,byte[])
* @see #setADAlarmEnable(int,int,boolean,byte[])
*/
public boolean hasADAlarmed(int a0, int a1, ByteArray a2)
throws com.dalsemi.onewire.OneWireException;
======================================
public double getADResolution(int, byte[])
sMethodName=public double getADResolution
sParams=int, byte[]
sThrows=
tempMethodName=public double getADResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public double getADResolution
params=int,byte[]
/**
* Returns the currently selected resolution for the specified
* channel. This device may not have selectable resolutions,
* though this method will return a valid value.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the current resolution of <code>channel</code> in volts
*
* @see #getADResolutions(int,double)
* @see #setADResolution(int,double,byte[])
*/
public double getADResolution(int channel, ByteArray state);
======================================
public double getADRange(int, byte[])
sMethodName=public double getADRange
sParams=int, byte[]
sThrows=
tempMethodName=public double getADRange2
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public double getADRange
params=int,byte[]
/**
* Returns the currently selected range for the specified
* channel. This device may not have selectable ranges,
* though this method will return a valid value.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the input voltage range
*
* @see #getADRanges(int)
* @see #setADRange(int,double,byte[])
*/
public double getADRange(int channel, ByteArray state);
======================================
public void setADAlarm(int, int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarm
sParams=int, int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarm4
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public void setADAlarm
params=int,int,double,byte[]
/**
* Sets the voltage value of the specified alarm on the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param alarm new alarm value
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasADAlarms()
* @see #getADAlarm(int,int,byte[])
* @see #getADAlarmEnable(int,int,byte[])
* @see #setADAlarmEnable(int,int,boolean,byte[])
* @see #hasADAlarmed(int,int,byte[])
*/
public void setADAlarm(int a0, int a1, double a2, ByteArray a3)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setADAlarmEnable(int, int, boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarmEnable
sParams=int, int, boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarmEnable4
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public void setADAlarmEnable
params=int,int,boolean,byte[]
/**
* Enables or disables the specified alarm on the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param alarmEnable true to enable the alarm, false to disable
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasADAlarms()
* @see #getADAlarm(int,int,byte[])
* @see #setADAlarm(int,int,double,byte[])
* @see #getADAlarmEnable(int,int,byte[])
* @see #hasADAlarmed(int,int,byte[])
*/
public void setADAlarmEnable(int a0, int a1, boolean a2, ByteArray a3)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setADResolution(int, double, byte[])
sMethodName=public void setADResolution
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADResolution3
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public void setADResolution
params=int,double,byte[]
/**
* Sets the conversion resolution value for the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param resolution one of the resolutions returned by <code>getADResolutions(int,double)</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #getADResolutions(int,double)
* @see #getADResolution(int,byte[])
*
*/
public void setADResolution(int channel, double resolution, ByteArray state);
======================================
public void setADRange(int, double, byte[])
sMethodName=public void setADRange
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADRange3
getMethodDocumentation
className=com.dalsemi.onewire.container.ADContainer
methodName=public void setADRange
params=int,double,byte[]
/**
* Sets the input range for the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param range one of the ranges returned by <code>getADRanges(int)</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #getADRanges(int)
* @see #getADRange(int,byte[])
*/
public void setADRange(int channel, double range, ByteArray state);
-------------------------------------------------------------------
creating: owapi\ClockContainer.java
No COM CLSID for ClockContainer
======================================
public boolean hasClockAlarm()
sMethodName=public boolean hasClockAlarm
sParams=
sThrows=
tempMethodName=public boolean hasClockAlarm0
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public boolean hasClockAlarm
params=
/**
* Checks to see if the clock has an alarm feature.
*
* @return true if the Real-Time clock has an alarm
*
* @see #getClockAlarm(byte[])
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean hasClockAlarm();
======================================
public boolean canDisableClock()
sMethodName=public boolean canDisableClock
sParams=
sThrows=
tempMethodName=public boolean canDisableClock0
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public boolean canDisableClock
params=
/**
* Checks to see if the clock can be disabled.
*
* @return true if the clock can be enabled and disabled
*
* @see #isClockRunning(byte[])
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean canDisableClock();
======================================
public long getClockResolution()
sMethodName=public long getClockResolution
sParams=
sThrows=
tempMethodName=public String getClockResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public long getClockResolution
params=
/**
* Gets the clock resolution in milliseconds.
*
* @return the clock resolution in milliseconds
*/
public String getClockResolution();
======================================
public long getClock(byte[])
sMethodName=public long getClock
sParams=byte[]
sThrows=
tempMethodName=public String getClock1
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public long getClock
params=byte[]
/**
* Extracts the Real-Time clock value in milliseconds.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the time represented in this clock in milliseconds since 1970
*
* @see OneWireSensor#readDevice()
* @see #setClock(long,byte[])
*/
public String getClock(ByteArray a0);
======================================
public long getClockAlarm(byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public long getClockAlarm
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public String getClockAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public long getClockAlarm
params=byte[]
/**
* Extracts the clock alarm value for the Real-Time clock.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the set value of the clock alarm in milliseconds since 1970
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public String getClockAlarm(ByteArray a0)
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean isClockAlarming(byte[])
sMethodName=public boolean isClockAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public boolean isClockAlarming
params=byte[]
/**
* Checks if the clock alarm flag has been set.
* This will occur when the value of the Real-Time
* clock equals the value of the clock alarm.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the Real-Time clock is alarming
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarming(ByteArray a0);
======================================
public boolean isClockAlarmEnabled(byte[])
sMethodName=public boolean isClockAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public boolean isClockAlarmEnabled
params=byte[]
/**
* Checks if the clock alarm is enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if clock alarm is enabled
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarming(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarmEnabled(ByteArray a0);
======================================
public boolean isClockRunning(byte[])
sMethodName=public boolean isClockRunning
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockRunning1
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public boolean isClockRunning
params=byte[]
/**
* Checks if the device's oscillator is enabled. The clock
* will not increment if the clock oscillator is not enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the clock is running
*
* @see OneWireSensor#readDevice()
* @see #canDisableClock()
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean isClockRunning(ByteArray a0);
======================================
public void setClock(long, byte[])
sMethodName=public void setClock
sParams=long, byte[]
sThrows=
tempMethodName=public void setClock2
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public void setClock
params=long,byte[]
/**
* Sets the Real-Time clock.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param time new value for the Real-Time clock, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getClock(byte[])
*/
public void setClock(String a0, ByteArray a1);
======================================
public void setClockAlarm(long, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarm
sParams=long, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public void setClockAlarm
params=long,byte[]
/**
* Sets the clock alarm.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param time - new value for the Real-Time clock alarm, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public void setClockAlarm(String a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setClockRunEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockRunEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockRunEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public void setClockRunEnable
params=boolean,byte[]
/**
* Enables or disables the oscillator, turning the clock 'on' and 'off'.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices can disable their oscillators. Check to see if this device can
* disable its oscillator first by calling the <code>canDisableClock()</code> method.
*
* @param runEnable true to enable the clock oscillator
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if the clock oscillator cannot be disabled
*
* @see OneWireSensor#writeDevice(byte[])
* @see #canDisableClock()
* @see #isClockRunning(byte[])
*/
public void setClockRunEnable(boolean a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setClockAlarmEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarmEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.ClockContainer
methodName=public void setClockAlarmEnable
params=boolean,byte[]
/**
* Enables or disables the clock alarm.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param alarmEnable true to enable the clock alarm
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #isClockAlarming(byte[])
*/
public void setClockAlarmEnable(boolean a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException;
-------------------------------------------------------------------
creating: owapi\CommandAPDU.java
======================================
public static final int CLA
======================================
public static final int INS
======================================
public static final int P1
======================================
public static final int P2
======================================
public static final int LC
======================================
public com.dalsemi.onewire.container.CommandAPDU(byte[])
sMethodName=public com.dalsemi.onewire.container.CommandAPDU
sParams=byte[]
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public void createNewInstance
params=byte[]
/**
* Constructs a new ISO 7816-4 <code>CommandAPDU</code>.
*
* @param buffer the entire <code>CommandAPDU</code> as a byte array
*/
public void createNewInstance(ByteArray buffer)
{
objectInstance = new com.dalsemi.onewire.container.CommandAPDU(buffer.array);
}
======================================
public com.dalsemi.onewire.container.CommandAPDU(byte,byte,byte,byte)
sMethodName=public com.dalsemi.onewire.container.CommandAPDU
sParams=byte,byte,byte,byte
sThrows=
tempMethodName=public void createNewInstance4
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public void createNewInstance
params=byte,byte,byte,byte
/**
* Constructs a new ISO 7816-4 CASE 1 <code>CommandAPDU</code>.
*
* @param cla <code>CLA</code> byte
* @param ins <code>INS</code> byte
* @param p1 parameter byte <code>P1</code>
* @param p2 parameter byte <code>P2</code>
*/
public void createNewInstance(byte cla, byte ins, byte p1, byte p2)
{
objectInstance = new com.dalsemi.onewire.container.CommandAPDU(cla, ins, p1, p2);
}
======================================
public com.dalsemi.onewire.container.CommandAPDU(byte,byte,byte,byte,int)
sMethodName=public com.dalsemi.onewire.container.CommandAPDU
sParams=byte,byte,byte,byte,int
sThrows=
tempMethodName=public void createNewInstanceFromInt5
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public void createNewInstance
params=byte,byte,byte,byte,int
/**
* Constructs a new ISO 7816-4 CASE 2 <code>CommandAPDU</code>.
*
* @param cla <code>CLA</code> byte
* @param ins <code>INS</code> byte
* @param p1 parameter byte <code>P1</code>
* @param p2 parameter byte <code>P2</code>
* @param le length of expected <code>ResponseAPDU</code>,
* ranges from <code>-1</code> to
* <code>255</code>, where <code>-1</code> is no length
* and <code>0</code> is the maximum length
* supported
*
* @see ResponseAPDU
*/
public void createNewInstanceFromInt(byte cla, byte ins, byte p1, byte p2, int le)
{
objectInstance = new com.dalsemi.onewire.container.CommandAPDU(cla, ins, p1, p2, le);
}
======================================
public com.dalsemi.onewire.container.CommandAPDU(byte,byte,byte,byte,byte[])
sMethodName=public com.dalsemi.onewire.container.CommandAPDU
sParams=byte,byte,byte,byte,byte[]
sThrows=
tempMethodName=public void createNewInstance5
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public void createNewInstance
params=byte,byte,byte,byte,byte[]
/**
* Constructs a new ISO 7816-4 CASE 3 <code>CommandAPDU</code>.
*
* @param cla <code>CLA</code> byte
* @param ins <code>INS</code> byte
* @param p1 parameter byte <code>P1</code>
* @param p2 parameter byte <code>P2</code>
* @param data this <code>CommandAPDU</code> data as a byte array,
* <code>LC</code> is derived from this data
* array length
*/
public void createNewInstance(byte cla, byte ins, byte p1, byte p2, ByteArray data)
{
objectInstance = new com.dalsemi.onewire.container.CommandAPDU(cla, ins, p1, p2, data.array);
}
======================================
public com.dalsemi.onewire.container.CommandAPDU(byte,byte,byte,byte,byte[],int)
sMethodName=public com.dalsemi.onewire.container.CommandAPDU
sParams=byte,byte,byte,byte,byte[],int
sThrows=
tempMethodName=public void createNewInstanceFromInt6
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public void createNewInstance
params=byte,byte,byte,byte,byte[],int
/**
* Constructs a new ISO 7816-4 CASE 4 <code>CommandAPDU</code>.
*
* @param cla <code>CLA</code> byte
* @param ins <code>INS</code> byte
* @param p1 parameter byte <code>P1</code>
* @param p2 parameter byte <code>P2</code>
* @param data <code>CommandAPDU</code> data as a byte array,
* <code>LC</code> is derived from this data
* array length
* @param le length of expected <code>ResponseAPDU</code>,
* ranges from <code>-1</code> to
* <code>255</code>, where <code>-1</code> is no length
* and <code>0</code> is the maximum length
* supported
*
* @see ResponseAPDU
*/
public void createNewInstanceFromInt(byte cla, byte ins, byte p1, byte p2, ByteArray data, int le)
{
objectInstance = new com.dalsemi.onewire.container.CommandAPDU(cla, ins, p1, p2, data.array, le);
}
======================================
public byte getCLA()
sMethodName=public byte getCLA
sParams=
sThrows=
tempMethodName=public byte getCLA0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public byte getCLA
params=
/**
* Gets the <code>CLA</code> byte value.
*
* @return <code>CLA</code> byte of this <code>CommandAPDU</code>
*/
public byte getCLA()
{
return objectInstance.getCLA();
}
======================================
public byte getINS()
sMethodName=public byte getINS
sParams=
sThrows=
tempMethodName=public byte getINS0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public byte getINS
params=
/**
* Gets the <code>INS</code> byte value.
*
* @return <code>INS</code> byte of this <code>CommandAPDU</code>
*/
public byte getINS()
{
return objectInstance.getINS();
}
======================================
public byte getP1()
sMethodName=public byte getP1
sParams=
sThrows=
tempMethodName=public byte getP10
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public byte getP1
params=
/**
* Gets the first parameter (<code>P1</code>) byte value.
*
* @return <code>P1</code> byte of this <code>CommandAPDU</code>
*/
public byte getP1()
{
return objectInstance.getP1();
}
======================================
public byte getP2()
sMethodName=public byte getP2
sParams=
sThrows=
tempMethodName=public byte getP20
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public byte getP2
params=
/**
* Gets the second parameter (<code>P2</code>) byte value.
*
* @return <code>P2</code> byte of this <code>CommandAPDU</code>
*/
public byte getP2()
{
return objectInstance.getP2();
}
======================================
public int getLC()
sMethodName=public int getLC
sParams=
sThrows=
tempMethodName=public int getLC0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public int getLC
params=
/**
* Gets the length of data field (<code>LC</code>).
*
* @return the number of bytes present in the data field of
* this <code>CommandAPDU</code>, <code>0</code>
* indicates that there is no body
*/
public int getLC()
{
return objectInstance.getLC();
}
======================================
public int getLE()
sMethodName=public int getLE
sParams=
sThrows=
tempMethodName=public int getLE0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public int getLE
params=
/**
* Gets the expected length of <code>ResponseAPDU</code> (<code>LE</code>).
*
* @return the maximum number of bytes expected in the data field
* of the <code>ResponseAPDU</code> to this <code>CommandAPDU</code>,
* <code>-1</code> indicates that no value is specified
*
* @see ResponseAPDU
*/
public int getLE()
{
return objectInstance.getLE();
}
======================================
public final byte getBuffer()[]
sMethodName=public final byte getBuffer
sParams=
sThrows=
tempMethodName=public final ByteArray getBuffer0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public final byte[] getBuffer
params=
/**
* Gets this <code>CommandAPDU</code> <code>apduBuffer</code>.
* This method allows user to manipulate the buffered <code>CommandAPDU</code>.
*
* @return <code>apduBuffer</code> that holds the current <code>CommandAPDU</code>
*
* @see #getBytes
*
*/
public final ByteArray getBuffer()
{
return new ByteArray().setupObject(objectInstance.getBuffer());
}
======================================
public final byte getByte(int)
sMethodName=public final byte getByte
sParams=int
sThrows=
tempMethodName=public final byte getByte1
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public final byte getByte
params=int
/**
* Gets the byte at the specified offset in the <code>apduBuffer</code>.
* This method can only be used to access the <code>CommandAPDU</code>
* currently stored. It is not possible to read beyond the
* end of the <code>CommandAPDU</code>.
*
* @param index the offset in the <code>apduBuffer</code>
*
* @return the value at the given offset,
* or <code>-1</code> if the offset is invalid
*
* @see #setByte
* @see #getLength
*/
public final byte getByte(int index)
{
return objectInstance.getByte(index);
}
======================================
public final byte getBytes()[]
sMethodName=public final byte getBytes
sParams=
sThrows=
tempMethodName=public final ByteArray getBytes0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public final byte[] getBytes
params=
/**
* Gets a byte array of the buffered <code>CommandAPDU</code>.
* The byte array returned gets allocated with the exact size of the
* buffered <code>CommandAPDU</code>. To get direct access to the
* internal <code>apduBuffer</code>, use <code>getBuffer()</code>.
*
* @return the buffered <code>CommandAPDU</code> copied into a new array
*
* @see #getBuffer
*/
public final ByteArray getBytes()
{
return new ByteArray().setupObject(objectInstance.getBytes());
}
======================================
public final int getLength()
sMethodName=public final int getLength
sParams=
sThrows=
tempMethodName=public final int getLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public final int getLength
params=
/**
* Gets the length of the buffered <code>CommandAPDU</code>.
*
* @return the length of the <code>CommandAPDU</code> currently stored
*/
public final int getLength()
{
return objectInstance.getLength();
}
======================================
public final void setByte(int, byte)
sMethodName=public final void setByte
sParams=int, byte
sThrows=
tempMethodName=public final void setByte2
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public final void setByte
params=int,byte
/**
* Sets the byte value at the specified offset in the
* <code>apduBuffer</code>.
* This method can only be used to modify a <code>CommandAPDU</code>
* already stored. It is not possible to set bytes beyond
* the end of the current <code>CommandAPDU</code>.
*
* @param index the offset in the <code>apduBuffer</code>
* @param value the new byte value to store
*
* @see #getByte
* @see #getLength
*
*/
public final void setByte(int index, byte value)
{
objectInstance.setByte(index, value);
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.container.CommandAPDU
methodName=public java.lang.String toString
params=
/**
* Gets a string representation of this <code>CommandAPDU</code>.
*
* @return a string describing this <code>CommandAPDU</code>
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
-------------------------------------------------------------------
creating: owapi\HumidityContainer.java
No COM CLSID for HumidityContainer
======================================
public static final int ALARM_HIGH
======================================
public static final int ALARM_LOW
======================================
public boolean isRelative()
sMethodName=public boolean isRelative
sParams=
sThrows=
tempMethodName=public boolean isRelative0
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public boolean isRelative
params=
/**
* Checks to see if humidity value given is a 'relative' humidity value.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* provides a relative humidity reading
*
* @see #getHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public boolean isRelative();
======================================
public boolean hasHumidityAlarms()
sMethodName=public boolean hasHumidityAlarms
sParams=
sThrows=
tempMethodName=public boolean hasHumidityAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public boolean hasHumidityAlarms
params=
/**
* Checks to see if this Humidity measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* has high/low trip alarms
*
* @see #getHumidityAlarm
* @see #setHumidityAlarm
*/
public boolean hasHumidityAlarms();
======================================
public boolean hasSelectableHumidityResolution()
sMethodName=public boolean hasSelectableHumidityResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableHumidityResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public boolean hasSelectableHumidityResolution
params=
/**
* Checks to see if this device has selectable Humidity resolution.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* has selectable Humidity resolution
*
* @see #getHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public boolean hasSelectableHumidityResolution();
======================================
public double getHumidityResolutions()[]
sMethodName=public double getHumidityResolutions
sParams=
sThrows=
tempMethodName=public double[] getHumidityResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public double[] getHumidityResolutions
params=
/**
* Get an array of available Humidity resolutions in percent humidity (0 to 100).
*
* @return byte array of available Humidity resolutions in percent with
* minimum resolution as the first element and maximum resolution
* as the last element.
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #setHumidityResolution
*/
public double[] getHumidityResolutions();
======================================
public double getHumidityAlarmResolution() throws com.dalsemi.onewire.OneWireException
sMethodName=public double getHumidityAlarmResolution
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getHumidityAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public double getHumidityAlarmResolution
params=
/**
* Gets the Humidity alarm resolution in percent.
*
* @return Humidity alarm resolution in percent for this 1-wire device
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #getHumidityAlarm
* @see #setHumidityAlarm
*
*/
public double getHumidityAlarmResolution()
throws com.dalsemi.onewire.OneWireException;
======================================
public void doHumidityConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doHumidityConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doHumidityConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public void doHumidityConvert
params=byte[]
/**
* Performs a Humidity conversion.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void doHumidityConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public double getHumidity(byte[])
sMethodName=public double getHumidity
sParams=byte[]
sThrows=
tempMethodName=public double getHumidity1
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public double getHumidity
params=byte[]
/**
* Gets the humidity expressed as a percent value (0.0 to 100.0) of humidity.
*
* @param state byte array with device state information
* @return humidity expressed as a percent
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #setHumidityResolution
*/
public double getHumidity(ByteArray state);
======================================
public double getHumidityResolution(byte[])
sMethodName=public double getHumidityResolution
sParams=byte[]
sThrows=
tempMethodName=public double getHumidityResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public double getHumidityResolution
params=byte[]
/**
* Gets the current Humidity resolution in percent from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return Humidity resolution in percent for this 1-wire device
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public double getHumidityResolution(ByteArray state);
======================================
public double getHumidityAlarm(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getHumidityAlarm
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getHumidityAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public double getHumidityAlarm
params=int,byte[]
/**
* Gets the specified Humidity alarm value in percent from the
* <code>state</code> data retrieved from the
* <code>readDevice()</code> method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return Humidity alarm trip values in percent for this 1-wire device
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #setHumidityAlarm
*/
public double getHumidityAlarm(int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setHumidityAlarm(int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setHumidityAlarm
sParams=int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setHumidityAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public void setHumidityAlarm
params=int,double,byte[]
/**
* Sets the Humidity alarm value in percent in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in percent
* @param state byte array with device state information
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #getHumidityAlarm
*/
public void setHumidityAlarm(int alarmType, double alarmValue, ByteArray state)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setHumidityResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setHumidityResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setHumidityResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.HumidityContainer
methodName=public void setHumidityResolution
params=double,byte[]
/**
* Sets the current Humidity resolution in percent in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution Humidity resolution in percent
* @param state byte array with device state information
*
* @throws OneWireException Device does not support selectable
* Humidity resolution
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #getHumidityResolutions
*/
public void setHumidityResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException;
-------------------------------------------------------------------
creating: owapi\JibComm.java
======================================
public static boolean doDebugMessages
======================================
public int min_read_runtime
======================================
public static void setMinRuntime(int)
sMethodName=public static void setMinRuntime
sParams=int
sThrows=
tempMethodName=public static void setMinRuntime1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public static void setMinRuntime
params=int
/**
* Sets the time given by a host for the Java Powered <u>i</u>Button to
* perform its task. In some cases, increases in this value may help
* avoid communications errors. 63 milliseconds is the absolute lowest
* rated value, but 96 milliseconds makes for fewer errors.
*
* @param runtime minimum runtime the host gives a Java <u>i</u>Button to perform its task (in ms)
*
* @throws IllegalArgumentException on illegal run time values (must be at least 63)
*/
public void setMinRuntime(int runtime)
{
com.dalsemi.onewire.container.JibComm.setMinRuntime(runtime);
}
======================================
public static void setRuntimeMultiplier(int)
sMethodName=public static void setRuntimeMultiplier
sParams=int
sThrows=
tempMethodName=public static void setRuntimeMultiplier1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public static void setRuntimeMultiplier
params=int
/**
* Sets the incremental increase in runtime a host will give a
* Java Powered <u>i</u>Button to perform its task. Beyond the initial
* minimum runtime, the Java <u>i</u>Button only understands increments
* of 250 milliseconds. However, due to clock and timing variations,
* this value may need to be altered. CRC errors are common if this value
* is too low for a given operation. 250 milliseconds is the absolute lowest
* rated value. 290 milliseconds is the default.
*
* @param multiplier new incremental runtime increase value to be used
* for this Java <u>i</u>Button to perform its task (in ms)
*
* @throws IllegalArgumentException on illegal multiplier values (must be at least 250)
*/
public void setRuntimeMultiplier(int multiplier)
{
com.dalsemi.onewire.container.JibComm.setRuntimeMultiplier(multiplier);
}
======================================
public com.dalsemi.onewire.container.JibComm(com.dalsemi.onewire.container.OneWireContainer16,com.dalsemi.onewire.adapter.DSPortAdapter,byte[]) throws java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.JibComm
sParams=com.dalsemi.onewire.container.OneWireContainer16,com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
sThrows=throws java.lang.IllegalArgumentException
tempMethodName=public void createNewInstance3
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer16,com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
/** Constructs a <code>JibComm</code> object to communicate with
* this Java iButton.
*
* @param newAdapter adapter used to communicate with this Java iButton
* @param newAddress address of this Java iButton
*
* @throws IllegalArgumentException Invalid Java iButton address
*
* @see Address
*/
public void createNewInstance(OneWireContainer16 a0, DSPortAdapter a1, ByteArray a2)
throws java.lang.IllegalArgumentException
{
objectInstance = new com.dalsemi.onewire.container.JibComm(((com.dalsemi.onewire.container.OneWireContainer16)a0.objectInstance), ((com.dalsemi.onewire.adapter.DSPortAdapter)a1.objectInstance), a2.array);
}
======================================
public synchronized byte transferJibData(byte[], int)[] throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public synchronized byte transferJibData
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public synchronized ByteArray transferJibData2
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized byte[] transferJibData
params=byte[],int
/**
* Transfers data to and from this Java iButton.
*
* @param data byte array with data to be written to this Java iButton
* @param runTime a <code>4</code> bit value <code>(0 -15)</code>
* that represents the expected run time of the device.
*
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @return byte array containing data read back from this Java iButton.
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
*/
public synchronized ByteArray transferJibData(ByteArray data, int runTime)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ByteArray().setupObject(objectInstance.transferJibData(data.array, runTime));
}
======================================
public void correctPOR() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void correctPOR
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void correctPOR0
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public void correctPOR
params=
/**
* Corrects the device from a Power-On-Reset (POR) error.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public void correctPOR()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.correctPOR();
}
======================================
public synchronized void getStatus(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized void getStatus
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized void getStatus2
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void getStatus
params=byte[],int
/**
* Gets the status from this Java iButton.
*
* @return status byte array read from this Java iButton.
* The contents of the status array is as follows:
*
* <pre>
* Byte 0 - number of free bytes in the Input Buffer.
* Byte 1 - number of used bytes in the Output Buffer.
* Byte 2 - contents of the OWMS Register.
* Byte 3 - contents of the CPST register.</pre>
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #checkStatus
* @see #setStatus
*/
public synchronized void getStatus(ByteArray status, int start)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.getStatus(status.array, start);
}
======================================
public synchronized void checkStatus(int, int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized void checkStatus
sParams=int, int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized void checkStatus4
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void checkStatus
params=int,int,byte[],int
/**
* Checks the status of this Java iButton.
*
* @param runTime a <code>4</code> bit value <code>(0 -15)</code>
* that represents the expected run time of the device.
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
* @param dir <code>SEND</code> if sending data to this Java iButton,
* <code>RECEIVE</code> if receiving
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getStatus
* @see #setStatus
*/
public synchronized void checkStatus(int runTime, int dir, ByteArray status, int start)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.checkStatus(runTime, dir, status.array, start);
}
======================================
public synchronized void setStatus(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized void setStatus
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized void setStatus1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void setStatus
params=int
/**
* Sets status register of this Java iButton.
*
* @param runTime a <code>4</code> bit value <code>(0 -15)</code>
* that represents the expected run time of the device
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #checkStatus
* @see #getStatus
*/
public synchronized void setStatus(int runTime)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.setStatus(runTime);
}
======================================
public synchronized void setHeader(byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public synchronized void setHeader
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public synchronized void setHeader1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void setHeader
params=byte[]
/**
* Sets header to be written to this Java iButton.
*
* @param header byte array with the header information
*
* @throws IllegalArgumentException Invalid header length
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #checkStatus
* @see #getHeader
*/
public synchronized void setHeader(ByteArray header)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
objectInstance.setHeader(header.array);
}
======================================
public synchronized void getHeader(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized void getHeader
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized void getHeader2
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void getHeader
params=byte[],int
/**
* Gets header from this Java iButton.
*
* @return header read from this Java iButton.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #checkStatus
* @see #setHeader
*/
public synchronized void getHeader(ByteArray header, int start)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.getHeader(header.array, start);
}
======================================
public void setData(byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setData
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setData1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public void setData
params=byte[]
/**
* Sets data to be written to this Java iButton.
*
* @param data data to be written to this Java iButton
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #checkStatus
* @see #getData
*/
public void setData(ByteArray data)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.setData(data.array);
}
======================================
public byte getData(int)[] throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public byte getData
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public ByteArray getData1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public byte[] getData
params=int
/**
* Gets data from this Java iButton.
*
* @param length expected number of bytes of data to be read from the IPR
*
* @return data from this Java iButton.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #checkStatus
* @see #setData
*/
public ByteArray getData(int length)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return new ByteArray().setupObject(objectInstance.getData(length));
}
======================================
public synchronized void run(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized void run
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized void run1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void run
params=int
/**
* Runs the Micro in this Java iButton.
*
* @param runTime a <code>4</code> bit value <code>(0 -15)</code>
* that represents the expected run time of the device
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
*/
public synchronized void run(int runTime)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.run(runTime);
}
======================================
public synchronized void interrupt(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized void interrupt
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized void interrupt1
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void interrupt
params=int
/**
* Interrupts the Micro in this Java iButton.
*
* @param runTime a <code>4</code> bit value <code>(0 -15)</code>
* that represents the expected run time of the device
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
*/
public synchronized void interrupt(int runTime)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.interrupt(runTime);
}
======================================
public void reset() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void reset
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void reset0
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public void reset
params=
/**
* Resets the Micro in this Java iButton.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
*/
public void reset()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.reset();
}
======================================
public synchronized void sendCommand(byte[], byte[], boolean, long) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized void sendCommand
sParams=byte[], byte[], boolean, long
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized void sendCommand4
getMethodDocumentation
className=com.dalsemi.onewire.container.JibComm
methodName=public synchronized void sendCommand
params=byte[],byte[],boolean,long
/**
* Sends command to this Java iButton.
*
* @param commandBuffer byte array containing the command
* @param releaseBuffer byte array containing the release code
* @param powerMode <code>true</code> if power supply is to be toggled
* @param sleepTime sleep time for the program while the Micro runs.
* Applicable only if <code>powerMode</code> is true.
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
*/
public synchronized void sendCommand(ByteArray commandBuffer, ByteArray releaseBuffer, boolean powerMode, String sleepTime)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.sendCommand(commandBuffer.array, releaseBuffer.array, powerMode, Long.parseLong(sleepTime));
}
-------------------------------------------------------------------
creating: owapi\MemoryBank.java
======================================
public java.lang.String getBankDescription()
sMethodName=public java.lang.String getBankDescription
sParams=
sThrows=
tempMethodName=public java.lang.String getBankDescription0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public java.lang.String getBankDescription
params=
/**
* Gets a string description of this memory bank.
*
* @return the memory bank description
*/
public java.lang.String getBankDescription()
{
return objectInstance.getBankDescription();
}
======================================
public boolean isGeneralPurposeMemory()
sMethodName=public boolean isGeneralPurposeMemory
sParams=
sThrows=
tempMethodName=public boolean isGeneralPurposeMemory0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public boolean isGeneralPurposeMemory
params=
/**
* Checks to see if this memory bank is general purpose
* user memory. If it is NOT then it may be Memory-Mapped and writing
* values to this memory may affect the behavior of the 1-Wire
* device.
*
* @return <CODE> true </CODE> if this memory bank is general purpose
*/
public boolean isGeneralPurposeMemory()
{
return objectInstance.isGeneralPurposeMemory();
}
======================================
public int getSize()
sMethodName=public int getSize
sParams=
sThrows=
tempMethodName=public int getSize0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public int getSize
params=
/**
* Gets the size of this memory bank in bytes.
*
* @return number of bytes in current memory bank
*/
public int getSize()
{
return objectInstance.getSize();
}
======================================
public boolean isReadWrite()
sMethodName=public boolean isReadWrite
sParams=
sThrows=
tempMethodName=public boolean isReadWrite0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public boolean isReadWrite
params=
/**
* Checks to see if this memory bank is read/write.
*
* @return <CODE> true </CODE> if this memory bank is read/write
*/
public boolean isReadWrite()
{
return objectInstance.isReadWrite();
}
======================================
public boolean isWriteOnce()
sMethodName=public boolean isWriteOnce
sParams=
sThrows=
tempMethodName=public boolean isWriteOnce0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public boolean isWriteOnce
params=
/**
* Checks to see if this memory bank is write once such
* as with EPROM technology.
*
* @return <CODE> true </CODE> if this memory bank can only be written once
*/
public boolean isWriteOnce()
{
return objectInstance.isWriteOnce();
}
======================================
public boolean isReadOnly()
sMethodName=public boolean isReadOnly
sParams=
sThrows=
tempMethodName=public boolean isReadOnly0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public boolean isReadOnly
params=
/**
* Checks to see if this memory bank is read only.
*
* @return <CODE> true </CODE> if this memory bank can only be read
*/
public boolean isReadOnly()
{
return objectInstance.isReadOnly();
}
======================================
public boolean isNonVolatile()
sMethodName=public boolean isNonVolatile
sParams=
sThrows=
tempMethodName=public boolean isNonVolatile0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public boolean isNonVolatile
params=
/**
* Checks to see if this memory bank is non-volatile. Memory is
* non-volatile if it retains its contents even when removed from
* the 1-Wire network.
*
* @return <CODE> true </CODE> if this memory bank is non volatile
*/
public boolean isNonVolatile()
{
return objectInstance.isNonVolatile();
}
======================================
public boolean needsProgramPulse()
sMethodName=public boolean needsProgramPulse
sParams=
sThrows=
tempMethodName=public boolean needsProgramPulse0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public boolean needsProgramPulse
params=
/**
* Checks to see if this memory bank requires a
* 'ProgramPulse' in order to write.
*
* @return <CODE> true </CODE> if writing to this memory bank
* requires a 'ProgramPulse' from the 1-Wire Adapter.
*
* @see DSPortAdapter
*/
public boolean needsProgramPulse()
{
return objectInstance.needsProgramPulse();
}
======================================
public boolean needsPowerDelivery()
sMethodName=public boolean needsPowerDelivery
sParams=
sThrows=
tempMethodName=public boolean needsPowerDelivery0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public boolean needsPowerDelivery
params=
/**
* Checks to see if this memory bank requires 'PowerDelivery'
* in order to write.
*
* @return <CODE> true </CODE> if writing to this memory bank
* requires 'PowerDelivery' from the 1-Wire Adapter
*
* @see DSPortAdapter
*/
public boolean needsPowerDelivery()
{
return objectInstance.needsPowerDelivery();
}
======================================
public int getStartPhysicalAddress()
sMethodName=public int getStartPhysicalAddress
sParams=
sThrows=
tempMethodName=public int getStartPhysicalAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public int getStartPhysicalAddress
params=
/**
* Gets the starting physical address of this bank. Physical
* banks are sometimes sub-divided into logical banks due to changes
* in attributes. Note that this method is for information only. The read
* and write methods will automatically calculate the physical address
* when writing to a logical memory bank.
*
* @return physical starting address of this logical bank
*/
public int getStartPhysicalAddress()
{
return objectInstance.getStartPhysicalAddress();
}
======================================
public void setWriteVerification(boolean)
sMethodName=public void setWriteVerification
sParams=boolean
sThrows=
tempMethodName=public void setWriteVerification1
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public void setWriteVerification
params=boolean
/**
* Sets or clears write verification for the
* {@link #write(int,byte[],int,int) write} method.
*
* @param doReadVerf <CODE> true </CODE> (default)
* verify write in 'write',
* <CODE> false </CODE> don't verify write (used on
* Write-Once bit manipulation)
*
* @see OTPMemoryBank
*/
public void setWriteVerification(boolean a0)
{
objectInstance.setWriteVerification(a0);
}
======================================
public void read(int, boolean, byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void read
sParams=int, boolean, byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void read5
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public void read
params=int,boolean,byte[],int,int
/**
* Reads memory in this bank with no CRC checking (device or
* data). The resulting data from this API may or may not be what is on
* the 1-Wire device. It is recommended that the data contain some kind
* of checking (CRC) like in the <CODE> readPagePacket </CODE> method in
* the
* {@link PagedMemoryBank PagedMemoryBank}
* interface. Some 1-Wire devices provide thier own CRC as in
* <CODE> readPageCRC </CODE> also found in the
* {@link PagedMemoryBank PagedMemoryBank}
* interface. The <CODE> readPageCRC </CODE> method
* is not supported on all memory types, see <CODE> hasPageAutoCRC </CODE>
* in the same interface.
* If neither is an option then this method could be called more
* then once to at least verify that the same data is read consistently. The
* readContinue parameter is used to eliminate the overhead in re-accessing
* a part already being read from. For example, if pages 0 - 4 are to
* be read, readContinue would be set to false for page 0 and would be set
* to true for the next four calls.
*
* <P> Note: Using readContinue = true can only be used if the new
* read continuous where the last one led off
* and it is inside a 'beginExclusive/endExclusive'
* block.
*
* @param startAddr starting address
* @param readContinue <CODE> true </CODE> then device read is
* continued without re-selecting
* @param readBuf location for data read
* @param offset offset into readBuf to place data
* @param len length in bytes to read
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void read(int a0, boolean a1, ByteArray a2, int a3, int a4)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.read(a0, a1, a2.array, a3, a4);
}
======================================
public void write(int, byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void write
sParams=int, byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void write4
getMethodDocumentation
className=com.dalsemi.onewire.container.MemoryBank
methodName=public void write
params=int,byte[],int,int
/**
* Writes memory in this bank. It is recommended that a structure with some
* built in error checking is used to provide data integrity on read.
* The method <CODE> writePagePacket </CODE> found in the
* {@link PagedMemoryBank PagedMemoryBank}
* interface, which automatically wraps the data in a length and CRC, could
* be used for this purpose.
*
* <P> When using on Write-Once devices care must be taken to write into
* into empty space. If <CODE> write </CODE> is used to write over an unlocked
* page on a Write-Once device it will fail. If write verification
* is turned off with the method
* {@link #setWriteVerification(boolean) setWriteVerification(false)}
* then the result will be an 'AND' of the existing data and the new data.
*
* @param startAddr starting address
* @param writeBuf data to write
* @param offset offset into writeBuf to get data
* @param len length in bytes to write
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a read back verification fails. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void write(int a0, ByteArray a1, int a2, int a3)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.write(a0, a1.array, a2, a3);
}
-------------------------------------------------------------------
creating: owapi\MissionContainer.java
No COM CLSID for MissionContainer
superClassName=com.dalsemi.onewire.container.OneWireSensor
======================================
public static final int ALARM_HIGH
======================================
public static final int ALARM_LOW
======================================
public void startNewMission(int, int, boolean, boolean, boolean[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void startNewMission
sParams=int, int, boolean, boolean, boolean[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void startNewMission5
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void startNewMission
params=int,int,boolean,boolean,boolean[]
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void startNewMission
params=int,int,boolean,boolean,boolean[]
methodMatcher=/void startNewMission *\((.*int.*int.*boolean.*boolean.*boolean\[\].*)\)/
/**
* No documentation available for method
*/
public void startNewMission(int a0, int a1, boolean a2, boolean a3, boolean[] a4)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void stopMission() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void stopMission
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void stopMission0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void stopMission
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void stopMission
params=
methodMatcher=/void stopMission *\((.*.*)\)/
/**
* No documentation available for method
*/
public void stopMission()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public boolean isMissionRunning() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isMissionRunning
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isMissionRunning0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean isMissionRunning
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean isMissionRunning
params=
methodMatcher=/boolean isMissionRunning *\((.*.*)\)/
/**
* No documentation available for method
*/
public boolean isMissionRunning()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public boolean isMissionRolloverEnabled() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isMissionRolloverEnabled
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isMissionRolloverEnabled0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean isMissionRolloverEnabled
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean isMissionRolloverEnabled
params=
methodMatcher=/boolean isMissionRolloverEnabled *\((.*.*)\)/
/**
* No documentation available for method
*/
public boolean isMissionRolloverEnabled()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public boolean hasMissionRolloverOccurred() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean hasMissionRolloverOccurred
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean hasMissionRolloverOccurred0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean hasMissionRolloverOccurred
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean hasMissionRolloverOccurred
params=
methodMatcher=/boolean hasMissionRolloverOccurred *\((.*.*)\)/
/**
* No documentation available for method
*/
public boolean hasMissionRolloverOccurred()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void loadMissionResults() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void loadMissionResults
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void loadMissionResults0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void loadMissionResults
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void loadMissionResults
params=
methodMatcher=/void loadMissionResults *\((.*.*)\)/
/**
* No documentation available for method
*/
public void loadMissionResults()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public boolean isMissionLoaded()
sMethodName=public boolean isMissionLoaded
sParams=
sThrows=
tempMethodName=public boolean isMissionLoaded0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean isMissionLoaded
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean isMissionLoaded
params=
methodMatcher=/boolean isMissionLoaded *\((.*.*)\)/
/**
* No documentation available for method
*/
public boolean isMissionLoaded();
======================================
public void clearMissionResults() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void clearMissionResults
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void clearMissionResults0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void clearMissionResults
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void clearMissionResults
params=
methodMatcher=/void clearMissionResults *\((.*.*)\)/
/**
* No documentation available for method
*/
public void clearMissionResults()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public int getNumberMissionChannels() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getNumberMissionChannels
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getNumberMissionChannels0
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getNumberMissionChannels
params=
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getNumberMissionChannels
params=
methodMatcher=/int getNumberMissionChannels *\((.*.*)\)/
/**
* No documentation available for method
*/
public int getNumberMissionChannels()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setMissionChannelEnable(int, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionChannelEnable
sParams=int, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionChannelEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionChannelEnable
params=int,boolean
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionChannelEnable
params=int,boolean
methodMatcher=/void setMissionChannelEnable *\((.*int.*boolean.*)\)/
/**
* No documentation available for method
*/
public void setMissionChannelEnable(int a0, boolean a1)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public boolean getMissionChannelEnable(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean getMissionChannelEnable
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean getMissionChannelEnable1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean getMissionChannelEnable
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean getMissionChannelEnable
params=int
methodMatcher=/boolean getMissionChannelEnable *\((.*int.*)\)/
/**
* No documentation available for method
*/
public boolean getMissionChannelEnable(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public java.lang.String getMissionLabel(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public java.lang.String getMissionLabel
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public java.lang.String getMissionLabel1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public java.lang.String getMissionLabel
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public java.lang.String getMissionLabel
params=int
methodMatcher=/String getMissionLabel *\((.*int.*)\)/
/**
* No documentation available for method
*/
public java.lang.String getMissionLabel(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public long getMissionTimeStamp(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public long getMissionTimeStamp
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public String getMissionTimeStamp1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public long getMissionTimeStamp
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public long getMissionTimeStamp
params=int
methodMatcher=/long getMissionTimeStamp *\((.*int.*)\)/
/**
* No documentation available for method
*/
public String getMissionTimeStamp(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public long getFirstSampleOffset(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public long getFirstSampleOffset
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public String getFirstSampleOffset1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public long getFirstSampleOffset
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public long getFirstSampleOffset
params=int
methodMatcher=/long getFirstSampleOffset *\((.*int.*)\)/
/**
* No documentation available for method
*/
public String getFirstSampleOffset(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public int getMissionSampleRate(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleRate
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleRate1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getMissionSampleRate
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getMissionSampleRate
params=int
methodMatcher=/int getMissionSampleRate *\((.*int.*)\)/
/**
* No documentation available for method
*/
public int getMissionSampleRate(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public int getMissionSampleCount(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleCount
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleCount1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getMissionSampleCount
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getMissionSampleCount
params=int
methodMatcher=/int getMissionSampleCount *\((.*int.*)\)/
/**
* No documentation available for method
*/
public int getMissionSampleCount(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public int getMissionSampleCountTotal(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleCountTotal
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleCountTotal1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getMissionSampleCountTotal
params=int
/**
* Returns the total number of samples taken for the specified channel
* during the current mission. This number can be more than the actual
* sample count if rollover is enabled and the log has been filled.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return number of samples taken for the specified channel
*/
public int getMissionSampleCountTotal(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public double getMissionSample(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionSample
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getMissionSample2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double getMissionSample
params=int,int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double getMissionSample
params=int,int
methodMatcher=/double getMissionSample *\((.*int.*int.*)\)/
/**
* No documentation available for method
*/
public double getMissionSample(int a0, int a1)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public int getMissionSampleAsInteger(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleAsInteger
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleAsInteger2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public int getMissionSampleAsInteger
params=int,int
/**
* Returns the sample as an integer value. This value is not converted to
* degrees Celsius for temperature or to percent RH for Humidity. It is
* simply the 8 or 16 bits of digital data written in the mission log for
* this sample entry. It is up to the user to mask off the unused bits
* and convert this value to it's proper units. This method is primarily
* for users of the DS2422 who are using an input device which is not an
* A-D or have an A-D wholly dissimilar to the one specified in the
* datasheet.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param sampleNum the sample number to return, between <code>0</code> and
* <code>(getMissionSampleCount(channel)-1)</code>
* @return the sample as a whole integer
*/
public int getMissionSampleAsInteger(int channel, int sampleNum)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public long getMissionSampleTimeStamp(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public long getMissionSampleTimeStamp
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public String getMissionSampleTimeStamp2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public long getMissionSampleTimeStamp
params=int,int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public long getMissionSampleTimeStamp
params=int,int
methodMatcher=/long getMissionSampleTimeStamp *\((.*int.*int.*)\)/
/**
* No documentation available for method
*/
public String getMissionSampleTimeStamp(int a0, int a1)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public double getMissionResolutions(int)[] throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionResolutions
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double[] getMissionResolutions1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double[] getMissionResolutions
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double[] getMissionResolutions
params=int
methodMatcher=/double\[\] getMissionResolutions *\((.*int.*)\)/
/**
* No documentation available for method
*/
public double[] getMissionResolutions(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public double getMissionResolution(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionResolution
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getMissionResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double getMissionResolution
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double getMissionResolution
params=int
methodMatcher=/double getMissionResolution *\((.*int.*)\)/
/**
* No documentation available for method
*/
public double getMissionResolution(int a0)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setMissionResolution(int, double) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionResolution
sParams=int, double
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionResolution
params=int,double
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionResolution
params=int,double
methodMatcher=/void setMissionResolution *\((.*int.*double.*)\)/
/**
* No documentation available for method
*/
public void setMissionResolution(int a0, double a1)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public boolean hasMissionAlarms(int)
sMethodName=public boolean hasMissionAlarms
sParams=int
sThrows=
tempMethodName=public boolean hasMissionAlarms1
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean hasMissionAlarms
params=int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean hasMissionAlarms
params=int
methodMatcher=/boolean hasMissionAlarms *\((.*int.*)\)/
/**
* No documentation available for method
*/
public boolean hasMissionAlarms(int a0);
======================================
public boolean hasMissionAlarmed(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean hasMissionAlarmed
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean hasMissionAlarmed2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean hasMissionAlarmed
params=int,int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean hasMissionAlarmed
params=int,int
methodMatcher=/boolean hasMissionAlarmed *\((.*int.*int.*)\)/
/**
* No documentation available for method
*/
public boolean hasMissionAlarmed(int a0, int a1)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public boolean getMissionAlarmEnable(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean getMissionAlarmEnable
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean getMissionAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean getMissionAlarmEnable
params=int,int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public boolean getMissionAlarmEnable
params=int,int
methodMatcher=/boolean getMissionAlarmEnable *\((.*int.*int.*)\)/
/**
* No documentation available for method
*/
public boolean getMissionAlarmEnable(int a0, int a1)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setMissionAlarmEnable(int, int, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionAlarmEnable
sParams=int, int, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionAlarmEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionAlarmEnable
params=int,int,boolean
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionAlarmEnable
params=int,int,boolean
methodMatcher=/void setMissionAlarmEnable *\((.*int.*int.*boolean.*)\)/
/**
* No documentation available for method
*/
public void setMissionAlarmEnable(int a0, int a1, boolean a2)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public double getMissionAlarm(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionAlarm
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getMissionAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double getMissionAlarm
params=int,int
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public double getMissionAlarm
params=int,int
methodMatcher=/double getMissionAlarm *\((.*int.*int.*)\)/
/**
* No documentation available for method
*/
public double getMissionAlarm(int a0, int a1)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setMissionAlarm(int, int, double) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionAlarm
sParams=int, int, double
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionAlarm
params=int,int,double
No documentation available for method
className=com.dalsemi.onewire.container.MissionContainer
methodName=public void setMissionAlarm
params=int,int,double
methodMatcher=/void setMissionAlarm *\((.*int.*int.*double.*)\)/
/**
* No documentation available for method
*/
public void setMissionAlarm(int a0, int a1, double a2)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
-------------------------------------------------------------------
creating: owapi\OneWireContainer.java
======================================
public void setupContainer(com.dalsemi.onewire.adapter.DSPortAdapter, byte[])
sMethodName=public void setupContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, byte[]
sThrows=
tempMethodName=public void setupContainerFromBytes2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public void setupContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
/**
* Provides this container with the adapter object used to access this device and
* the address of the iButton or 1-Wire device.
*
* @param sourceAdapter adapter object required to communicate with
* this iButton
* @param newAddress address of this 1-Wire device
* @see Address
*/
public void setupContainerFromBytes(DSPortAdapter a0, ByteArray a1)
{
objectInstance.setupContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)a0.objectInstance), a1.array);
}
======================================
public void setupContainer(com.dalsemi.onewire.adapter.DSPortAdapter, long)
sMethodName=public void setupContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, long
sThrows=
tempMethodName=public void setupContainerFromLong2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public void setupContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,long
/**
* Provides this container with the adapter object used to access this device and
* the address of the iButton or 1-Wire device.
*
* @param sourceAdapter adapter object required to communicate with
* this iButton
* @param newAddress address of this 1-Wire device
* @see Address
*/
public void setupContainerFromLong(DSPortAdapter a0, String a1)
{
objectInstance.setupContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)a0.objectInstance), Long.parseLong(a1));
}
======================================
public void setupContainer(com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.String)
sMethodName=public void setupContainer
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, java.lang.String
sThrows=
tempMethodName=public void setupContainer2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public void setupContainer
params=com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String
/**
* Provides this container with the adapter object used to access this device and
* the address of the iButton or 1-Wire device.
*
* @param sourceAdapter adapter object required to communicate with
* this iButton
* @param newAddress address of this 1-Wire device
* @see Address
*/
public void setupContainer(DSPortAdapter a0, java.lang.String a1)
{
objectInstance.setupContainer(((com.dalsemi.onewire.adapter.DSPortAdapter)a0.objectInstance), a1);
}
======================================
public com.dalsemi.onewire.adapter.DSPortAdapter getAdapter()
sMethodName=public com.dalsemi.onewire.adapter.DSPortAdapter getAdapter
sParams=
sThrows=
tempMethodName=public DSPortAdapter getAdapter0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public com.dalsemi.onewire.adapter.DSPortAdapter getAdapter
params=
/**
* Retrieves the port adapter object used to create this container.
*
* @return port adapter instance
*/
public DSPortAdapter getAdapter()
{
return new DSPortAdapter(objectInstance.getAdapter());
}
======================================
public java.lang.String getName()
sMethodName=public java.lang.String getName
sParams=
sThrows=
tempMethodName=public java.lang.String getName0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public java.lang.String getName
params=
/**
* Retrieves the Dallas Semiconductor part number of the 1-Wire device
* as a <code>String</code>. For example 'Crypto iButton' or 'DS1992'.
*
* @return 1-Wire device name
*/
public java.lang.String getName()
{
return objectInstance.getName();
}
======================================
public java.lang.String getAlternateNames()
sMethodName=public java.lang.String getAlternateNames
sParams=
sThrows=
tempMethodName=public java.lang.String getAlternateNames0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public java.lang.String getAlternateNames
params=
/**
* Retrieves the alternate Dallas Semiconductor 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'.
*
* @return 1-Wire device alternate names
*/
public java.lang.String getAlternateNames()
{
return objectInstance.getAlternateNames();
}
======================================
public java.lang.String getDescription()
sMethodName=public java.lang.String getDescription
sParams=
sThrows=
tempMethodName=public java.lang.String getDescription0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public java.lang.String getDescription
params=
/**
* Retrieves a short description of the function of the 1-Wire device type.
*
* @return device functional description
*/
public java.lang.String getDescription()
{
return objectInstance.getDescription();
}
======================================
public void setSpeed(int, boolean)
sMethodName=public void setSpeed
sParams=int, boolean
sThrows=
tempMethodName=public void setSpeed2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public void setSpeed
params=int,boolean
/**
* Sets the maximum speed for this container. Note this may be slower then the
* devices maximum speed. This method can be used by an application
* to restrict the communication rate due 1-Wire line conditions. <p>
*
* @param newSpeed
* <ul>
* <li> 0 (SPEED_REGULAR) set to normal communciation speed
* <li> 1 (SPEED_FLEX) set to flexible communciation speed used
* for long lines
* <li> 2 (SPEED_OVERDRIVE) set to normal communciation speed to
* overdrive
* <li> 3 (SPEED_HYPERDRIVE) set to normal communciation speed to
* hyperdrive
* <li> >3 future speeds
* </ul>
*
* @param fallBack boolean indicating it is OK to fall back to a slower
* speed if true
*
*/
public void setSpeed(int newSpeed, boolean fallBack)
{
objectInstance.setSpeed(newSpeed, fallBack);
}
======================================
public int getMaxSpeed()
sMethodName=public int getMaxSpeed
sParams=
sThrows=
tempMethodName=public int getMaxSpeed0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public int getMaxSpeed
params=
/**
* Returns the maximum speed this iButton or 1-Wire device can
* communicate at.
* Override this method if derived iButton type can go faster then
* SPEED_REGULAR(0).
*
* @return maximum speed
* @see DSPortAdapter#setSpeed
*/
public int getMaxSpeed()
{
return objectInstance.getMaxSpeed();
}
======================================
public byte getAddress()[]
sMethodName=public byte getAddress
sParams=
sThrows=
tempMethodName=public ByteArray getAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public byte[] getAddress
params=
/**
* Gets the 1-Wire Network address of this device as an array of bytes.
*
* @return 1-Wire address
* @see Address
*/
public ByteArray getAddress()
{
return new ByteArray().setupObject(objectInstance.getAddress());
}
======================================
public java.lang.String getAddressAsString()
sMethodName=public java.lang.String getAddressAsString
sParams=
sThrows=
tempMethodName=public java.lang.String getAddressAsString0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public java.lang.String getAddressAsString
params=
/**
* Gets this device's 1-Wire Network address as a String.
*
* @return 1-Wire address
* @see Address
*/
public java.lang.String getAddressAsString()
{
return objectInstance.getAddressAsString();
}
======================================
public long getAddressAsLong()
sMethodName=public long getAddressAsLong
sParams=
sThrows=
tempMethodName=public String getAddressAsLong0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public long getAddressAsLong
params=
/**
* Gets this device's 1-Wire Network address as a long.
*
* @return 1-Wire address
* @see Address
*/
public String getAddressAsLong()
{
return ""+objectInstance.getAddressAsLong();
}
======================================
public java.util.Enumeration getMemoryBanks()
sMethodName=public java.util.Enumeration getMemoryBanks
sParams=
sThrows=
tempMethodName=public java.util.Enumeration getMemoryBanks0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public java.util.Enumeration getMemoryBanks
params=
/**
* Returns an <code>Enumeration</code> of <code>MemoryBank</code>. Default is no memory banks.
*
* @return enumeration of memory banks to read and write memory
* on this iButton or 1-Wire device
* @see MemoryBank
*/
public java.util.Enumeration getMemoryBanks()
{
java.util.Enumeration retEnum = objectInstance.getMemoryBanks();
java.util.Vector reRetEnum = new java.util.Vector();
while(retEnum.hasMoreElements())
{
/*Double Check This*/
Object o = retEnum.nextElement();
if(o instanceof com.dalsemi.onewire.container.OTPMemoryBank)
o = new OTPMemoryBank(o);
else if(o instanceof com.dalsemi.onewire.container.PagedMemoryBank)
o = new PagedMemoryBank(o);
else
o = new MemoryBank(o);
reRetEnum.addElement(o);
}
return reRetEnum.elements();
}
======================================
public boolean isPresent() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isPresent
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isPresent0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public boolean isPresent
params=
/**
* Verifies that the iButton or 1-Wire device is present on
* the 1-Wire Network.
*
* @return <code>true</code> if device present on the 1-Wire Network
*
* @throws OneWireIOException on a 1-Wire communication error such as
* a read back verification fails.
* @throws OneWireException if adapter is not open
*/
public boolean isPresent()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isPresent();
}
======================================
public boolean isAlarming() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isAlarming
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isAlarming0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public boolean isAlarming
params=
/**
* Verifies that the iButton or 1-Wire device is present
* on the 1-Wire Network and in an alarm state. This does not
* apply to all device types.
*
* @return <code>true</code> if device present and in alarm condition
*
* @throws OneWireIOException on a 1-Wire communication error such as
* a read back verification fails.
* @throws OneWireException if adapter is not open
*/
public boolean isAlarming()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return objectInstance.isAlarming();
}
======================================
public void doSpeed() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doSpeed
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doSpeed0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public void doSpeed
params=
/**
* Go to the specified speed for this container. This method uses the
* containers selected speed (method setSpeed(speed, fallback)) and
* will optionally fall back to a slower speed if communciation failed.
* Only call this method once to get the device into the desired speed
* as long as the device is still responding.
*
* @throws OneWireIOException WHEN selected speed fails and fallback
* is false
* @throws OneWireException WHEN hypterdrive is selected speed
* @see #setSpeed(int,boolean)
*/
public void doSpeed()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
objectInstance.doSpeed();
}
======================================
public int hashCode()
sMethodName=public int hashCode
sParams=
sThrows=
tempMethodName=public int hashCode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public int hashCode
params=
/**
* Returns a hash code value for the object. This method is
* supported for the benefit of hashtables such as those provided by
* <code>java.util.Hashtable</code>.
*
* @return a hash code value for this object.
* @see java.util.Hashtable
*/
public int hashCode()
{
return objectInstance.hashCode();
}
======================================
public boolean equals(java.lang.Object)
sMethodName=public boolean equals
sParams=java.lang.Object
sThrows=
tempMethodName=public boolean equals1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public boolean equals
params=java.lang.Object
/**
* Indicates whether some other object is "equal to" this one.
* @param obj the reference object with which to compare.
* @return <code>true</code> if this object is the same as the obj
* argument; <code>false</code> otherwise.
*/
public boolean equals(java.lang.Object o)
{
return objectInstance.equals(o);
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer
methodName=public java.lang.String toString
params=
/**
* Returns a string representation of the object.
*
* @return a string representation of the object.
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer01.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer02.java
superClassName=java.lang.Object
======================================
public void writeScratchpad(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void writeScratchpad
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void writeScratchpad2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer02
methodName=public void writeScratchpad
params=int,byte[]
/**
* Writes the data to the scratchpad from the given address.
*
* @param addr address to begin writing. Must be between
* 0x00 and 0x3F.
* @param data data to write.
*
*
* @throws IllegalArgumentException If address is out of range, or data is to long for scratchpad
* @throws OneWireIOException If device is not found on the 1-Wire network
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeScratchpad(int addr, ByteArray data)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer02)objectInstance).writeScratchpad(addr, data.array);
}
======================================
public byte readScratchpad()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readScratchpad
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readScratchpad0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer02
methodName=public byte[] readScratchpad
params=
/**
* Reads the entire scratchpad.
*
* @return <code>byte[]</code> containing the data from the scratchpad;
* the array will have a length of 64.
*
* @throws OneWireIOException If device is not found on the 1-Wire network
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readScratchpad()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer02)objectInstance).readScratchpad());
}
======================================
public void copyScratchpad(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void copyScratchpad
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void copyScratchpad3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer02
methodName=public void copyScratchpad
params=int,byte[],int
/**
* Writes the data from the scratchpad to the specified block or
* blocks. Note that the write will erase the data from the
* scratchpad.
*
* @param key subkey being written
* @param passwd password for the subkey being written
* @param blockNum number of the block to be copied (see page 7 of the
* DS1991 data sheet) block 0-7, or 8 to copy all 64 bytes.
*
*
* @throws IllegalArgumentException If key is out of range (0 to 2), or password is not 8 characters, or if
* blockNum is out of range (0 to 8)
* @throws OneWireIOException If device is not found on the 1-Wire network
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void copyScratchpad(int key, ByteArray passwd, int blockNum)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer02)objectInstance).copyScratchpad(key, passwd.array, blockNum);
}
======================================
public byte readSubkey(int, byte[])[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public byte readSubkey
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public ByteArray readSubkey2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer02
methodName=public byte[] readSubkey
params=int,byte[]
/**
* Reads the subkey requested with the given key name and password.
* Note that this method allows for reading from the subkey data
* only which starts at address 0x10 within a key. It does not allow
* reading from any earlier address within a key because the device
* cannot be force to allow reading the password. This is why the
* subkey number is or-ed with 0x10 in creating the address in bytes
* 1 and 2 of the sendBlock.
*
* @param key number indicating the key to be read: 0, 1, or 2
* @param passwd password of destination subkey
*
* @return byte[] containing the data from the subkey;
* the array will have a length of 64, since it includes the key
* identifier, sent password, and 48 bytes of data.
*
*
* @throws IllegalArgumentException If key is out of range (0 to 2), or password is not 8 characters, or if
* data does not have a length of 64
* @throws OneWireIOException If device is not found on the 1-Wire network
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readSubkey(int key, ByteArray passwd)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer02)objectInstance).readSubkey(key, passwd.array));
}
======================================
public void readSubkey(byte[], int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void readSubkey
sParams=byte[], int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void readSubkey3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer02
methodName=public void readSubkey
params=byte[],int,byte[]
/**
* Reads the subkey requested with the given key name and password.
* Note that this method allows for reading from the subkey data
* only which starts at address 0x10 within a key. It does not allow
* reading from any earlier address within a key because the device
* cannot be force to allow reading the password. This is why the
* subkey number is or-ed with 0x10 in creating the address in bytes
* 1 and 2 of the sendBlock.
*
* @param data buffer of length 64 into which to write the data
* @param key number indicating the key to be read: 0, 1, or 2
* @param passwd password of destination subkey
*
*
* @throws IllegalArgumentException If key is out of range (0 to 2), or password is not 8 characters, or if
* data does not have a length of 64
* @throws OneWireIOException If device is not found on the 1-Wire network
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void readSubkey(ByteArray data, int key, ByteArray passwd)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer02)objectInstance).readSubkey(data.array, key, passwd.array);
}
======================================
public void writePassword(int, byte[], byte[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void writePassword
sParams=int, byte[], byte[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void writePassword4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer02
methodName=public void writePassword
params=int,byte[],byte[],byte[]
/**
* Writes a new identifier and password to the secure subkey iButton
*
* @param key number indicating the key to be read: 0, 1, or 2
* @param oldName identifier of the key used to confirm the correct
* key's password to be changed. Must be exactly length 8.
* @param newName identifier to be used for the key with the new
* password. Must be exactly length 8.
* @param newPasswd new password for destination subkey. Must be
* exactly length 8.
*
*
* @throws IllegalArgumentException If key value is out of range (0 to 2), or if newPasswd, newName, or oldName
* are not 8 characters
* @throws OneWireIOException If device is not found on the 1-Wire network
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writePassword(int key, ByteArray oldName, ByteArray newName, ByteArray newPasswd)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer02)objectInstance).writePassword(key, oldName.array, newName.array, newPasswd.array);
}
======================================
public void writeSubkey(int, int, byte[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void writeSubkey
sParams=int, int, byte[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void writeSubkey4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer02
methodName=public void writeSubkey
params=int,int,byte[],byte[]
/**
* Writes new data to the secure subkey
*
* @param key number indicating the key to be written: 0, 1, or 2
* @param addr address to start writing at ( 0x00 to 0x3F )
* @param passwd passwird for the subkey
* @param data data to be written
*
*
* @throws IllegalArgumentException If key is out of range (0 to 2), or if address is out of range, or if passwd is
* not 8 characters, or if data length is out of bounds
* @throws OneWireIOException If device is not found on the 1-Wire network
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeSubkey(int key, int addr, ByteArray passwd, ByteArray data)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer02)objectInstance).writeSubkey(key, addr, passwd.array, data.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer04.java
superClassName=java.lang.Object
-->OneWireContainer04 implements com.dalsemi.onewire.container.ClockContainer
OneWireContainer04 implements com.dalsemi.onewire.container.ClockContainer
======================================
public boolean hasClockAlarm()
sMethodName=public boolean hasClockAlarm
sParams=
sThrows=
tempMethodName=public boolean hasClockAlarm0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean hasClockAlarm
params=
/**
* Query to see if the clock has an alarm feature.
*
* @return true if the Real-Time clock has an alarm
*
* @see #getClockAlarm(byte[])
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean hasClockAlarm()
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).hasClockAlarm();
}
======================================
public boolean canDisableClock()
sMethodName=public boolean canDisableClock
sParams=
sThrows=
tempMethodName=public boolean canDisableClock0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean canDisableClock
params=
/**
* Query to see if the clock can be disabled.
*
* @return true if the clock can be enabled and disabled
*
* @see #isClockRunning(byte[])
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean canDisableClock()
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).canDisableClock();
}
======================================
public long getClockResolution()
sMethodName=public long getClockResolution
sParams=
sThrows=
tempMethodName=public String getClockResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public long getClockResolution
params=
/**
* Query to get the clock resolution in milliseconds
*
* @return the clock resolution in milliseconds
*/
public String getClockResolution()
{
return ""+((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).getClockResolution();
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public byte[] readDevice
params=
/**
* Retrieves the 1-Wire device sensor state. This state is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device state needs to be changed then call
* the 'writeDevice' to finalize the changes.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).writeDevice(state.array);
}
======================================
public long getClock(byte[])
sMethodName=public long getClock
sParams=byte[]
sThrows=
tempMethodName=public String getClock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public long getClock
params=byte[]
/**
* Extracts the Real-Time clock value in milliseconds.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the time represented in this clock in milliseconds since 1970
*
* @see OneWireSensor#readDevice()
* @see #setClock(long,byte[])
*/
public String getClock(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).getClock(a0.array);
}
======================================
public long getClockAlarm(byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public long getClockAlarm
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public String getClockAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public long getClockAlarm
params=byte[]
/**
* Extracts the clock alarm value for the Real-Time clock.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return milliseconds since 1970 that the clock alarm is set to
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public String getClockAlarm(ByteArray a0)
throws com.dalsemi.onewire.OneWireException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).getClockAlarm(a0.array);
}
======================================
public boolean isClockAlarming(byte[])
sMethodName=public boolean isClockAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isClockAlarming
params=byte[]
/**
* Checks if the clock alarm flag has been set.
* This will occur when the value of the Real-Time
* clock equals the value of the clock alarm.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the Real-Time clock is alarming
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarming(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isClockAlarming(a0.array);
}
======================================
public boolean isClockAlarmEnabled(byte[])
sMethodName=public boolean isClockAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isClockAlarmEnabled
params=byte[]
/**
* Checks if the clock alarm is enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if clock alarm is enabled
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarming(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarmEnabled(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isClockAlarmEnabled(a0.array);
}
======================================
public boolean isClockRunning(byte[])
sMethodName=public boolean isClockRunning
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockRunning1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isClockRunning
params=byte[]
/**
* Checks if the device's oscillator is enabled. The clock
* will not increment if the clock oscillator is not enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the clock is running
*
* @see OneWireSensor#readDevice()
* @see #canDisableClock()
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean isClockRunning(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isClockRunning(a0.array);
}
======================================
public long getIntervalTimer(byte[])
sMethodName=public long getIntervalTimer
sParams=byte[]
sThrows=
tempMethodName=public String getIntervalTimer1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public long getIntervalTimer
params=byte[]
/**
* Get the Interval Timer Value in milliseconds.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return time in milliseconds
* that have occured since the interval counter was started
*
* @see OneWireSensor#readDevice()
* @see #setIntervalTimer(long,byte[])
*/
public String getIntervalTimer(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).getIntervalTimer(a0.array);
}
======================================
public long getCycleCounter(byte[])
sMethodName=public long getCycleCounter
sParams=byte[]
sThrows=
tempMethodName=public String getCycleCounter1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public long getCycleCounter
params=byte[]
/**
* Get the power cycle count value. This is the total number of
* power cycles that the DS1994 has seen since the counter was reset.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return power cycle count
*
* @see OneWireSensor#readDevice()
* @see #setCycleCounter(long,byte[]) setCycleCounter
*/
public String getCycleCounter(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).getCycleCounter(a0.array);
}
======================================
public long getIntervalTimerAlarm(byte[])
sMethodName=public long getIntervalTimerAlarm
sParams=byte[]
sThrows=
tempMethodName=public String getIntervalTimerAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public long getIntervalTimerAlarm
params=byte[]
/**
* Get the Interval Timer Alarm Value.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return time in milliseconds that have
* the interval timer alarm is set to
*
* @see OneWireSensor#readDevice()
* @see #setIntervalTimerAlarm(long,byte[]) setIntervalTimerAlarm
*/
public String getIntervalTimerAlarm(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).getIntervalTimerAlarm(a0.array);
}
======================================
public long getCycleCounterAlarm(byte[])
sMethodName=public long getCycleCounterAlarm
sParams=byte[]
sThrows=
tempMethodName=public String getCycleCounterAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public long getCycleCounterAlarm
params=byte[]
/**
* Get the cycle count Alarm Value.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return total number of power cycles
* that the DS1994 has to to see before the alarm will be triggered
*
* @see OneWireSensor#readDevice()
* @see #setCycleCounterAlarm(long,byte[]) setCycleCounterAlarm
*/
public String getCycleCounterAlarm(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).getCycleCounterAlarm(a0.array);
}
======================================
public boolean isIntervalTimerAlarming(byte[])
sMethodName=public boolean isIntervalTimerAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isIntervalTimerAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isIntervalTimerAlarming
params=byte[]
/**
* Check if the Interval Timer Alarm flag has been set.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <CODE>true</CODE> if interval timer is alarming
*
* @see OneWireSensor#readDevice()
* @see #isIntervalTimerAlarmEnabled(byte[]) isIntervalTimerAlarmEnabled
* @see #setIntervalTimerAlarmEnable(boolean,byte[]) setIntervalTimerAlarmEnable
*/
public boolean isIntervalTimerAlarming(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isIntervalTimerAlarming(a0.array);
}
======================================
public boolean isCycleCounterAlarming(byte[])
sMethodName=public boolean isCycleCounterAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isCycleCounterAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isCycleCounterAlarming
params=byte[]
/**
* Check if the Cycle Alarm flag has been set.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if cycle counter is alarming
*
* @see OneWireSensor#readDevice()
* @see #isCycleCounterAlarmEnabled(byte[]) isCycleCounterAlarmEnabled
* @see #setCycleCounterAlarmEnable(boolean,byte[]) setCycleCounterAlarmEnable
*/
public boolean isCycleCounterAlarming(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isCycleCounterAlarming(a0.array);
}
======================================
public boolean isIntervalTimerAlarmEnabled(byte[])
sMethodName=public boolean isIntervalTimerAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isIntervalTimerAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isIntervalTimerAlarmEnabled
params=byte[]
/**
* Check if the Interval Timer Alarm is enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if interval timer alarm is enabled
*
* @see OneWireSensor#readDevice()
* @see #isIntervalTimerAlarming(byte[]) isIntervalTimerAlarming
* @see #setIntervalTimerAlarmEnable(boolean,byte[]) setIntervalTimerAlarmEnable
*/
public boolean isIntervalTimerAlarmEnabled(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isIntervalTimerAlarmEnabled(a0.array);
}
======================================
public boolean isCycleCounterAlarmEnabled(byte[])
sMethodName=public boolean isCycleCounterAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isCycleCounterAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isCycleCounterAlarmEnabled
params=byte[]
/**
* Check if the Cycle Alarm is enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> true if cycle counter alarm is enabled
*
* @see OneWireSensor#readDevice()
* @see #isCycleCounterAlarming(byte[]) isCycleCounterAlarming
* @see #setCycleCounterAlarmEnable(boolean,byte[]) setCycleCounterAlarmEnable
*/
public boolean isCycleCounterAlarmEnabled(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isCycleCounterAlarmEnabled(a0.array);
}
======================================
public boolean isClockWriteProtected(byte[])
sMethodName=public boolean isClockWriteProtected
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockWriteProtected1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isClockWriteProtected
params=byte[]
/**
* Check if the Real-Time clock/Alarm is write protected.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if real time clock/alarm is write
* protected
*
* @see OneWireSensor#readDevice()
* @see #writeProtectClock(byte[]) writeProtectClock
*/
public boolean isClockWriteProtected(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isClockWriteProtected(a0.array);
}
======================================
public boolean isIntervalTimerWriteProtected(byte[])
sMethodName=public boolean isIntervalTimerWriteProtected
sParams=byte[]
sThrows=
tempMethodName=public boolean isIntervalTimerWriteProtected1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isIntervalTimerWriteProtected
params=byte[]
/**
* Check if the Interval Timer and Interval Timer Alarm
* register is write protected.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if interval timer and interval timer alarm is
* write protected
*
* @see OneWireSensor#readDevice()
* @see #writeProtectIntervalTimer(byte[]) writeProtectIntervalTimer
*/
public boolean isIntervalTimerWriteProtected(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isIntervalTimerWriteProtected(a0.array);
}
======================================
public boolean isCycleCounterWriteProtected(byte[])
sMethodName=public boolean isCycleCounterWriteProtected
sParams=byte[]
sThrows=
tempMethodName=public boolean isCycleCounterWriteProtected1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isCycleCounterWriteProtected
params=byte[]
/**
* Check if the Cycle Counter and Alarm is write protected.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if cycle counter/alarm is write
* protected
*
* @see OneWireSensor#readDevice()
* @see #writeProtectCycleCounter(byte[]) writeProtectCycleCounter
*/
public boolean isCycleCounterWriteProtected(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isCycleCounterWriteProtected(a0.array);
}
======================================
public boolean canReadAfterExpire(byte[])
sMethodName=public boolean canReadAfterExpire
sParams=byte[]
sThrows=
tempMethodName=public boolean canReadAfterExpire1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean canReadAfterExpire
params=byte[]
/**
* Check if the device can be read after a write protected
* alarm has occured.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if the device can be read after a
* write protected alarm has occured
*
* @see OneWireSensor#readDevice()
* @see #setReadAfterExpire(boolean, byte[]) setReadAfterExpire
*/
public boolean canReadAfterExpire(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).canReadAfterExpire(a0.array);
}
======================================
public boolean isIntervalTimerAutomatic(byte[])
sMethodName=public boolean isIntervalTimerAutomatic
sParams=byte[]
sThrows=
tempMethodName=public boolean isIntervalTimerAutomatic1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isIntervalTimerAutomatic
params=byte[]
/**
* Checks if the Interval timer is automatic or manual. If it is
* automatic then the interval counter will increment while the devices I/O line
* is high after the delay select period has elapsed (either 3.5 or 123 ms, see
* the isAutomaticDelayLong() method).
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if the interval timer is set to automatic
* mode
*
* @see OneWireSensor#readDevice()
* @see #setIntervalTimerAutomatic(boolean, byte[]) setIntervalTimerAutomatic
*/
public boolean isIntervalTimerAutomatic(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isIntervalTimerAutomatic(a0.array);
}
======================================
public boolean isIntervalTimerStopped(byte[])
sMethodName=public boolean isIntervalTimerStopped
sParams=byte[]
sThrows=
tempMethodName=public boolean isIntervalTimerStopped1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isIntervalTimerStopped
params=byte[]
/**
* Check if the Interval timer is stopped. This only has meaning
* if the interval timer is in manual mode (not <CODE>isIntervalTimerAutomatic</CODE>).
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if the interval timer is stopped
*
* @see OneWireSensor#readDevice()
* @see #isIntervalTimerAutomatic(byte[]) isIntervalTimerAutomatic
* @see #setIntervalTimerAutomatic(boolean, byte[]) setIntervalTimerAutomatic
* @see #setIntervalTimerRunState(boolean, byte[]) setIntervalTimerRunState
*/
public boolean isIntervalTimerStopped(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isIntervalTimerStopped(a0.array);
}
======================================
public boolean isAutomaticDelayLong(byte[])
sMethodName=public boolean isAutomaticDelayLong
sParams=byte[]
sThrows=
tempMethodName=public boolean isAutomaticDelayLong1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public boolean isAutomaticDelayLong
params=byte[]
/**
* Checks if the automatic delay for the Inteval Timer and the Cycle
* counter is either 3.5ms (regular) or 123ms (long).
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if the automatic interval/cycle counter
* delay is in the long (123ms) mode, else it is 3.5ms
*
* @see OneWireSensor#readDevice()
* @see #setAutomaticDelayLong(boolean,byte[]) setAutomaticDelayLong
*/
public boolean isAutomaticDelayLong(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).isAutomaticDelayLong(a0.array);
}
======================================
public void setClock(long, byte[])
sMethodName=public void setClock
sParams=long, byte[]
sThrows=
tempMethodName=public void setClock2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setClock
params=long,byte[]
/**
* Sets the Real-Time clock.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param time new value for the Real-Time clock, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getClock(byte[])
*/
public void setClock(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setClock(Long.parseLong(a0), a1.array);
}
======================================
public void setClockAlarm(long, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarm
sParams=long, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setClockAlarm
params=long,byte[]
/**
* Sets the clock alarm.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param time - new value for the Real-Time clock alarm, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public void setClockAlarm(String a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setClockAlarm(Long.parseLong(a0), a1.array);
}
======================================
public void setClockRunEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockRunEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockRunEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setClockRunEnable
params=boolean,byte[]
/**
* Enables or disables the oscillator, turning the clock 'on' and 'off'.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>. Also note that
* not all clock devices can disable their oscillators. Check to see if this device can
* disable its oscillator first by calling the <code>canDisableClock()</code> method.
*
* @param runEnable true to enable the clock oscillator
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if the clock oscillator cannot be disabled
*
* @see OneWireSensor#writeDevice(byte[])
* @see #canDisableClock()
* @see #isClockRunning(byte[])
*/
public void setClockRunEnable(boolean a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setClockRunEnable(a0, a1.array);
}
======================================
public void setClockAlarmEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarmEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setClockAlarmEnable
params=boolean,byte[]
/**
* Enables or disables the clock alarm.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param alarmEnable true to enable the clock alarm
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #isClockAlarming(byte[])
*/
public void setClockAlarmEnable(boolean a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setClockAlarmEnable(a0, a1.array);
}
======================================
public void setIntervalTimer(long, byte[])
sMethodName=public void setIntervalTimer
sParams=long, byte[]
sThrows=
tempMethodName=public void setIntervalTimer2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setIntervalTimer
params=long,byte[]
/**
* Sets the Interval Timer.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param time interval in milliseconds to set (truncated to 1/256th of second)
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getIntervalTimer(byte[]) getIntervalTimer
*/
public void setIntervalTimer(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setIntervalTimer(Long.parseLong(a0), a1.array);
}
======================================
public void setCycleCounter(long, byte[])
sMethodName=public void setCycleCounter
sParams=long, byte[]
sThrows=
tempMethodName=public void setCycleCounter2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setCycleCounter
params=long,byte[]
/**
* Sets power Cycle Counter.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param cycles initialize cycle counter value
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getCycleCounter(byte[]) getCycleCounter
*/
public void setCycleCounter(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setCycleCounter(Long.parseLong(a0), a1.array);
}
======================================
public void setIntervalTimerAlarm(long, byte[])
sMethodName=public void setIntervalTimerAlarm
sParams=long, byte[]
sThrows=
tempMethodName=public void setIntervalTimerAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setIntervalTimerAlarm
params=long,byte[]
/**
* Sets the Interval Timer Alarm.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param time in milliseconds to set the inverval timer
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getIntervalTimerAlarm(byte[]) getIntervalTimerAlarm
*/
public void setIntervalTimerAlarm(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setIntervalTimerAlarm(Long.parseLong(a0), a1.array);
}
======================================
public void setCycleCounterAlarm(long, byte[])
sMethodName=public void setCycleCounterAlarm
sParams=long, byte[]
sThrows=
tempMethodName=public void setCycleCounterAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setCycleCounterAlarm
params=long,byte[]
/**
* Sets the power Cycle Count Alarm. This counter holds the number
* of times the DS1994 must experience power cycles
* before it generates an alarm.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param cycles power Cycle Count alarm
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getCycleCounterAlarm(byte[]) getCycleCounterAlarm
*/
public void setCycleCounterAlarm(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setCycleCounterAlarm(Long.parseLong(a0), a1.array);
}
======================================
public void writeProtectClock(byte[])
sMethodName=public void writeProtectClock
sParams=byte[]
sThrows=
tempMethodName=public void writeProtectClock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void writeProtectClock
params=byte[]
/**
* Sets the write protect options for the Real-Time
* clock/Alarm.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* <P>WARNING: after calling this method and then
* <CODE> writeDevice </CODE> the device will be permanently write
* protected. </P> <BR>
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isClockWriteProtected(byte[]) isClockWriteProtected
*/
public void writeProtectClock(ByteArray a0)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).writeProtectClock(a0.array);
}
======================================
public void writeProtectIntervalTimer(byte[])
sMethodName=public void writeProtectIntervalTimer
sParams=byte[]
sThrows=
tempMethodName=public void writeProtectIntervalTimer1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void writeProtectIntervalTimer
params=byte[]
/**
* Sets the write protect options for Interval Timer and
* Interval Timer Alarm register.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* <P>WARNING: after calling this method and then
* <CODE> writeDevice </CODE> the device will be permanently write
* protected. </P> <BR>
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isIntervalTimerWriteProtected(byte[]) isIntervalTimerWriteProtected
*/
public void writeProtectIntervalTimer(ByteArray a0)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).writeProtectIntervalTimer(a0.array);
}
======================================
public void writeProtectCycleCounter(byte[])
sMethodName=public void writeProtectCycleCounter
sParams=byte[]
sThrows=
tempMethodName=public void writeProtectCycleCounter1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void writeProtectCycleCounter
params=byte[]
/**
* Sets the write protect options for the Cycle Counter
* and Alarm register.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* <P>WARNING: after calling this method and then
* <CODE> writeDevice </CODE> the device will be permanently write
* protected. </P> <BR>
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isCycleCounterWriteProtected(byte[]) isCycleCounterWriteProtected
*/
public void writeProtectCycleCounter(ByteArray a0)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).writeProtectCycleCounter(a0.array);
}
======================================
public void setReadAfterExpire(boolean, byte[])
sMethodName=public void setReadAfterExpire
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setReadAfterExpire2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setReadAfterExpire
params=boolean,byte[]
/**
* Sets the read state of the device after a
* write protected alarm has occured.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param readAfter <CODE>true</CODE> to read device after it
* expires from a write protected alarm event
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #canReadAfterExpire(byte[]) canReadAfterExpire
*/
public void setReadAfterExpire(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setReadAfterExpire(a0, a1.array);
}
======================================
public void setIntervalTimerAutomatic(boolean, byte[])
sMethodName=public void setIntervalTimerAutomatic
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setIntervalTimerAutomatic2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setIntervalTimerAutomatic
params=boolean,byte[]
/**
* Sets the Interval timer to automatic or manual mode.
* When in automatic mode, the interval counter will increment
* while the devices I/O line is high after the delay select
* period has elapsed (either 3.5 or 123 ms, see the
* <CODE>isAutomaticDelayLong()</CODE> method).
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param autoTimer <CODE>true</CODE> for the interval timer to operate in
* automatic mode
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isIntervalTimerAutomatic(byte[]) isIntervalTimerAutomatic
*/
public void setIntervalTimerAutomatic(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setIntervalTimerAutomatic(a0, a1.array);
}
======================================
public void setIntervalTimerRunState(boolean, byte[])
sMethodName=public void setIntervalTimerRunState
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setIntervalTimerRunState2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setIntervalTimerRunState
params=boolean,byte[]
/**
* Sets the Interval timer run/stop mode. This only
* has meaning if the interval timer is in manual mode
* (not <CODE>isIntervalTimerAutomatic()</CODE>).
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param runState <CODE>true</CODE> to set the interval timer to run
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isIntervalTimerAutomatic(byte[]) isIntervalTimerAutomatic
* @see #isIntervalTimerStopped(byte[]) isIntervalTimerStopped
*/
public void setIntervalTimerRunState(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setIntervalTimerRunState(a0, a1.array);
}
======================================
public void setAutomaticDelayLong(boolean, byte[])
sMethodName=public void setAutomaticDelayLong
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setAutomaticDelayLong2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setAutomaticDelayLong
params=boolean,byte[]
/**
* Sets the automatic delay for the Inteval Timer and the Cycle
* counter to either 123ms (long) or 3.5ms (regular).
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param delayLong <CODE>true</CODE> to set the interval timer to
* cycle counter to increment after 123ms or <CODE>false</CODE>
* for 3.5ms
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isAutomaticDelayLong(byte[]) isAutomaticDelayLong
*/
public void setAutomaticDelayLong(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setAutomaticDelayLong(a0, a1.array);
}
======================================
public void setIntervalTimerAlarmEnable(boolean, byte[])
sMethodName=public void setIntervalTimerAlarmEnable
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setIntervalTimerAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setIntervalTimerAlarmEnable
params=boolean,byte[]
/**
* Sets the Interval Timer Alarm enable.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param alarmEnable <CODE>true</CODE> to enable the interval timer alarm
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isIntervalTimerAlarmEnabled(byte[]) isIntervalTimerAlarmEnabled
*/
public void setIntervalTimerAlarmEnable(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setIntervalTimerAlarmEnable(a0, a1.array);
}
======================================
public void setCycleCounterAlarmEnable(boolean, byte[])
sMethodName=public void setCycleCounterAlarmEnable
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setCycleCounterAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer04
methodName=public void setCycleCounterAlarmEnable
params=boolean,byte[]
/**
* Sets the Cycle counter Alarm enable.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param alarmEnable <CODE>true</CODE> to enable the cycle counter alarm
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #isCycleCounterAlarmEnabled(byte[]) isCycleCounterAlarmEnabled
*/
public void setCycleCounterAlarmEnable(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer04)objectInstance).setCycleCounterAlarmEnable(a0, a1.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer05.java
superClassName=java.lang.Object
-->OneWireContainer05 implements com.dalsemi.onewire.container.SwitchContainer
OneWireContainer05 implements com.dalsemi.onewire.container.SwitchContainer
======================================
public int getNumberChannels(byte[])
sMethodName=public int getNumberChannels
sParams=byte[]
sThrows=
tempMethodName=public int getNumberChannels1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public int getNumberChannels
params=byte[]
/**
* Gets the number of channels supported by this switch.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberChannels(byte[])</code> - 1)]. Note that
* all devices of the same family will not necessarily have the
* same number of channels.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the number of channels for this device
*
* @see OneWireSensor#readDevice()
*/
public int getNumberChannels(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).getNumberChannels(a0.array);
}
======================================
public boolean isHighSideSwitch()
sMethodName=public boolean isHighSideSwitch
sParams=
sThrows=
tempMethodName=public boolean isHighSideSwitch0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean isHighSideSwitch
params=
/**
* Checks if the channels of this switch are 'high side'
* switches. This indicates that when 'on' or <code>true</code>, the switch output is
* connect to the 1-Wire data. If this method returns <code>false</code>
* then when the switch is 'on' or <code>true</code>, the switch is connected
* to ground.
*
* @return <code>true</code> if the switch is a 'high side' switch,
* <code>false</code> if the switch is a 'low side' switch
*
* @see #getLatchState(int,byte[])
*/
public boolean isHighSideSwitch()
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).isHighSideSwitch();
}
======================================
public boolean hasActivitySensing()
sMethodName=public boolean hasActivitySensing
sParams=
sThrows=
tempMethodName=public boolean hasActivitySensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean hasActivitySensing
params=
/**
* Checks if the channels of this switch support
* activity sensing. If this method returns <code>true</code> then the
* method <code>getSensedActivity(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support activity sensing
*
* @see #getSensedActivity(int,byte[])
* @see #clearActivity()
*/
public boolean hasActivitySensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).hasActivitySensing();
}
======================================
public boolean hasLevelSensing()
sMethodName=public boolean hasLevelSensing
sParams=
sThrows=
tempMethodName=public boolean hasLevelSensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean hasLevelSensing
params=
/**
* Checks if the channels of this switch support
* level sensing. If this method returns <code>true</code> then the
* method <code>getLevel(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support level sensing
*
* @see #getLevel(int,byte[])
*/
public boolean hasLevelSensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).hasLevelSensing();
}
======================================
public boolean hasSmartOn()
sMethodName=public boolean hasSmartOn
sParams=
sThrows=
tempMethodName=public boolean hasSmartOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean hasSmartOn
params=
/**
* Checks if the channels of this switch support
* 'smart on'. Smart on is the ability to turn on a channel
* such that only 1-Wire device on this channel are awake
* and ready to do an operation. This greatly reduces
* the time to discover the device down a branch.
* If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* can be used with the <code>doSmart</code> parameter <code>true</code>.
*
* @return <code>true</code> if channels support 'smart on'
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean hasSmartOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).hasSmartOn();
}
======================================
public boolean onlySingleChannelOn()
sMethodName=public boolean onlySingleChannelOn
sParams=
sThrows=
tempMethodName=public boolean onlySingleChannelOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean onlySingleChannelOn
params=
/**
* Checks if the channels of this switch require that only one
* channel is on at any one time. If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* will not only affect the state of the given
* channel but may affect the state of the other channels as well
* to insure that only one channel is on at a time.
*
* @return <code>true</code> if only one channel can be on at a time.
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean onlySingleChannelOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).onlySingleChannelOn();
}
======================================
public boolean getLevel(int, byte[])
sMethodName=public boolean getLevel
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLevel2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean getLevel
params=int,byte[]
/**
* Checks the sensed level on the indicated channel.
* To avoid an exception, verify that this switch
* has level sensing with the <code>hasLevelSensing()</code>.
* Level sensing means that the device can sense the logic
* level on its PIO pin.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if level sensed is 'high' and <code>false</code> if level sensed is 'low'
*
* @see OneWireSensor#readDevice()
* @see #hasLevelSensing()
*/
public boolean getLevel(int a0, ByteArray a1)
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).getLevel(a0, a1.array);
}
======================================
public boolean getLatchState(int, byte[])
sMethodName=public boolean getLatchState
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLatchState2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean getLatchState
params=int,byte[]
/**
* Checks the latch state of the indicated channel.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if channel latch is 'on'
* or conducting and <code>false</code> if channel latch is 'off' and not
* conducting. Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
*
* @see OneWireSensor#readDevice()
* @see #isHighSideSwitch()
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean getLatchState(int a0, ByteArray a1)
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).getLatchState(a0, a1.array);
}
======================================
public boolean getSensedActivity(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getSensedActivity
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getSensedActivity2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public boolean getSensedActivity
params=int,byte[]
/**
* Checks if the indicated channel has experienced activity.
* This occurs when the level on the PIO pins changes. To clear
* the activity that is reported, call <code>clearActivity()</code>.
* To avoid an exception, verify that this device supports activity
* sensing by calling the method <code>hasActivitySensing()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if activity was detected and <code>false</code> if no activity was detected
*
* @throws OneWireException if this device does not have activity sensing
*
* @see #hasActivitySensing()
* @see #clearActivity()
*/
public boolean getSensedActivity(int channel, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).getSensedActivity(channel, state.array);
}
======================================
public void clearActivity() throws com.dalsemi.onewire.OneWireException
sMethodName=public void clearActivity
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void clearActivity0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public void clearActivity
params=
/**
* Clears the activity latches the next time possible. For
* example, on a DS2406/07, this happens the next time the
* status is read with <code>readDevice()</code>.
*
* @throws OneWireException if this device does not support activity sensing
*
* @see OneWireSensor#readDevice()
* @see #getSensedActivity(int,byte[])
*/
public void clearActivity()
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).clearActivity();
}
======================================
public void setLatchState(int, boolean, boolean, byte[])
sMethodName=public void setLatchState
sParams=int, boolean, boolean, byte[]
sThrows=
tempMethodName=public void setLatchState4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public void setLatchState
params=int,boolean,boolean,byte[]
/**
* Sets the latch state of the indicated channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param latchState <code>true</code> to set the channel latch 'on'
* (conducting) and <code>false</code> to set the channel latch 'off' (not
* conducting). Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
* @param doSmart If latchState is 'on'/<code>true</code> then doSmart indicates
* if a 'smart on' is to be done. To avoid an exception
* check the capabilities of this device using the
* <code>hasSmartOn()</code> method.
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #hasSmartOn()
* @see #getLatchState(int,byte[])
* @see OneWireSensor#writeDevice(byte[])
*/
public void setLatchState(int a0, boolean a1, boolean a2, ByteArray a3)
{
((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).setLatchState(a0, a1, a2, a3.array);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public byte[] readDevice
params=
/**
* Retrieves the 1-Wire device sensor state. This state is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device state needs to be changed then call
* the 'writeDevice' to finalize the changes.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer05
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer05)objectInstance).writeDevice(state.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer06.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer08.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer09.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer0A.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer0B.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer0C.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer0F.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer10.java
superClassName=java.lang.Object
-->OneWireContainer10 implements com.dalsemi.onewire.container.TemperatureContainer
OneWireContainer10 implements com.dalsemi.onewire.container.TemperatureContainer
======================================
public static final double RESOLUTION_NORMAL
======================================
public static final double RESOLUTION_MAXIMUM
======================================
public boolean hasTemperatureAlarms()
sMethodName=public boolean hasTemperatureAlarms
sParams=
sThrows=
tempMethodName=public boolean hasTemperatureAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public boolean hasTemperatureAlarms
params=
/**
* Checks to see if this temperature measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>OneWireContainer10</code>
* has high/low trip alarms
*
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*/
public boolean hasTemperatureAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).hasTemperatureAlarms();
}
======================================
public boolean hasSelectableTemperatureResolution()
sMethodName=public boolean hasSelectableTemperatureResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public boolean hasSelectableTemperatureResolution
params=
/**
* Checks to see if this device has selectable temperature resolution.
*
* @return <code>true</code> if this <code>OneWireContainer10</code>
* has selectable temperature resolution
*
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public boolean hasSelectableTemperatureResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).hasSelectableTemperatureResolution();
}
======================================
public double getTemperatureResolutions()[]
sMethodName=public double getTemperatureResolutions
sParams=
sThrows=
tempMethodName=public double[] getTemperatureResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public double[] getTemperatureResolutions
params=
/**
* Gets an array of available temperature resolutions in Celsius.
*
* @return byte array of available temperature resolutions in Celsius for
* this <code>OneWireContainer10</code>. The minimum resolution is
* returned as the first element and maximum resolution as the last
* element.
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #setTemperatureResolution
*/
public double[] getTemperatureResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).getTemperatureResolutions();
}
======================================
public double getTemperatureAlarmResolution()
sMethodName=public double getTemperatureAlarmResolution
sParams=
sThrows=
tempMethodName=public double getTemperatureAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public double getTemperatureAlarmResolution
params=
/**
* Gets the temperature alarm resolution in Celsius.
*
* @return temperature alarm resolution in Celsius for this
* <code>OneWireContainer10</code>
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*
*/
public double getTemperatureAlarmResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).getTemperatureAlarmResolution();
}
======================================
public double getMaxTemperature()
sMethodName=public double getMaxTemperature
sParams=
sThrows=
tempMethodName=public double getMaxTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public double getMaxTemperature
params=
/**
* Gets the maximum temperature in Celsius.
*
* @return maximum temperature in Celsius for this
* <code>OneWireContainer10</code>
*
* @see #getMinTemperature
*/
public double getMaxTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).getMaxTemperature();
}
======================================
public double getMinTemperature()
sMethodName=public double getMinTemperature
sParams=
sThrows=
tempMethodName=public double getMinTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public double getMinTemperature
params=
/**
* Gets the minimum temperature in Celsius.
*
* @return minimum temperature in Celsius for this
* <code>OneWireContainer10</code>
*
* @see #getMaxTemperature
*/
public double getMinTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).getMinTemperature();
}
======================================
public void doTemperatureConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doTemperatureConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doTemperatureConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public void doTemperatureConvert
params=byte[]
/**
* Performs a temperature conversion on <code>state</code> information.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer10</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getTemperature
*/
public void doTemperatureConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).doTemperatureConvert(state.array);
}
======================================
public double getTemperature(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getTemperature
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public double getTemperature
params=byte[]
/**
* Gets the temperature value in Celsius from the <code>state</code>
* data retrieved from the <code>readDevice()</code> method.
*
* @param state byte array with device state information for this
* <code>OneWireContainer10</code>
*
* @return temperature in Celsius from the last
* <code>doTemperatureConvert()</code>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer10</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
*
* @see #doTemperatureConvert
*/
public double getTemperature(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).getTemperature(state.array);
}
======================================
public double getTemperatureAlarm(int, byte[])
sMethodName=public double getTemperatureAlarm
sParams=int, byte[]
sThrows=
tempMethodName=public double getTemperatureAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public double getTemperatureAlarm
params=int,byte[]
/**
* Gets the specified temperature alarm value in Celsius from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return temperature alarm trip values in Celsius for this
* <code>OneWireContainer10</code>
*
* @see #hasTemperatureAlarms
* @see #setTemperatureAlarm
*/
public double getTemperatureAlarm(int alarmType, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).getTemperatureAlarm(alarmType, state.array);
}
======================================
public double getTemperatureResolution(byte[])
sMethodName=public double getTemperatureResolution
sParams=byte[]
sThrows=
tempMethodName=public double getTemperatureResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public double getTemperatureResolution
params=byte[]
/**
* Gets the current temperature resolution in Celsius from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return temperature resolution in Celsius for this
* <code>OneWireContainer10</code>
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public double getTemperatureResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).getTemperatureResolution(state.array);
}
======================================
public void setTemperatureAlarm(int, double, byte[])
sMethodName=public void setTemperatureAlarm
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setTemperatureAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public void setTemperatureAlarm
params=int,double,byte[]
/**
* Sets the temperature alarm value in Celsius in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in Celsius
* @param state byte array with device state information
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
*/
public void setTemperatureAlarm(int alarmType, double alarmValue, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).setTemperatureAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setTemperatureResolution(double, byte[])
sMethodName=public void setTemperatureResolution
sParams=double, byte[]
sThrows=
tempMethodName=public void setTemperatureResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public void setTemperatureResolution
params=double,byte[]
/**
* Sets the current temperature resolution in Celsius in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution temperature resolution in Celsius. Valid values are
* <code>RESOLUTION_NORMAL</code> and
* <code>RESOLUTION_MAXIMUM</code>.
* @param state byte array with device state information
*
* @see #RESOLUTION_NORMAL
* @see #RESOLUTION_MAXIMUM
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
*/
public void setTemperatureResolution(double resolution, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).setTemperatureResolution(resolution, state.array);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public byte[] readDevice
params=
/**
* Retrieves this <code>OneWireContainer10</code> state information.
* The state information is returned as a byte array. Pass this byte
* array to the '<code>get</code>' and '<code>set</code>' methods.
* If the device state needs to be changed, then call the
* <code>writeDevice()</code> to finalize the changes.
*
* @return <code>OneWireContainer10</code> state information.
* Device state looks like this:
* <pre>
* 0 : temperature LSB
* 1 : temperature MSB
* 2 : trip high
* 3 : trip low
* 4 : reserved (put the resolution here, 0 for normal, 1 for max)
* 5 : reserved
* 6 : count remain
* 7 : count per degree Celsius
* 8 : an 8 bit CRC over the previous 8 bytes of data
* </pre>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer10</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #writeDevice
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public void writeDevice
params=byte[]
/**
* Writes to this <code>OneWireContainer10</code> <code>state</code>
* information that have been changed by '<code>set</code>' methods.
* Only the state registers that changed are updated. This is done
* by referencing a field information appended to the state data.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer10</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #readDevice
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer10)objectInstance).writeDevice(state.array);
}
======================================
public static double convertToFahrenheit(double)
sMethodName=public static double convertToFahrenheit
sParams=double
sThrows=
tempMethodName=public static double convertToFahrenheit1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public static double convertToFahrenheit
params=double
/**
* Converts a temperature reading from Celsius to Fahrenheit.
*
* @param celsiusTemperature temperature value in Celsius
*
* @return the Fahrenheit conversion of the supplied temperature
*
* @deprecated Replace with call to toFahrenheit()
*
* @see Convert#toFahrenheit(double)
*/
public double convertToFahrenheit(double a0)
{
return com.dalsemi.onewire.container.OneWireContainer10.convertToFahrenheit(a0);
}
======================================
public static double convertToCelsius(double)
sMethodName=public static double convertToCelsius
sParams=double
sThrows=
tempMethodName=public static double convertToCelsius1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer10
methodName=public static double convertToCelsius
params=double
/**
* Converts a temperature reading from Fahrenheit to Celsius.
*
* @param fahrenheitTemperature temperature value in Fahrenheit
*
* @return the Celsius conversion of the supplied temperature
*
* @deprecated Replace with call to toCelsius()
*
* @see Convert#toCelsius(double)
*/
public double convertToCelsius(double a0)
{
return com.dalsemi.onewire.container.OneWireContainer10.convertToCelsius(a0);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer12.java
superClassName=java.lang.Object
-->OneWireContainer12 implements com.dalsemi.onewire.container.SwitchContainer
OneWireContainer12 implements com.dalsemi.onewire.container.SwitchContainer
======================================
public static final byte SOURCE_ACTIVITY_LATCH
======================================
public static final byte SOURCE_FLIP_FLOP
======================================
public static final byte SOURCE_PIO
======================================
public static final byte POLARITY_ZERO
======================================
public static final byte POLARITY_ONE
======================================
public static final byte CHANNEL_NONE
======================================
public static final byte DONT_CHANGE
======================================
public static final byte CHANNEL_A_ONLY
======================================
public static final byte CHANNEL_B_ONLY
======================================
public static final byte CHANNEL_BOTH
======================================
public static final byte CRC_DISABLE
======================================
public static final byte CRC_EVERY_BYTE
======================================
public static final byte CRC_EVERY_8_BYTES
======================================
public static final byte CRC_EVERY_32_BYTES
======================================
public boolean isPowerSupplied(byte[])
sMethodName=public boolean isPowerSupplied
sParams=byte[]
sThrows=
tempMethodName=public boolean isPowerSupplied1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean isPowerSupplied
params=byte[]
/**
* Checks to see how the DS2406 is being supplied with power.
* The 6-pin (2 channel) package of the DS2406 can be powered
* by an outside source, but will still function on
* parasite power only.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if the device is getting supplied with
* power and <code>false</code> if the device is parasite powered
*
* @see OneWireSensor#readDevice()
*/
public boolean isPowerSupplied(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).isPowerSupplied(a0.array);
}
======================================
public int getNumberChannels(byte[])
sMethodName=public int getNumberChannels
sParams=byte[]
sThrows=
tempMethodName=public int getNumberChannels1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public int getNumberChannels
params=byte[]
/**
* Gets the number of channels supported by this switch.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberChannels(byte[])</code> - 1)]. Note that
* all devices of the same family will not necessarily have the
* same number of channels.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the number of channels for this device
*
* @see OneWireSensor#readDevice()
*/
public int getNumberChannels(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).getNumberChannels(a0.array);
}
======================================
public boolean isHighSideSwitch()
sMethodName=public boolean isHighSideSwitch
sParams=
sThrows=
tempMethodName=public boolean isHighSideSwitch0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean isHighSideSwitch
params=
/**
* Checks if the channels of this switch are 'high side'
* switches. This indicates that when 'on' or <code>true</code>, the switch output is
* connect to the 1-Wire data. If this method returns <code>false</code>
* then when the switch is 'on' or <code>true</code>, the switch is connected
* to ground.
*
* @return <code>true</code> if the switch is a 'high side' switch,
* <code>false</code> if the switch is a 'low side' switch
*
* @see #getLatchState(int,byte[])
*/
public boolean isHighSideSwitch()
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).isHighSideSwitch();
}
======================================
public boolean hasActivitySensing()
sMethodName=public boolean hasActivitySensing
sParams=
sThrows=
tempMethodName=public boolean hasActivitySensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean hasActivitySensing
params=
/**
* Checks if the channels of this switch support
* activity sensing. If this method returns <code>true</code> then the
* method <code>getSensedActivity(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support activity sensing
*
* @see #getSensedActivity(int,byte[])
* @see #clearActivity()
*/
public boolean hasActivitySensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).hasActivitySensing();
}
======================================
public boolean hasLevelSensing()
sMethodName=public boolean hasLevelSensing
sParams=
sThrows=
tempMethodName=public boolean hasLevelSensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean hasLevelSensing
params=
/**
* Checks if the channels of this switch support
* level sensing. If this method returns <code>true</code> then the
* method <code>getLevel(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support level sensing
*
* @see #getLevel(int,byte[])
*/
public boolean hasLevelSensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).hasLevelSensing();
}
======================================
public boolean hasSmartOn()
sMethodName=public boolean hasSmartOn
sParams=
sThrows=
tempMethodName=public boolean hasSmartOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean hasSmartOn
params=
/**
* Checks if the channels of this switch support
* 'smart on'. Smart on is the ability to turn on a channel
* such that only 1-Wire device on this channel are awake
* and ready to do an operation. This greatly reduces
* the time to discover the device down a branch.
* If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* can be used with the <code>doSmart</code> parameter <code>true</code>.
*
* @return <code>true</code> if channels support 'smart on'
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean hasSmartOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).hasSmartOn();
}
======================================
public boolean onlySingleChannelOn()
sMethodName=public boolean onlySingleChannelOn
sParams=
sThrows=
tempMethodName=public boolean onlySingleChannelOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean onlySingleChannelOn
params=
/**
* Checks if the channels of this switch require that only one
* channel is on at any one time. If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* will not only affect the state of the given
* channel but may affect the state of the other channels as well
* to insure that only one channel is on at a time.
*
* @return <code>true</code> if only one channel can be on at a time.
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean onlySingleChannelOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).onlySingleChannelOn();
}
======================================
public boolean getLevel(int, byte[])
sMethodName=public boolean getLevel
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLevel2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean getLevel
params=int,byte[]
/**
* Checks the sensed level on the indicated channel.
* To avoid an exception, verify that this switch
* has level sensing with the <code>hasLevelSensing()</code>.
* Level sensing means that the device can sense the logic
* level on its PIO pin.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if level sensed is 'high' and <code>false</code> if level sensed is 'low'
*
* @see OneWireSensor#readDevice()
* @see #hasLevelSensing()
*/
public boolean getLevel(int a0, ByteArray a1)
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).getLevel(a0, a1.array);
}
======================================
public boolean getLatchState(int, byte[])
sMethodName=public boolean getLatchState
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLatchState2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean getLatchState
params=int,byte[]
/**
* Checks the latch state of the indicated channel.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if channel latch is 'on'
* or conducting and <code>false</code> if channel latch is 'off' and not
* conducting. Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
*
* @see OneWireSensor#readDevice()
* @see #isHighSideSwitch()
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean getLatchState(int a0, ByteArray a1)
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).getLatchState(a0, a1.array);
}
======================================
public boolean getSensedActivity(int, byte[])
sMethodName=public boolean getSensedActivity
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getSensedActivity2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public boolean getSensedActivity
params=int,byte[]
/**
* Checks if the indicated channel has experienced activity.
* This occurs when the level on the PIO pins changes. To clear
* the activity that is reported, call <code>clearActivity()</code>.
* To avoid an exception, verify that this device supports activity
* sensing by calling the method <code>hasActivitySensing()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if activity was detected and <code>false</code> if no activity was detected
*
* @see #hasActivitySensing()
* @see #clearActivity()
*/
public boolean getSensedActivity(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).getSensedActivity(channel, state.array);
}
======================================
public void clearActivity()
sMethodName=public void clearActivity
sParams=
sThrows=
tempMethodName=public void clearActivity0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public void clearActivity
params=
/**
* <p>Clears the activity latches the next time possible. For
* example, on a DS2406/07, this happens the next time the
* status is read with <code>readDevice()</code>.</p>
*
* <p>The activity latches will only be cleared once. With the
* DS2406/07, this means that only the first call to
* <code>readDevice()</code> will clear the activity latches.
* Subsequent calls to <code>readDevice()</code> will leave the
* activity latch states intact, unless this method has been
* invoked since the last call to <code>readDevice()</code>.</p>
*
* @see OneWireSensor#readDevice()
* @see #getSensedActivity(int,byte[])
*/
public void clearActivity()
{
((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).clearActivity();
}
======================================
public void setLatchState(int, boolean, boolean, byte[])
sMethodName=public void setLatchState
sParams=int, boolean, boolean, byte[]
sThrows=
tempMethodName=public void setLatchState4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public void setLatchState
params=int,boolean,boolean,byte[]
/**
* Sets the latch state of the indicated channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param latchState <code>true</code> to set the channel latch 'on'
* (conducting) and <code>false</code> to set the channel latch 'off' (not
* conducting). Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
* @param doSmart If latchState is 'on'/<code>true</code> then doSmart indicates
* if a 'smart on' is to be done. To avoid an exception
* check the capabilities of this device using the
* <code>hasSmartOn()</code> method.
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #hasSmartOn()
* @see #getLatchState(int,byte[])
* @see OneWireSensor#writeDevice(byte[])
*/
public void setLatchState(int a0, boolean a1, boolean a2, ByteArray a3)
{
((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).setLatchState(a0, a1, a2, a3.array);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public byte[] readDevice
params=
/**
* Retrieves the 1-Wire device sensor state. This state is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device state needs to be changed then call
* the 'writeDevice' to finalize the changes.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).writeDevice(state.array);
}
======================================
public synchronized void setSpeedCheck(boolean)
sMethodName=public synchronized void setSpeedCheck
sParams=boolean
sThrows=
tempMethodName=public synchronized void setSpeedCheck1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public synchronized void setSpeedCheck
params=boolean
/**
* Directs the container to avoid the calls to doSpeed() in methods that communicate
* with the Thermocron. To ensure that all parts can talk to the 1-Wire bus
* at their desired speed, each method contains a call
* to <code>doSpeed()</code>. However, this is an expensive operation.
* If a user manages the bus speed in an
* application, call this method with <code>doSpeedCheck</code>
* as <code>false</code>. The default behavior is
* to call <code>doSpeed()</code>.
*
* @param doSpeedCheck <code>true</code> for <code>doSpeed()</code> to be called before every
* 1-Wire bus access, <code>false</code> to skip this expensive call
*
* @see OneWireContainer#doSpeed()
*/
public synchronized void setSpeedCheck(boolean doSpeedCheck)
{
((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).setSpeedCheck(doSpeedCheck);
}
======================================
public void setSearchConditions(byte, byte, byte, byte[])
sMethodName=public void setSearchConditions
sParams=byte, byte, byte, byte[]
sThrows=
tempMethodName=public void setSearchConditions4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public void setSearchConditions
params=byte,byte,byte,byte[]
/**
* <p>Programs the Conditional Search options for the DS2406/2407.</p>
*
* <p>The DS2406/2407 supports Conditional Searches with
* user programmable search conditions. This means that
* the part can alarm on several kinds of conditions,
* programmable by the user.</p>
*
* <p>The user can select a channel and a source to compare to
* a polarity. If the source's logical value is equal to the
* polarity, the device alarms (responds to a Conditional Search).
* For instance, if <code>channel</code> is <code>CHANNEL_A</code>,
* <code>source</code> is <code>SOURCE_ACTIVITY_LATCH</code>,
* and <code>polarity</code> is <code>POLARITY_ONE</code>, then the
* device will respond to a Conditional Search when the activity
* latch on channel A is 1 (when activity has been detected on
* channel A). When <code>channel</code> is <code>CHANNEL_BOTH</code>,
* the selected source signals are ORed for comparison with the polarity.
* When <code>channel</code> is <code>CHANNEL_NONE</code>, the selected
* source signal is considered a logical '0'. In other words, if
* <code>channel</code> is <code>CHANNEL_NONE</code>, if <code>polarity</code>
* is <code>POLARITY_ZERO</code>, the device always responds to a
* Conditional Search. If <code>polarity</code> is <code>POLARITY_ONE</code>,
* the device never responds to a Conditional Search.</p>
*
* <p>Note that for any of these options, the value <code>DONT_CHANGE</code>
* will insure that the value previously used by the DS2406/2407 will
* not be altered.</p>
*
* <p>The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.</p>
*
* <p>Also note that the Hidden Mode of the DS2407 is not supported in this
* implementation as an option for source selection. Hidden Mode was
* phased out for the newer DS2406. See the datasheet for the DS2407
* for more information on Hidden Mode.</p>
*
* @param channel the channel of interest for the source of the conditional check
* (valid values are <code>CHANNEL_NONE</code>, <code>CHANNEL_A_ONLY</code>, <code>CHANNEL_B_ONLY</code>, <code>CHANNEL_BOTH</code>, and <code>DONT_CHANGE</code>)
* @param source the source selection for the conditional check
* (valid values are <code>SOURCE_ACTIVITY_LATCH</code>, <code>SOURCE_FLIP_FLOP</code>, <code>SOURCE_PIO</code>, and <code>DONT_CHANGE</code>)
* @param polarity the polarity selection for the conditional check
* (valid values are <code>POLARITY_ZERO</code>, <code>POLARITY_ONE</code>, and <code>DONT_CHANGE</code>)
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#readDevice()
* @see OneWireSensor#writeDevice(byte[])
* @see #CHANNEL_NONE
* @see #CHANNEL_A_ONLY
* @see #CHANNEL_B_ONLY
* @see #CHANNEL_BOTH
* @see #SOURCE_ACTIVITY_LATCH
* @see #SOURCE_PIO
* @see #SOURCE_FLIP_FLOP
* @see #POLARITY_ONE
* @see #POLARITY_ZERO
* @see #DONT_CHANGE
*/
public void setSearchConditions(byte a0, byte a1, byte a2, ByteArray a3)
{
((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).setSearchConditions(a0, a1, a2, a3.array);
}
======================================
public byte channelAccess(byte[], boolean, boolean, int, int, boolean, boolean)[] throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public byte channelAccess
sParams=byte[], boolean, boolean, int, int, boolean, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public ByteArray channelAccess7
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer12
methodName=public byte[] channelAccess
params=byte[],boolean,boolean,int,int,boolean,boolean
/**
* <p>Accesses the PIO channels to sense the logical status of
* the output node. This method supports all the modes of
* communication with the part as described in the datasheet for
* the DS2406/2407.</p>
*
* @param inbuffer The input buffer. Depending on the other options chosen
* to this method, this will contain data to be written to
* the channels or it will hold space for data that will be read.
*
* @param toggleRW By selecting <code>toggleRW</code> to be
* <code>true</code>, the part will alternately
* read and write bytes from and to this channel. Setting
* <code>toggleRW</code> to <code>false</code> means
* that only one operation will occur, whichever operation
* is selected by <code>readInitially</code>. <br> <i> <b> NOTE: </b>
* When toggleRW is <code>true</code> the 'read' bytes are
* automatically provided and only the results of the read
* bytes are returned. </i>
*
* @param readInitially If <code>readInitially</code> is
* <code>true</code>, the first operation to occur will
* be a read, else it will be a write. If <code>toggleRW</code>
* is <code>false</code>, the operation chosen by this flag
* is the only operation that will occur. If <code>toggleRW</code>
* is <code>true</code>, this operation is the one
* that will occur first, then the other will occur. For example,
* if <code>toggleRW</code> is <code>true</code> and
* <code>readInitially</code> is <code>false</code> (and you only
* have one channel communication), 8 bits will be written to channel
* A and then 8 bits will be read from channel A.
*
* @param CRCMode The 2406/7 supports 4 CRC generation modes for error detection
* when performing channel access. This argument should have one
* of the following values:
* <pre><code>
* CRC_DISABLE Never generate a CRC
* CRC_EVERY_BYTE Generate a CRC after every byte transmission.
* CRC_EVERY_8_BYTES Generate a CRC after every 8 bytes.
* CRC_EVERY_32_BYTES Generate a CRC after every 32 bytes.
* </code></pre>
* Invalid values will be masked to valid values. The CRC is 16 bits,
* and does not get passed back with the output. This method returns
* <code>null</code> on a CRC failure.
*
* @param channelMode The 2406/7 supports 3 modes of channel communication. This
* argument should take one of the following values:
* <pre><code>
* CHANNEL_A_ONLY Only communicate with PIO A
* CHANNEL_B_ONLY Only communicate with PIO B
* CHANNEL_BOTH Communicate with both PIO's
* </code></pre>
* If <code>CHANNEL_BOTH</code> is selected, data is written and read
* from the input buffer to the two channels.
* See the datasheet for a description of operation in this
* mode. If communicating with both channels, it is up to the
* caller to format the data correctly in the input buffer
* so the correct channel gets the correct data. Similarly,
* any return data must be parsed by the user.
*
* @param clearActivity <code>true</code> to reset the activity latch
*
* @param interleave The value for the Interleave Control bit.
* If <code>true</code>, operates in synchronous mode.
* If <code>false</code>, operates in asynchronous mode.
* See the datasheet for a discussion of asynchronous and
* synchronous mode. This argument only matters if communicating
* with both channels.
*
* @return If any bytes were read, this returns a byte array of data
* read from the channel access. If no bytes were read, it
* will return the input buffer that was to be written.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #CHANNEL_A_ONLY
* @see #CHANNEL_B_ONLY
* @see #CHANNEL_BOTH
* @see #CRC_DISABLE
* @see #CRC_EVERY_BYTE
* @see #CRC_EVERY_8_BYTES
* @see #CRC_EVERY_32_BYTES
*/
public ByteArray channelAccess(ByteArray inbuffer, boolean toggleRW, boolean readInitially, int CRCMode, int channelMode, boolean clearActivity, boolean interleave)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer12)objectInstance).channelAccess(inbuffer.array, toggleRW, readInitially, CRCMode, channelMode, clearActivity, interleave));
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer13.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer14.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer16.java
superClassName=java.lang.Object
======================================
public static final int PASSWORD_LENGTH_SIZE
======================================
public static final int PASSWORD_SIZE
======================================
public static final int AID_LENGTH_SIZE
======================================
public static final int AID_SIZE
======================================
public static final int AID_LENGTH_OFFSET
======================================
public static final int AID_NAME_OFFSET
======================================
public static final int APPLET_FILE_HEADER_SIZE
======================================
public static int APDU_PACKET_LENGTH
======================================
public void setupJibComm(com.dalsemi.onewire.adapter.DSPortAdapter, byte[])
sMethodName=public void setupJibComm
sParams=com.dalsemi.onewire.adapter.DSPortAdapter, byte[]
sThrows=
tempMethodName=public void setupJibComm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public void setupJibComm
params=com.dalsemi.onewire.adapter.DSPortAdapter,byte[]
/**
* Provides an <code>JibComm</code> object to communicate
* with this Java iButton.
*
* @param sourceAdapter adapter object required to communicate with
* this Java iButton
* @param newAddress address of this One-Wire device as a byte array
*
* @see Address
*/
public void setupJibComm(DSPortAdapter sourceAdapter, ByteArray newAddress)
{
((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setupJibComm(((com.dalsemi.onewire.adapter.DSPortAdapter)sourceAdapter.objectInstance), newAddress.array);
}
======================================
public com.dalsemi.onewire.container.CommandAPDU getCommandAPDUInfo()
sMethodName=public com.dalsemi.onewire.container.CommandAPDU getCommandAPDUInfo
sParams=
sThrows=
tempMethodName=public CommandAPDU getCommandAPDUInfo0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.CommandAPDU getCommandAPDUInfo
params=
/**
* Gets the current <code>CommandAPDU</code> sent to this Java iButton
*
* @return current <code>CommandAPDU</code> sent to this Java iButton
*/
public CommandAPDU getCommandAPDUInfo()
{
return new CommandAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getCommandAPDUInfo());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getResponseAPDUInfo()
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getResponseAPDUInfo
sParams=
sThrows=
tempMethodName=public ResponseAPDU getResponseAPDUInfo0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getResponseAPDUInfo
params=
/**
* Gets the current <code>ResponseAPDU</code> received from this Java iButton
*
* @return current <code>ResponseAPDU</code> received from this Java iButton
*/
public ResponseAPDU getResponseAPDUInfo()
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getResponseAPDUInfo());
}
======================================
public int getRunTime()
sMethodName=public int getRunTime
sParams=
sThrows=
tempMethodName=public int getRunTime0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public int getRunTime
params=
/**
* Gets the run time value set for this Java iButton
*
* @return run time value of this Java iButton
*
* @see #setRunTime
*/
public int getRunTime()
{
return ((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getRunTime();
}
======================================
public int getSelectRunTime()
sMethodName=public int getSelectRunTime
sParams=
sThrows=
tempMethodName=public int getSelectRunTime0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public int getSelectRunTime
params=
/**
* Gets the select run time value set for this Java iButton
*
* @return run time value of this Java iButton on select operations
*
* @see #setSelectRunTime
*/
public int getSelectRunTime()
{
return ((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getSelectRunTime();
}
======================================
public int getLoadRunTime()
sMethodName=public int getLoadRunTime
sParams=
sThrows=
tempMethodName=public int getLoadRunTime0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public int getLoadRunTime
params=
/**
* Gets the load run time value set for this Java iButton
*
* @return run time value of this Java iButton on load operations
*
* @see #setLoadRunTime
*/
public int getLoadRunTime()
{
return ((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getLoadRunTime();
}
======================================
public void setRunTime(int) throws java.lang.IllegalArgumentException
sMethodName=public void setRunTime
sParams=int
sThrows=throws java.lang.IllegalArgumentException
tempMethodName=public void setRunTime1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public void setRunTime
params=int
/**
* Sets the run time value for this Java iButton
*
* @param runTime a <code>4</code> bit value (<code>0 -15</code>) that
* represents the expected run time of the device
*
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @throws IllegalArgumentException Invalid run time value
*
* @see #getRunTime
*/
public void setRunTime(int newRunTime)
throws java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setRunTime(newRunTime);
}
======================================
public void setSelectRunTime(int) throws java.lang.IllegalArgumentException
sMethodName=public void setSelectRunTime
sParams=int
sThrows=throws java.lang.IllegalArgumentException
tempMethodName=public void setSelectRunTime1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public void setSelectRunTime
params=int
/**
* Sets the select operation run time value for this Java iButton.
* The select-applet operation may require special consideration
* because APDU processing is done on a select.
*
* @param runTime a <code>4</code> bit value (<code>0 -15</code>) that
* represents the expected run time of the device on a
* select operation. This value should not be less than
* the normal <code>runTime</codE> value.
*
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @throws IllegalArgumentException Invalid run time value
*
* @see #getSelectRunTime
*/
public void setSelectRunTime(int newRunTime)
throws java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setSelectRunTime(newRunTime);
}
======================================
public void setLoadRunTime(int) throws java.lang.IllegalArgumentException
sMethodName=public void setLoadRunTime
sParams=int
sThrows=throws java.lang.IllegalArgumentException
tempMethodName=public void setLoadRunTime1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public void setLoadRunTime
params=int
/**
* Sets the load operation run time value for this Java iButton.
* The last packet of a load-applet operation may require special consideration
* because additional processing is performed once the applet is loaded.
* All non-final load packets run based on the normal <code>runTime</code>
* value.
*
* @param runTime a <code>4</code> bit value (<code>0 -15</code>) that
* represents the expected run time of the device on a
* final load packet. This value should not be less than
* the normal <code>runTime</code> value.
*
* Actual run time is calculated as followed:
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @throws IllegalArgumentException Invalid run time value
*
* @see #getLoadRunTime
*/
public void setLoadRunTime(int newRunTime)
throws java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setLoadRunTime(newRunTime);
}
======================================
public void setReadingRunTime(int) throws java.lang.IllegalArgumentException
sMethodName=public void setReadingRunTime
sParams=int
sThrows=throws java.lang.IllegalArgumentException
tempMethodName=public void setReadingRunTime1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public void setReadingRunTime
params=int
/**
* Sets the run time value for reading bytes from the output buffer of this Java iButton.
* Generally, output data is read giving the button the minimal amount of runtime
* needed. However, for larger amounts of data, this may fail, causing the operation
* to be retried. To avoid the retry, this value can be altered if something is known about
* the size of the output data.
*
* @param runTime a <code>4</code> bit value (<code>0-15</code>) that
* represents the run time of the device for reading
* data from the output buffer of this Java Powered iButton
*
* @throws IllegalArgumentException Invalid run time value
*
* @see #getLoadRunTime
*/
public void setReadingRunTime(int newRunTime)
throws java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setReadingRunTime(newRunTime);
}
======================================
public boolean setLoadPacketSize(int)
sMethodName=public boolean setLoadPacketSize
sParams=int
sThrows=
tempMethodName=public boolean setLoadPacketSize1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public boolean setLoadPacketSize
params=int
/**
* Sets the size of the packets sent on load.
* The range can be from <code>64</code> to <code>112</code> bytes.
*
* @param size new packet size
*
* @return <code>true</code> if packet size is set to the new value <BR>
* <code>false</code> if invalid packet size is requested
*
* @see #getLoadPacketSize
* @see #loadApplet
*/
public boolean setLoadPacketSize(int size)
{
return ((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setLoadPacketSize(size);
}
======================================
public int getLoadPacketSize()
sMethodName=public int getLoadPacketSize
sParams=
sThrows=
tempMethodName=public int getLoadPacketSize0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public int getLoadPacketSize
params=
/**
* Gets the size of the packets sent on load.
*
* @return size of the packets sent on load
*
* @see #setLoadPacketSize
* @see #loadApplet
*
*/
public int getLoadPacketSize()
{
return ((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getLoadPacketSize();
}
======================================
public void setPIN(java.lang.String)
sMethodName=public void setPIN
sParams=java.lang.String
sThrows=
tempMethodName=public void setPIN1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public void setPIN
params=java.lang.String
/**
* Sets the PIN used to communicate with this Java iButton.
* Once this method has been called, the PIN will be sent to every method
* that requires a PIN.
*
* @param passwd PIN to be set and sent to this Java iButton for each command
* that requires a PIN
*
* @see #getCommandPINMode
* @see #setCommandPINMode
* @see #setCommonPIN
*/
public void setPIN(java.lang.String passwd)
{
((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setPIN(passwd);
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getFreeRAM() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getFreeRAM
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getFreeRAM0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getFreeRAM
params=
/**
* Gets the amount of free RAM in this Java iButton. No PIN required.
*
* @return <code>ResponseAPDU</code> with a data field containing the amount
* of free RAM in this Java iButton. Value returned is in little endian
* format.
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
*/
public ResponseAPDU getFreeRAM()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getFreeRAM());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getRandomBytes(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getRandomBytes
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getRandomBytes1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getRandomBytes
params=int
/**
* Gets requested number of bytes of random data generated by this Java
* iButton. No PIN required.
*
* @param numBytes the number of bytes requested. <code>numByes</code>
* should not exceed <code>119</code>. If the number is greater
* than <code>119</code>, the API only returns <code>119</code>.
*
* @return <code>ResponseAPDU</code> with a data field containing random
* bytes generated
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public ResponseAPDU getRandomBytes(int numBytes)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getRandomBytes(numBytes));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getFirmwareVersionString() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getFirmwareVersionString
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getFirmwareVersionString0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getFirmwareVersionString
params=
/**
* Gets the firmware version string. No PIN required.
*
* @return <code>ResponseAPDU</code> with a data field containing the firmware
* version string of this Java iButton
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public ResponseAPDU getFirmwareVersionString()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getFirmwareVersionString());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getLastError() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getLastError
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getLastError0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getLastError
params=
/**
* Gets the last error value.
* If the error reporting mode is set (<code>1</code>), then this method
* will return the value of the last exception. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the last exception value
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getErrorReportingMode
* @see #setErrorReportingMode
*/
public ResponseAPDU getLastError()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getLastError());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getErrorReportingMode() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getErrorReportingMode
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getErrorReportingMode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getErrorReportingMode
params=
/**
* Gets the Error Reporting Mode. This function is not supported in
* the <code>.033</code> version of the firmware. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the error reporting mode
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6A02. Command not supported by this Java iButton.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getLastError
* @see #setErrorReportingMode
*/
public ResponseAPDU getErrorReportingMode()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getErrorReportingMode());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setErrorReportingMode(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setErrorReportingMode
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setErrorReportingMode1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setErrorReportingMode
params=int
/**
* Sets the Error Reporting mode.
* If the error reporting mode is set (<code>1</code>), this Java iButton
* stores the last exception value code. This code can be retreived by
* calling <code>getLastError()</code>.
*
*
* @param mode <code>1</code> to turn on Error Reporting Mode.
* <code>0</code> to turn off.
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getLastError
* @see #getErrorReportingMode
*/
public ResponseAPDU setErrorReportingMode(int mode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setErrorReportingMode(mode));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getAIDByNumber(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getAIDByNumber
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getAIDByNumber1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getAIDByNumber
params=int
/**
* Gets the AID of the applet by its installed number. No PIN required.
*
* @param index installed number of the applet on this Java iButton to get
* the AID of
*
* @return <code>ResponseAPDU</code> containing the AID of the applet
* requested
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x8453. Applet not found.
* Valid applet index are in the range of <code>0-15</code>.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public ResponseAPDU getAIDByNumber(int index)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getAIDByNumber(index));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU deleteSelectedApplet() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU deleteSelectedApplet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU deleteSelectedApplet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU deleteSelectedApplet
params=
/**
* Deletes the currently selected applet.
* If PIN protection is enabled, a PIN must be supplied.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #deleteAppletByAID
* @see #deleteAppletByNumber
*/
public ResponseAPDU deleteSelectedApplet()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).deleteSelectedApplet());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU deleteAppletByNumber(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU deleteAppletByNumber
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU deleteAppletByNumber1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU deleteAppletByNumber
params=int
/**
* Deletes an applet by its installed number.
*
* @param index installed number of the applet to delete
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>Failure SW 0x8453. Applet not found.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #deleteAppletByAID
* @see #deleteSelectedApplet
*/
public ResponseAPDU deleteAppletByNumber(int index)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).deleteAppletByNumber(index));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU deleteAppletByAID(java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU deleteAppletByAID
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU deleteAppletByAID1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU deleteAppletByAID
params=java.lang.String
/**
* Deletes an applet by its AID.
*
* @param aid AID of applet to be deleted
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>Failure SW 0x8453. Applet not found.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #deleteSelectedApplet
* @see #deleteAppletByNumber
*/
public ResponseAPDU deleteAppletByAID(java.lang.String aid)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).deleteAppletByAID(aid));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU loadApplet(java.io.InputStream, java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException, java.io.IOException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU loadApplet
sParams=java.io.InputStream, java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException, java.io.IOException
tempMethodName=public ResponseAPDU loadApplet2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU loadApplet
params=java.io.InputStream,java.lang.String
/**
* Loads an applet onto this Java iButton.
* This method takes an input stream
* and an AID. The AID length must NOT exceed <code>AID_SIZE</code>.
*
* @param in Stream to read the applet from
* @param aid AID of the applet to be loaded
*
* @return <code>ResponseAPDU</code> indicating success or failure
* Possible return values are
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6400. Insufficient Memory
* <li>Failure SW 0x6901. Invalid AID Length
* <li>Failure SW 0x6902. Invalid API Version
* <li>Failure SW 0x6903. Invalid Password
* <li>Failure SW 0x6904. Invalid Signature Length
* <li>Failure SW 0x6905. Hash Corruption
* <li>Failure SW 0x6906. Hash Failure
* <li>Failure SW 0x6982. Invalid Signature
* <li>Failure SW 0x6A84. Class Length Overrun
* <li>Failure SW 0x6A86. Invalid Loader Command
* <li>Failure SW 0x6A87. Invalid Packet
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IOException Problem reading applet from the stream
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getLoadPINMode
* @see #setLoadPINMode
*/
public ResponseAPDU loadApplet(java.io.InputStream appletInputStream, java.lang.String aid)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException, java.io.IOException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).loadApplet(appletInputStream, aid));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU loadApplet(java.lang.String, java.lang.String, java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException, java.io.FileNotFoundException, java.io.IOException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU loadApplet
sParams=java.lang.String, java.lang.String, java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException, java.io.FileNotFoundException, java.io.IOException
tempMethodName=public ResponseAPDU loadApplet3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU loadApplet
params=java.lang.String,java.lang.String,java.lang.String
/**
* Loads an applet onto this Java iButton.
* This method takes an applet filename, directory
* and AID. The AID length must NOT exceed <code>AID_SIZE</code>.
*
* @param fileName file name of the applet to be loaded into this Java iButton
* @param directoryName path to the applet to be loaded
* @param aid AID of the applet to be loaded
*
* @return <code>ResponseAPDU</code> indicating success or failure
* Possible return values are
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6400. Insufficient Memory
* <li>Failure SW 0x6901. Invalid AID Length
* <li>Failure SW 0x6902. Invalid API Version
* <li>Failure SW 0x6903. Invalid Password
* <li>Failure SW 0x6904. Invalid Signature Length
* <li>Failure SW 0x6905. Hash Corruption
* <li>Failure SW 0x6906. Hash Failure
* <li>Failure SW 0x6982. Invalid Signature
* <li>Failure SW 0x6A84. Class Length Overrun
* <li>Failure SW 0x6A86. Invalid Loader Command
* <li>Failure SW 0x6A87. Invalid Packet
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws FileNotFoundException Applet file not found
* @throws IOException Problem reading applet file
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getLoadPINMode
* @see #setLoadPINMode
*/
public ResponseAPDU loadApplet(java.lang.String fileName, java.lang.String directoryName, java.lang.String aid)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException, java.io.FileNotFoundException, java.io.IOException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).loadApplet(fileName, directoryName, aid));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU masterErase() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU masterErase
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU masterErase0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU masterErase
params=
/**
* Clears all memory in this Java iButton. The erase will occur at the
* beginning of the next command.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public ResponseAPDU masterErase()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).masterErase());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getPORCount() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getPORCount
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getPORCount0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getPORCount
params=
/**
* Gets the number of times this Java iButton has been power-on-reset (POR)
* since the last master erase. Return value is in little endian
* format. No PIN required.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000. Data field contains the POR count.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #masterErase
*/
public ResponseAPDU getPORCount()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getPORCount());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getRealTimeClock() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getRealTimeClock
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getRealTimeClock0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getRealTimeClock
params=
/**
* Gets the Real Time Clock. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the value of the real
* time clock
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public ResponseAPDU getRealTimeClock()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getRealTimeClock());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getATR() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getATR
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getATR0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getATR
params=
/**
* Gets the Answer To Reset (ATR) from this Java iButton. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the ATR in the data field
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public ResponseAPDU getATR()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getATR());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getEphemeralGCMode() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getEphemeralGCMode
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getEphemeralGCMode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getEphemeralGCMode
params=
/**
* Gets the Ephemeral Gabage Collection Mode.
* A value of <code>1</code> indicates ephemeral garbage collection
* is turned on, <code>0</code> if turned off. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the Ephemeral Garbage
* Collector Mode
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #setEphemeralGCMode
*/
public ResponseAPDU getEphemeralGCMode()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getEphemeralGCMode());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getAppletGCMode() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getAppletGCMode
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getAppletGCMode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getAppletGCMode
params=
/**
* Gets the Applet Garbage Collection Mode.
* A value of <code>1</code> indicates applet garbage collection
* is turned on, <code>0</code> if turned off. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the Applet Garbage
* Collector Mode
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #setAppletGCMode
*/
public ResponseAPDU getAppletGCMode()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getAppletGCMode());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getCommandPINMode() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getCommandPINMode
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getCommandPINMode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getCommandPINMode
params=
/**
* Gets the Command PIN Mode.
* A value of <code>1</code> indicates that a PIN is required for
* all Administrative and AID commands, <code>0</code> indicates
* free access. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the Command PIN Mode
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #setCommandPINMode
* @see #setCommonPIN
* @see #setPIN
*/
public ResponseAPDU getCommandPINMode()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getCommandPINMode());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getLoadPINMode() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getLoadPINMode
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getLoadPINMode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getLoadPINMode
params=
/**
* Gets the Load PIN Mode.
* A value of <code>1</code> indicates that a PIN is required for Applet
* loading. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the Load PIN Mode
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #loadApplet
* @see #setLoadPINMode
*/
public ResponseAPDU getLoadPINMode()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getLoadPINMode());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getRestoreMode() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getRestoreMode
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getRestoreMode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getRestoreMode
params=
/**
* Gets the Restore Mode.
* When Restore Mode is enabled (<code>1</code>), all field updates and
* <code>javacard.framework.System</code> transactions are considered atomic.
* If a tear occurs in the middle of these updates, values just
* prior to the update are restored. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the Restore Mode
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #setRestoreMode
*/
public ResponseAPDU getRestoreMode()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getRestoreMode());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getExceptionMode() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getExceptionMode
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getExceptionMode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getExceptionMode
params=
/**
* Gets the Exception Mode.
* When Exception Mode is enabled (<code>1</code>), Java API exceptions
* are thrown. All uncaught exceptions return 0x6F00 in the SW.
* When disabled, an error is returned from the VM. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the Exception Mode value
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #setExceptionMode
*/
public ResponseAPDU getExceptionMode()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getExceptionMode());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU getCommitBufferSize() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU getCommitBufferSize
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU getCommitBufferSize0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU getCommitBufferSize
params=
/**
* Gets the size of the Commit Buffer.
* Committing one field to the buffer requires <code>9</code> bytes.
* Therefore the default size of <code>72</code> bytes allows <code>8</code>
* field updates. The minimum size allowed is <code>72</code> bytes and the
* maximum is restricted by the amount of free RAM. All values will be rounded
* up to the next multiple of <code>9</code>. No PIN required.
*
* @return <code>ResponseAPDU</code> containing the Commit Buffer size in little
* endian format
* <ul>
* <li>Success SW 0x9000.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getFreeRAM
* @see #setCommitBufferSize
*/
public ResponseAPDU getCommitBufferSize()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).getCommitBufferSize());
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setCommonPIN(java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setCommonPIN
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setCommonPIN1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setCommonPIN
params=java.lang.String
/**
* Sets the Common PIN.
* This method is used to change the value of the Common PIN on the Java
* iButton. If this Java iButton currently has a PIN, the <code>setPIN()</code>
* method should be called prior to this method with the 'oldPIN' value.
*
* @param newPIN the value of the PIN to be set in this Java iButton
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getCommandPINMode
* @see #setCommandPINMode
* @see #setPIN
*/
public ResponseAPDU setCommonPIN(java.lang.String newPIN)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setCommonPIN(newPIN));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setEphemeralGCMode(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setEphemeralGCMode
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setEphemeralGCMode1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setEphemeralGCMode
params=int
/**
* Sets the Ephemeral Garbage Collection Mode.
* A value of <code>1</code> turns the Ephemeral Garbage Collection on
* and a value of <code>0</code> turns it off.
*
* @param mode <code>1</code> to turn on Ephemeral Garbage Collection Mode.
* <code>0</code> to turn off.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getEphemeralGCMode
*/
public ResponseAPDU setEphemeralGCMode(int mode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setEphemeralGCMode(mode));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setAppletGCMode(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setAppletGCMode
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setAppletGCMode1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setAppletGCMode
params=int
/**
* Sets the Applet Garbage Collection Mode.
* A value of <code>1</code> turns the Applet Garbage Collection on
* and a value of <code>0</code> turns it off.
*
* @param mode <code>1</code> to turn on Applet Garbage Collection Mode.
* <code>0</code> to turn off.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getAppletGCMode
*/
public ResponseAPDU setAppletGCMode(int mode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setAppletGCMode(mode));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setCommandPINMode(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setCommandPINMode
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setCommandPINMode1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setCommandPINMode
params=int
/**
* Sets the Command PIN Mode.
* If command PIN mode is set to <code>1</code>, a PIN is required for all
* Administrative commands.
*
* @param mode <code>1</code> to turn on Command PIN Mode.
* <code>0</code> to turn off.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getCommandPINMode
* @see #setCommonPIN
* @see #setPIN
*/
public ResponseAPDU setCommandPINMode(int mode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setCommandPINMode(mode));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setLoadPINMode(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setLoadPINMode
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setLoadPINMode1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setLoadPINMode
params=int
/**
* Sets the Load PIN Mode.
* If the load PIN mode is set (<code>1</code>), then PINs are required
* on applet loading.
*
* @param mode <code>1</code> to turn on Load PIN Mode.
* <code>0</code> to turn off.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getLoadPINMode
* @see #loadApplet
*/
public ResponseAPDU setLoadPINMode(int mode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setLoadPINMode(mode));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setRestoreMode(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setRestoreMode
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setRestoreMode1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setRestoreMode
params=int
/**
* Sets the Restore Mode.
* When Restore Mode is enabled (<code>1</code>), all field updates and
* <code>javacard.framework.System</code> transactions are considered atomic.
* If a tear occurs in the middle of these updates, values just prior to the
* update are restored.
*
* @param mode <code>1</code> to turn on Restore Mode.
* <code>0</code> to turn off.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getRestoreMode
*/
public ResponseAPDU setRestoreMode(int mode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setRestoreMode(mode));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setExceptionMode(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setExceptionMode
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setExceptionMode1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setExceptionMode
params=int
/**
* Sets the Exception Mode.
* When Exception Mode is enabled (<code>1</code>), Java API exceptions
* are thrown. All uncaught exceptions return 0x6F00 in the SW. When
* disabled, an error is returned from the VM.
*
* @param mode <code>1</code> to turn on Exception Mode.
* <code>0</code> to turn off.
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getExceptionMode
*/
public ResponseAPDU setExceptionMode(int mode)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setExceptionMode(mode));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU setCommitBufferSize(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU setCommitBufferSize
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU setCommitBufferSize1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU setCommitBufferSize
params=int
/**
* Sets the Commit Buffer size.
* Committing one field to the buffer requires <code>9</code> bytes.
* Therefore the default size of <code>72</code> bytes allows <code>8</code>
* field updates. The minimum size allowed is <code>72</code> bytes and the
* maximum is restricted by the amount of free RAM. All values will be rounded
* up to the next multiple of <code>9</code>.
*
* @param size size of the desired commit buffer
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6681. Invalid PIN.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #getCommitBufferSize
*/
public ResponseAPDU setCommitBufferSize(int size)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).setCommitBufferSize(size));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU select(java.lang.String) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU select
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU select1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU select
params=java.lang.String
/**
* Selects an applet by AID.
* Lenght of AID should not exceed <code>AID_SIZE</code>. No PIN required.
*
* @param aid the AID of the applet to be selected
*
* @return <code>ResponseAPDU</code> indicating success or failure
* <ul>
* <li>Success SW 0x9000.
* <li>Failure SW 0x6A82. Unable to Select Applet
* <li>Failure SW 0x8453. Applet not found.
* <li>For additional error codes, please see:
* <A HREF="http://www.ibutton.com/jibkit/documents/sw.html">
* http://www.ibutton.com/jibkit/documents/sw.html</A>
* </ul>
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #deleteAppletByAID
* @see #deleteAppletByNumber
* @see #deleteSelectedApplet
* @see #getAIDByNumber
* @see #process
*/
public ResponseAPDU select(java.lang.String aid)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).select(aid));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU process(com.dalsemi.onewire.container.CommandAPDU) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU process
sParams=com.dalsemi.onewire.container.CommandAPDU
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU process1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU process
params=com.dalsemi.onewire.container.CommandAPDU
/**
* Sends a generic process command to this JavaiButton.
* This method can be used to send any <code>CommandAPDU</code>.
* No PIN required.
*
* @param capdu <code>CommandAPDU</code> to be sent to this Java iButton
*
* @return <code>ResponseAPDU</code> the response from this Java iButton
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*
* @see #select
*/
public ResponseAPDU process(CommandAPDU capdu)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).process(((com.dalsemi.onewire.container.CommandAPDU)capdu.objectInstance)));
}
======================================
public com.dalsemi.onewire.container.ResponseAPDU sendAPDU(com.dalsemi.onewire.container.CommandAPDU, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU sendAPDU
sParams=com.dalsemi.onewire.container.CommandAPDU, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
tempMethodName=public ResponseAPDU sendAPDU2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer16
methodName=public com.dalsemi.onewire.container.ResponseAPDU sendAPDU
params=com.dalsemi.onewire.container.CommandAPDU,int
/**
* Sends a <code>CommandAPDU</code> to this Java iButton.
* No PIN required.
*
* @param capdu the <code>CommandAPDU</code> to be sent to this Java iButton
*
* @param runTime a <code>4</code> bit value (<code>0 -15</code>) that
* represents the expected run time of the device
*
* <code><pre>
* runTime * 250 + 62.5 mS <BR>
* Therefore, 0 -> 0 * 250 + 62.5 = 62.5 mS
* 1 -> 1 * 250 + 62.5 = 312.5 mS </pre></code>
* and so on.
*
* @return <code>ResponseAPDU</code> the <code>ResponseAPDU</code> from
* this Java iButton
*
* @throws IllegalArgumentException Invalid run time value
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public ResponseAPDU sendAPDU(CommandAPDU capdu, int runTime)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException, java.lang.IllegalArgumentException
{
return new ResponseAPDU(((com.dalsemi.onewire.container.OneWireContainer16)objectInstance).sendAPDU(((com.dalsemi.onewire.container.CommandAPDU)capdu.objectInstance), runTime));
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer18.java
superClassName=java.lang.Object
======================================
public static final byte READ_MEMORY
======================================
public static final byte WRITE_SCRATCHPAD
======================================
public static final byte MATCH_SCRATCHPAD
======================================
public static final byte ERASE_SCRATCHPAD
======================================
public static final byte READ_SCRATCHPAD
======================================
public static final byte READ_AUTHENTICATED_PAGE
======================================
public static final byte COPY_SCRATCHPAD
======================================
public static final byte COMPUTE_SHA
======================================
public static final byte COMPUTE_FIRST_SECRET
======================================
public static final byte COMPUTE_NEXT_SECRET
======================================
public static final byte VALIDATE_DATA_PAGE
======================================
public static final byte SIGN_DATA_PAGE
======================================
public static final byte COMPUTE_CHALLENGE
======================================
public static final byte AUTH_HOST
======================================
public static final byte RESUME
======================================
public synchronized void setSpeedCheck(boolean)
sMethodName=public synchronized void setSpeedCheck
sParams=boolean
sThrows=
tempMethodName=public synchronized void setSpeedCheck1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized void setSpeedCheck
params=boolean
/**
* Directs the container to avoid the calls to doSpeed() in methods that communicate
* with the SHA iButton. To ensure that all parts can talk to the 1-Wire bus
* at their desired speed, each method contains a call
* to <code>doSpeed()</code>. However, this is an expensive operation.
* If a user manages the bus speed in an
* application, call this method with <code>doSpeedCheck</code>
* as <code>false</code>. The default behavior is
* to call <code>doSpeed()</code>.
*
* @param doSpeedCheck <code>true</code> for <code>doSpeed()</code> to be called before every
* 1-Wire bus access, <code>false</code> to skip this expensive call
*
* @see OneWireContainer#doSpeed()
*/
public synchronized void setSpeedCheck(boolean doSpeedCheck)
{
((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).setSpeedCheck(doSpeedCheck);
}
======================================
public synchronized void useResume(boolean)
sMethodName=public synchronized void useResume
sParams=boolean
sThrows=
tempMethodName=public synchronized void useResume1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized void useResume
params=boolean
/**
* <p>Tells this <code>OneWireContainer18</code> whether it can use the <code>RESUME</code> command.
* The <code>RESUME</code> command allows the DS1963S to be re-selected for communication
* quickly by using a one <code>byte</code> <code>RESUME</code> command rather than a
* nine <code>byte</code> selection sequence. If another 1-Wire device is accessed,
* <code>useResume(false)</code> must be called, a normal selection of the part
* must be performed, and then <code>useResume(true)</code> can be called.</p>
*
* @param set <code>true</code> to use the one <code>byte</code> <code>RESUME</code> command
* instead of the nine <code>byte</code> select command
*
* @see #RESUME
*/
public synchronized void useResume(boolean set)
{
((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).useResume(set);
}
======================================
public synchronized boolean eraseScratchPad(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean eraseScratchPad
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean eraseScratchPad1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean eraseScratchPad
params=int
/**
* <p>Erases the scratchpad of the DS1963S. The cryptographic features
* of the DS1963S leave the device in 'hidden mode', which makes most
* memory functions inaccessible. A call to <code>eraseScratchPad(int)</code>
* brings the device out of 'hidden mode', filling the scratchpad
* with 0x0FF <code>bytes</code>.</p>
*
* <p>The argument <code>page</code> is usually unimportant, except in cases
* where a memory page needs to be erased. Erase a memory page by calling
* <code>eraseScratchPad(page_number)</code>, followed by <code>readScratchPad()</code>
* and then <code>copyScratchPad()</code>.
*
* @param page the target page number
*
* @return true if successful, false if the operation failed while waiting for the
* DS1963S's output to alternate (see the datasheet for a description)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #waitForSuccessfulFinish()
* @see #readScratchPad(byte[],int)
* @see #copyScratchPad()
*/
public synchronized boolean eraseScratchPad(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).eraseScratchPad(page);
}
======================================
public synchronized boolean waitForSuccessfulFinish() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean waitForSuccessfulFinish
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean waitForSuccessfulFinish0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean waitForSuccessfulFinish
params=
/**
* <p>Waits for the DS1963S's output to alternate. Several operations must
* wait for the DS1963S to stop sending 0x0ff's and begin alternating its
* output bits. This method reads until it finds a non-0x0ff <code>byte</code> or until it
* reaches a specified number of tries, indicating failure.</p>
*
* <p>This method can often be optimized away. A normal 1-Wire transaction
* involves writing and reading a known number of bytes. If a few more bytes
* are read, a program can check to see if the DS1963S has started alternating
* its output much quicker than calling this method will. For instance,
* to copy the scratchpad, the source code might look like this:
* <code><pre>
* buffer [0] = COPY_SCRATCHPAD;
* buffer [1] = TA1;
* buffer [2] = TA2;
* buffer [3] = ES;
*
* adapter.dataBlock(buffer,0,4);
* return waitForSuccessfulFinish();
* </pre></code>
* To optimize the code, read more bytes than required:
* <code><pre>
* buffer [0] = COPY_SCRATCHPAD;
* buffer [1] = TA1;
* buffer [2] = TA2;
* buffer [3] = ES;
*
* //copy 0x0FF into the buffer, this effectively reads
* System.arraycopy(FF, 0, buffer, 4, 5);
*
* //read 5 extra bytes
* adapter.dataBlock(buffer, 0, 9);
*
* //if the last byte has not shown alternating output,
* //still call waitForSuccessfulFinish(), else
* //we are already done
* if (buffer [8] == ( byte ) 0x0ff)
* return waitForSuccessfulFinish();
* else
* return true;
* </pre></code></p>
*
* <p>The second method is faster because it is more expensive to
* invoke another method that goes down to the native access layer
* than it is to just read a few more bytes while the program is
* already at the native access layer.</p>
*
* <p>See the datasheet for which operations function in this manner.
* Only call this method after another method which has successfully
* communicated with the DS1963S.</p>
*
* @return <code>true</code> if the DS1963S completed its operation successfully
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #copyScratchPad()
* @see #eraseScratchPad(int)
* @see #readAuthenticatedPage(int,byte[],int)
*/
public synchronized boolean waitForSuccessfulFinish()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).waitForSuccessfulFinish();
}
======================================
public void readMemoryPage(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void readMemoryPage
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void readMemoryPage3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public void readMemoryPage
params=int,byte[],int
/**
* <p>Reads a memory page from the DS1963S. Pages 0-15 are normal memory pages.
* Pages 16 and 17 contain the secrets--the DS1963S will return all 1's (0x0ff
* bytes). Page 18 is the physical location of the scratchpad, and will only
* return valid data if the part is not in hidden mode (0x0ff bytes are returned
* otherwise). Pages 19 and 20 contain the write cycle counters.
* Page 21 contains the counter for the pseudo random number generator (PRNG).
* Consult the datasheet for the memory maps of these special pages.</p>
*
* <p>Note that the same data can be returned through the <code>MemoryBank</code>s
* returned by <code>getMemoryBanks()</code>. However, this method contains
* several enhancements for faster reading.</p>
*
* @param pageNum page number to read
* @param data array for the return of the data (must be at least 32 bytes long)
* @param start offset into the byte array to start copying page data
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #readAuthenticatedPage(int,byte[],int)
* @see #getMemoryBanks()
*/
public void readMemoryPage(int pageNum, ByteArray data, int start)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).readMemoryPage(pageNum, data.array, start);
}
======================================
public boolean readAuthenticatedPage(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean readAuthenticatedPage
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean readAuthenticatedPage3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public boolean readAuthenticatedPage
params=int,byte[],int
/**
* <p>Reads and authenticates a page. See <code>readMemoryPage()</code> for a description
* of page numbers and their contents. This method will also generate a signature for the
* selected page, used in the authentication of roving (User) iButtons.
* Extra data is returned with the page as well--such as the write cycle
* counter for the page and the write cycle counter of the selected
* secret page.</p>
* <ul>
* <li>32 bytes of page data </li>
* <li>4 bytes secret counter for page </li>
* <li>4 bytes write cycle counter for page </li>
* <li>2 byte CRC </li>
* </ul>
* <p>Note that the CRC will be verified by this method, though it is returned with the data.</p>
*
* @param pageNum page number to read and authenticate
* @param data array for the page data plus extra information (2 write cycle
* counters of 4 bytes each, one 2 byte CRC, appended after 32 bytes of
* the data page). This byte array must be at least 42 bytes long.
* @param start offset to copy into the array
*
* @return <code>true</code> if successful, <code>false</code> if the operation
* failed while waiting for the DS1963S's output to alternate
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #readMemoryPage(int,byte[],int)
*/
public boolean readAuthenticatedPage(int pageNum, ByteArray data, int start)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).readAuthenticatedPage(pageNum, data.array, start);
}
======================================
public synchronized boolean writeScratchPad(int, int, byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean writeScratchPad
sParams=int, int, byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean writeScratchPad5
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean writeScratchPad
params=int,int,byte[],int,int
/**
* <p>Writes data to the scratchpad. In order to write to a data page using this method,
* next call <code>readScratchPad()</code>, and then <code>copyScratchPad()</code>.
* Note that the addresses passed to this method will be the addresses the data is
* copied to if the <code>copyScratchPad()</code> method is called afterward.</p>
*
* <p>Also note that if too many bytes are written, this method will truncate the
* data so that only a valid number of bytes will be sent.</p>
*
* @param targetPage the page number this data will eventually be copied to
* @param targetPageOffset the offset on the page to copy this data to
* @param inputbuffer the data that will be copied into the scratchpad
* @param start offset into the input buffer for the data to write
* @param length number of bytes to write
*
* @return <code>true</code> if successful, <code>false</code> on a CRC error
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #copyScratchPad()
* @see #eraseScratchPad(int)
* @see #readScratchPad(byte[],int)
* @see #writeDataPage(int,byte[])
*/
public synchronized boolean writeScratchPad(int targetPage, int targetPageOffset, ByteArray inputbuffer, int start, int length)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).writeScratchPad(targetPage, targetPageOffset, inputbuffer.array, start, length);
}
======================================
public synchronized boolean matchScratchPad(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean matchScratchPad
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean matchScratchPad1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean matchScratchPad
params=byte[]
/**
* <p>Verifies the hidden signature in the scratchpad of the DS1963S.
* After a <code>VALIDATE_DATA_PAGE</code> command, the scratchpad
* contains a signature that cannot be read, but must be verified.
* This method gives the DS1963S a signature. The iButton then
* checks to see if it equals the hidden signature in its
* scratchpad.</p>
*
* <p>The signature must be 20 bytes long, and it must start at offset 0
* of the input array.</p>
*
* @param mac the signature starting at offset 0
*
* @return <code>true</code> if the signature matches
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #VALIDATE_DATA_PAGE
*/
public synchronized boolean matchScratchPad(ByteArray mac)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).matchScratchPad(mac.array);
}
======================================
public synchronized int readScratchPad(byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized int readScratchPad
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized int readScratchPad2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized int readScratchPad
params=byte[],int
/**
* <p>Reads the contents of the DS1963S scratchpad. If the device is in hidden
* mode, all 1's (0x0ff bytes) will be returned.</p>
*
* <p>This method will return up to 32 bytes. It may return less
* if the target address stored internally on the DS1963S is
* not a multiple of 32.</p>
*
* @param data array to hold the contents of the scratchpad
* @param start offset to copy the scratchpad data into the <code>byte</code> array
*
* @return the number of bytes read, or -1 if there was a CRC failure
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #writeScratchPad(int,int,byte[],int,int)
*/
public synchronized int readScratchPad(ByteArray data, int start)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).readScratchPad(data.array, start);
}
======================================
public synchronized boolean copyScratchPad() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean copyScratchPad
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean copyScratchPad0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean copyScratchPad
params=
/**
* Copies the contents of the scratchpad to the target destination
* that was specified in a call to <code>writeScratchPad()</code> or
* <code>eraseScratchPad()</code>. This method will not success unless
* a call to <code>readScratchPad()</code> is made first to verify
* the target address registers in the DS1963S.
*
* @return <code>true</code> if successful, <code>false</code> if the operation
* failed while waiting for the DS1963S's output to alternate
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #eraseScratchPad(int)
* @see #readScratchPad(byte[],int)
* @see #writeScratchPad(int,int,byte[],int,int)
*/
public synchronized boolean copyScratchPad()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).copyScratchPad();
}
======================================
public synchronized boolean installMasterSecret(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean installMasterSecret
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean installMasterSecret3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean installMasterSecret
params=int,byte[],int
/**
* <p>Installs a secret on a DS1963S. The secret is written in partial phrases
* of 47 bytes (32 bytes to a memory page, 15 bytes to the scratchpad) and
* is cumulative until the entire secret is processed. Secrets are associated
* with a page number. See the datasheet for more information on this
* association.</p>
*
* <p>In most cases, <code>page</code> should be equal to <code>secret_number</code>
* or <code>secret_number+8</code>, based on the association of secrets and page numbers.
* Secrets are stored across pages 16 and 17 of the DS1963S memory. A secret is 8 bytes, so
* there are 8 secrets. These 8 secrets are associated with the first 16 pages of memory.</p>
*
* <p>On TINI, this method will be slightly faster if the secret's length is divisible by 47.
* However, since secret key generation is a part of initialization, it is probably
* not necessary.</p>
*
* @param page the page number used to write the partial secrets to
* @param secret the entire secret, in partial phrases, to be installed
* @param secret_number the secret 'page' to use (0 - 7)
*
* @return <code>true</code> if successful
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #bindSecretToiButton(int,byte[],byte[],int)
*/
public synchronized boolean installMasterSecret(int page, ByteArray secret, int secret_number)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).installMasterSecret(page, secret.array, secret_number);
}
======================================
public synchronized boolean bindSecretToiButton(int, byte[], byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean bindSecretToiButton
sParams=int, byte[], byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean bindSecretToiButton4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean bindSecretToiButton
params=int,byte[],byte[],int
/**
* <p>Binds an installed secret to a DS1963S by using
* well-known binding data and the DS1963S's unique
* address. This makes the secret unique
* for this iButton. Coprocessor iButtons use this method
* to recreate the iButton's secret to verify authentication.
* Roving iButtons use this method to finalize their secret keys.</p>
*
* <p>Note that unlike in the <code>installMasterSecret()</code> method,
* the page number does not need to be equivalent to the <code>secret_number</code>
* modulo 8. The new secret (installed secret + binding code) is generated
* from this page but can be copied into another secret. User iButtons should
* bind to the same page the secret was installed on. Coprocessor iButtons
* must copy to a new secret to preserve the general system authentication
* secret.</p>
*
* <p>The binding should be either 7 bytes long or 15 bytes long.
* A 15-length <code>byte</code> array is unaltered and placed in the scratchpad
* for the binding. A 7-length <code>byte</code> array is combined with the page
* number and DS1963S unique address and then placed in the scratchpad.
* Coprocessors should use a pre-formatted 15-length <code>byte</code> array.
* User iButtons should let the method format for them (i.e.
* use the 7-length <code>byte</code> array option).</p>
*
* @param page the page number that has the master secret already installed
* @param bind_data 32 bytes of binding data used to bind the iButton to the system
* @param bind_code the 7-byte or 15-byte binding code
* @param secret_number secret number to copy the resulting secret to
*
* @return <code>true</code> if successful
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #installMasterSecret(int,byte[],int)
*/
public synchronized boolean bindSecretToiButton(int page, ByteArray bind_data, ByteArray bind_code, int secret_number)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).bindSecretToiButton(page, bind_data.array, bind_code.array, secret_number);
}
======================================
public synchronized boolean writeDataPage(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean writeDataPage
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean writeDataPage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean writeDataPage
params=int,byte[]
/**
* <p>Writes a data page to the DS1963S. This method is the equivalent of calling:
* <ul>
* <li><code>eraseScratchPad(0); </code></li>
* <li><code>writeScratchPad(page_number,0,page_data_array,0,32); </code></li>
* <li><code>readScratchPad(buffer,0); </code></li>
* <li><code>copyScratchPad(); </code></li>
* </ul>
* However, this method makes several optimizations to help it
* run faster. Because of the optimizations, this is the preferred
* way of writing data to a normal memory page on the DS1963S.</p>
*
* @param page_number page number to write
* @param page_data page data to write (must be at least 32 bytes long)
*
* @return <code>true</code> if successful, <code>false</code> if the operation
* failed on a CRC error or while waiting for the DS1963S's output
* to alternate
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #eraseScratchPad(int)
* @see #writeScratchPad(int,int,byte[],int,int)
* @see #readScratchPad(byte[],int)
* @see #copyScratchPad()
*/
public synchronized boolean writeDataPage(int page_number, ByteArray page_data)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).writeDataPage(page_number, page_data.array);
}
======================================
public boolean SHAFunction(byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean SHAFunction
sParams=byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean SHAFunction1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public boolean SHAFunction
params=byte
/**
* <p>Performs one of the DS1963S's cryptographic functions. See the datasheet for
* more information on these functions.</p>
*
* Valid parameters for the <code>function</code> argument are:
* <ul>
* <li> COMPUTE_FIRST_SECRET </li>
* <li> COMPUTE_NEXT_SECRET </li>
* <li> VALIDATE_DATA_PAGE </li>
* <li> SIGN_DATA_PAGE </li>
* <li> COMPUTE_CHALLENGE </li>
* <li> AUTH_HOST </li>
* </ul>
* <p>This method uses the last target address used by this
* <code>OneWireContainer</code>. These are read in the
* <code>copyScratchPad()</code> and <code>readScratchPad()</code>
* methods.</p>
*
* @param function the SHA function code
*
* @return <code>true</code> if the function successfully completed,
* <code>false</code> if the operation failed on a CRC error
* or while waiting for the DS1963S's output to alternate
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAFunction(byte,int)
* @see #copyScratchPad()
* @see #readScratchPad(byte[],int)
*/
public boolean SHAFunction(byte function)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).SHAFunction(function);
}
======================================
public synchronized boolean SHAFunction(byte, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized boolean SHAFunction
sParams=byte, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized boolean SHAFunction2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer18
methodName=public synchronized boolean SHAFunction
params=byte,int
/**
* <p>Performs one of the DS1963S's cryptographic functions. See the datasheet for
* more information on these functions.</p>
*
* Valid parameters for the <code>function</code> argument are:
* <ul>
* <li> COMPUTE_FIRST_SECRET </li>
* <li> COMPUTE_NEXT_SECRET </li>
* <li> VALIDATE_DATA_PAGE </li>
* <li> SIGN_DATA_PAGE </li>
* <li> COMPUTE_CHALLENGE </li>
* <li> AUTH_HOST </li>
* </ul>
* <p>This method uses the last target address used by this
* <code>OneWireContainer</code>. These are read in the
* <code>copyScratchPad()</code> and <code>readScratchPad()</code>
* methods.</p>
*
* @param function the SHA function code
* @param T the raw target address for the operation
*
* @return <code>true</code> if the function successfully completed,
* <code>false</code> if the operation failed on a CRC error
* or while waiting for the DS1963S's output to alternate
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #SHAFunction(byte)
* @see #copyScratchPad()
* @see #readScratchPad(byte[],int)
*/
public synchronized boolean SHAFunction(byte function, int T)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer18)objectInstance).SHAFunction(function, T);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer1A.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer1D.java
superClassName=java.lang.Object
======================================
public long readCounter(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public long readCounter
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public String readCounter1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1D
methodName=public long readCounter
params=int
/**
* Read the counter value associated with a page on this
* 1-Wire Device.
*
* @param counterPage page number of the counter to read
*
* @return 4 byte value counter stored in a long integer
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public String readCounter(int counterPage)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer1D)objectInstance).readCounter(counterPage);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer1F.java
superClassName=java.lang.Object
-->OneWireContainer1F implements com.dalsemi.onewire.container.SwitchContainer
OneWireContainer1F implements com.dalsemi.onewire.container.SwitchContainer
======================================
public static final int CHANNEL_MAIN
======================================
public static final int CHANNEL_AUX
======================================
public synchronized void setSpeedCheck(boolean)
sMethodName=public synchronized void setSpeedCheck
sParams=boolean
sThrows=
tempMethodName=public synchronized void setSpeedCheck1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public synchronized void setSpeedCheck
params=boolean
/**
* Directs the container to avoid the calls to doSpeed() in methods that communicate
* with the Thermocron. To ensure that all parts can talk to the 1-Wire bus
* at their desired speed, each method contains a call
* to <code>doSpeed()</code>. However, this is an expensive operation.
* If a user manages the bus speed in an
* application, call this method with <code>doSpeedCheck</code>
* as <code>false</code>. The default behavior is
* to call <code>doSpeed()</code>.
*
* @param doSpeedCheck <code>true</code> for <code>doSpeed()</code> to be called before every
* 1-Wire bus access, <code>false</code> to skip this expensive call
*
* @see OneWireContainer#doSpeed()
*/
public synchronized void setSpeedCheck(boolean doSpeedCheck)
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).setSpeedCheck(doSpeedCheck);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public byte[] readDevice
params=
/**
* Retrieves the 1-Wire device sensor state. This state is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device state needs to be changed then call
* the 'writeDevice' to finalize the changes.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).writeDevice(state.array);
}
======================================
public void dischargeLines(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void dischargeLines
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void dischargeLines1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public void dischargeLines
params=int
/**
* <P>Force a power-on reset for parasitically powered 1-Wire
* devices connected to the main or auziliary output of the DS2409. </P>
*
* <P>IMPORTANT: the duration of the discharge time should be 100ms minimum.</P> <BR>
*
* @param time number of milliseconds the lines are
* to be discharged for (minimum 100)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void dischargeLines(int time)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).dischargeLines(time);
}
======================================
public boolean isHighSideSwitch()
sMethodName=public boolean isHighSideSwitch
sParams=
sThrows=
tempMethodName=public boolean isHighSideSwitch0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean isHighSideSwitch
params=
/**
* Checks to see if the channels of this switch are 'high side'
* switches. This indicates that when 'on' or <code>true</code>, the switch output is
* connect to the 1-Wire data. If this method returns <code>false</code>
* then when the switch is 'on' or <code>true</code>, the switch is connected
* to ground.
*
* @return <code>true</code> if the switch is a 'high side' switch,
* <code>false</code> if the switch is a 'low side' switch
*
* @see #getLatchState(int,byte[])
*/
public boolean isHighSideSwitch()
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).isHighSideSwitch();
}
======================================
public boolean hasActivitySensing()
sMethodName=public boolean hasActivitySensing
sParams=
sThrows=
tempMethodName=public boolean hasActivitySensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean hasActivitySensing
params=
/**
* Checks to see if the channels of this switch support
* activity sensing. If this method returns <code>true</code> then the
* method <code>getSensedActivity(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support activity sensing
*
* @see #getSensedActivity(int,byte[])
* @see #clearActivity()
*/
public boolean hasActivitySensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).hasActivitySensing();
}
======================================
public boolean hasLevelSensing()
sMethodName=public boolean hasLevelSensing
sParams=
sThrows=
tempMethodName=public boolean hasLevelSensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean hasLevelSensing
params=
/**
* Checks to see if the channels of this switch support
* level sensing. If this method returns <code>true</code> then the
* method <code>getLevel(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support level sensing
*
* @see #getLevel(int,byte[])
*/
public boolean hasLevelSensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).hasLevelSensing();
}
======================================
public boolean hasSmartOn()
sMethodName=public boolean hasSmartOn
sParams=
sThrows=
tempMethodName=public boolean hasSmartOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean hasSmartOn
params=
/**
* Checks to see if the channels of this switch support
* 'smart on'. Smart on is the ability to turn on a channel
* such that only 1-Wire device on this channel are awake
* and ready to do an operation. This greatly reduces
* the time to discover the device down a branch.
* If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* can be used with the <code>doSmart</code> parameter <code>true</code>.
*
* @return <code>true</code> if channels support 'smart on'
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean hasSmartOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).hasSmartOn();
}
======================================
public boolean onlySingleChannelOn()
sMethodName=public boolean onlySingleChannelOn
sParams=
sThrows=
tempMethodName=public boolean onlySingleChannelOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean onlySingleChannelOn
params=
/**
* Checks to see if the channels of this switch require that only one
* channel is on at any one time. If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* will not only affect the state of the given
* channel but may affect the state of the other channels as well
* to insure that only one channel is on at a time.
*
* @return <code>true</code> if only one channel can be on at a time.
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean onlySingleChannelOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).onlySingleChannelOn();
}
======================================
public int getNumberChannels(byte[])
sMethodName=public int getNumberChannels
sParams=byte[]
sThrows=
tempMethodName=public int getNumberChannels1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public int getNumberChannels
params=byte[]
/**
* Query to get the number of channels supported by this switch.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberChannels(byte[])</code> - 1)]. Note that
* all devices of the same family will not necessarily have the
* same number of channels. The DS2406 comes in two packages--one that
* has a single channel, and one that has two channels.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the number of channels for this device
*/
public int getNumberChannels(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).getNumberChannels(state.array);
}
======================================
public boolean getLevel(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getLevel
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getLevel2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean getLevel
params=int,byte[]
/**
* Checks the sensed level on the indicated channel.
* To avoid an exception, verify that this switch
* has level sensing with the <code>hasLevelSensing()</code>.
* Level sensing means that the device can sense the logic
* level on its PIO pin.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if level sensed is 'high' and <code>false</code> if level sensed is 'low'
*
* @see OneWireSensor#readDevice()
* @see #hasLevelSensing()
*/
public boolean getLevel(int a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).getLevel(a0, a1.array);
}
======================================
public boolean getLatchState(int, byte[])
sMethodName=public boolean getLatchState
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLatchState2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean getLatchState
params=int,byte[]
/**
* Checks the latch state of the indicated channel.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if channel latch is 'on'
* or conducting and <code>false</code> if channel latch is 'off' and not
* conducting. Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
*
* @see OneWireSensor#readDevice()
* @see #isHighSideSwitch()
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean getLatchState(int a0, ByteArray a1)
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).getLatchState(a0, a1.array);
}
======================================
public boolean getSensedActivity(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getSensedActivity
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getSensedActivity2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean getSensedActivity
params=int,byte[]
/**
* Checks if the indicated channel has experienced activity.
* This occurs when the level on the PIO pins changes. To clear
* the activity that is reported, call <code>clearActivity()</code>.
* To avoid an exception, verify that this device supports activity
* sensing by calling the method <code>hasActivitySensing()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if activity was detected and <code>false</code> if no activity was detected
*
* @throws OneWireException if this device does not have activity sensing
*
* @see #hasActivitySensing()
* @see #clearActivity()
*/
public boolean getSensedActivity(int channel, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).getSensedActivity(channel, state.array);
}
======================================
public boolean isModeAuto(byte[])
sMethodName=public boolean isModeAuto
sParams=byte[]
sThrows=
tempMethodName=public boolean isModeAuto1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean isModeAuto
params=byte[]
/**
* Checks if the control I/O pin mode is automatic (see DS2409 data sheet).
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if control mode is automatic
*/
public boolean isModeAuto(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).isModeAuto(state.array);
}
======================================
public int getControlChannelAssociation(byte[])
sMethodName=public int getControlChannelAssociation
sParams=byte[]
sThrows=
tempMethodName=public int getControlChannelAssociation1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public int getControlChannelAssociation
params=byte[]
/**
* Checks the channel association of the control pin.
* This value only makes sense if
* the control mode is automatic (see <CODE>isModeAuto</CODE>).
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>int</code> the channel number that is associated
* with the control pin
*/
public int getControlChannelAssociation(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).getControlChannelAssociation(state.array);
}
======================================
public int getControlData(byte[])
sMethodName=public int getControlData
sParams=byte[]
sThrows=
tempMethodName=public int getControlData1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public int getControlData
params=byte[]
/**
* Checks the control data value.
* This value only makes sense if
* the control mode is manual (see <CODE>isModeAuto</CODE>).
* 0 = output transistor off, 1 = output transistor on
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>int</code> the control output transistor state
*/
public int getControlData(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).getControlData(state.array);
}
======================================
public boolean getLastSmartOnDeviceDetect()
sMethodName=public boolean getLastSmartOnDeviceDetect
sParams=
sThrows=
tempMethodName=public boolean getLastSmartOnDeviceDetect0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public boolean getLastSmartOnDeviceDetect
params=
/**
* Gets flag that indicates if a device was present when doing the
* last smart on. Note that this flag is only valid if the DS2409
* flag was cleared with an ALL_LINES_OFF command and the last writeDevice
* performed a 'smart-on' on one of the channels.
*
* @return <code>true</code> if device detected on branch
*/
public boolean getLastSmartOnDeviceDetect()
{
return ((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).getLastSmartOnDeviceDetect();
}
======================================
public void setLatchState(int, boolean, boolean, byte[])
sMethodName=public void setLatchState
sParams=int, boolean, boolean, byte[]
sThrows=
tempMethodName=public void setLatchState4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public void setLatchState
params=int,boolean,boolean,byte[]
/**
* Sets the latch state of the indicated channel.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param latchState <code>true</code> to set the channel latch 'on'
* (conducting) and <code>false</code> to set the channel latch 'off' (not
* conducting). Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
* @param doSmart If latchState is 'on'/<code>true</code> then doSmart indicates
* if a 'smart on' is to be done. To avoid an exception
* check the capabilities of this device using the
* <code>hasSmartOn()</code> method.
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #hasSmartOn()
* @see #getLatchState(int,byte[])
* @see OneWireSensor#writeDevice(byte[])
*/
public void setLatchState(int a0, boolean a1, boolean a2, ByteArray a3)
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).setLatchState(a0, a1, a2, a3.array);
}
======================================
public void clearActivity() throws com.dalsemi.onewire.OneWireException
sMethodName=public void clearActivity
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void clearActivity0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public void clearActivity
params=
/**
* Clears the activity latches the next time possible. For
* example, on a DS2406/07, this happens the next time the
* status is read with <code>readDevice()</code>.
*
* @throws OneWireException if this device does not support activity sensing
*
* @see OneWireSensor#readDevice()
* @see #getSensedActivity(int,byte[])
*/
public void clearActivity()
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).clearActivity();
}
======================================
public void setModeAuto(boolean, byte[])
sMethodName=public void setModeAuto
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setModeAuto2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public void setModeAuto
params=boolean,byte[]
/**
* Sets the control pin mode.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param makeAuto <CODE>true</CODE> to set to auto mode, false for manual mode
* @param state current state of the device returned from <code>readDevice()</code>
*/
public void setModeAuto(boolean makeAuto, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).setModeAuto(makeAuto, state.array);
}
======================================
public void setControlChannelAssociation(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setControlChannelAssociation
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setControlChannelAssociation2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public void setControlChannelAssociation
params=int,byte[]
/**
* Sets the control pin channel association. This only makes sense
* if the contol pin is in automatic mode.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param channel channel to associate with control pin
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException when trying to set channel association in manual mode
*/
public void setControlChannelAssociation(int channel, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).setControlChannelAssociation(channel, state.array);
}
======================================
public void setControlData(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setControlData
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setControlData2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer1F
methodName=public void setControlData
params=boolean,byte[]
/**
* Sets the control pin data to a value. Note this
* method only works if the control pin is in manual mode.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param data <CODE>true</CODE> for on and <CODE>false</CODE> for off
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException when trying to set control data in automatic mode
*/
public void setControlData(boolean data, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer1F)objectInstance).setControlData(data, state.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer20.java
superClassName=java.lang.Object
-->OneWireContainer20 implements com.dalsemi.onewire.container.ADContainer
OneWireContainer20 implements com.dalsemi.onewire.container.ADContainer
======================================
public static final int BITMAP_OFFSET
======================================
public static final int ALARM_OFFSET
======================================
public static final int EXPOWER_OFFSET
======================================
public static final int CHANNELA
======================================
public static final int CHANNELB
======================================
public static final int CHANNELC
======================================
public static final int CHANNELD
======================================
public static final int NO_PRESET
======================================
public static final int PRESET_TO_ZEROS
======================================
public static final int PRESET_TO_ONES
======================================
public static final int NUM_CHANNELS
======================================
public int getNumberADChannels()
sMethodName=public int getNumberADChannels
sParams=
sThrows=
tempMethodName=public int getNumberADChannels0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public int getNumberADChannels
params=
/**
* Queries to get the number of channels supported by this A/D.
* Channel specific methods will use a channel number specified
* by an integer from <CODE>[0 to (getNumberChannels() - 1)]</CODE>.
*
* @return the number of channels
*/
public int getNumberADChannels()
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getNumberADChannels();
}
======================================
public boolean hasADAlarms()
sMethodName=public boolean hasADAlarms
sParams=
sThrows=
tempMethodName=public boolean hasADAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean hasADAlarms
params=
/**
* Queries to see if this A/D measuring device has high/low
* alarms.
*
* @return <CODE>true</CODE> if it has high/low trips
*/
public boolean hasADAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).hasADAlarms();
}
======================================
public double getADRanges(int)[]
sMethodName=public double getADRanges
sParams=int
sThrows=
tempMethodName=public double[] getADRanges1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public double[] getADRanges
params=int
/**
* Queries to get an array of available ranges for the specified
* A/D channel.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
*
* @return available ranges starting
* from the largest range to the smallest range
*/
public double[] getADRanges(int channel)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADRanges(channel);
}
======================================
public double getADResolutions(int, double)[]
sMethodName=public double getADResolutions
sParams=int, double
sThrows=
tempMethodName=public double[] getADResolutions2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public double[] getADResolutions
params=int,double
/**
* Queries to get an array of available resolutions based
* on the specified range on the specified A/D channel.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param range specified range
*
* @return available resolutions
*/
public double[] getADResolutions(int channel, double range)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADResolutions(channel, range);
}
======================================
public boolean canADMultiChannelRead()
sMethodName=public boolean canADMultiChannelRead
sParams=
sThrows=
tempMethodName=public boolean canADMultiChannelRead0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean canADMultiChannelRead
params=
/**
* Queries to see if this A/D supports doing multiple voltage
* conversions at the same time.
*
* @return <CODE>true</CODE> if can do multi-channel voltage reads
*/
public boolean canADMultiChannelRead()
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).canADMultiChannelRead();
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public byte[] readDevice
params=
/**
* Retrieves the entire A/D control/status and alarm pages.
* It reads this and verifies the data with the onboard CRC generator.
* Use the byte array returned from this method with static
* utility methods to extract the status, alarm and other register values.
* Appended to the data is 2 bytes that represent a bitmap
* of changed bytes. These bytes are used in the <CODE>writeADRegisters()</CODE>
* in conjuction with the 'set' methods to only write back the changed
* register bytes.
*
* @return register page contents verified
* with onboard CRC
*
* @throws OneWireIOException Data was not read correctly
* @throws OneWireException Could not find part
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void writeDevice
params=byte[]
/**
* Writes the bytes in the provided A/D register pages that
* have been changed by the 'set' methods. It knows which state has
* changed by looking at the bitmap fields appended to the
* register data. Any alarm flags will be automatically
* cleared. Only VCC powered indicator byte in physical location 0x1C
* can be written in the calibration memory bank.
*
* @param state register pages
*
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find part
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).writeDevice(state.array);
}
======================================
public double getADVoltage(byte[])[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double[] getADVoltage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public double[] getADVoltage
params=byte[]
/**
* Reads the voltage values. Must be used after a <CODE>doADConvert()</CODE>
* method call. Also must include the last valid state from the
* <CODE>readDevice()</CODE> method and this A/D must support multi-channel
* read <CODE>canMultiChannelRead()</CODE> if there are more then 1 channel.
*
* @param state current state of this device returned from
* <CODE>readDevice()</CODE>
*
* @return voltage values for all channels
*
* @throws OneWireIOException Data was not read correctly
* @throws OneWireException Could not find part
*/
public double[] getADVoltage(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADVoltage(state.array);
}
======================================
public double getADVoltage(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double getADVoltage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public double getADVoltage
params=int,byte[]
/**
* Reads a channels voltage value. Must be used after a
* <CODE>doADConvert()</CODE> method call. Also must include
* the last valid state from the <CODE>readDevice()</CODE> method.
* Note, if more then one channel is to be read then it is more
* efficient to use the <CODE>getADVoltage(byte[])</CODE> method that returns
* all channel values.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @return voltage value for the specified
* channel
*
* @throws OneWireIOException Data was not read correctly
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Invalid channel number passed
*/
public double getADVoltage(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADVoltage(channel, state.array);
}
======================================
public void doADConvert(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvert2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void doADConvert
params=int,byte[]
/**
* Performs voltage conversion on specified channel. The method
* <CODE>getADVoltage()</CODE> can be used to read the result
* of the conversion.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find part
*/
public void doADConvert(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).doADConvert(channel, state.array);
}
======================================
public void doADConvert(boolean[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=boolean[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvertMulti2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void doADConvert
params=boolean[],byte[]
/**
* Performs voltage conversion on all specified channels. The method
* <CODE>getADVoltage()</CODE> can be used to read the result of the
* conversion. This A/D must support multi-channel read
* <CODE>canMultiChannelRead()</CODE> if there are more then 1 channel
* is specified.
*
* @param doConvert which channels to perform conversion on.
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find part
*/
public void doADConvertMulti(boolean[] doConvert, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).doADConvert(doConvert, state.array);
}
======================================
public void doADConvert(int, int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void doADConvert
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void doADConvert3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void doADConvert
params=int,int,byte[]
/**
* Performs voltage conversion on specified channel. The method
* <CODE>getADVoltage()</CODE> can be used to read the result
* of the conversion.
*
* @param channel 0,1,2,3 representing the channels A,B,C,D
* @param preset preset value:
* <CODE>NO_PRESET (0), PRESET_TO_ZEROS (1), and PRESET_TO_ONES (2)</CODE>
* @param state state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Data could not be written correctly
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Invalid channel number passed
*/
public void doADConvert(int channel, int preset, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).doADConvert(channel, preset, state.array);
}
======================================
public void doADConvert(boolean[], int[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=boolean[], int[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvertMulti3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void doADConvert
params=boolean[],int[],byte[]
/**
* Performs voltage conversion on all specified channels.
* The method <CODE>getADVoltage()</CODE> can be used to read the result
* of the conversion.
*
* @param doConvert which channels to perform conversion on
* @param preset preset values
* <CODE>NO_PRESET (0), PRESET_TO_ZEROS (1), and PRESET_TO_ONES (2)</CODE>
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Data could not be written correctly
* @throws OneWireException Could not find part
*/
public void doADConvertMulti(boolean[] doConvert, int[] preset, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).doADConvert(doConvert, preset, state.array);
}
======================================
public double getADAlarm(int, int, byte[])
sMethodName=public double getADAlarm
sParams=int, int, byte[]
sThrows=
tempMethodName=public double getADAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public double getADAlarm
params=int,int,byte[]
/**
* Extracts the alarm voltage value of the specified channel from the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1) or ALARM_LOW (0)</CODE>
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @return alarm value in volts
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public double getADAlarm(int channel, int alarmType, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADAlarm(channel, alarmType, state.array);
}
======================================
public boolean getADAlarmEnable(int, int, byte[])
sMethodName=public boolean getADAlarmEnable
sParams=int, int, byte[]
sThrows=
tempMethodName=public boolean getADAlarmEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean getADAlarmEnable
params=int,int,byte[]
/**
* Extracts the alarm enable value of the specified channel from
* the provided state buffer. The state buffer is retrieved from
* the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the state
* returned from <CODE>readDevice()</CODE>
*
* @return <CODE>true</CODE> if specified alarm is enabled
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public boolean getADAlarmEnable(int channel, int alarmType, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADAlarmEnable(channel, alarmType, state.array);
}
======================================
public boolean hasADAlarmed(int, int, byte[])
sMethodName=public boolean hasADAlarmed
sParams=int, int, byte[]
sThrows=
tempMethodName=public boolean hasADAlarmed3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean hasADAlarmed
params=int,int,byte[]
/**
* Checks the alarm event value of the specified channel from the provided
* state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the state
* returned from <CODE>readDevice()</CODE>
*
* @return <CODE>true</CODE> if specified alarm occurred
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public boolean hasADAlarmed(int channel, int alarmType, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).hasADAlarmed(channel, alarmType, state.array);
}
======================================
public double getADResolution(int, byte[])
sMethodName=public double getADResolution
sParams=int, byte[]
sThrows=
tempMethodName=public double getADResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public double getADResolution
params=int,byte[]
/**
* Extracts the conversion resolution of the specified channel from the
* provided state buffer expressed in volts. The state is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the state
* returned from <CODE>readDevice()</CODE>
*
* @return resolution of channel in volts
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public double getADResolution(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADResolution(channel, state.array);
}
======================================
public double getADRange(int, byte[])
sMethodName=public double getADRange
sParams=int, byte[]
sThrows=
tempMethodName=public double getADRange2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public double getADRange
params=int,byte[]
/**
* Extracts the input voltage range of the specified channel from
* the provided state buffer. The state buffer is retrieved from
* the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the state
* returned from <CODE>readDevice()</CODE>
*
* @return A/D input voltage range
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public double getADRange(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getADRange(channel, state.array);
}
======================================
public boolean isOutputEnabled(int, byte[]) throws java.lang.IllegalArgumentException
sMethodName=public boolean isOutputEnabled
sParams=int, byte[]
sThrows=throws java.lang.IllegalArgumentException
tempMethodName=public boolean isOutputEnabled2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean isOutputEnabled
params=int,byte[]
/**
* Detects if the output is enabled for the specified channel from
* the provided register buffer. The register buffer is retrieved
* from the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the device
* returned from <CODE>readDevice()</CODE>
*
* @return <CODE>true</CODE> if output is enabled on specified channel
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public boolean isOutputEnabled(int channel, ByteArray state)
throws java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).isOutputEnabled(channel, state.array);
}
======================================
public boolean getOutputState(int, byte[]) throws java.lang.IllegalArgumentException
sMethodName=public boolean getOutputState
sParams=int, byte[]
sThrows=throws java.lang.IllegalArgumentException
tempMethodName=public boolean getOutputState2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean getOutputState
params=int,byte[]
/**
* Detects if the output is enabled for the specified channel from
* the provided register buffer. The register buffer is retrieved
* from the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the device
* returned from <CODE>readDevice()</CODE>
*
* @return <CODE>false</CODE> if output is conducting to ground and
* <CODE>true</CODE> if not conducting
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public boolean getOutputState(int channel, ByteArray state)
throws java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getOutputState(channel, state.array);
}
======================================
public boolean getDevicePOR(byte[])
sMethodName=public boolean getDevicePOR
sParams=byte[]
sThrows=
tempMethodName=public boolean getDevicePOR1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean getDevicePOR
params=byte[]
/**
* Detects if this device has seen a Power-On-Reset (POR). If this has
* occured it may be necessary to set the state of the device to the
* desired values. The register buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param state current state of the device
* returned from <CODE>readDevice()</CODE>
*
* @return <CODE>false</CODE> if output is conducting to ground and
* <CODE>true</CODE> if not conducting
*/
public boolean getDevicePOR(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).getDevicePOR(state.array);
}
======================================
public boolean isPowerExternal(byte[])
sMethodName=public boolean isPowerExternal
sParams=byte[]
sThrows=
tempMethodName=public boolean isPowerExternal1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public boolean isPowerExternal
params=byte[]
/**
* Extracts the state of the external power indicator from the provided
* register buffer. Use 'setPower' to set or clear the external power
* indicator flag. The register buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @return <CODE>true</CODE> if set to external power operation
*/
public boolean isPowerExternal(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).isPowerExternal(state.array);
}
======================================
public void setADAlarm(int, int, double, byte[])
sMethodName=public void setADAlarm
sParams=int, int, double, byte[]
sThrows=
tempMethodName=public void setADAlarm4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void setADAlarm
params=int,int,double,byte[]
/**
* Sets the alarm voltage value of the specified channel in the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method. The method <CODE>writeDevice()</CODE>
* must be called to finalize these changes to the device. Note that
* multiple 'set' methods can be called before one call to
* <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarm alarm value (will be reduced to 8 bit resolution)
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public void setADAlarm(int channel, int alarmType, double alarm, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).setADAlarm(channel, alarmType, alarm, state.array);
}
======================================
public void setADAlarmEnable(int, int, boolean, byte[])
sMethodName=public void setADAlarmEnable
sParams=int, int, boolean, byte[]
sThrows=
tempMethodName=public void setADAlarmEnable4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void setADAlarmEnable
params=int,int,boolean,byte[]
/**
* Sets the alarm enable value of the specified channel in the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method. The method <CODE>writeDevice()</CODE>
* must be called to finalize these changes to the device. Note that
* multiple 'set' methods can be called before one call to
* <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarmEnable alarm enable value
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public void setADAlarmEnable(int channel, int alarmType, boolean alarmEnable, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).setADAlarmEnable(channel, alarmType, alarmEnable, state.array);
}
======================================
public void setADResolution(int, double, byte[])
sMethodName=public void setADResolution
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADResolution3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void setADResolution
params=int,double,byte[]
/**
* Sets the conversion resolution value for the specified channel in
* the provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method. The method <CODE>writeDevice()</CODE>
* must be called to finalize these changes to the device. Note that
* multiple 'set' methods can be called before one call to
* <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param resolution resolution to use in volts
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public void setADResolution(int channel, double resolution, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).setADResolution(channel, resolution, state.array);
}
======================================
public void setADRange(int, double, byte[])
sMethodName=public void setADRange
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADRange3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void setADRange
params=int,double,byte[]
/**
* Sets the input range for the specified channel in the provided state
* buffer. The state buffer is retrieved from the <CODE>readDevice()</CODE>
* method. The method <CODE>writeDevice()</CODE> must be called to finalize
* these changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param range max volt range, use
* getRanges() method to get available ranges
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws IllegalArgumentException Invalid channel number passed
*/
public void setADRange(int channel, double range, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).setADRange(channel, range, state.array);
}
======================================
public void setOutput(int, boolean, boolean, byte[])
sMethodName=public void setOutput
sParams=int, boolean, boolean, byte[]
sThrows=
tempMethodName=public void setOutput4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void setOutput
params=int,boolean,boolean,byte[]
/**
* Sets the output enable and state for the specified channel in the
* provided register buffer. The register buffer is retrieved from
* the <CODE>readDevice()</CODE> method. The method <CODE>writeDevice()</CODE>
* must be called to finalize these changes to the device. Note that
* multiple 'set' methods can be called before one call to
* <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param outputEnable <CODE>true</CODE> if output is enabled
* @param outputState <CODE>false</CODE> if output is conducting to
* ground and <CODE>true</CODE> if not conducting. This
* parameter is not used if <CODE>outputEnable</CODE> is
* <CODE>false</CODE>
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*/
public void setOutput(int channel, boolean outputEnable, boolean outputState, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).setOutput(channel, outputEnable, outputState, state.array);
}
======================================
public void setPower(boolean, byte[])
sMethodName=public void setPower
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setPower2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public void setPower
params=boolean,byte[]
/**
* Sets or clears the external power flag in the provided register buffer.
* The register buffer is retrieved from the <CODE>readDevice()</CODE> method.
* The method <CODE>writeDevice()</CODE> must be called to finalize these
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param external <CODE>true</CODE> if setting external power is used
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*/
public void setPower(boolean external, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer20)objectInstance).setPower(external, state.array);
}
======================================
public static double interpretVoltage(long, double)
sMethodName=public static double interpretVoltage
sParams=long, double
sThrows=
tempMethodName=public static double interpretVoltage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public static double interpretVoltage
params=long,double
/**
* Converts a raw voltage long value for the DS2450 into a valid voltage.
* Requires the max voltage value.
*
* @param rawVoltage raw voltage
* @param range max voltage
*
* @return calculated voltage based on the range
*/
public double interpretVoltage(String rawVoltage, double range)
{
return com.dalsemi.onewire.container.OneWireContainer20.interpretVoltage(Long.parseLong(rawVoltage), range);
}
======================================
public static int voltageToInt(double, double)
sMethodName=public static int voltageToInt
sParams=double, double
sThrows=
tempMethodName=public static int voltageToInt2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer20
methodName=public static int voltageToInt
params=double,double
/**
* Converts a voltage double value to the DS2450 specific int value.
* Requires the max voltage value.
*
* @param voltage voltage
* @param range max voltage
*
* @return the DS2450 voltage
*/
public int voltageToInt(double voltage, double range)
{
return com.dalsemi.onewire.container.OneWireContainer20.voltageToInt(voltage, range);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer21.java
superClassName=java.lang.Object
-->OneWireContainer21 implements com.dalsemi.onewire.container.TemperatureContainer,com.dalsemi.onewire.container.ClockContainer
OneWireContainer21 implements com.dalsemi.onewire.container.TemperatureContainer
OneWireContainer21 implements com.dalsemi.onewire.container.ClockContainer
======================================
public static final int STATUS_REGISTER
======================================
public static final int CONTROL_REGISTER
======================================
public static final byte ONCE_PER_SECOND
======================================
public static final byte ONCE_PER_MINUTE
======================================
public static final byte ONCE_PER_HOUR
======================================
public static final byte ONCE_PER_DAY
======================================
public static final byte ONCE_PER_WEEK
======================================
public static final byte TEMPERATURE_LOW_ALARM
======================================
public static final byte TEMPERATURE_HIGH_ALARM
======================================
public static final byte TIMER_ALARM
======================================
public static final byte TIMER_ALARM_SEARCH_FLAG
======================================
public static final byte TEMP_HIGH_SEARCH_FLAG
======================================
public static final byte TEMP_LOW_SEARCH_FLAG
======================================
public static final byte ROLLOVER_ENABLE_FLAG
======================================
public static final byte MISSION_ENABLE_FLAG
======================================
public static final byte MEMORY_CLEAR_ENABLE_FLAG
======================================
public static final byte OSCILLATOR_ENABLE_FLAG
======================================
public static final byte TIMER_ALARM_FLAG
======================================
public static final byte TEMPERATURE_HIGH_FLAG
======================================
public static final byte TEMPERATURE_LOW_FLAG
======================================
public static final byte SAMPLE_IN_PROGRESS_FLAG
======================================
public static final byte MISSION_IN_PROGRESS_FLAG
======================================
public static final byte MEMORY_CLEARED_FLAG
======================================
public static final byte TEMP_CORE_BUSY_FLAG
======================================
public synchronized void setSpeedCheck(boolean)
sMethodName=public synchronized void setSpeedCheck
sParams=boolean
sThrows=
tempMethodName=public synchronized void setSpeedCheck1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public synchronized void setSpeedCheck
params=boolean
/**
* Directs the container to avoid the calls to doSpeed() in methods that communicate
* with the Thermocron. To ensure that all parts can talk to the 1-Wire bus
* at their desired speed, each method contains a call
* to <code>doSpeed()</code>. However, this is an expensive operation.
* If a user manages the bus speed in an
* application, call this method with <code>doSpeedCheck</code>
* as <code>false</code>. The default behavior is
* to call <code>doSpeed()</code>.
*
* @param doSpeedCheck <code>true</code> for <code>doSpeed()</code> to be called before every
* 1-Wire bus access, <code>false</code> to skip this expensive call
*
* @see OneWireContainer#doSpeed()
*/
public synchronized void setSpeedCheck(boolean doSpeedCheck)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setSpeedCheck(doSpeedCheck);
}
======================================
public double getPhysicalRangeLowTemperature()
sMethodName=public double getPhysicalRangeLowTemperature
sParams=
sThrows=
tempMethodName=public double getPhysicalRangeLowTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getPhysicalRangeLowTemperature
params=
/**
* This method returns the low temperature of
* the thermochron's physical temperature range.
* The physical range is the range of temperatures
* that the thermochron can record.
*
* The following is a list of physical ranges in
* degrees Celsius:
*
* DS1921L-F5X = physical range -40 to +85
*
* DS1921H = physical range 15 to 46
*
* DS1921Z = physical range -5 to 26
*
* @return the physical range low temperature in degrees Celsius
*/
public double getPhysicalRangeLowTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getPhysicalRangeLowTemperature();
}
======================================
public double getPhysicalRangeHighTemperature()
sMethodName=public double getPhysicalRangeHighTemperature
sParams=
sThrows=
tempMethodName=public double getPhysicalRangeHighTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getPhysicalRangeHighTemperature
params=
/**
* This method returns the high temperature of
* the thermochron's physical temperature range.
* The physical range is the range of temperatures
* that the thermochron can record.
*
* The following is a list of physical ranges in
* degrees Celsius:
*
* DS1921L-F5X = physical range -40 to +85
*
* DS1921H = physical range 15 to 46
*
* DS1921Z = physical range -5 to 26
*
* @return the physical range low temperature in degrees Celsius
*/
public double getPhysicalRangeHighTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getPhysicalRangeHighTemperature();
}
======================================
public double getOperatingRangeLowTemperature()
sMethodName=public double getOperatingRangeLowTemperature
sParams=
sThrows=
tempMethodName=public double getOperatingRangeLowTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getOperatingRangeLowTemperature
params=
/**
* This method returns the low temperature of
* the thermochron's operating temperature range.
* The operating range is the range of temperatures
* for which the thermochron can function properly.
*
* The following is a list of operating ranges in
* degrees Celsius:
*
* DS1921L-F50 = operating range -40 to +85.
* DS1921L-F51 = operating range -10 to +85.
* DS1921L-F52 = operating range -20 to +85.
* DS1921L-F53 = operating range -30 to +85.
*
* DS1921H = operating range -40 to +85
* DS1921Z = operating range -40 to +85
*
* @return the operating range low temperature in degrees Celsius
*/
public double getOperatingRangeLowTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getOperatingRangeLowTemperature();
}
======================================
public double getOperatingRangeHighTemperature()
sMethodName=public double getOperatingRangeHighTemperature
sParams=
sThrows=
tempMethodName=public double getOperatingRangeHighTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getOperatingRangeHighTemperature
params=
/**
* This method returns the high temperature of
* the thermochron's operating temperature range.
* The operating range is the range of temperatures
* for which the thermochron can function properly.
*
* The following is a list of operating ranges in
* degrees Celsius:
*
* DS1921L-F50 = operating range -40 to +85.
* DS1921L-F51 = operating range -10 to +85.
* DS1921L-F52 = operating range -20 to +85.
* DS1921L-F53 = operating range -30 to +85.
*
* DS1921H = operating range -40 to +85
* DS1921Z = operating range -40 to +85
*
* @return the operating range high temperature in degrees Celsius
*/
public double getOperatingRangeHighTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getOperatingRangeHighTemperature();
}
======================================
public double getTemperatureResolution()
sMethodName=public double getTemperatureResolution
sParams=
sThrows=
tempMethodName=public double getTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getTemperatureResolution
params=
/**
* Retrieves the resolution with which the thermochron takes
* temperatures in degrees Celsius.
*
* @return the temperature resolution of this thermochron.
*/
public double getTemperatureResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperatureResolution();
}
======================================
public double getHistogramLowTemperature()
sMethodName=public double getHistogramLowTemperature
sParams=
sThrows=
tempMethodName=public double getHistogramLowTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getHistogramLowTemperature
params=
/**
* Retrieves the lowest temperature of the first histogram bin
* in degrees Celsius.
*
* @return the lowest histogram bin temperature.
*/
public double getHistogramLowTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getHistogramLowTemperature();
}
======================================
public double getHistogramBinWidth()
sMethodName=public double getHistogramBinWidth
sParams=
sThrows=
tempMethodName=public double getHistogramBinWidth0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getHistogramBinWidth
params=
/**
* This method returns the width of a histogram bin in degrees
* Celsius.
*
* @return the width of a histogram bin for this thermochron.
*/
public double getHistogramBinWidth()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getHistogramBinWidth();
}
======================================
public double decodeTemperature(byte)
sMethodName=public double decodeTemperature
sParams=byte
sThrows=
tempMethodName=public double decodeTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double decodeTemperature
params=byte
/**
* Converts a temperature from the DS1921 <code>byte</code> encoded
* format to degrees Celsius. The raw temperature readings are unsigned
* <code>byte</code> values, representing a 2.0 degree accuracy.
*
* @param tempByte raw DS1921 temperature reading
*
* @return temperature in degrees Celsius
*
* @see #encodeTemperature(double)
*/
public double decodeTemperature(byte tempByte)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).decodeTemperature(tempByte);
}
======================================
public byte encodeTemperature(double)
sMethodName=public byte encodeTemperature
sParams=double
sThrows=
tempMethodName=public byte encodeTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public byte encodeTemperature
params=double
/**
* Converts a temperature in degrees Celsius to
* a <code>byte</code> formatted for the DS1921.
*
* @param temperature the temperature (Celsius) to convert
*
* @return the temperature in raw DS1921 format
*
* @see #decodeTemperature(byte)
*/
public byte encodeTemperature(double temperature)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).encodeTemperature(temperature);
}
======================================
public void writeByte(int, byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeByte
sParams=int, byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeByte2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void writeByte
params=int,byte
/**
* Writes a byte of data into the DS1921's memory. Note that writing to
* the register page while a mission is in progress ends that mission.
* Also note that the preferred way to write a page is through the
* <code>MemoryBank</code> objects returned from the <code>getMemoryBanks()</code>
* method.
*
* @param memAddr the address for writing (in the range of 0x200-0x21F)
* @param source the data <code>byte</code> to write
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #readByte(int)
* @see #getMemoryBanks()
*/
public void writeByte(int memAddr, byte source)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).writeByte(memAddr, source);
}
======================================
public byte readByte(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readByte
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public byte readByte1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public byte readByte
params=int
/**
* Reads a single byte from the DS1921. Note that the preferred manner
* of reading from the DS1921 Thermocron is through the <code>readDevice()</code>
* method or through the <code>MemoryBank</code> objects returned in the
* <code>getMemoryBanks()</code> method.
*
* @param memAddr the address to read from (in the range of 0x200-0x21F)
*
* @return the data byte read
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #writeByte(int,byte)
* @see #readDevice()
* @see #getMemoryBanks()
*/
public byte readByte(int memAddr)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).readByte(memAddr);
}
======================================
public boolean getFlag(int, byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean getFlag
sParams=int, byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getFlag2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean getFlag
params=int,byte
/**
* <p>Gets the status of the specified flag from the specified register.
* This method actually communicates with the Thermocron. To improve
* performance if you intend to make multiple calls to this method,
* first call <code>readDevice()</code> and use the
* <code>getFlag(int, byte, byte[])</code> method instead.</p>
*
* <p>The DS1921 Thermocron has two sets of flags. One set belongs
* to the control register. When reading from the control register,
* valid values for <code>bitMask</code> are:</p>
* <ul>
* <li><code> TIMER_ALARM_SEARCH_FLAG </code></li>
* <li><code> TEMP_HIGH_SEARCH_FLAG </code></li>
* <li><code> TEMP_LOW_SEARCH_FLAG </code></li>
* <li><code> ROLLOVER_ENABLE_FLAG </code></li>
* <li><code> MISSION_ENABLE_FLAG </code></li>
* <li><code> MEMORY_CLEAR_ENABLE_FLAG </code></li>
* <li><code> OSCILLATOR_ENABLE_FLAG </code></li>
* </ul>
* <p>When reading from the status register, valid values
* for <code>bitMask</code> are:</p>
* <ul>
* <li><code> TIMER_ALARM_FLAG </code></li>
* <li><code> TEMPERATURE_HIGH_FLAG </code></li>
* <li><code> TEMPERATURE_LOW_FLAG </code></li>
* <li><code> SAMPLE_IN_PROGRESS_FLAG </code></li>
* <li><code> MISSION_IN_PROGRESS_FLAG </code></li>
* <li><code> MEMORY_CLEARED_FLAG </code></li>
* <li><code> TEMP_CORE_BUSY_FLAG </code></li>
* </ul>
*
* @param register address of register containing the flag (valid values
* are <code>CONTROL_REGISTER</code> and <code>STATUS_REGISTER</code>)
* @param bitMask the flag to read (see above for available options)
*
* @return the status of the flag, where <code>true</code>
* signifies a "1" and <code>false</code> signifies a "0"
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getFlag(int,byte,byte[])
* @see #readDevice()
* @see #setFlag(int,byte,boolean)
* @see #TIMER_ALARM_SEARCH_FLAG
* @see #TEMP_HIGH_SEARCH_FLAG
* @see #TEMP_LOW_SEARCH_FLAG
* @see #ROLLOVER_ENABLE_FLAG
* @see #MISSION_ENABLE_FLAG
* @see #MEMORY_CLEAR_ENABLE_FLAG
* @see #OSCILLATOR_ENABLE_FLAG
* @see #TIMER_ALARM_FLAG
* @see #TEMPERATURE_HIGH_FLAG
* @see #TEMPERATURE_LOW_FLAG
* @see #SAMPLE_IN_PROGRESS_FLAG
* @see #MISSION_IN_PROGRESS_FLAG
* @see #MEMORY_CLEARED_FLAG
* @see #TEMP_CORE_BUSY_FLAG
*
*
*/
public boolean getFlag(int register, byte bitMask)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getFlag(register, bitMask);
}
======================================
public boolean getFlag(int, byte, byte[])
sMethodName=public boolean getFlag
sParams=int, byte, byte[]
sThrows=
tempMethodName=public boolean getFlag3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean getFlag
params=int,byte,byte[]
/**
* <p>Gets the status of the specified flag from the specified register.
* This method is the preferred manner of reading the control and
* status flags.</p>
*
* <p>For more information on valid values for the <code>bitMask</code>
* parameter, see the {@link #getFlag(int,byte) getFlag(int,byte)} method.</p>
*
* @param register address of register containing the flag (valid values
* are <code>CONTROL_REGISTER</code> and <code>STATUS_REGISTER</code>)
* @param bitMask the flag to read (see {@link #getFlag(int,byte) getFlag(int,byte)}
* for available options)
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the status of the flag, where <code>true</code>
* signifies a "1" and <code>false</code> signifies a "0"
*
* @see #getFlag(int,byte)
* @see #readDevice()
* @see #setFlag(int,byte,boolean,byte[])
*/
public boolean getFlag(int register, byte bitMask, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getFlag(register, bitMask, state.array);
}
======================================
public void setFlag(int, byte, boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setFlag
sParams=int, byte, boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setFlag3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setFlag
params=int,byte,boolean
/**
* <p>Sets the status of the specified flag in the specified register.
* If a mission is in progress a <code>OneWireIOException</code> will be thrown
* (one cannot write to the registers while a mission is commencing). This method
* actually communicates with the DS1921 Thermocron. To improve
* performance if you intend to make multiple calls to this method,
* first call <code>readDevice()</code> and use the
* <code>setFlag(int,byte,boolean,byte[])</code> method instead.</p>
*
* <p>For more information on valid values for the <code>bitMask</code>
* parameter, see the {@link #getFlag(int,byte) getFlag(int,byte)} method.</p>
*
* @param register address of register containing the flag (valid values
* are <code>CONTROL_REGISTER</code> and <code>STATUS_REGISTER</code>)
* @param bitMask the flag to read (see {@link #getFlag(int,byte) getFlag(int,byte)}
* for available options)
* @param flagValue new value for the flag (<code>true</code> is logic "1")
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* In the case of the DS1921 Thermocron, this could also be due to a
* currently running mission.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getFlag(int,byte)
* @see #getFlag(int,byte,byte[])
* @see #setFlag(int,byte,boolean,byte[])
* @see #readDevice()
*/
public void setFlag(int register, byte bitMask, boolean flagValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setFlag(register, bitMask, flagValue);
}
======================================
public void setFlag(int, byte, boolean, byte[])
sMethodName=public void setFlag
sParams=int, byte, boolean, byte[]
sThrows=
tempMethodName=public void setFlag4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setFlag
params=int,byte,boolean,byte[]
/**
* <p>Sets the status of the specified flag in the specified register.
* If a mission is in progress a <code>OneWireIOException</code> will be thrown
* (one cannot write to the registers while a mission is commencing). This method
* is the preferred manner of setting the DS1921 status and control flags.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.</p>
*
* <p>For more information on valid values for the <code>bitMask</code>
* parameter, see the {@link #getFlag(int,byte) getFlag(int,byte)} method.</p>
*
* @param register address of register containing the flag (valid values
* are <code>CONTROL_REGISTER</code> and <code>STATUS_REGISTER</code>)
* @param bitMask the flag to read (see {@link #getFlag(int,byte) getFlag(int,byte)}
* for available options)
* @param flagValue new value for the flag (<code>true</code> is logic "1")
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #getFlag(int,byte)
* @see #getFlag(int,byte,byte[])
* @see #setFlag(int,byte,boolean)
* @see #readDevice()
* @see #writeDevice(byte[])
*/
public void setFlag(int register, byte bitMask, boolean flagValue, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setFlag(register, bitMask, flagValue, state.array);
}
======================================
public void enableMission(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void enableMission
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void enableMission1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void enableMission
params=int
/**
* <p>Begins this DS1921's mission. If a mission is
* already in progress, this will throw a <code>OneWireIOException</code>.
* The mission will wait the number of minutes specified by the
* mission start delay (use <code>setMissionStartDelay()</code>)
* before beginning.</p>
*
* <p>Note that this method actually communicates with the DS1921
* Thermocron. No call to <code>writeDevice()</code> is required to
* finalize mission enabling. However, some flags (such as the mission
* start delay) may need to be set with a call to <code>writeDevice()</code>
* before the mission is enabled. See the usage section
* above for an example of starting a mission.</p>
*
* @param sampleRate the number of minutes to wait in between temperature samples
* (valid values are 1 to 255)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* In the case of the DS1921 Thermocron, this could also be due to a
* currently running mission.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #disableMission()
* @see #setMissionStartDelay(int,byte[])
* @see #writeDevice(byte[])
*/
public void enableMission(int sampleRate)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).enableMission(sampleRate);
}
======================================
public void disableMission() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void disableMission
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void disableMission0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void disableMission
params=
/**
* Ends this DS1921's running mission. Note that this method
* actually communicates with the DS1921 Thermocron. No additional
* call to <code>writeDevice(byte[])</code> is required.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #enableMission(int)
*/
public void disableMission()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).disableMission();
}
======================================
public void setMissionStartDelay(int, byte[])
sMethodName=public void setMissionStartDelay
sParams=int, byte[]
sThrows=
tempMethodName=public void setMissionStartDelay2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setMissionStartDelay
params=int,byte[]
/**
* <p>Sets the time to wait before starting the mission.
* The DS1921 will sleep <code>missionStartDelay</code>
* minutes after the mission is enabled with <code>enableMission(int)</code>,
* then begin taking samples. Only the least significant 16 bits of
* <code>missionStartDelay</code> are relevant.</p>
*
* <p>The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.</p>
*
* @param missionStartDelay the time in minutes to delay the first sample
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #readDevice()
* @see #writeDevice(byte[])
* @see #enableMission(int)
*/
public void setMissionStartDelay(int missionStartDelay, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setMissionStartDelay(missionStartDelay, state.array);
}
======================================
public void clearMemory() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void clearMemory
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void clearMemory0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void clearMemory
params=
/**
* <p>Clears the memory of any previous mission. The memory
* must be cleared before setting up a new mission. If a
* mission is in progress a <code>OneWireIOException</code> is thrown.</p>
*
* <p>The Clear Memory command clears the Thermocron's memory
* at address 220h and higher. It also clears the sample rate, mission
* start delay, mission time stamp, and mission samples counter.</p>
*
* <p>Note that this method actually communicates with the DS1921 Thermocron.
* No call to <code>writeDevice(byte[])</code> is necessary to finalize this
* activity.</p>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* In the case of the DS1921 Thermocron, this could also be due to a
* currently running mission.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #enableMission(int)
* @see #writeDevice(byte[])
*/
public void clearMemory()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).clearMemory();
}
======================================
public java.util.Calendar getAlarmTime(byte[])
sMethodName=public java.util.Calendar getAlarmTime
sParams=byte[]
sThrows=
tempMethodName=public java.util.Calendar getAlarmTime1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public java.util.Calendar getAlarmTime
params=byte[]
/**
* <p>Gets the clock alarm time settings. The alarm settings used by the
* Thermocron are Hour, Minute, Second, and Day of Week. Note that not
* all values in the returned <code>java.util.Calendar</code> object
* are valid. Only four values in the <code>Calendar</code> should
* be used. The field names for these values are:<pre><code>
* Calendar.DAY_OF_MONTH
* Calendar.HOUR
* Calendar.MINUTE
* Calendar.SECOND</code></pre>
* </p>
* <p>To access these fields, use the method <code>Calendar.get(Calendar.HOUR)</code>.
* The hour is reported in 24-hour format. Use the method <code>getClockAlarm(byte[])</code>
* to find out the next time an alarm event will occur.</p>
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the alarm clock time and day of the week
*
* @see #setClockAlarm(int,int,int,int,int,byte[])
* @see #readDevice()
* @see #getClockAlarm(byte[])
*/
public java.util.Calendar getAlarmTime(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getAlarmTime(state.array);
}
======================================
public void setClockAlarm(int, int, int, int, int, byte[])
sMethodName=public void setClockAlarm
sParams=int, int, int, int, int, byte[]
sThrows=
tempMethodName=public void setClockAlarm6
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setClockAlarm
params=int,int,int,int,int,byte[]
/**
* Set the DS1921's alarm clock. Some of the parameters
* might be unimportant depending on the alarm frequency setting.
* For instance, if the alarm frequency setting is <code>ONCE_PER_MINUTE</code>,
* then the <code>hour</code> argument is irrelevant.</p>
*
* <p>Valid values for <code>alarmFrequency</code> are:<pre><code>
* ONCE_PER_SECOND
* ONCE_PER_MINUTE
* ONCE_PER_HOUR
* ONCE_PER_DAY
* ONCE_PER_WEEK</code></pre>
* </p>
*
* <p>The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.</p>
*
* @param hours the hour of the day (0-23)
* @param minutes the minute setting (0-59)
* @param seconds the second setting (0-59)
* @param day the day of the week (1-7, 1==Sunday)
* @param alarmFrequency frequency that the alarm should occur at
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #readDevice()
* @see #writeDevice(byte[])
* @see #getClockAlarm(byte[])
* @see #ONCE_PER_SECOND
* @see #ONCE_PER_MINUTE
* @see #ONCE_PER_HOUR
* @see #ONCE_PER_DAY
* @see #ONCE_PER_WEEK
*/
public void setClockAlarm(int hours, int minutes, int seconds, int day, int alarmFrequency, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setClockAlarm(hours, minutes, seconds, day, alarmFrequency, state.array);
}
======================================
public int getSampleRate(byte[])
sMethodName=public int getSampleRate
sParams=byte[]
sThrows=
tempMethodName=public int getSampleRate1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public int getSampleRate
params=byte[]
/**
* Returns the rate at which the DS1921 takes temperature samples.
* This rate is set when the mission is enabled (in the method
* <code>enableMission(int)</code>.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the time, in minutes, between temperature readings
*
* @see #enableMission(int)
* @see #readDevice()
*/
public int getSampleRate(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getSampleRate(state.array);
}
======================================
public int getMissionSamplesCounter(byte[])
sMethodName=public int getMissionSamplesCounter
sParams=byte[]
sThrows=
tempMethodName=public int getMissionSamplesCounter1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public int getMissionSamplesCounter
params=byte[]
/**
* Determines the number of samples taken on this mission.
* Only the last 2048 samples appear in the Thermocron's log,
* though all readings from the current mission are logged
* in the histogram.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the number of samples taken in the current mission
*
* @see #readDevice()
* @see #getDeviceSamplesCounter(byte[])
*/
public int getMissionSamplesCounter(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getMissionSamplesCounter(state.array);
}
======================================
public int getDeviceSamplesCounter(byte[])
sMethodName=public int getDeviceSamplesCounter
sParams=byte[]
sThrows=
tempMethodName=public int getDeviceSamplesCounter1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public int getDeviceSamplesCounter
params=byte[]
/**
* <p>Determines the total number of samples taken by this Thermocron.
* This includes samples taken in past missions. It also includes
* 'forced' readings. A 'forced' reading refers to a reading taken
* when the Thermocron does not have a running mission and is instructed
* to read the current temperature.</p>
*
* <p>The DS1921 Thermocron is tested to last for 1 million temperature
* readings.</p>
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the total number of measurements taken by this Thermocron
*
* @see #readDevice()
* @see #getMissionSamplesCounter(byte[])
*/
public int getDeviceSamplesCounter(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getDeviceSamplesCounter(state.array);
}
======================================
public java.util.Calendar getMissionTimeStamp(byte[])
sMethodName=public java.util.Calendar getMissionTimeStamp
sParams=byte[]
sThrows=
tempMethodName=public java.util.Calendar getMissionTimeStamp1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public java.util.Calendar getMissionTimeStamp
params=byte[]
/**
* Returns the date and time that the last mission was
* started. The values in the <code>java.util.Calendar</code>
* object are fully specified. In other words, the year, month,
* date, hour, minute, and second are all valid in the returned
* object.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the date and time that the last mission was started
*
* @see #readDevice()
*/
public java.util.Calendar getMissionTimeStamp(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getMissionTimeStamp(state.array);
}
======================================
public long getFirstLogOffset(byte[])
sMethodName=public long getFirstLogOffset
sParams=byte[]
sThrows=
tempMethodName=public String getFirstLogOffset1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public long getFirstLogOffset
params=byte[]
/**
* <p>Helps determine the times for values in a temperature log. If rollover
* is enabled, temperature log entries will over-write previous
* entries once more than 2048 logs are written. The returned value can be
* added to the underlying millisecond value of <code>getMissionTimeStamp()</code>
* to determine the time that the 'first' log entry actually occurred.</p>
* <pre><code>
* //ds1921 is a OneWireContainer21
* byte[] state = ds1921.readDevice();
* Calendar c = ds1921.getMissionTimeStamp(state);
* //find the time for the first log entry
* long first_entry = c.getTime().getTime();
* first_entry += ds1921.getFirstLogOffset(state);
* . . .
* </code></pre>
*
* <p>Be cautious of Java's Daylight Savings Time offsets when using this
* function--if you use the <code>Date</code> or <code>Calendar</code>
* class to print this out, Java may try to automatically format
* the <code>java.lang.String</code> to handle Daylight Savings Time, resulting in offset
* by 1 hour problems.</p>
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return milliseconds between the beginning of the mission
* and the time of the first log entry reported from
* <code>getTemperatureLog()</code>
*
* @see #readDevice()
* @see #getMissionTimeStamp(byte[])
* @see #getTemperatureLog(byte[])
*/
public String getFirstLogOffset(ByteArray state)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getFirstLogOffset(state.array);
}
======================================
public synchronized byte getTemperatureLog(byte[])[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public synchronized byte getTemperatureLog
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public synchronized ByteArray getTemperatureLog1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public synchronized byte[] getTemperatureLog
params=byte[]
/**
* <p>Returns the log of temperature measurements. Each <code>byte</code>
* in the returned array is an independent sample. Use the method
* <code>decodeTemperature(byte)</code> to get the double value
* of the encoded temperature. See the DS1921 datasheet for more
* on the data's encoding scheme. The array's length equals the
* number of measurements taken thus far. The temperature log can
* be read while a mission is still in progress. </p>
*
* <p>Note that although this method takes the device state as a parameter,
* this method still must communicate directly with the Thermocron
* to read the log.</p>
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the DS1921's encoded temperature log
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #decodeTemperature(byte)
* @see #readDevice()
* @see #getFirstLogOffset(byte[])
* @see #getMissionTimeStamp(byte[])
*/
public synchronized ByteArray getTemperatureLog(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperatureLog(state.array));
}
======================================
public int getTemperatureHistogram()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int getTemperatureHistogram
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int[] getTemperatureHistogram0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public int[] getTemperatureHistogram
params=
/**
* <p>Returns an array of at most 64 counter bins holding the DS1921 histogram data
* (63 bins for the DS1921L-F5X and 64 bins for the DS1921H or DS1921Z). For the
* temperature histogram, the DS1921 provides bins that each consist of a 16-bit,
* non rolling-over binary counter that is incremented each time a temperature value
* acquired during a mission falls into the range of the bin. The bin to be
* updated is determined by cutting off the two least significant bits of the
* binary temperature value. For example, on a DS1921L-F5X, bin 0 will hold the
* counter for temperatures ranging from -40 to -38.5 (Celsius) and lower. Bin 1
* is associated with the range of -38 to 36.5 and so on. The last bin, in this
* case bin 62, holds temperature values of 84 degrees and higher. Please see the
* respective DS1921H or DS1921Z datasheets for their bin arrangements. The
* temperature histogram can be read while a mission is still in progress.</p>
*
* @return the 63 temperature counters
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public int[] getTemperatureHistogram()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperatureHistogram();
}
======================================
public boolean getAlarmStatus(byte, byte[])
sMethodName=public boolean getAlarmStatus
sParams=byte, byte[]
sThrows=
tempMethodName=public boolean getAlarmStatus2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean getAlarmStatus
params=byte,byte[]
/**
* Returns <code>true</code> if the specified alarm has been
* triggered. Valid values for the <code>alarmBit</code>
* parameter are:<code><pre>
* TEMPERATURE_LOW_ALARM
* TEMPERATURE_HIGH_ALARM
* TIMER_ALARM
* </pre></code>
*
* @param alarmBit the alarm to check
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <true> if the specified alarm has been triggered
*
* @see #TEMPERATURE_LOW_ALARM
* @see #TEMPERATURE_HIGH_ALARM
* @see #TIMER_ALARM
* @see #readDevice()
* @see #getAlarmHistory(byte)
*/
public boolean getAlarmStatus(byte alarmBit, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getAlarmStatus(alarmBit, state.array);
}
======================================
public byte getAlarmHistory(byte)[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte getAlarmHistory
sParams=byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray getAlarmHistory1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public byte[] getAlarmHistory
params=byte
/**
* <p>Returns an array containing the alarm log.
* The DS1921 contains two separate alarm logs. One for the high temperature
* alarm and one for the low temperature alarm. Each log can store
* up to 12 log entries and each log entry will record up to 255
* consecutive alarm violations.</p>
*
* <p>The returned array is not altered from its representation
* on the DS1921 Thermocron. It is therefore up to the caller to
* interpret the data. The number of logs in this alarm history
* is equal to the array length divided by 4, since each entry
* is 4 bytes. The first three bytes are the number of samples into the
* mission that the alarm occurred. The fourth byte is the number of
* consecutive samples that violated the alarm. To extract the starting
* offset and number of violations from the array:</p>
* <code><pre>
* byte[] data = ds1921.getAlarmHistory(OneWireContainer21.TEMPERATURE_HIGH_ALARM);
* int start_offset;
* int violation_count;
* . . .
* for (int i=0;i < data.length/4; i++)
* {
* start_offset = (data [i * 4] & 0x0ff)
* | ((data [i * 4 + 1] << 8) & 0x0ff00)
* | ((data [i * 4 + 2] << 16) & 0x0ff0000);
* violation_count = 0x0ff & data[i*4+3];
*
* . . .
*
* // note: you may find it useful to multiply start_offset
* // by getSampleRate() in order to get the number of
* // minutes into the mission that the violation occurred
* // on. You can do the same with violation_count
* // to determine how long the violation lasted.
* }
* </pre></code>
*
* <p>Acceptable values for the <code>alarmBit</code>
* parameter are:<pre><code>
* TEMPERATURE_LOW_ALARM
* TEMPERATURE_HIGH_ALARM</code></pre>
* </p>
*
* @param alarmBit the alarm log to get
*
* @return the time/duration of the alarm (see above for the structure of the array)
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getAlarmStatus(byte,byte[])
*/
public ByteArray getAlarmHistory(byte alarmBit)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getAlarmHistory(alarmBit));
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public byte[] readDevice
params=
/**
* Retrieves the 1-Wire device sensor state. This state is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device state needs to be changed then call
* the 'writeDevice' to finalize the changes.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).writeDevice(state.array);
}
======================================
public boolean hasTemperatureAlarms()
sMethodName=public boolean hasTemperatureAlarms
sParams=
sThrows=
tempMethodName=public boolean hasTemperatureAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean hasTemperatureAlarms
params=
/**
* Checks to see if this temperature measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>TemperatureContainer</code>
* has high/low trip alarms
*
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*/
public boolean hasTemperatureAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).hasTemperatureAlarms();
}
======================================
public boolean hasSelectableTemperatureResolution()
sMethodName=public boolean hasSelectableTemperatureResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean hasSelectableTemperatureResolution
params=
/**
* Checks to see if this device has selectable temperature resolution.
*
* @return <code>true</code> if this <code>TemperatureContainer</code>
* has selectable temperature resolution
*
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public boolean hasSelectableTemperatureResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).hasSelectableTemperatureResolution();
}
======================================
public double getTemperatureResolutions()[]
sMethodName=public double getTemperatureResolutions
sParams=
sThrows=
tempMethodName=public double[] getTemperatureResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double[] getTemperatureResolutions
params=
/**
* Get an array of available temperature resolutions in Celsius.
*
* @return byte array of available temperature resolutions in Celsius with
* minimum resolution as the first element and maximum resolution
* as the last element
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #setTemperatureResolution
*/
public double[] getTemperatureResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperatureResolutions();
}
======================================
public double getTemperatureAlarmResolution()
sMethodName=public double getTemperatureAlarmResolution
sParams=
sThrows=
tempMethodName=public double getTemperatureAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getTemperatureAlarmResolution
params=
/**
* Gets the temperature alarm resolution in Celsius.
*
* @return temperature alarm resolution in Celsius for this 1-wire device
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*
*/
public double getTemperatureAlarmResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperatureAlarmResolution();
}
======================================
public double getMaxTemperature()
sMethodName=public double getMaxTemperature
sParams=
sThrows=
tempMethodName=public double getMaxTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getMaxTemperature
params=
/**
* Gets the maximum temperature in Celsius.
*
* @return maximum temperature in Celsius for this 1-wire device
*
* @see #getMinTemperature()
*/
public double getMaxTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getMaxTemperature();
}
======================================
public double getMinTemperature()
sMethodName=public double getMinTemperature
sParams=
sThrows=
tempMethodName=public double getMinTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getMinTemperature
params=
/**
* Gets the minimum temperature in Celsius.
*
* @return minimum temperature in Celsius for this 1-wire device
*
* @see #getMaxTemperature()
*/
public double getMinTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getMinTemperature();
}
======================================
public void doTemperatureConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doTemperatureConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doTemperatureConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void doTemperatureConvert
params=byte[]
/**
* Performs a temperature conversion. Use the <code>state</code>
* information to calculate the conversion time.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* In the case of the DS1921 Thermocron, this could also be due to a
* currently running mission.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void doTemperatureConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).doTemperatureConvert(state.array);
}
======================================
public double getTemperature(byte[])
sMethodName=public double getTemperature
sParams=byte[]
sThrows=
tempMethodName=public double getTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getTemperature
params=byte[]
/**
* Gets the temperature value in Celsius from the <code>state</code>
* data retrieved from the <code>readDevice()</code> method.
*
* @param state byte array with device state information
*
* @return temperature in Celsius from the last
* <code>doTemperatureConvert()</code>
*/
public double getTemperature(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperature(state.array);
}
======================================
public double getTemperatureAlarm(int, byte[])
sMethodName=public double getTemperatureAlarm
sParams=int, byte[]
sThrows=
tempMethodName=public double getTemperatureAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getTemperatureAlarm
params=int,byte[]
/**
* Gets the specified temperature alarm value in Celsius from the
* <code>state</code> data retrieved from the
* <code>readDevice()</code> method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return temperature alarm trip values in Celsius for this 1-wire device
*
* @see #hasTemperatureAlarms
* @see #setTemperatureAlarm
*/
public double getTemperatureAlarm(int alarmType, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperatureAlarm(alarmType, state.array);
}
======================================
public double getTemperatureResolution(byte[])
sMethodName=public double getTemperatureResolution
sParams=byte[]
sThrows=
tempMethodName=public double getTemperatureResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public double getTemperatureResolution
params=byte[]
/**
* Gets the current temperature resolution in Celsius from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return temperature resolution in Celsius for this 1-wire device
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public double getTemperatureResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getTemperatureResolution(state.array);
}
======================================
public void setTemperatureAlarm(int, double, byte[])
sMethodName=public void setTemperatureAlarm
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setTemperatureAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setTemperatureAlarm
params=int,double,byte[]
/**
* Sets the temperature alarm value in Celsius in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in Celsius
* @param state byte array with device state information
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
*/
public void setTemperatureAlarm(int alarmType, double alarmValue, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setTemperatureAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setTemperatureResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setTemperatureResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setTemperatureResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setTemperatureResolution
params=double,byte[]
/**
* Sets the current temperature resolution in Celsius in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution temperature resolution in Celsius
* @param state byte array with device state information
*
* @throws OneWireException if the device does not support
* selectable temperature resolution
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
*/
public void setTemperatureResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setTemperatureResolution(resolution, state.array);
}
======================================
public boolean hasClockAlarm()
sMethodName=public boolean hasClockAlarm
sParams=
sThrows=
tempMethodName=public boolean hasClockAlarm0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean hasClockAlarm
params=
/**
* Checks to see if the clock has an alarm feature.
*
* @return true if the Real-Time clock has an alarm
*
* @see #getClockAlarm(byte[])
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean hasClockAlarm()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).hasClockAlarm();
}
======================================
public boolean canDisableClock()
sMethodName=public boolean canDisableClock
sParams=
sThrows=
tempMethodName=public boolean canDisableClock0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean canDisableClock
params=
/**
* Checks to see if the clock can be disabled.
*
* @return true if the clock can be enabled and disabled
*
* @see #isClockRunning(byte[])
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean canDisableClock()
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).canDisableClock();
}
======================================
public long getClockResolution()
sMethodName=public long getClockResolution
sParams=
sThrows=
tempMethodName=public String getClockResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public long getClockResolution
params=
/**
* Gets the clock resolution in milliseconds
*
* @return the clock resolution in milliseconds
*/
public String getClockResolution()
{
return ""+((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getClockResolution();
}
======================================
public long getClock(byte[])
sMethodName=public long getClock
sParams=byte[]
sThrows=
tempMethodName=public String getClock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public long getClock
params=byte[]
/**
* Extracts the Real-Time clock value in milliseconds.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the time represented in this clock in milliseconds since 1970
*
* @see OneWireSensor#readDevice()
* @see #setClock(long,byte[])
*/
public String getClock(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getClock(a0.array);
}
======================================
public long getClockAlarm(byte[])
sMethodName=public long getClockAlarm
sParams=byte[]
sThrows=
tempMethodName=public String getClockAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public long getClockAlarm
params=byte[]
/**
* Extracts the clock alarm value for the Real-Time clock. In the case
* of the DS1921 Thermocron, this is the time that the next periodic
* alarm event will occur.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return milliseconds since 1970 that the clock alarm is set to
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public String getClockAlarm(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).getClockAlarm(a0.array);
}
======================================
public boolean isClockAlarming(byte[])
sMethodName=public boolean isClockAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean isClockAlarming
params=byte[]
/**
* Checks if the clock alarm flag has been set.
* This will occur when the value of the Real-Time
* clock equals the value of the clock alarm.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the Real-Time clock is alarming
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarming(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).isClockAlarming(a0.array);
}
======================================
public boolean isClockAlarmEnabled(byte[])
sMethodName=public boolean isClockAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean isClockAlarmEnabled
params=byte[]
/**
* Checks if the clock alarm is enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if clock alarm is enabled
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarming(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarmEnabled(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).isClockAlarmEnabled(a0.array);
}
======================================
public boolean isClockRunning(byte[])
sMethodName=public boolean isClockRunning
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockRunning1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public boolean isClockRunning
params=byte[]
/**
* Checks if the device's oscillator is enabled. The clock
* will not increment if the clock oscillator is not enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the clock is running
*
* @see OneWireSensor#readDevice()
* @see #canDisableClock()
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean isClockRunning(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).isClockRunning(a0.array);
}
======================================
public void setClock(long, byte[])
sMethodName=public void setClock
sParams=long, byte[]
sThrows=
tempMethodName=public void setClock2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setClock
params=long,byte[]
/**
* Sets the Real-Time clock.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param time new value for the Real-Time clock, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getClock(byte[])
*/
public void setClock(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setClock(Long.parseLong(a0), a1.array);
}
======================================
public void setClockAlarm(long, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarm
sParams=long, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setClockAlarm
params=long,byte[]
/**
* Sets the clock alarm.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param time - new value for the Real-Time clock alarm, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public void setClockAlarm(String a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setClockAlarm(Long.parseLong(a0), a1.array);
}
======================================
public void setClockRunEnable(boolean, byte[])
sMethodName=public void setClockRunEnable
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setClockRunEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setClockRunEnable
params=boolean,byte[]
/**
* Enables or disables the oscillator, turning the clock 'on' and 'off'.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices can disable their oscillators. Check to see if this device can
* disable its oscillator first by calling the <code>canDisableClock()</code> method.
*
* @param runEnable true to enable the clock oscillator
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #canDisableClock()
* @see #isClockRunning(byte[])
*/
public void setClockRunEnable(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setClockRunEnable(a0, a1.array);
}
======================================
public void setClockAlarmEnable(boolean, byte[])
sMethodName=public void setClockAlarmEnable
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setClockAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer21
methodName=public void setClockAlarmEnable
params=boolean,byte[]
/**
* Enables or disables the clock alarm.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param alarmEnable true to enable the clock alarm
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #isClockAlarming(byte[])
*/
public void setClockAlarmEnable(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer21)objectInstance).setClockAlarmEnable(a0, a1.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer22.java
superClassName=com.dalsemi.onewire.container.OneWireContainer
superClassName=java.lang.Object
-->OneWireContainer22 implements com.dalsemi.onewire.container.TemperatureContainer
OneWireContainer22 implements com.dalsemi.onewire.container.TemperatureContainer
-------------------------------------------------------------------
creating: owapi\OneWireContainer23.java
superClassName=java.lang.Object
-------------------------------------------------------------------
creating: owapi\OneWireContainer24.java
superClassName=java.lang.Object
-->OneWireContainer24 implements com.dalsemi.onewire.container.ClockContainer
OneWireContainer24 implements com.dalsemi.onewire.container.ClockContainer
======================================
public boolean hasClockAlarm()
sMethodName=public boolean hasClockAlarm
sParams=
sThrows=
tempMethodName=public boolean hasClockAlarm0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public boolean hasClockAlarm
params=
/**
* Query to see if the clock has an alarm feature.
*
* @return true if the Real-Time clock has an alarm
*
* @see #getClockAlarm(byte[])
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean hasClockAlarm()
{
return ((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).hasClockAlarm();
}
======================================
public boolean canDisableClock()
sMethodName=public boolean canDisableClock
sParams=
sThrows=
tempMethodName=public boolean canDisableClock0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public boolean canDisableClock
params=
/**
* Query to see if the clock can be disabled.
*
* @return true if the clock can be enabled and disabled
*
* @see #isClockRunning(byte[])
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean canDisableClock()
{
return ((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).canDisableClock();
}
======================================
public long getClockResolution()
sMethodName=public long getClockResolution
sParams=
sThrows=
tempMethodName=public String getClockResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public long getClockResolution
params=
/**
* Query to get the clock resolution in milliseconds
*
* @return the clock resolution in milliseconds
*/
public String getClockResolution()
{
return ""+((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).getClockResolution();
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public byte[] readDevice
params=
/**
* Retrieves the five byte state over the 1-Wire bus. This state array must be passed
* to the Get/Set methods as well as the WriteDevice method.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).writeDevice(state.array);
}
======================================
public long getClock(byte[])
sMethodName=public long getClock
sParams=byte[]
sThrows=
tempMethodName=public String getClock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public long getClock
params=byte[]
/**
* Extracts the Real-Time clock value in milliseconds.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the time represented in this clock in milliseconds since some reference time,
* as chosen by the user (ie. 12:00am, Jan 1st 1970)
*
* @see OneWireSensor#readDevice()
* @see #setClock(long,byte[])
*/
public String getClock(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).getClock(a0.array);
}
======================================
public long getClockAlarm(byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public long getClockAlarm
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public String getClockAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public long getClockAlarm
params=byte[]
/**
* Extracts the clock alarm value for the Real-Time clock.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return milliseconds since 1970 that the clock alarm is set to
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public String getClockAlarm(ByteArray a0)
throws com.dalsemi.onewire.OneWireException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).getClockAlarm(a0.array);
}
======================================
public boolean isClockAlarming(byte[])
sMethodName=public boolean isClockAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public boolean isClockAlarming
params=byte[]
/**
* Checks if the clock alarm flag has been set.
* This will occur when the value of the Real-Time
* clock equals the value of the clock alarm.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the Real-Time clock is alarming
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarming(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).isClockAlarming(a0.array);
}
======================================
public boolean isClockAlarmEnabled(byte[])
sMethodName=public boolean isClockAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public boolean isClockAlarmEnabled
params=byte[]
/**
* Checks if the clock alarm is enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if clock alarm is enabled
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarming(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarmEnabled(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).isClockAlarmEnabled(a0.array);
}
======================================
public boolean isClockRunning(byte[])
sMethodName=public boolean isClockRunning
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockRunning1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public boolean isClockRunning
params=byte[]
/**
* Checks if the device's oscillator is enabled. The clock
* will not increment if the clock oscillator is not enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the clock is running
*
* @see OneWireSensor#readDevice()
* @see #canDisableClock()
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean isClockRunning(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).isClockRunning(a0.array);
}
======================================
public void setClock(long, byte[])
sMethodName=public void setClock
sParams=long, byte[]
sThrows=
tempMethodName=public void setClock2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public void setClock
params=long,byte[]
/**
* Sets the Real-Time clock.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param time new value for the Real-Time clock, in milliseconds
* since some reference time (ie. 12:00am, January 1st, 1970)
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getClock(byte[])
*/
public void setClock(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).setClock(Long.parseLong(a0), a1.array);
}
======================================
public void setClockAlarm(long, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarm
sParams=long, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public void setClockAlarm
params=long,byte[]
/**
* Sets the clock alarm.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param time - new value for the Real-Time clock alarm, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public void setClockAlarm(String a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).setClockAlarm(Long.parseLong(a0), a1.array);
}
======================================
public void setClockAlarmEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarmEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public void setClockAlarmEnable
params=boolean,byte[]
/**
* Enables or disables the clock alarm.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param alarmEnable true to enable the clock alarm
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #isClockAlarming(byte[])
*/
public void setClockAlarmEnable(boolean a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).setClockAlarmEnable(a0, a1.array);
}
======================================
public void setClockRunEnable(boolean, byte[])
sMethodName=public void setClockRunEnable
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setClockRunEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer24
methodName=public void setClockRunEnable
params=boolean,byte[]
/**
* Enables or disables the oscillator, turning the clock 'on' and 'off'.
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>. Also note that
* not all clock devices can disable their oscillators. Check to see if this device can
* disable its oscillator first by calling the <code>canDisableClock()</code> method.
*
* @param runEnable true to enable the clock oscillator
* @param state current state of the device returned from <code>readDevice()</code>
*
*
* @see OneWireSensor#writeDevice(byte[])
* @see #canDisableClock()
* @see #isClockRunning(byte[])
*/
public void setClockRunEnable(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer24)objectInstance).setClockRunEnable(a0, a1.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer26.java
superClassName=java.lang.Object
-->OneWireContainer26 implements com.dalsemi.onewire.container.ADContainer,com.dalsemi.onewire.container.TemperatureContainer,com.dalsemi.onewire.container.ClockContainer,com.dalsemi.onewire.container.HumidityContainer
OneWireContainer26 implements com.dalsemi.onewire.container.ADContainer
OneWireContainer26 implements com.dalsemi.onewire.container.TemperatureContainer
OneWireContainer26 implements com.dalsemi.onewire.container.ClockContainer
OneWireContainer26 implements com.dalsemi.onewire.container.HumidityContainer
======================================
public static final int CHANNEL_VDD
======================================
public static final int CHANNEL_VAD
======================================
public static final int CHANNEL_VSENSE
======================================
public static final byte IAD_FLAG
======================================
public static final byte CA_FLAG
======================================
public static final byte EE_FLAG
======================================
public static final byte AD_FLAG
======================================
public static final byte TB_FLAG
======================================
public static final byte NVB_FLAG
======================================
public static final byte ADB_FLAG
======================================
public synchronized void setSenseResistor(double)
sMethodName=public synchronized void setSenseResistor
sParams=double
sThrows=
tempMethodName=public synchronized void setSenseResistor1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public synchronized void setSenseResistor
params=double
/**
* Set the value of the sense resistor used to determine
* battery current. This value is used in the <CODE>getCurrent()</CODE> calculation.
* See the DS2438 datasheet for more information on sensing battery
* current.
*
* @param resistance Value of the sense resistor in Ohms.
*/
public synchronized void setSenseResistor(double resistance)
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setSenseResistor(resistance);
}
======================================
public double getSenseResistor()
sMethodName=public double getSenseResistor
sParams=
sThrows=
tempMethodName=public double getSenseResistor0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getSenseResistor
params=
/**
* Get the value used for the sense resistor in the <CODE>getCurrent()</CODE>
* calculations.
*
* @return currently stored value of the sense resistor in Ohms
*/
public double getSenseResistor()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getSenseResistor();
}
======================================
public synchronized void setSpeedCheck(boolean)
sMethodName=public synchronized void setSpeedCheck
sParams=boolean
sThrows=
tempMethodName=public synchronized void setSpeedCheck1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public synchronized void setSpeedCheck
params=boolean
/**
* Directs the container to avoid the calls to doSpeed() in methods that communicate
* with the Thermocron. To ensure that all parts can talk to the 1-Wire bus
* at their desired speed, each method contains a call
* to <code>doSpeed()</code>. However, this is an expensive operation.
* If a user manages the bus speed in an
* application, call this method with <code>doSpeedCheck</code>
* as <code>false</code>. The default behavior is
* to call <code>doSpeed()</code>.
*
* @param doSpeedCheck <code>true</code> for <code>doSpeed()</code> to be called before every
* 1-Wire bus access, <code>false</code> to skip this expensive call
*
* @see OneWireContainer#doSpeed()
*/
public synchronized void setSpeedCheck(boolean doSpeedCheck)
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setSpeedCheck(doSpeedCheck);
}
======================================
public byte readPage(int)[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public byte readPage
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public ByteArray readPage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public byte[] readPage
params=int
/**
* Reads the specified 8 byte page and returns the data in an array.
*
* @param page the page number to read
*
* @return eight byte array that make up the page
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public ByteArray readPage(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).readPage(page));
}
======================================
public void writePage(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writePage
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writePage3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void writePage
params=int,byte[],int
/**
* Writes a page of memory to this device. Pages 3-6 are always
* available for user storage and page 7 is available if the CA bit is set
* to 0 (false) with <CODE>setFlag()</CODE>.
*
* @param page the page number
* @param source data to be written to page
* @param offset offset with page to begin writting
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public void writePage(int page, ByteArray source, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).writePage(page, source.array, offset);
}
======================================
public boolean getFlag(byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public boolean getFlag
sParams=byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public boolean getFlag1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean getFlag
params=byte
/**
* Checks the specified flag in the status/configuration register
* and returns its status as a boolean.
*
* @param flagToGet flag bitmask.
* Acceptable parameters: IAD_FLAG, CA_FLAG, EE_FLAG, AD_FLAG, TB_FLAG,
* NVB_FLAG, ADB_FLAG
* (may be ORed with | to check the status of more than one).
*
* @return state of flag
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public boolean getFlag(byte flagToGet)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getFlag(flagToGet);
}
======================================
public void setFlag(byte, boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void setFlag
sParams=byte, boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void setFlag2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setFlag
params=byte,boolean
/**
* Set one of the flags in the STATUS/CONFIGURATION register.
*
* @param bitmask of the flag to set
* Acceptable parameters: IAD_FLAG, CA_FLAG, EE_FLAG, AD_FLAG, TB_FLAG,
* NVB_FLAG, ADB_FLAG.
*
* @param flagValue value to set flag to
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public void setFlag(byte flagToSet, boolean flagValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setFlag(flagToSet, flagValue);
}
======================================
public double getCurrent(byte[])
sMethodName=public double getCurrent
sParams=byte[]
sThrows=
tempMethodName=public double getCurrent1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getCurrent
params=byte[]
/**
* Get the instantaneous current. The IAD flag must be true!!
* Remember to set the Sense resistor value using
* <CODE>setSenseResitor(double)</CODE>.
*
*
* @param state current state of device
* @return current value in Amperes
*/
public double getCurrent(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getCurrent(state.array);
}
======================================
public double getRemainingCapacity() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public double getRemainingCapacity
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public double getRemainingCapacity0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getRemainingCapacity
params=
/**
* Calculate the remaining capacity in mAH as outlined in the data sheet.
*
* @return battery capacity remaining in mAH
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public double getRemainingCapacity()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getRemainingCapacity();
}
======================================
public boolean isCharging(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public boolean isCharging
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public boolean isCharging1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean isCharging
params=byte[]
/**
* Determines if the battery is charging and returns a boolean.
*
*
* @param state current state of device
*
* @return true if battery is changing, false if battery is idle or discharging
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public boolean isCharging(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).isCharging(state.array);
}
======================================
public void calibrateCurrentADC() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void calibrateCurrentADC
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void calibrateCurrentADC0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void calibrateCurrentADC
params=
/**
* Calibrate the current ADC. Although the part is shipped calibrated,
* calibrations should be done whenever possible for best results.
* NOTE: You MUST force zero current through Rsens (the sensor resistor)
* while calibrating.
*
* @throws OneWireIOException Error calibrating
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public void calibrateCurrentADC()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).calibrateCurrentADC();
}
======================================
public void setThreshold(byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setThreshold
sParams=byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setThreshold1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setThreshold
params=byte
/**
* Set the minimum current measurement magnitude for which the ICA/CCA/DCA
* are incremented. This is important for applications where the current
* may get very small for long periods of time. Small currents can be
* inaccurate by a high percentage, which leads to very inaccurate
* accumulations.
*
* @param threshold minimum number of bits a current measurement must have to be accumulated,
* Only 0,2,4 and 8 are valid parameters
*
* @throws OneWireIOException Error setting the threshold
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public void setThreshold(byte thresholdValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setThreshold(thresholdValue);
}
======================================
public int getICA() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public int getICA
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public int getICA0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public int getICA
params=
/**
* Retrieves the current ICA value in mVHr.
*
* @return value in the ICA register
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public int getICA()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getICA();
}
======================================
public int getCCA() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public int getCCA
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public int getCCA0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public int getCCA
params=
/**
* Retrieves the current CCA value in mVHr. This value is accumulated over
* the lifetime of the part (until it is set to 0 or the CA flag is set
* to false) and includes only charging current (positive).
*
* @return CCA value
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public int getCCA()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getCCA();
}
======================================
public int getDCA() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public int getDCA
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public int getDCA0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public int getDCA
params=
/**
* Retrieves the value of the DCA in mVHr. This value is accumulated over
* the lifetime of the part (until explicitly set to 0 or if the CA flag
* is set to false) and includes only discharging current (negative).
*
* @return DCA value
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public int getDCA()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getDCA();
}
======================================
public void setICA(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void setICA
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void setICA1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setICA
params=int
/**
* Set the value of the ICA.
*
* @param icaValue new ICA value
*
* @throws OneWireIOException Error writing data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public void setICA(int icaValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setICA(icaValue);
}
======================================
public void setCCA(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void setCCA
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void setCCA1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setCCA
params=int
/**
* Set the value of the CCA.
*
* @param ccaValue new CCA value
*
* @throws OneWireIOException Error writing data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public void setCCA(int ccaValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setCCA(ccaValue);
}
======================================
public void setDCA(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
sMethodName=public void setDCA
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
tempMethodName=public void setDCA1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setDCA
params=int
/**
* Set the value of the DCA.
*
* @param dcaValue new DCA value
*
* @throws OneWireIOException Error writing data
* @throws OneWireException Could not find part
* @throws IllegalArgumentException Bad parameters passed
*/
public void setDCA(int dcaValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException, java.lang.IllegalArgumentException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setDCA(dcaValue);
}
======================================
public long getDisconnectTime(byte[])
sMethodName=public long getDisconnectTime
sParams=byte[]
sThrows=
tempMethodName=public String getDisconnectTime1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public long getDisconnectTime
params=byte[]
/**
* This method extracts the Clock Value in milliseconds from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return time in milliseconds that have
* occured since 1970
*/
public String getDisconnectTime(ByteArray state)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getDisconnectTime(state.array);
}
======================================
public long getEndOfChargeTime(byte[])
sMethodName=public long getEndOfChargeTime
sParams=byte[]
sThrows=
tempMethodName=public String getEndOfChargeTime1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public long getEndOfChargeTime
params=byte[]
/**
* This method extracts the Clock Value in milliseconds from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return time in milliseconds that have
* occured since 1970
*/
public String getEndOfChargeTime(ByteArray state)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getEndOfChargeTime(state.array);
}
======================================
public int getNumberADChannels()
sMethodName=public int getNumberADChannels
sParams=
sThrows=
tempMethodName=public int getNumberADChannels0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public int getNumberADChannels
params=
/**
* Query to get the number of channels supported by this A/D.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (getNumberChannels() - 1)].
*
* @return number of channels
*/
public int getNumberADChannels()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getNumberADChannels();
}
======================================
public boolean hasADAlarms()
sMethodName=public boolean hasADAlarms
sParams=
sThrows=
tempMethodName=public boolean hasADAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean hasADAlarms
params=
/**
* Query to see if this A/D measuring device has high/low
* alarms.
*
* @return true if has high/low trips
*/
public boolean hasADAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).hasADAlarms();
}
======================================
public double getADRanges(int)[]
sMethodName=public double getADRanges
sParams=int
sThrows=
tempMethodName=public double[] getADRanges1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double[] getADRanges
params=int
/**
* Query to get an array of available ranges for the specified
* A/D channel.
*
* @param channel channel in the range
* [0 to (getNumberChannels() - 1)]
*
* @return available ranges
*/
public double[] getADRanges(int channel)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADRanges(channel);
}
======================================
public double getADResolutions(int, double)[]
sMethodName=public double getADResolutions
sParams=int, double
sThrows=
tempMethodName=public double[] getADResolutions2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double[] getADResolutions
params=int,double
/**
* Query to get an array of available resolutions based
* on the specified range on the specified A/D channel.
*
* @param channel channel in the range
* [0 to (getNumberChannels() - 1)]
* @param range A/D range
*
* @return available resolutions
*/
public double[] getADResolutions(int channel, double range)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADResolutions(channel, range);
}
======================================
public boolean canADMultiChannelRead()
sMethodName=public boolean canADMultiChannelRead
sParams=
sThrows=
tempMethodName=public boolean canADMultiChannelRead0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean canADMultiChannelRead
params=
/**
* Query to see if this A/D supports doing multiple voltage
* conversions at the same time.
*
* @return true if device can do multi-channel voltage reads
*/
public boolean canADMultiChannelRead()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).canADMultiChannelRead();
}
======================================
public void doADConvert(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvert2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void doADConvert
params=int,byte[]
/**
* This method is used to perform voltage conversion on all specified
* channels. The method 'getVoltage()' can be used to read the result
* of the conversion.
*
* @param channel channel in the range
* <CODE> [0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Error writing data
* @throws OneWireException Could not find part
*/
public void doADConvert(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).doADConvert(channel, state.array);
}
======================================
public void doADConvert(boolean[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=boolean[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvertMulti2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void doADConvert
params=boolean[],byte[]
/**
* This method is used to perform voltage conversion on all specified
* channels. The method <CODE>getVoltage()</CODE> can be used to read the result
* of the conversion. This A/D must support multi-channel read
* <CODE>canMultiChannelRead()</CODE> if there are more then 1 channel is specified.
*
* @param doConvert channels
* to perform conversion on
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Error writing data
* @throws OneWireException Could not find part
*/
public void doADConvertMulti(boolean[] doConvert, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).doADConvert(doConvert, state.array);
}
======================================
public double getADVoltage(byte[])[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double[] getADVoltage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double[] getADVoltage
params=byte[]
/**
* This method is used to read the voltage values. Must
* be used after a <CODE>doADConvert()</CODE> method call. Also must
* include the last valid state from the <CODE>readDevice()</CODE> method
* and this A/D must support multi-channel read <CODE>canMultiChannelRead()</CODE>
* if there are more then 1 channel.
*
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @return voltage values for all channels
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public double[] getADVoltage(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADVoltage(state.array);
}
======================================
public double getADVoltage(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double getADVoltage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getADVoltage
params=int,byte[]
/**
* This method is used to read a channels voltage value. Must
* be used after a <CODE>doADConvert()</CODE> method call. Also must
* include the last valid state from the <CODE>readDevice()</CODE> method.
* Note, if more then one channel is to be read then it is more
* efficient to use the <CODE>getVoltage()</CODE> method that returns all
* channel values.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @return voltage value for the specified
* channel
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public double getADVoltage(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADVoltage(channel, state.array);
}
======================================
public double getADAlarm(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getADAlarm
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getADAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getADAlarm
params=int,int,byte[]
/**
* This method is used to extract the alarm voltage value of the
* specified channel from the provided state buffer. The
* state buffer is retrieved from the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @return alarm_value in volts
*
* @throws OneWireException Device does not support A/D alarms
*/
public double getADAlarm(int channel, int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADAlarm(channel, alarmType, state.array);
}
======================================
public boolean getADAlarmEnable(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getADAlarmEnable
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getADAlarmEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean getADAlarmEnable
params=int,int,byte[]
/**
* This method is used to extract the alarm enable value of the
* specified channel from the provided state buffer. The state
* buffer is retrieved from the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the state
* returned from <CODE>readDevice()</CODE>
*
* @return true if specified alarm is enabled
*
* @throws OneWireException Device does not support A/D alarms
*/
public boolean getADAlarmEnable(int channel, int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADAlarmEnable(channel, alarmType, state.array);
}
======================================
public boolean hasADAlarmed(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean hasADAlarmed
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean hasADAlarmed3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean hasADAlarmed
params=int,int,byte[]
/**
* This method is used to check the alarm event value of the
* specified channel from the provided state buffer. The
* state buffer is retrieved from the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the state
returned from <CODE>readDevice()</CODE>
*
* @return true if specified alarm occurred
*
* @throws OneWireException Device does not support A/D alarms
*/
public boolean hasADAlarmed(int channel, int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).hasADAlarmed(channel, alarmType, state.array);
}
======================================
public double getADResolution(int, byte[])
sMethodName=public double getADResolution
sParams=int, byte[]
sThrows=
tempMethodName=public double getADResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getADResolution
params=int,byte[]
/**
* This method is used to extract the conversion resolution of the
* specified channel from the provided state buffer expressed in
* volts. The state is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the state
* returned from <CODE>readDevice()</CODE>
*
* @return resolution of channel in volts
*/
public double getADResolution(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADResolution(channel, state.array);
}
======================================
public double getADRange(int, byte[])
sMethodName=public double getADRange
sParams=int, byte[]
sThrows=
tempMethodName=public double getADRange2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getADRange
params=int,byte[]
/**
* This method is used to extract the input voltage range of the
* specified channel from the provided state buffer. The state
* buffer is retrieved from the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the state
* returned from <CODE>readDevice()</CODE>
*
* @return input voltage range
*/
public double getADRange(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getADRange(channel, state.array);
}
======================================
public void setADAlarm(int, int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarm
sParams=int, int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarm4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setADAlarm
params=int,int,double,byte[]
/**
* This method is used to set the alarm voltage value of the
* specified channel in the provided state buffer. The
* state buffer is retrieved from the <CODE>readDevice()</CODE> method.
* The method <CODE>writeDevice()</CODE> must be called to finalize these
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarm alarm value (will be reduced to 8 bit resolution)
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireException Device does not support A/D alarms
*/
public void setADAlarm(int channel, int alarmType, double alarm, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setADAlarm(channel, alarmType, alarm, state.array);
}
======================================
public void setADAlarmEnable(int, int, boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarmEnable
sParams=int, int, boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarmEnable4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setADAlarmEnable
params=int,int,boolean,byte[]
/**
* This method is used to set the alarm enable value of the
* specified channel in the provided state buffer. The
* state buffer is retrieved from the <CODE>readDevice()</CODE> method.
* The method <CODE>writeDevice()</CODE> must be called to finalize these
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarmEnable alarm enable value
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireException Device does not support A/D alarms
*/
public void setADAlarmEnable(int channel, int alarmType, boolean alarmEnable, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setADAlarmEnable(channel, alarmType, alarmEnable, state.array);
}
======================================
public void setADResolution(int, double, byte[])
sMethodName=public void setADResolution
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADResolution3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setADResolution
params=int,double,byte[]
/**
* This method is used to set the conversion resolution value for the
* specified channel in the provided state buffer. The
* state buffer is retrieved from the <CODE>readDevice()</CODE> method.
* The method <CODE>writeDevice()</CODE> must be called to finalize these
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param resolution resolution to use in volts
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*/
public void setADResolution(int channel, double resolution, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setADResolution(channel, resolution, state.array);
}
======================================
public void setADRange(int, double, byte[])
sMethodName=public void setADRange
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADRange3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setADRange
params=int,double,byte[]
/**
* This method is used to set the input range for the
* specified channel in the provided state buffer. The
* state buffer is retrieved from the <CODE>readDevice()</CODE> method.
* The method <CODE>writeDevice()</CODE> must be called to finalize these
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param range maximum volt range, use
* <CODE>getRanges()</CODE> method to get available ranges
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*/
public void setADRange(int channel, double range, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setADRange(channel, range, state.array);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public byte[] readDevice
params=
/**
* This method 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 <CODE>writeDevice()</CODE> to finalize the one or more change.
*
* @return 1-Wire device's state
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void writeDevice
params=byte[]
/**
* This method write 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.
*
* @param state device's state
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find part
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).writeDevice(state.array);
}
======================================
public boolean hasTemperatureAlarms()
sMethodName=public boolean hasTemperatureAlarms
sParams=
sThrows=
tempMethodName=public boolean hasTemperatureAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean hasTemperatureAlarms
params=
/**
* Query to see if this temperature measuring device has high/low
* trip alarms.
*
* @return true if has high/low trip alarms
*/
public boolean hasTemperatureAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).hasTemperatureAlarms();
}
======================================
public boolean hasSelectableTemperatureResolution()
sMethodName=public boolean hasSelectableTemperatureResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean hasSelectableTemperatureResolution
params=
/**
* Query to see if this device has selectable resolution.
*
* @return true if device has selectable resolution
*/
public boolean hasSelectableTemperatureResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).hasSelectableTemperatureResolution();
}
======================================
public double getTemperatureResolutions()[]
sMethodName=public double getTemperatureResolutions
sParams=
sThrows=
tempMethodName=public double[] getTemperatureResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double[] getTemperatureResolutions
params=
/**
* Query to get an array of available resolutions in degrees C.
*
* @return available resolutions in degrees C
*/
public double[] getTemperatureResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getTemperatureResolutions();
}
======================================
public double getTemperatureAlarmResolution() throws com.dalsemi.onewire.OneWireException
sMethodName=public double getTemperatureAlarmResolution
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getTemperatureAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getTemperatureAlarmResolution
params=
/**
* Query to get the high/low resolution in degrees C.
*
* @return high/low resolution resolution in degrees C
*
* @throws OneWireException Device does not have temperature alarms
*/
public double getTemperatureAlarmResolution()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getTemperatureAlarmResolution();
}
======================================
public double getMaxTemperature()
sMethodName=public double getMaxTemperature
sParams=
sThrows=
tempMethodName=public double getMaxTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getMaxTemperature
params=
/**
* Query to get the maximum temperature in degrees C.
*
* @return maximum temperature in degrees C
*/
public double getMaxTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getMaxTemperature();
}
======================================
public double getMinTemperature()
sMethodName=public double getMinTemperature
sParams=
sThrows=
tempMethodName=public double getMinTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getMinTemperature
params=
/**
* Query to get the minimum temperature in degrees C.
*
* @return minimum temperature in degrees C
*/
public double getMinTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getMinTemperature();
}
======================================
public void doTemperatureConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doTemperatureConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doTemperatureConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void doTemperatureConvert
params=byte[]
/**
* Perform an temperature conversion. Use this state information
* to calculate the conversion time.
*
* @param state device state
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find part
*/
public void doTemperatureConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).doTemperatureConvert(state.array);
}
======================================
public double getTemperature(byte[])
sMethodName=public double getTemperature
sParams=byte[]
sThrows=
tempMethodName=public double getTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getTemperature
params=byte[]
/**
* This method extracts the Temperature Value in degrees C from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return temperature in degrees C from the last <CODE>doTemperature()</CODE>
*/
public double getTemperature(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getTemperature(state.array);
}
======================================
public double getTemperatureAlarm(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getTemperatureAlarm
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getTemperatureAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getTemperatureAlarm
params=int,byte[]
/**
* This method extracts the specified Alarm value in degrees C from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param alarmType alarm trip type <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state device state
*
* @return alarm trip temperature in degrees C
*
* @throws OneWireException Device does not have temperature alarms
*/
public double getTemperatureAlarm(int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getTemperatureAlarm(alarmType, state.array);
}
======================================
public double getTemperatureResolution(byte[])
sMethodName=public double getTemperatureResolution
sParams=byte[]
sThrows=
tempMethodName=public double getTemperatureResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getTemperatureResolution
params=byte[]
/**
* This method extracts the current resolution in degrees C from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return temperature resolution in degrees C
*/
public double getTemperatureResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getTemperatureResolution(state.array);
}
======================================
public void setTemperatureAlarm(int, double, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setTemperatureAlarm
sParams=int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setTemperatureAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setTemperatureAlarm
params=int,double,byte[]
/**
* This method sets the alarm value in degrees C in the
* provided state data. Use the method <CODE>writeDevice()</CODE> with
* this data to finalize the change to the device.
*
* @param alarmType alarm type <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarmValue trip value in degrees C
* @param state device state
*
* @throws OneWireException Device does not have temperature alarms
*/
public void setTemperatureAlarm(int alarmType, double alarmValue, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setTemperatureAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setTemperatureResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setTemperatureResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setTemperatureResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setTemperatureResolution
params=double,byte[]
/**
* This method sets the current resolution in degrees C in the
* provided state data. Use the method <CODE>writeDevice()</CODE> with
* this data to finalize the change to the device.
*
* @param resolution temperature resolution in degrees C
* @param state device state
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find part
*/
public void setTemperatureResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setTemperatureResolution(resolution, state.array);
}
======================================
public boolean hasClockAlarm()
sMethodName=public boolean hasClockAlarm
sParams=
sThrows=
tempMethodName=public boolean hasClockAlarm0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean hasClockAlarm
params=
/**
* Query to see if the clock has an alarm feature.
*
* @return true if real-time-clock has an alarm
*/
public boolean hasClockAlarm()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).hasClockAlarm();
}
======================================
public boolean canDisableClock()
sMethodName=public boolean canDisableClock
sParams=
sThrows=
tempMethodName=public boolean canDisableClock0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean canDisableClock
params=
/**
* Query to see if the clock can be disabled. See
* the methods <CODE>isClockRunning()</CODE> and <CODE>setClockRunEnable()</CODE>.
*
* @return true if the clock can be enabled and
* disabled
*/
public boolean canDisableClock()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).canDisableClock();
}
======================================
public long getClockResolution()
sMethodName=public long getClockResolution
sParams=
sThrows=
tempMethodName=public String getClockResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public long getClockResolution
params=
/**
* Query to get the clock resolution in milliseconds
*
* @return clock resolution in milliseconds.
*/
public String getClockResolution()
{
return ""+((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getClockResolution();
}
======================================
public long getClock(byte[])
sMethodName=public long getClock
sParams=byte[]
sThrows=
tempMethodName=public String getClock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public long getClock
params=byte[]
/**
* This method extracts the Clock Value in milliseconds from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return time in milliseconds that have
* occured since 1970
*/
public String getClock(ByteArray state)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getClock(state.array);
}
======================================
public long getClockAlarm(byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public long getClockAlarm
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public String getClockAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public long getClockAlarm
params=byte[]
/**
* This method extracts the Clock Alarm Value from the provided
* state data retrieved from the <CODE>readDevice()</CODE>
* method.
*
* @param state device state
*
* @return time in milliseconds that have
* the clock alarm is set to
*
* @throws OneWireException Device does not have clock alarm
*/
public String getClockAlarm(ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getClockAlarm(state.array);
}
======================================
public boolean isClockAlarming(byte[])
sMethodName=public boolean isClockAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean isClockAlarming
params=byte[]
/**
* This method checks if the Clock Alarm flag has been set
* from the state data retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return true if clock is alarming
*/
public boolean isClockAlarming(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).isClockAlarming(state.array);
}
======================================
public boolean isClockAlarmEnabled(byte[])
sMethodName=public boolean isClockAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean isClockAlarmEnabled
params=byte[]
/**
* This method checks if the Clock Alarm is enabled
* from the provided state data retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return true if clock alarm is enabled
*/
public boolean isClockAlarmEnabled(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).isClockAlarmEnabled(state.array);
}
======================================
public boolean isClockRunning(byte[])
sMethodName=public boolean isClockRunning
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockRunning1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean isClockRunning
params=byte[]
/**
* This method checks if the device's oscilator is enabled. The clock
* will not increment if the clock is not enabled.
* This value is read from the provided state data retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return true if clock is running
*/
public boolean isClockRunning(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).isClockRunning(state.array);
}
======================================
public void setClock(long, byte[])
sMethodName=public void setClock
sParams=long, byte[]
sThrows=
tempMethodName=public void setClock2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setClock
params=long,byte[]
/**
* This method sets the Clock time in the provided state data
* Use the method <CODE>writeDevice()</CODE> with
* this data to finalize the change to the device.
*
* @param time new clock setting in milliseconds
* @param state device state
*/
public void setClock(String time, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setClock(Long.parseLong(time), state.array);
}
======================================
public void setClockAlarm(long, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarm
sParams=long, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setClockAlarm
params=long,byte[]
/**
* This method sets the Clock Alarm in the provided state
* data. Use the method <CODE>writeDevice()</CODE> with
* this data to finalize the change to the device.
*
* @param time new clock setting in mlliseconds
* @param state device state
*
* @throws OneWireException Device does not support clock alarm
*/
public void setClockAlarm(String time, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setClockAlarm(Long.parseLong(time), state.array);
}
======================================
public void setClockRunEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockRunEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockRunEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setClockRunEnable
params=boolean,byte[]
/**
* This method sets the oscillator enable to the specified
* value. Use the method <CODE>writeDevice()</CODE> with this
* data to finalize the change to the device.
*
* @param runEnable true to enable clock oscillator
* @param state device state
*
* @throws OneWireException Device does not support disabled clock
*/
public void setClockRunEnable(boolean runEnable, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setClockRunEnable(runEnable, state.array);
}
======================================
public void setClockAlarmEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarmEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setClockAlarmEnable
params=boolean,byte[]
/**
* This method sets the Clock Alarm enable. Use the method
* <CODE>writeDevice()</CODE> with this data to finalize the
* change to the device.
*
* @param alarmEnable - true to enable clock alarm
* @param state device state
*
* @throws OneWireException Device does not support clock alarm
*/
public void setClockAlarmEnable(boolean alarmEnable, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setClockAlarmEnable(alarmEnable, state.array);
}
======================================
public boolean isRelative()
sMethodName=public boolean isRelative
sParams=
sThrows=
tempMethodName=public boolean isRelative0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean isRelative
params=
/**
* Checks to see if humidity value given is a 'relative' humidity value.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* provides a relative humidity reading
*
* @see #getHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public boolean isRelative()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).isRelative();
}
======================================
public boolean hasHumidityAlarms()
sMethodName=public boolean hasHumidityAlarms
sParams=
sThrows=
tempMethodName=public boolean hasHumidityAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean hasHumidityAlarms
params=
/**
* Checks to see if this Humidity measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* has high/low trip alarms
*
* @see #getHumidityAlarm
* @see #setHumidityAlarm
*/
public boolean hasHumidityAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).hasHumidityAlarms();
}
======================================
public boolean hasSelectableHumidityResolution()
sMethodName=public boolean hasSelectableHumidityResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableHumidityResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public boolean hasSelectableHumidityResolution
params=
/**
* Checks to see if this device has selectable Humidity resolution.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* has selectable Humidity resolution
*
* @see #getHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public boolean hasSelectableHumidityResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).hasSelectableHumidityResolution();
}
======================================
public double getHumidityResolutions()[]
sMethodName=public double getHumidityResolutions
sParams=
sThrows=
tempMethodName=public double[] getHumidityResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double[] getHumidityResolutions
params=
/**
* Get an array of available Humidity resolutions in percent humidity (0 to 100).
*
* @return byte array of available Humidity resolutions in percent with
* minimum resolution as the first element and maximum resolution
* as the last element.
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #setHumidityResolution
*/
public double[] getHumidityResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getHumidityResolutions();
}
======================================
public double getHumidityAlarmResolution() throws com.dalsemi.onewire.OneWireException
sMethodName=public double getHumidityAlarmResolution
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getHumidityAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getHumidityAlarmResolution
params=
/**
* Gets the Humidity alarm resolution in percent.
*
* @return Humidity alarm resolution in percent for this 1-wire device
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #getHumidityAlarm
* @see #setHumidityAlarm
*
*/
public double getHumidityAlarmResolution()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getHumidityAlarmResolution();
}
======================================
public void doHumidityConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doHumidityConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doHumidityConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void doHumidityConvert
params=byte[]
/**
* Performs a Humidity conversion.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void doHumidityConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).doHumidityConvert(state.array);
}
======================================
public double getHumidity(byte[])
sMethodName=public double getHumidity
sParams=byte[]
sThrows=
tempMethodName=public double getHumidity1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getHumidity
params=byte[]
/**
* Gets the humidity expressed as a percent value (0.0 to 100.0) of humidity.
*
* @param state byte array with device state information
* @return humidity expressed as a percent
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #setHumidityResolution
*/
public double getHumidity(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getHumidity(state.array);
}
======================================
public double getHumidityResolution(byte[])
sMethodName=public double getHumidityResolution
sParams=byte[]
sThrows=
tempMethodName=public double getHumidityResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getHumidityResolution
params=byte[]
/**
* Gets the current Humidity resolution in percent from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return Humidity resolution in percent for this 1-wire device
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public double getHumidityResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getHumidityResolution(state.array);
}
======================================
public double getHumidityAlarm(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getHumidityAlarm
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getHumidityAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public double getHumidityAlarm
params=int,byte[]
/**
* Gets the specified Humidity alarm value in percent from the
* <code>state</code> data retrieved from the
* <code>readDevice()</code> method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return Humidity alarm trip values in percent for this 1-wire device
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #setHumidityAlarm
*/
public double getHumidityAlarm(int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).getHumidityAlarm(alarmType, state.array);
}
======================================
public void setHumidityAlarm(int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setHumidityAlarm
sParams=int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setHumidityAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setHumidityAlarm
params=int,double,byte[]
/**
* Sets the Humidity alarm value in percent in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in percent
* @param state byte array with device state information
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #getHumidityAlarm
*/
public void setHumidityAlarm(int alarmType, double alarmValue, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setHumidityAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setHumidityResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setHumidityResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setHumidityResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer26
methodName=public void setHumidityResolution
params=double,byte[]
/**
* Sets the current Humidity resolution in percent in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution Humidity resolution in percent
* @param state byte array with device state information
*
* @throws OneWireException Device does not support selectable
* Humidity resolution
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #getHumidityResolutions
*/
public void setHumidityResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer26)objectInstance).setHumidityResolution(resolution, state.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer27.java
superClassName=com.dalsemi.onewire.container.OneWireContainer
superClassName=java.lang.Object
-->OneWireContainer27 implements com.dalsemi.onewire.container.ClockContainer
OneWireContainer27 implements com.dalsemi.onewire.container.ClockContainer
======================================
public static final byte INTERRUPT_INTERVAL_1
======================================
public static final byte INTERRUPT_INTERVAL_4
======================================
public static final byte INTERRUPT_INTERVAL_32
======================================
public static final byte INTERRUPT_INTERVAL_64
======================================
public static final byte INTERRUPT_INTERVAL_2048
======================================
public static final byte INTERRUPT_INTERVAL_4096
======================================
public static final byte INTERRUPT_INTERVAL_65536
======================================
public static final byte INTERRUPT_INTERVAL_131072
======================================
public long getInterruptInterval(byte[])
sMethodName=public long getInterruptInterval
sParams=byte[]
sThrows=
tempMethodName=public String getInterruptInterval1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer27
methodName=public long getInterruptInterval
params=byte[]
/**
* Returns the interval, in seconds, that the device will interrupt on.
*
* @param state current state of the device returned from <code>readDevice()</code>
* @return number of seconds in between interrupts.
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getClock(byte[])
*/
public String getInterruptInterval(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer27)objectInstance).getInterruptInterval(a0.array);
}
======================================
public boolean isInterruptEnabled(byte[])
sMethodName=public boolean isInterruptEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isInterruptEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer27
methodName=public boolean isInterruptEnabled
params=byte[]
/**
*
* Checks to see if interrupt mode is turned on. If so, pulses will be generated
* at an interval selected by setInterruptInterval.
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if interrupts are enabled
*
* @see OneWireSensor#readDevice()
* @see #canDisableClock()
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean isInterruptEnabled(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer27)objectInstance).isInterruptEnabled(a0.array);
}
======================================
public void setInterruptInterval(byte, byte[])
sMethodName=public void setInterruptInterval
sParams=byte, byte[]
sThrows=
tempMethodName=public void setInterruptInterval2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer27
methodName=public void setInterruptInterval
params=byte,byte[]
/**
* Sets the interval at which interrupting will occur. Note that this feature
* must be enabled first using setInterruptEnable(true,state).
*
* The method <code>writeDevice(byte[])</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice(byte[])</code>.
*
* @param intervalValue One of the following variables should be passed, representing
* different time intervals to interrupt at:
* <code>INTERRUPT_INTERVAL_1</code> 1 second
* <code>INTERRUPT_INTERVAL_4</code> 4 seconds
* <code>INTERRUPT_INTERVAL_32</code> 32 seconds
* <code>INTERRUPT_INTERVAL_32</code> 64 seconds
* <code>INTERRUPT_INTERVAL_64</code> 2048 seconds
* <code>INTERRUPT_INTERVAL_2048</code> 4096 seconds
* <code>INTERRUPT_INTERVAL_4096</code> 65536 seconds
* <code>INTERRUPT_INTERVAL_131072</code> 131072 seconds
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getClock(byte[])
*/
public void setInterruptInterval(byte a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer27)objectInstance).setInterruptInterval(a0, a1.array);
}
======================================
public void setInterruptEnable(boolean, byte[])
sMethodName=public void setInterruptEnable
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setInterruptEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer27
methodName=public void setInterruptEnable
params=boolean,byte[]
/**
* Enables or disables hardware interrupting. If enabled, the
* device sends an interrupt at intervals defined by using the
* setInterruptInterval function.
* @param runEnable true to enable interval interrupts.
* @param state current state of the device returned from <code>readDevice()</code>
*
*
* @see OneWireSensor#writeDevice(byte[])
* @see #canDisableClock()
* @see #isClockRunning(byte[])
*/
public void setInterruptEnable(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer27)objectInstance).setInterruptEnable(a0, a1.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer28.java
superClassName=java.lang.Object
-->OneWireContainer28 implements com.dalsemi.onewire.container.TemperatureContainer
OneWireContainer28 implements com.dalsemi.onewire.container.TemperatureContainer
======================================
public static final byte WRITE_SCRATCHPAD_COMMAND
======================================
public static final byte READ_SCRATCHPAD_COMMAND
======================================
public static final byte COPY_SCRATCHPAD_COMMAND
======================================
public static final byte CONVERT_TEMPERATURE_COMMAND
======================================
public static final byte RECALL_E2MEMORY_COMMAND
======================================
public static final byte READ_POWER_SUPPLY_COMMAND
======================================
public static final byte RESOLUTION_12_BIT
======================================
public static final byte RESOLUTION_11_BIT
======================================
public static final byte RESOLUTION_10_BIT
======================================
public static final byte RESOLUTION_9_BIT
======================================
public boolean hasTemperatureAlarms()
sMethodName=public boolean hasTemperatureAlarms
sParams=
sThrows=
tempMethodName=public boolean hasTemperatureAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public boolean hasTemperatureAlarms
params=
/**
* Checks to see if this temperature measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>OneWireContainer28</code>
* has high/low trip alarms
*
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*/
public boolean hasTemperatureAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).hasTemperatureAlarms();
}
======================================
public boolean hasSelectableTemperatureResolution()
sMethodName=public boolean hasSelectableTemperatureResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public boolean hasSelectableTemperatureResolution
params=
/**
* Checks to see if this device has selectable temperature resolution.
*
* @return <code>true</code> if this <code>OneWireContainer28</code>
* has selectable temperature resolution
*
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public boolean hasSelectableTemperatureResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).hasSelectableTemperatureResolution();
}
======================================
public double getTemperatureResolutions()[]
sMethodName=public double getTemperatureResolutions
sParams=
sThrows=
tempMethodName=public double[] getTemperatureResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public double[] getTemperatureResolutions
params=
/**
* Gets an array of available temperature resolutions in Celsius.
*
* @return byte array of available temperature resolutions in Celsius for
* this <code>OneWireContainer28</code>. The minimum resolution is
* returned as the first element and maximum resolution as the last
* element.
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #setTemperatureResolution
*/
public double[] getTemperatureResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).getTemperatureResolutions();
}
======================================
public double getTemperatureAlarmResolution()
sMethodName=public double getTemperatureAlarmResolution
sParams=
sThrows=
tempMethodName=public double getTemperatureAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public double getTemperatureAlarmResolution
params=
/**
* Gets the temperature alarm resolution in Celsius.
*
* @return temperature alarm resolution in Celsius for this
* <code>OneWireContainer28</code>
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*
*/
public double getTemperatureAlarmResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).getTemperatureAlarmResolution();
}
======================================
public double getMaxTemperature()
sMethodName=public double getMaxTemperature
sParams=
sThrows=
tempMethodName=public double getMaxTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public double getMaxTemperature
params=
/**
* Gets the maximum temperature in Celsius.
*
* @return maximum temperature in Celsius for this
* <code>OneWireContainer28</code>
*
* @see #getMinTemperature
*/
public double getMaxTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).getMaxTemperature();
}
======================================
public double getMinTemperature()
sMethodName=public double getMinTemperature
sParams=
sThrows=
tempMethodName=public double getMinTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public double getMinTemperature
params=
/**
* Gets the minimum temperature in Celsius.
*
* @return minimum temperature in Celsius for this
* <code>OneWireContainer28</code>
*
* @see #getMaxTemperature
*/
public double getMinTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).getMinTemperature();
}
======================================
public void doTemperatureConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doTemperatureConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doTemperatureConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public void doTemperatureConvert
params=byte[]
/**
* Performs a temperature conversion on <code>state</code> information.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getTemperature
*/
public void doTemperatureConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).doTemperatureConvert(state.array);
}
======================================
public double getTemperature(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getTemperature
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public double getTemperature
params=byte[]
/**
* Gets the temperature value in Celsius from the <code>state</code>
* data retrieved from the <code>readDevice()</code> method.
*
* @param state byte array with device state information for this
* <code>OneWireContainer28</code>
*
* @return temperature in Celsius from the last
* <code>doTemperatureConvert()</code>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
*
* @see #doTemperatureConvert
*/
public double getTemperature(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).getTemperature(state.array);
}
======================================
public double getTemperatureAlarm(int, byte[])
sMethodName=public double getTemperatureAlarm
sParams=int, byte[]
sThrows=
tempMethodName=public double getTemperatureAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public double getTemperatureAlarm
params=int,byte[]
/**
* Gets the specified temperature alarm value in Celsius from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return temperature alarm trip values in Celsius for this
* <code>OneWireContainer28</code>
*
* @see #hasTemperatureAlarms
* @see #setTemperatureAlarm
*/
public double getTemperatureAlarm(int alarmType, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).getTemperatureAlarm(alarmType, state.array);
}
======================================
public double getTemperatureResolution(byte[])
sMethodName=public double getTemperatureResolution
sParams=byte[]
sThrows=
tempMethodName=public double getTemperatureResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public double getTemperatureResolution
params=byte[]
/**
* Gets the current temperature resolution in Celsius from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return temperature resolution in Celsius for this
* <code>OneWireContainer28</code>
*
* @see #RESOLUTION_9_BIT
* @see #RESOLUTION_10_BIT
* @see #RESOLUTION_11_BIT
* @see #RESOLUTION_12_BIT
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public double getTemperatureResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).getTemperatureResolution(state.array);
}
======================================
public void setTemperatureAlarm(int, double, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setTemperatureAlarm
sParams=int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setTemperatureAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public void setTemperatureAlarm
params=int,double,byte[]
/**
* Sets the temperature alarm value in Celsius in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in Celsius
* @param state byte array with device state information
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
*/
public void setTemperatureAlarm(int alarmType, double alarmValue, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).setTemperatureAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setTemperatureResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setTemperatureResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setTemperatureResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public void setTemperatureResolution
params=double,byte[]
/**
* Sets the current temperature resolution in Celsius in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution temperature resolution in Celsius. Valid values are
* <code>RESOLUTION_9_BIT</code>,
* <code>RESOLUTION_10_BIT</code>,
* <code>RESOLUTION_11_BIT</code> and
* <code>RESOLUTION_12_BIT</code>.
* @param state byte array with device state information
*
* @see #RESOLUTION_9_BIT
* @see #RESOLUTION_10_BIT
* @see #RESOLUTION_11_BIT
* @see #RESOLUTION_12_BIT
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
*/
public void setTemperatureResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).setTemperatureResolution(resolution, state.array);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public byte[] readDevice
params=
/**
* Retrieves this <code>OneWireContainer28</code> state information.
* The state information is returned as a byte array. Pass this byte
* array to the '<code>get</code>' and '<code>set</code>' methods.
* If the device state needs to be changed, then call the
* <code>writeDevice()</code> to finalize the changes.
*
* @return <code>OneWireContainer28</code> state information.
* Device state looks like this:
* <pre>
* 0 : temperature LSB
* 1 : temperature MSB
* 2 : trip high
* 3 : trip low
* 4 : configuration register (for resolution)
* 5 : reserved
* 6 : reserved
* 7 : reserved
* 8 : an 8 bit CRC of the previous 8 bytes
* </pre>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #writeDevice
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public void writeDevice
params=byte[]
/**
* Writes to this <code>OneWireContainer28</code> <code>state</code>
* information that have been changed by '<code>set</code>' methods.
* Only the state registers that changed are updated. This is done
* by referencing a field information appended to the state data.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #readDevice
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).writeDevice(state.array);
}
======================================
public byte readScratchpad()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readScratchpad
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readScratchpad0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public byte[] readScratchpad
params=
/**
* Reads the Scratchpad of the DS18B20.
*
* @return 9-byte buffer representing the scratchpad
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readScratchpad()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).readScratchpad());
}
======================================
public void writeScratchpad(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeScratchpad
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeScratchpad1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public void writeScratchpad
params=byte[]
/**
* Writes to the Scratchpad of the DS18B20.
*
* @param data data to be written to the scratchpad. First
* byte of data must be the temperature High Trip Point, the
* second byte must be the temperature Low Trip Point, and
* the third must be the Resolution (configuration register).
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
* @throws IllegalArgumentException when data is of invalid length
*/
public void writeScratchpad(ByteArray data)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).writeScratchpad(data.array);
}
======================================
public void copyScratchpad() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void copyScratchpad
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void copyScratchpad0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public void copyScratchpad
params=
/**
* Copies the Scratchpad to the E-squared memory of the DS18B20.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void copyScratchpad()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).copyScratchpad();
}
======================================
public byte recallE2()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte recallE2
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray recallE20
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public byte[] recallE2
params=
/**
* Recalls the DS18B20 temperature trigger values (<code>ALARM_HIGH</code>
* and <code>ALARM_LOW</code>) and the configuration register to the
* scratchpad and reads the scratchpad.
*
* @return byte array representing data in the device's scratchpad.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray recallE2()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).recallE2());
}
======================================
public boolean isExternalPowerSupplied() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isExternalPowerSupplied
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isExternalPowerSupplied0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public boolean isExternalPowerSupplied
params=
/**
* Reads the way power is supplied to the DS18B20.
*
* @return <code>true</code> for external power, <BR>
* <code>false</code> for parasite power
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from this <code>OneWireContainer28</code>.
* This could be caused by a physical interruption in the 1-Wire
* Network due to shorts or a newly arriving 1-Wire device issuing a
* 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean isExternalPowerSupplied()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).isExternalPowerSupplied();
}
======================================
public float convertToFahrenheit(float)
sMethodName=public float convertToFahrenheit
sParams=float
sThrows=
tempMethodName=public float convertToFahrenheit1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer28
methodName=public float convertToFahrenheit
params=float
/**
* Converts a temperature reading from Celsius to Fahrenheit.
*
* @param celsiusTemperature temperature value in Celsius
*
* @return the Fahrenheit conversion of the supplied temperature
*
* @deprecated Replace with call to toFahrenheit()
*
* @see Convert#toFahrenheit(double)
*/
public float convertToFahrenheit(float a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer28)objectInstance).convertToFahrenheit(a0);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer29.java
superClassName=java.lang.Object
-->OneWireContainer29 implements com.dalsemi.onewire.container.SwitchContainer
OneWireContainer29 implements com.dalsemi.onewire.container.SwitchContainer
======================================
public static final byte RESET_ACTIVITY_LATCHES
======================================
public int getNumberChannels(byte[])
sMethodName=public int getNumberChannels
sParams=byte[]
sThrows=
tempMethodName=public int getNumberChannels1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public int getNumberChannels
params=byte[]
/**
* Gets the number of channels supported by this switch.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberChannels(byte[])</code> - 1)]. Note that
* all devices of the same family will not necessarily have the
* same number of channels.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the number of channels for this device
*
* @see OneWireSensor#readDevice()
*/
public int getNumberChannels(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).getNumberChannels(a0.array);
}
======================================
public boolean isHighSideSwitch()
sMethodName=public boolean isHighSideSwitch
sParams=
sThrows=
tempMethodName=public boolean isHighSideSwitch0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean isHighSideSwitch
params=
/**
* Checks if the channels of this switch are 'high side'
* switches. This indicates that when 'on' or <code>true</code>, the switch output is
* connect to the 1-Wire data. If this method returns <code>false</code>
* then when the switch is 'on' or <code>true</code>, the switch is connected
* to ground.
*
* @return <code>true</code> if the switch is a 'high side' switch,
* <code>false</code> if the switch is a 'low side' switch
*
* @see #getLatchState(int,byte[])
*/
public boolean isHighSideSwitch()
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).isHighSideSwitch();
}
======================================
public boolean hasActivitySensing()
sMethodName=public boolean hasActivitySensing
sParams=
sThrows=
tempMethodName=public boolean hasActivitySensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean hasActivitySensing
params=
/**
* Checks if the channels of this switch support
* activity sensing. If this method returns <code>true</code> then the
* method <code>getSensedActivity(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support activity sensing
*
* @see #getSensedActivity(int,byte[])
* @see #clearActivity()
*/
public boolean hasActivitySensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).hasActivitySensing();
}
======================================
public boolean hasLevelSensing()
sMethodName=public boolean hasLevelSensing
sParams=
sThrows=
tempMethodName=public boolean hasLevelSensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean hasLevelSensing
params=
/**
* Checks if the channels of this switch support
* level sensing. If this method returns <code>true</code> then the
* method <code>getLevel(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support level sensing
*
* @see #getLevel(int,byte[])
*/
public boolean hasLevelSensing()
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).hasLevelSensing();
}
======================================
public boolean hasSmartOn()
sMethodName=public boolean hasSmartOn
sParams=
sThrows=
tempMethodName=public boolean hasSmartOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean hasSmartOn
params=
/**
* Checks if the channels of this switch support
* 'smart on'. Smart on is the ability to turn on a channel
* such that only 1-Wire device on this channel are awake
* and ready to do an operation. This greatly reduces
* the time to discover the device down a branch.
* If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* can be used with the <code>doSmart</code> parameter <code>true</code>.
*
* @return <code>true</code> if channels support 'smart on'
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean hasSmartOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).hasSmartOn();
}
======================================
public boolean onlySingleChannelOn()
sMethodName=public boolean onlySingleChannelOn
sParams=
sThrows=
tempMethodName=public boolean onlySingleChannelOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean onlySingleChannelOn
params=
/**
* Checks if the channels of this switch require that only one
* channel is on at any one time. If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* will not only affect the state of the given
* channel but may affect the state of the other channels as well
* to insure that only one channel is on at a time.
*
* @return <code>true</code> if only one channel can be on at a time.
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean onlySingleChannelOn()
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).onlySingleChannelOn();
}
======================================
public boolean getLevel(int, byte[])
sMethodName=public boolean getLevel
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLevel2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean getLevel
params=int,byte[]
/**
* Checks the sensed level on the indicated channel.
* To avoid an exception, verify that this switch
* has level sensing with the <code>hasLevelSensing()</code>.
* Level sensing means that the device can sense the logic
* level on its PIO pin.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if level sensed is 'high' and <code>false</code> if level sensed is 'low'
*
* @see OneWireSensor#readDevice()
* @see #hasLevelSensing()
*/
public boolean getLevel(int a0, ByteArray a1)
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).getLevel(a0, a1.array);
}
======================================
public boolean getLatchState(int, byte[])
sMethodName=public boolean getLatchState
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLatchState2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean getLatchState
params=int,byte[]
/**
* Checks the latch state of the indicated channel.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if channel latch is 'on'
* or conducting and <code>false</code> if channel latch is 'off' and not
* conducting. Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
*
* @see OneWireSensor#readDevice()
* @see #isHighSideSwitch()
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean getLatchState(int a0, ByteArray a1)
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).getLatchState(a0, a1.array);
}
======================================
public boolean getSensedActivity(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getSensedActivity
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getSensedActivity2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean getSensedActivity
params=int,byte[]
/**
* Checks if the indicated channel has experienced activity.
* This occurs when the level on the PIO pins changes. To clear
* the activity that is reported, call <code>clearActivity()</code>.
* To avoid an exception, verify that this device supports activity
* sensing by calling the method <code>hasActivitySensing()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if activity was detected and <code>false</code> if no activity was detected
*
* @throws OneWireException if this device does not have activity sensing
*
* @see #hasActivitySensing()
* @see #clearActivity()
*/
public boolean getSensedActivity(int channel, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).getSensedActivity(channel, state.array);
}
======================================
public void clearActivity() throws com.dalsemi.onewire.OneWireException
sMethodName=public void clearActivity
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void clearActivity0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void clearActivity
params=
/**
* Clears the activity latches the next time possible. For
* example, on a DS2406/07, this happens the next time the
* status is read with <code>readDevice()</code>.
*
* @throws OneWireException if this device does not support activity sensing
*
* @see OneWireSensor#readDevice()
* @see #getSensedActivity(int,byte[])
*/
public void clearActivity()
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).clearActivity();
}
======================================
public void setLatchState(int, boolean, boolean, byte[])
sMethodName=public void setLatchState
sParams=int, boolean, boolean, byte[]
sThrows=
tempMethodName=public void setLatchState4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void setLatchState
params=int,boolean,boolean,byte[]
/**
* Sets the latch state of the indicated channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param latchState <code>true</code> to set the channel latch 'on'
* (conducting) and <code>false</code> to set the channel latch 'off' (not
* conducting). Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
* @param doSmart If latchState is 'on'/<code>true</code> then doSmart indicates
* if a 'smart on' is to be done. To avoid an exception
* check the capabilities of this device using the
* <code>hasSmartOn()</code> method.
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #hasSmartOn()
* @see #getLatchState(int,byte[])
* @see OneWireSensor#writeDevice(byte[])
*/
public void setLatchState(int a0, boolean a1, boolean a2, ByteArray a3)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).setLatchState(a0, a1, a2, a3.array);
}
======================================
public void setLatchState(byte, byte[])
sMethodName=public void setLatchState
sParams=byte, byte[]
sThrows=
tempMethodName=public void setLatchState2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void setLatchState
params=byte,byte[]
/**
* Sets the latch state for all of the channels.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param set the state to set all of the channels, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #getLatchState(int,byte[])
* @see OneWireSensor#writeDevice(byte[])
*/
public void setLatchState(byte a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).setLatchState(a0, a1.array);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public byte[] readDevice
params=
/**
* Retrieves the 1-Wire device sensor state. This state is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device state needs to be changed then call
* the 'writeDevice' to finalize the changes.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).readDevice());
}
======================================
public byte readRegister()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readRegister
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readRegister0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public byte[] readRegister
params=
/**
* Retrieves the 1-Wire device register mask. This register is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device register mask needs to be changed then call
* the 'writeRegister' to finalize the changes.
*
* @return 1-Wire device register mask
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readRegister()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).readRegister());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).writeDevice(state.array);
}
======================================
public void writeRegister(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeRegister
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeRegister1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void writeRegister
params=byte[]
/**
* Writes the 1-Wire device register mask that
* have been changed by 'set' methods.
*
* @param register 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeRegister(ByteArray register)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).writeRegister(register.array);
}
======================================
public void setResetMode(byte[], boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setResetMode
sParams=byte[], boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setResetMode2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void setResetMode
params=byte[],boolean
/**
* Turns the Reset mode on/off.
*
* @param set if 'TRUE' the reset mode will be set or 'FALSE' to turn it off.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void setResetMode(ByteArray register, boolean set)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).setResetMode(register.array, set);
}
======================================
public boolean getVCC(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean getVCC
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getVCC1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean getVCC
params=byte[]
/**
* Retrieves the state of the VCC pin. If the pin is powered 'TRUE' is
* returned else 'FALSE' is returned if the pin is grounded.
*
* @return <code>true</code> if VCC is powered and <code>false</code> if it is
* grounded.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean getVCC(ByteArray register)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).getVCC(register.array);
}
======================================
public void clearPowerOnReset(byte[])
sMethodName=public void clearPowerOnReset
sParams=byte[]
sThrows=
tempMethodName=public void clearPowerOnReset1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void clearPowerOnReset
params=byte[]
/**
* Checks if the Power On Reset if on and if so clears it.
*
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*/
public void clearPowerOnReset(ByteArray register)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).clearPowerOnReset(register.array);
}
======================================
public void orConditionalSearch(byte[])
sMethodName=public void orConditionalSearch
sParams=byte[]
sThrows=
tempMethodName=public void orConditionalSearch1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void orConditionalSearch
params=byte[]
/**
* Checks if the 'or' Condition Search is set and if not sets it.
*
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*/
public void orConditionalSearch(ByteArray register)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).orConditionalSearch(register.array);
}
======================================
public void andConditionalSearch(byte[])
sMethodName=public void andConditionalSearch
sParams=byte[]
sThrows=
tempMethodName=public void andConditionalSearch1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void andConditionalSearch
params=byte[]
/**
* Checks if the 'and' Conditional Search is set and if not sets it.
*
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*/
public void andConditionalSearch(ByteArray register)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).andConditionalSearch(register.array);
}
======================================
public void pioConditionalSearch(byte[])
sMethodName=public void pioConditionalSearch
sParams=byte[]
sThrows=
tempMethodName=public void pioConditionalSearch1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void pioConditionalSearch
params=byte[]
/**
* Checks if the 'PIO' Conditional Search is set for input and if not sets it.
*
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*/
public void pioConditionalSearch(ByteArray register)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).pioConditionalSearch(register.array);
}
======================================
public void activityConditionalSearch(byte[])
sMethodName=public void activityConditionalSearch
sParams=byte[]
sThrows=
tempMethodName=public void activityConditionalSearch1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void activityConditionalSearch
params=byte[]
/**
* Checks if the activity latches are set for Conditional Search and if not sets it.
*
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*/
public void activityConditionalSearch(ByteArray register)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).activityConditionalSearch(register.array);
}
======================================
public void setChannelMask(int, boolean, byte[])
sMethodName=public void setChannelMask
sParams=int, boolean, byte[]
sThrows=
tempMethodName=public void setChannelMask3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void setChannelMask
params=int,boolean,byte[]
/**
* Sets the channel passed to the proper state depending on the set parameter for
* responding to the Conditional Search.
*
* @param channel current channel to set
* @param set whether to turn the channel on/off for Conditional Search
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*/
public void setChannelMask(int channel, boolean set, ByteArray register)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).setChannelMask(channel, set, register.array);
}
======================================
public void setChannelPolarity(int, boolean, byte[])
sMethodName=public void setChannelPolarity
sParams=int, boolean, byte[]
sThrows=
tempMethodName=public void setChannelPolarity3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public void setChannelPolarity
params=int,boolean,byte[]
/**
* Sets the channel passed to the proper state depending on the set parameter for
* the correct polarity in the Conditional Search.
*
* @param channel current channel to set
* @param set whether to turn the channel on/off for polarity
* Conditional Search
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*/
public void setChannelPolarity(int channel, boolean set, ByteArray register)
{
((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).setChannelPolarity(channel, set, register.array);
}
======================================
public boolean getChannelMask(int, byte[])
sMethodName=public boolean getChannelMask
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getChannelMask2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean getChannelMask
params=int,byte[]
/**
* Retrieves the information if the channel is masked for the Conditional Search.
*
* @param channel current channel to set
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*
* @return <code>true</code> if the channel is masked and <code>false</code> other wise.
*/
public boolean getChannelMask(int channel, ByteArray register)
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).getChannelMask(channel, register.array);
}
======================================
public boolean getChannelPolarity(int, byte[])
sMethodName=public boolean getChannelPolarity
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getChannelPolarity2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer29
methodName=public boolean getChannelPolarity
params=int,byte[]
/**
* Retrieves the polarity of the channel for the Conditional Search.
*
* @param channel current channel to set
* @param register current register for conditional search, which
* if returned from <code>readRegister()</code>
*
* @return <code>true</code> if the channel is masked and <code>false</code> other wise.
*/
public boolean getChannelPolarity(int channel, ByteArray register)
{
return ((com.dalsemi.onewire.container.OneWireContainer29)objectInstance).getChannelPolarity(channel, register.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer2C.java
superClassName=java.lang.Object
-->OneWireContainer2C implements com.dalsemi.onewire.container.PotentiometerContainer
OneWireContainer2C implements com.dalsemi.onewire.container.PotentiometerContainer
======================================
public boolean isLinear(byte[])
sMethodName=public boolean isLinear
sParams=byte[]
sThrows=
tempMethodName=public boolean isLinear1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public boolean isLinear
params=byte[]
/**
* Queries to see if this Potentiometer One Wire Device
* has linear potentiometer element(s) or logarithmic
* potentiometer element(s).
*
* @param state state buffer of the Potentiometer One Wire Device
* (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if this device has linear potentiometer
* element(s); <CODE>false</CODE> if this device has logarithmic
* potentiometer element(s)
*/
public boolean isLinear(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).isLinear(state.array);
}
======================================
public boolean wiperSettingsAreVolatile(byte[])
sMethodName=public boolean wiperSettingsAreVolatile
sParams=byte[]
sThrows=
tempMethodName=public boolean wiperSettingsAreVolatile1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public boolean wiperSettingsAreVolatile
params=byte[]
/**
* Queries to see if this 1-Wire Potentiometer device's
* wiper settings are volatile or non-volatile.
*
* @param state state buffer of the 1-Wire Potentiometer device
* (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if the wiper settings are volatile;
* <CODE>false</CODE> if the wiper settings are non-volatile
*/
public boolean wiperSettingsAreVolatile(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).wiperSettingsAreVolatile(state.array);
}
======================================
public int numberOfPotentiometers(byte[])
sMethodName=public int numberOfPotentiometers
sParams=byte[]
sThrows=
tempMethodName=public int numberOfPotentiometers1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int numberOfPotentiometers
params=byte[]
/**
* Queries to see how many potentiometers this
* Potentiometer One Wire Device has.
*
* @param state state buffer of this 1-Wire Potentiometer device
* (returned by <CODE>readDevice()</CODE>)
* @return the number of potentiometers on this device
*/
public int numberOfPotentiometers(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).numberOfPotentiometers(state.array);
}
======================================
public int numberOfWiperSettings(byte[])
sMethodName=public int numberOfWiperSettings
sParams=byte[]
sThrows=
tempMethodName=public int numberOfWiperSettings1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int numberOfWiperSettings
params=byte[]
/**
* Queries to find the number of wiper settings
* that any wiper on this Potentiometer One Wire
* Device can have.
*
* @param state state buffer of this 1-Wire Potentiometer device
* (returned by <CODE>readDevice()</CODE>)
* @return number of wiper positions available
*/
public int numberOfWiperSettings(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).numberOfWiperSettings(state.array);
}
======================================
public int potentiometerResistance(byte[])
sMethodName=public int potentiometerResistance
sParams=byte[]
sThrows=
tempMethodName=public int potentiometerResistance1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int potentiometerResistance
params=byte[]
/**
* Queries to find the resistance value of the potentiometer.
*
* @param state state buffer of this 1-Wire Potentiometer device
* (returned by <CODE>readDevice()</CODE>)
* @return the resistance value in k-Ohms
*/
public int potentiometerResistance(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).potentiometerResistance(state.array);
}
======================================
public int getCurrentWiperNumber(byte[])
sMethodName=public int getCurrentWiperNumber
sParams=byte[]
sThrows=
tempMethodName=public int getCurrentWiperNumber1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int getCurrentWiperNumber
params=byte[]
/**
* Gets the currently selected wiper number. All wiper actions
* affect this wiper. The number of wipers is the same as
* <CODE>numberOfPotentiometers()</CODE>.
*
* @param state state buffer of this 1-Wire Potentiometer device
* (returned by <CODE>readDevice()</CODE>)
* @return the current wiper number
*/
public int getCurrentWiperNumber(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).getCurrentWiperNumber(state.array);
}
======================================
public void setCurrentWiperNumber(int, byte[])
sMethodName=public void setCurrentWiperNumber
sParams=int, byte[]
sThrows=
tempMethodName=public void setCurrentWiperNumber2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public void setCurrentWiperNumber
params=int,byte[]
/**
* Sets the currently selected wiper number. All wiper actions
* affect this wiper. The number of wipers is the same as
* <CODE>numberOfPotentiometers()</CODE>.
*
* @param wiper_number wiper number to select for communication.
* Valid choices are 0 to 3
* @param state state buffer of this 1-Wire Potentiometer device
* (returned by <CODE>readDevice()</CODE>)
*/
public void setCurrentWiperNumber(int wiper_number, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).setCurrentWiperNumber(wiper_number, state.array);
}
======================================
public boolean isChargePumpOn(byte[])
sMethodName=public boolean isChargePumpOn
sParams=byte[]
sThrows=
tempMethodName=public boolean isChargePumpOn1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public boolean isChargePumpOn
params=byte[]
/**
* Determines if this device's charge pump is enabled.
*
* @param state state buffer of this Potentiometer One Wire Device
* (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if it is enabled; <CODE>false</CODE> if not
*/
public boolean isChargePumpOn(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).isChargePumpOn(state.array);
}
======================================
public void setChargePump(boolean, byte[])
sMethodName=public void setChargePump
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setChargePump2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public void setChargePump
params=boolean,byte[]
/**
* 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 <A HREF="http://www.dalsemi.com">www.dalsemi.com</A>)
*
* @param charge_pump_on <CODE>true</CODE> if you want to enable the charge pump
* @param state state buffer of this Potentiometer One Wire Device
* (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if the operation was successful;
* <CODE>false</CODE> if there was an error
*/
public void setChargePump(boolean charge_pump_on, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).setChargePump(charge_pump_on, state.array);
}
======================================
public int getWiperPosition() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int getWiperPosition
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int getWiperPosition0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int getWiperPosition
params=
/**
* 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.
*
* @return the wiper position between 0 and 255
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find device
*/
public int getWiperPosition()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).getWiperPosition();
}
======================================
public boolean setWiperPosition(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean setWiperPosition
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean setWiperPosition1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public boolean setWiperPosition
params=int
/**
* Sets the wiper position for the potentiometer.
*
* @param position the position to set the wiper. This value will be cast
* to a byte, only the 8 least significant bits matter.
* @return <CODE>true</CODE> if the operation was successful;
* <CODE>false</CODE> otherwise
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find device
*/
public boolean setWiperPosition(int position)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).setWiperPosition(position);
}
======================================
public int increment(boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int increment
sParams=boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int increment1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int increment
params=boolean
/**
* Increments the wiper position.
*
* @param reselect increment/decrement can be called without resetting
* the part if the last call was an increment/decrement.
* <CODE>true</CODE> if you want to select the part
* (you must call with <CODE>true</CODE> after any other
* one-wire method)
* @return the new position of the wiper (0-255)
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find device
*/
public int increment(boolean reselect)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).increment(reselect);
}
======================================
public int decrement(boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int decrement
sParams=boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int decrement1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int decrement
params=boolean
/**
* Decrements the wiper position.
*
* @param reselect increment/decrement can be called without resetting
* the part if the last call was an increment/decrement.
* <CODE>true</CODE> if you want to select the part (you
* must call with <CODE>true</CODE> after any other one-wire
* method)
* @return the new position of the wiper (0-255)
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find device
*/
public int decrement(boolean reselect)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).decrement(reselect);
}
======================================
public int increment() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int increment
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int increment0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int increment
params=
/**
* Increments the wiper position.
*
* @param reselect increment/decrement can be called without resetting
* the part if the last call was an increment/decrement.
* <CODE>true</CODE> if you want to select the part
* (you must call with <CODE>true</CODE> after any other
* one-wire method)
* @return the new position of the wiper (0-255)
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find device
*/
public int increment()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).increment();
}
======================================
public int decrement() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int decrement
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int decrement0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public int decrement
params=
/**
* Decrements the wiper position.
*
* @param reselect increment/decrement can be called without resetting
* the part if the last call was an increment/decrement.
* <CODE>true</CODE> if you want to select the part (you
* must call with <CODE>true</CODE> after any other one-wire
* method)
* @return the new position of the wiper (0-255)
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find device
*/
public int decrement()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).decrement();
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public byte[] readDevice
params=
/**
* 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 <CODE>writeDevice</CODE> to finalize the one or more change.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException Data was not read correctly
* @throws OneWireException Could not find device
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2C
methodName=public void writeDevice
params=byte[]
/**
* 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.
*
* @param state byte array of clock register page contents
*
* @throws OneWireIOException Data was not written correctly
* @throws OneWireException Could not find device
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer2C)objectInstance).writeDevice(state.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer2D.java
No COM CLSID for OneWireContainer2D
superClassName=java.lang.Object
======================================
public static final byte WRITEONCE_FLAG
======================================
public boolean isPageWriteOnce(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isPageWriteOnce
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isPageWriteOnce1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2D
methodName=public boolean isPageWriteOnce
params=int
/**
* Query to see if current memory bank is write write once such
* as with EPROM technology.
*
* @return 'true' if current memory bank can only be written once
*/
public boolean isPageWriteOnce(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer2D)objectInstance).isPageWriteOnce(page);
}
======================================
public void setPageWriteOnce(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setPageWriteOnce
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setPageWriteOnce1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer2D
methodName=public void setPageWriteOnce
params=int
/**
* Lock the specifed page in the current memory bank. Not supported
* by all devices. See the method 'canLockPage()'.
*
* @param page number of page to lock
*
* @throws OneWireIOException
* @throws OneWireException
*/
public void setPageWriteOnce(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer2D)objectInstance).setPageWriteOnce(page);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer30.java
superClassName=java.lang.Object
-->OneWireContainer30 implements com.dalsemi.onewire.container.ADContainer,com.dalsemi.onewire.container.TemperatureContainer
OneWireContainer30 implements com.dalsemi.onewire.container.ADContainer
OneWireContainer30 implements com.dalsemi.onewire.container.TemperatureContainer
======================================
public static final byte PROTECTION_REGISTER
======================================
public static final byte STATUS_REGISTER
======================================
public static final byte EEPROM_REGISTER
======================================
public static final byte SPECIAL_FEATURE_REGISTER
======================================
public static final byte OVERVOLTAGE_FLAG
======================================
public static final byte UNDERVOLTAGE_FLAG
======================================
public static final byte CHARGE_OVERCURRENT_FLAG
======================================
public static final byte DISCHARGE_OVERCURRENT_FLAG
======================================
public static final byte CC_PIN_STATE_FLAG
======================================
public static final byte DC_PIN_STATE_FLAG
======================================
public static final byte CHARGE_ENABLE_FLAG
======================================
public static final byte DISCHARGE_ENABLE_FLAG
======================================
public static final byte SLEEP_MODE_ENABLE_FLAG
======================================
public static final byte READ_NET_ADDRESS_OPCODE_FLAG
======================================
public static final byte EEPROM_COPY_FLAG
======================================
public static final byte EEPROM_LOCK_ENABLE_FLAG
======================================
public static final byte EEPROM_BLOCK_1_LOCK_FLAG
======================================
public static final byte EEPROM_BLOCK_0_LOCK_FLAG
======================================
public static final byte PS_PIN_STATE_FLAG
======================================
public static final byte PIO_PIN_SENSE_AND_CONTROL_FLAG
======================================
public synchronized void setResistorInternal()
sMethodName=public synchronized void setResistorInternal
sParams=
sThrows=
tempMethodName=public synchronized void setResistorInternal0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public synchronized void setResistorInternal
params=
/**
* Sets the DS2760 to use its internal .025 ohm resistor for measurements.
* This should only be enabled if there is NO external resistor physically
* attached to the device.
*/
public synchronized void setResistorInternal()
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setResistorInternal();
}
======================================
public synchronized void setResistorExternal(double)
sMethodName=public synchronized void setResistorExternal
sParams=double
sThrows=
tempMethodName=public synchronized void setResistorExternal1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public synchronized void setResistorExternal
params=double
/**
* Sets the DS2760 to use an external, user-selectable resistance. This
* Resistance should be wired directly to the VSS (negative terminal of
* the cell).
*
* @param Rsens resistance in ohms
*/
public synchronized void setResistorExternal(double Rsens)
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setResistorExternal(Rsens);
}
======================================
public byte readByte(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readByte
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public byte readByte1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public byte readByte
params=int
/**
* Reads a register byte from the memory of the DS2760. Note that there
* is no error checking as the DS2760 performs no CRC on the data.
* <p>
* Note: This function should only be used when reading the register
* memory of the DS2760. The EEPROM blocks (addresses 32-64) should be
* accessed with writeBlock/readBlock.
*
* @param memAddr the address to read (0-255)
*
* @return data read from memory
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public byte readByte(int memAddr)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).readByte(memAddr);
}
======================================
public void readBytes(int, byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void readBytes
sParams=int, byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void readBytes4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void readBytes
params=int,byte[],int,int
/**
* Reads bytes from the DS2760. Note that there is no error-checking as
* the DS2760 does not perform a CRC on the data.
* <p>
* Note: This function should only be used when reading the register
* memory of the DS2760. The EEPROM blocks (addresses 32-64) should be
* accessed with writeBlock/readBlock.
*
* @param memAddr the address to read (0-255)
* @param buffer buffer to receive data
* @param start start position within buffer to place data
* @param len length of buffer
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public void readBytes(int memAddr, ByteArray buffer, int start, int len)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).readBytes(memAddr, buffer.array, start, len);
}
======================================
public void writeByte(int, byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeByte
sParams=int, byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeByte2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void writeByte
params=int,byte
/**
* Writes a register byte to the memory of the DS2760. Note that the
* DS2760 does not make any use of cyclic redundancy checks (error-checking).
* To ensure error free transmission, double check write operation.
* <p>
* Note: This method should only be used when writing to the register memory
* of the DS2760. The EEPROM blocks (addresses 32-64) require special treatment
* and thus the writeBlock/readBlock functions should be used for those.
*
* @param memAddr address to write (0-255)
* @param data data byte to write to memory
*
* @throws OneWireIOException Error writing data
* @throws OneWireException Could not find part
*/
public void writeByte(int memAddr, byte data)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).writeByte(memAddr, data);
}
======================================
public byte readEEPROMBlock(int)[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readEEPROMBlock
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readEEPROMBlock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public byte[] readEEPROMBlock
params=int
/**
* Reads a 16 byte data block from one of the user EEPROM blocks.
* Note that there is no error-checking as the DS2760 performs
* no CRCs.
*
* @param blockNumber the EEPROM block number to read,
* acceptable parameters are 0 and 1
*
* @return 16 data bytes
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public ByteArray readEEPROMBlock(int blockNumber)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).readEEPROMBlock(blockNumber));
}
======================================
public void writeEEPROMBlock(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeEEPROMBlock
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeEEPROMBlock2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void writeEEPROMBlock
params=int,byte[]
/**
* Writes a 16 byte data block to one of the user blocks. The block may be
* rewritten at any time, except after it is locked with <CODE>lockBlock()</CODE>.
* This method performs error checking by verifying data written.
*
* @param blockNumber block to write,
* acceptable parameters are 0 and 1
* @param data 16 bytes of data to write
*
* @throws OneWireIOException Error writing data
* @throws OneWireException Could not find part
*/
public void writeEEPROMBlock(int blockNumber, ByteArray data)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).writeEEPROMBlock(blockNumber, data.array);
}
======================================
public void lockBlock(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void lockBlock
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void lockBlock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void lockBlock
params=int
/**
* Permanently write-protects one of the user blocks of EEPROM.
*
* @param blockNumber block number to permanently write protect,
* acceptable parameters are 0 and 1.
*
* @throws OneWireIOException Error locking block
* @throws OneWireException Could not find part
*/
public void lockBlock(int blockNumber)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).lockBlock(blockNumber);
}
======================================
public boolean getFlag(int, byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean getFlag
sParams=int, byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getFlag2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean getFlag
params=int,byte
/**
* Checks the specified flag in the specified register. <BR>
* Valid registers are:
* <A HREF="#PROTECTION_REGISTER"><CODE>PROTECTION_REGISTER</CODE></A>,
* <A HREF="#STATUS_REGISTER"><CODE>STATUS_REGISTER</CODE></A>,
* <A HREF="#EEPROM_REGISTER"><CODE>EEPROM_REGISTER</CODE></A> and
* <A HREF="#SPECIAL_FEATURE_REGISTER"><CODE>SPECIAL_FEATURE_REGISTER</CODE></A>.
*
* @param memAddr registers address. Pre-defined
* fields for each register are defined above.
* @param flagToGet bitmask of desired flag, the acceptable parameters
* pertaining to each register are defined as constant fields above
*
* @return value of the flag: <CODE>true</CODE> if flag is set (=1)
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*
*/
public boolean getFlag(int memAddr, byte flagToGet)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getFlag(memAddr, flagToGet);
}
======================================
public void setFlag(int, byte, boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setFlag
sParams=int, byte, boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setFlag3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setFlag
params=int,byte,boolean
/**
* Sets one of the flags in one of the registers.<BR>
* Valid registers are:
* <A HREF="#PROTECTION_REGISTER"><CODE>PROTECTION_REGISTER</CODE></A>,
* <A HREF="#STATUS_REGISTER"><CODE>STATUS_REGISTER</CODE></A>,
* <A HREF="#EEPROM_REGISTER"><CODE>EEPROM_REGISTER</CODE></A> and
* <A HREF="#SPECIAL_FEATURE_REGISTER"><CODE>SPECIAL_FEATURE_REGISTER</CODE></A>.
*
* @param memAddr register address, these addresses are
* predefined above
* @param flagToSet bitmask of flag to set, valid
* parameters pertaining to each register are defined
* as constant fields above
* @param flagValue value to set the flag to
*
* @throws OneWireIOException Error setting flag
* @throws OneWireException Could not find part
*/
public void setFlag(int memAddr, byte flagToSet, boolean flagValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setFlag(memAddr, flagToSet, flagValue);
}
======================================
public double getCurrent(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getCurrent
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double getCurrent1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getCurrent
params=byte[]
/**
* Gets the instantaneous current.
*
*
* @param state device state
* @return current in Amperes
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public double getCurrent(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getCurrent(state.array);
}
======================================
public void setRemainingCapacity(double) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setRemainingCapacity
sParams=double
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setRemainingCapacity1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setRemainingCapacity
params=double
/**
* Allows user to set the remaining capacity. Good for accurate capacity
* measurements using temperature and battery life.
* <p> By measuring the battery's current and voltage when it is fully
* charged and when it is empty, the voltage corresponding to an empty battery
* and the current corresponding to a full one can be derived. These
* values can be detected in user program and the remaining capacity can
* be set to the empty/full levels accordingly for nice accuracy.
*
* @param remainingCapacity remaining capacity in mAH
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public void setRemainingCapacity(double remainingCapacity)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setRemainingCapacity(remainingCapacity);
}
======================================
public double getRemainingCapacity(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getRemainingCapacity
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double getRemainingCapacity1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getRemainingCapacity
params=byte[]
/**
* Calculates the remaining capacity in mAHours from the current
* Accumulator. Accurate to +/- .25 mAH.
*
* @param state device state
* @return mAHours of battery capacity remaining
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public double getRemainingCapacity(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getRemainingCapacity(state.array);
}
======================================
public void setLatchState(boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setLatchState
sParams=boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setLatchState1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setLatchState
params=boolean
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setLatchState
params=boolean
methodMatcher=/void setLatchState *\((.*boolean.*)\)/
/**
* No documentation available for method
*/
public void setLatchState(boolean on)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setLatchState(on);
}
======================================
public boolean getLatchState() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean getLatchState
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getLatchState0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean getLatchState
params=
/**
* Returns the latch state of the Programmable Input/Ouput
* pin on the DS2760.
*
* @return state of the Programmable Input/Ouput pin
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find part
*/
public boolean getLatchState()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getLatchState();
}
======================================
public void clearConditions() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void clearConditions
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void clearConditions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void clearConditions
params=
/**
* Clears the overvoltage, undervoltage, charge overcurrent,
* and discharge overcurrent flags. Each time a violation
* occurs, these flags stay set until reset. This method
* resets all 4 flags.
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find part
*/
public void clearConditions()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).clearConditions();
}
======================================
public int getNumberADChannels()
sMethodName=public int getNumberADChannels
sParams=
sThrows=
tempMethodName=public int getNumberADChannels0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public int getNumberADChannels
params=
/**
* Queries to get the number of channels supported by this A/D device.
* Channel specific methods will use a channel number specified
* by an integer from <CODE>[0 to (getNumberChannels() - 1)]</CODE>.
*
* @return number of channels
*/
public int getNumberADChannels()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getNumberADChannels();
}
======================================
public boolean hasADAlarms()
sMethodName=public boolean hasADAlarms
sParams=
sThrows=
tempMethodName=public boolean hasADAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean hasADAlarms
params=
/**
* Queries to see if this A/D measuring device has high/low
* alarms.
*
* @return <CODE>true</CODE> if has high/low trips
*/
public boolean hasADAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).hasADAlarms();
}
======================================
public double getADRanges(int)[]
sMethodName=public double getADRanges
sParams=int
sThrows=
tempMethodName=public double[] getADRanges1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double[] getADRanges
params=int
/**
* Queries to get an array of available ranges for the specified
* A/D channel.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
*
* @return available ranges
*/
public double[] getADRanges(int channel)
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADRanges(channel);
}
======================================
public double getADResolutions(int, double)[]
sMethodName=public double getADResolutions
sParams=int, double
sThrows=
tempMethodName=public double[] getADResolutions2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double[] getADResolutions
params=int,double
/**
* Queries to get an array of available resolutions based
* on the specified range on the specified A/D channel.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param range range of channel specified in channel parameter
*
* @return available resolutions
*/
public double[] getADResolutions(int channel, double range)
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADResolutions(channel, range);
}
======================================
public boolean canADMultiChannelRead()
sMethodName=public boolean canADMultiChannelRead
sParams=
sThrows=
tempMethodName=public boolean canADMultiChannelRead0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean canADMultiChannelRead
params=
/**
* Queries to see if this A/D device supports doing multiple voltage
* conversions at the same time.
*
* @return <CODE>true</CODE> if can do multi-channel voltage reads
*/
public boolean canADMultiChannelRead()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).canADMultiChannelRead();
}
======================================
public void doADConvert(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvert2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void doADConvert
params=int,byte[]
/**
* Performs voltage conversion on the specified channel. The method
* <CODE>getADVoltage()</CODE> can be used to read the result of the
* conversion.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of this
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find device
*/
public void doADConvert(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).doADConvert(channel, state.array);
}
======================================
public void doADConvert(boolean[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=boolean[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvertMulti2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void doADConvert
params=boolean[],byte[]
/**
* Performs voltage conversion on all specified channels. The method
* <CODE>getADVoltage()</CODE> can be used to read the result
* of the conversion. This A/D must support multi-channel read
* <CODE>canMultiChannelRead()</CODE> if there are more than 1 channel
* is specified.
*
* @param doConvert channels to perform conversion on
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Device does not support multi-channel reading
*/
public void doADConvertMulti(boolean[] doConvert, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).doADConvert(doConvert, state.array);
}
======================================
public double getADVoltage(byte[])[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double[] getADVoltage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double[] getADVoltage
params=byte[]
/**
* Reads the voltage values. Must be used after a <CODE>doADConvert()</CODE>
* method call. Also must include the last valid state from the
* <CODE>readDevice()</CODE> method and this A/D must support multi-channel
* read <CODE>canMultiChannelRead()</CODE> if there are more than 1 channel.
*
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @return voltage values for all channels
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Device does not support multi-channel reading
*/
public double[] getADVoltage(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADVoltage(state.array);
}
======================================
public double getADVoltage(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double getADVoltage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getADVoltage
params=int,byte[]
/**
* Reads a channel voltage value. Must be used after a
* <CODE>doADConvert()</CODE> method call. Also must
* include the last valid state from the <CODE>readDevice()</CODE>
* method.
* Note, if more than one channel is to be read then it is more
* efficient to use the <CODE>getADVoltage(byte[])</CODE> method that returns all
* channel values.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @return voltage value for the specified
* channel
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find device
*/
public double getADVoltage(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADVoltage(channel, state.array);
}
======================================
public double getADAlarm(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getADAlarm
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getADAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getADAlarm
params=int,int,byte[]
/**
* Extracts the alarm voltage value of the specified channel from the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @return alarm_value in volts
*
* @throws OneWireException Device does not support A/D alarms
*/
public double getADAlarm(int channel, int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADAlarm(channel, alarmType, state.array);
}
======================================
public boolean getADAlarmEnable(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getADAlarmEnable
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getADAlarmEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean getADAlarmEnable
params=int,int,byte[]
/**
* Extracts the alarm enable value of the specified channel from the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the device
* returned from <CODE>readDevice()</CODE>
*
* @return <CODE>true</CODE> if specified alarm is enabled
*
* @throws OneWireException Device does not support A/D alarms
*/
public boolean getADAlarmEnable(int channel, int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADAlarmEnable(channel, alarmType, state.array);
}
======================================
public boolean hasADAlarmed(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean hasADAlarmed
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean hasADAlarmed3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean hasADAlarmed
params=int,int,byte[]
/**
* Checks the A/D alarm event value of the specified channel from the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state current state of the device
* returned from <CODE>readDevice()</CODE>
*
* @return <CODE>true</CODE> if specified alarm occurred
*
* @throws OneWireException Device does not support A/D alarms
*/
public boolean hasADAlarmed(int channel, int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).hasADAlarmed(channel, alarmType, state.array);
}
======================================
public double getADResolution(int, byte[])
sMethodName=public double getADResolution
sParams=int, byte[]
sThrows=
tempMethodName=public double getADResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getADResolution
params=int,byte[]
/**
* Extracts the A/D conversion resolution of the specified channel from the
* provided state buffer expressed in volts. The state is retrieved from
* the <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the device
* returned from <CODE>readDevice()</CODE>
*
* @return A/D resolution of channel in volts
*/
public double getADResolution(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADResolution(channel, state.array);
}
======================================
public double getADRange(int, byte[])
sMethodName=public double getADRange
sParams=int, byte[]
sThrows=
tempMethodName=public double getADRange2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getADRange
params=int,byte[]
/**
* Extracts the A/D input voltage range of the specified channel from the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param state current state of the device
* returned from <CODE>readDevice()</CODE>
*
* @return A/D input voltage range
*/
public double getADRange(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getADRange(channel, state.array);
}
======================================
public void setADAlarm(int, int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarm
sParams=int, int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarm4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setADAlarm
params=int,int,double,byte[]
/**
* Sets the A/D alarm voltage value of the specified channel in the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method. The method <CODE>writeDevice()</CODE>
* must be called to finalize these changes to the device. Note that
* multiple 'set' methods can be called before one call to
* <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarm A/D alarm value (will be reduced to 8 bit resolution)
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireException Device does not support A/D alarms
*/
public void setADAlarm(int channel, int alarmType, double alarm, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setADAlarm(channel, alarmType, alarm, state.array);
}
======================================
public void setADAlarmEnable(int, int, boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarmEnable
sParams=int, int, boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarmEnable4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setADAlarmEnable
params=int,int,boolean,byte[]
/**
* Sets the A/D alarm enable value of the specified channel in the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method. The method <CODE>writeDevice()</CODE>
* must be called to finalize these changes to the device. Note that
* multiple 'set' methods can be called before one call to
* <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param alarmType desired alarm, <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarmEnable A/D alarm enable value
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*
* @throws OneWireException Device does not support A/D alarms
*/
public void setADAlarmEnable(int channel, int alarmType, boolean alarmEnable, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setADAlarmEnable(channel, alarmType, alarmEnable, state.array);
}
======================================
public void setADResolution(int, double, byte[])
sMethodName=public void setADResolution
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADResolution3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setADResolution
params=int,double,byte[]
/**
* Sets the A/D conversion resolution value for the specified channel in the
* provided state buffer. The state buffer is retrieved from the
* <CODE>readDevice()</CODE> method.
* The method <CODE>writeDevice()</CODE> must be called to finalize these
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param resolution A/D resolution in volts
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*/
public void setADResolution(int channel, double resolution, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setADResolution(channel, resolution, state.array);
}
======================================
public void setADRange(int, double, byte[])
sMethodName=public void setADRange
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADRange3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setADRange
params=int,double,byte[]
/**
* Sets the A/D input range for the specified channel in the provided state
* buffer. The state buffer is retrieved from the <CODE>readDevice()</CODE>
* method. The method <CODE>writeDevice()</CODE> must be called to finalize
* these changes to the device. Note that multiple 'set' methods can
* be called before one call to <CODE>writeDevice()</CODE>.
*
* @param channel channel in the range
* <CODE>[0 to (getNumberChannels() - 1)]</CODE>
* @param range max A/D volt range, use
* <CODE>getRanges()</CODE> method to get available ranges
* @param state current state of the
* device returned from <CODE>readDevice()</CODE>
*/
public void setADRange(int channel, double range, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setADRange(channel, range, state.array);
}
======================================
public boolean hasTemperatureAlarms()
sMethodName=public boolean hasTemperatureAlarms
sParams=
sThrows=
tempMethodName=public boolean hasTemperatureAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean hasTemperatureAlarms
params=
/**
* Queries to see if this temperature measuring device has high/low
* trip alarms.
*
* @return <CODE>true</CODE> if has high/low temperature trip alarms
*/
public boolean hasTemperatureAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).hasTemperatureAlarms();
}
======================================
public boolean hasSelectableTemperatureResolution()
sMethodName=public boolean hasSelectableTemperatureResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public boolean hasSelectableTemperatureResolution
params=
/**
* Queries to see if this device has selectable temperature resolution.
*
* @return <CODE>true</CODE> if has selectable temperature resolution
*/
public boolean hasSelectableTemperatureResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).hasSelectableTemperatureResolution();
}
======================================
public double getTemperatureResolutions()[]
sMethodName=public double getTemperatureResolutions
sParams=
sThrows=
tempMethodName=public double[] getTemperatureResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double[] getTemperatureResolutions
params=
/**
* Queries to get an array of available temperature resolutions in
* degrees C.
*
* @return available temperature resolutions in degrees C
*/
public double[] getTemperatureResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getTemperatureResolutions();
}
======================================
public double getTemperatureAlarmResolution() throws com.dalsemi.onewire.OneWireException
sMethodName=public double getTemperatureAlarmResolution
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getTemperatureAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getTemperatureAlarmResolution
params=
/**
* Queries to get the high/low temperature alarm resolution in degrees C.
*
* @return high/low temperature alarm resolution in degrees C
*
* @throws OneWireException Device does not support temperature alarms
*/
public double getTemperatureAlarmResolution()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getTemperatureAlarmResolution();
}
======================================
public double getMaxTemperature()
sMethodName=public double getMaxTemperature
sParams=
sThrows=
tempMethodName=public double getMaxTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getMaxTemperature
params=
/**
* Queries to get the maximum temperature in degrees C.
*
* @return maximum temperature in degrees C
*/
public double getMaxTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getMaxTemperature();
}
======================================
public double getMinTemperature()
sMethodName=public double getMinTemperature
sParams=
sThrows=
tempMethodName=public double getMinTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getMinTemperature
params=
/**
* Queries to get the minimum temperature in degrees C.
*
* @return minimum temperature in degrees C
*/
public double getMinTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getMinTemperature();
}
======================================
public void doTemperatureConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doTemperatureConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doTemperatureConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void doTemperatureConvert
params=byte[]
/**
* Performs a temperature conversion.
*
* @param state device state
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find device
*/
public void doTemperatureConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).doTemperatureConvert(state.array);
}
======================================
public double getTemperature(byte[])
sMethodName=public double getTemperature
sParams=byte[]
sThrows=
tempMethodName=public double getTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getTemperature
params=byte[]
/**
* Extracts the temperature value in degrees C from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return temperature in degrees C from the last
* <CODE>doTemperatureConvert()</CODE>
*/
public double getTemperature(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getTemperature(state.array);
}
======================================
public double getTemperatureAlarm(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getTemperatureAlarm
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getTemperatureAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getTemperatureAlarm
params=int,byte[]
/**
* Extracts the specified temperature alarm value in degrees C from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param alarmType trip type <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param state device state
*
* @return alarm trip temperature in degrees C
*
* @throws OneWireException Device does not support temerature alarms
*/
public double getTemperatureAlarm(int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getTemperatureAlarm(alarmType, state.array);
}
======================================
public double getTemperatureResolution(byte[])
sMethodName=public double getTemperatureResolution
sParams=byte[]
sThrows=
tempMethodName=public double getTemperatureResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public double getTemperatureResolution
params=byte[]
/**
* Extracts the current temperature resolution in degrees C from the
* state data retrieved from the <CODE>readDevice()</CODE> method.
*
* @param state device state
*
* @return temperature resolution in degrees C
*/
public double getTemperatureResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).getTemperatureResolution(state.array);
}
======================================
public void setTemperatureAlarm(int, double, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setTemperatureAlarm
sParams=int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setTemperatureAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setTemperatureAlarm
params=int,double,byte[]
/**
* Sets the temperature alarm value in degrees C in the
* provided state data. Use the method <CODE>writeDevice()</CODE> with
* this data to finalize the change to the device.
*
* @param alarmType trip type <CODE>ALARM_HIGH (1)
* or ALARM_LOW (0)</CODE>
* @param alarmValue high/low temperature trip value in degrees C
* @param state device state
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Device does not support temperature alarms
*/
public void setTemperatureAlarm(int alarmType, double alarmValue, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setTemperatureAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setTemperatureResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setTemperatureResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setTemperatureResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void setTemperatureResolution
params=double,byte[]
/**
* Sets the current temperature resolution in degrees C in the provided state data.
* Use the method <CODE>writeDevice()</CODE> with this data to finalize
* the change to the device.
*
* @param resolution temperature resolution in degrees C
* @param state device state
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find device
*/
public void setTemperatureResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).setTemperatureResolution(resolution, state.array);
}
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public byte[] readDevice
params=
/**
* 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 <CODE>writeDevice()</CODE> to finalize the one or more change. With the
* DS2760, there are no CRC checks on data. To ensure the integrity
* of this data, call twice and make sure only fields expected to change
* have changed. This method returns bytes 0 to 31 of the memory.
* Many applications will not need to worry about the lack of CRC checks.
*
* @return 1-Wire device state
*
* @throws OneWireIOException Error reading data
* @throws OneWireException Could not find device
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer30
methodName=public void writeDevice
params=byte[]
/**
* 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.
*
* @param state device state
*
* @throws OneWireIOException Error writting data
* @throws OneWireException Could not find device
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer30)objectInstance).writeDevice(state.array);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer33.java
superClassName=java.lang.Object
======================================
public com.dalsemi.onewire.container.MemoryBankScratchSHAEE getScratchpadMemoryBank()
sMethodName=public com.dalsemi.onewire.container.MemoryBankScratchSHAEE getScratchpadMemoryBank
sParams=
sThrows=
tempMethodName=public MemoryBankScratchSHAEE getScratchpadMemoryBank0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public com.dalsemi.onewire.container.MemoryBankScratchSHAEE getScratchpadMemoryBank
params=
/**
* Returns the instance of the Scratchpad memory bank. Contains
* methods for reading/writing the Scratchpad contents. Also,
* methods for Load First Secret, Compute Next Secret, and
* Refresh Scratchpad
*
* @return the instance of the Scratchpad memory bank
*/
public MemoryBankScratchSHAEE getScratchpadMemoryBank()
{
return new MemoryBankScratchSHAEE(((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).getScratchpadMemoryBank());
}
======================================
public com.dalsemi.onewire.container.MemoryBankSHAEE getStatusPageMemoryBank()
sMethodName=public com.dalsemi.onewire.container.MemoryBankSHAEE getStatusPageMemoryBank
sParams=
sThrows=
tempMethodName=public MemoryBankSHAEE getStatusPageMemoryBank0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public com.dalsemi.onewire.container.MemoryBankSHAEE getStatusPageMemoryBank
params=
/**
* Returns the instance of the Status page memory bank.
*
* @return the instance of the Status page memory bank
*/
public MemoryBankSHAEE getStatusPageMemoryBank()
{
return new MemoryBankSHAEE(((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).getStatusPageMemoryBank());
}
======================================
public com.dalsemi.onewire.container.MemoryBankSHAEE getMemoryBankForPage(int)
sMethodName=public com.dalsemi.onewire.container.MemoryBankSHAEE getMemoryBankForPage
sParams=int
sThrows=
tempMethodName=public MemoryBankSHAEE getMemoryBankForPage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public com.dalsemi.onewire.container.MemoryBankSHAEE getMemoryBankForPage
params=int
/**
* Returns the instance of the memory bank for a particular page
*
* @param page the page for the requested memory bank;
*
* @return the instance of the memory bank for the specified page
*/
public MemoryBankSHAEE getMemoryBankForPage(int page)
{
return new MemoryBankSHAEE(((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).getMemoryBankForPage(page));
}
======================================
public void setContainerSecret(byte[], int)
sMethodName=public void setContainerSecret
sParams=byte[], int
sThrows=
tempMethodName=public void setContainerSecret2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void setContainerSecret
params=byte[],int
/**
* Sets the bus master secret for this DS2432.
*
* @param newSecret Secret for this DS2432.
* @param offset index into array to copy the secret from
*/
public void setContainerSecret(ByteArray newSecret, int offset)
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).setContainerSecret(newSecret.array, offset);
}
======================================
public void getContainerSecret(byte[], int)
sMethodName=public void getContainerSecret
sParams=byte[], int
sThrows=
tempMethodName=public void getContainerSecret2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void getContainerSecret
params=byte[],int
/**
* Get the secret of this device as an array of bytes.
*
* @param secretBuf array of bytes for holding the container secret
* @param offset index into array to copy the secret to
*/
public void getContainerSecret(ByteArray secretBuf, int offset)
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).getContainerSecret(secretBuf.array, offset);
}
======================================
public boolean isContainerSecretSet() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerSecretSet
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerSecretSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean isContainerSecretSet
params=
/**
* Get the current status of the secret.
*
* @return boolean telling if the secret is set
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean isContainerSecretSet()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).isContainerSecretSet();
}
======================================
public boolean isSecretWriteProtected() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isSecretWriteProtected
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isSecretWriteProtected0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean isSecretWriteProtected
params=
/**
* Get the status of the secret, if it is write protected.
*
* @return boolean telling if the secret is write protected.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean isSecretWriteProtected()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).isSecretWriteProtected();
}
======================================
public void setChallenge(byte[], int)
sMethodName=public void setChallenge
sParams=byte[], int
sThrows=
tempMethodName=public void setChallenge2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void setChallenge
params=byte[],int
/**
* Sets the challenge for the Read Authenticate Page
*
* @param challengeset Challenge for all the memory banks.
*/
public void setChallenge(ByteArray challengeset, int offset)
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).setChallenge( challengeset.array, offset);
}
======================================
public void getChallenge(byte[], int)
sMethodName=public void getChallenge
sParams=byte[], int
sThrows=
tempMethodName=public void getChallenge2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void getChallenge
params=byte[],int
/**
* Get the challenge of this device as an array of bytes.
*
* @param get array of bytes containing the iButton challenge
*/
public void getChallenge(ByteArray get, int offset)
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).getChallenge(get.array, offset);
}
======================================
public boolean isWriteProtectAllSet() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isWriteProtectAllSet
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isWriteProtectAllSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean isWriteProtectAllSet
params=
/**
* Get the status of all the pages, if they are write protected.
*
* @return boolean telling if all the pages are write protected.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean isWriteProtectAllSet()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).isWriteProtectAllSet();
}
======================================
public void writeProtectSecret() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeProtectSecret
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeProtectSecret0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void writeProtectSecret
params=
/**
* Write protects the secret for the DS2432.
*/
public void writeProtectSecret()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).writeProtectSecret();
}
======================================
public void writeProtectAll() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeProtectAll
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeProtectAll0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void writeProtectAll
params=
/**
* Write protect pages 0 to 3
*/
public void writeProtectAll()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).writeProtectAll();
}
======================================
public void setEPROMModePageOne() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setEPROMModePageOne
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setEPROMModePageOne0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void setEPROMModePageOne
params=
/**
* Sets the EPROM mode for page 1. After setting, Page One can only be written to once.
*/
public void setEPROMModePageOne()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).setEPROMModePageOne();
}
======================================
public boolean isPageOneEPROMmode() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isPageOneEPROMmode
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isPageOneEPROMmode0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean isPageOneEPROMmode
params=
/**
* Tells if page one is in EPROM mode.
*
* @return boolean telling if page one is in EPROM mode.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean isPageOneEPROMmode()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).isPageOneEPROMmode();
}
======================================
public void writeProtectPageZero() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeProtectPageZero
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeProtectPageZero0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void writeProtectPageZero
params=
/**
* Write protect page zero only.
*/
public void writeProtectPageZero()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).writeProtectPageZero();
}
======================================
public boolean isWriteProtectPageZeroSet() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isWriteProtectPageZeroSet
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isWriteProtectPageZeroSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean isWriteProtectPageZeroSet
params=
/**
* Get the status of page zero, if it is write protected.
*
* @return boolean telling if page zero is write protected.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean isWriteProtectPageZeroSet()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).isWriteProtectPageZeroSet();
}
======================================
public void computeNextSecret(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void computeNextSecret
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void computeNextSecret3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void computeNextSecret
params=int,byte[],int
/**
* Compute Next Secret
*
* @param addr address of page to use for the next secret computation.
* @param parialsecret the data to put into the scrathpad in computing next secret.
*/
public void computeNextSecret(int pageNum, ByteArray partialsecret, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).computeNextSecret(pageNum, partialsecret.array, offset);
}
======================================
public void computeNextSecret(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void computeNextSecret
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void computeNextSecret1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void computeNextSecret
params=int
/**
* Compute Next Secret
*
* @param addr address of page to use for the next secret computation.
* @param parialsecret the data to put into the scrathpad in computing next secret.
*/
public void computeNextSecret(int pageNum)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).computeNextSecret(pageNum);
}
======================================
public boolean loadFirstSecret(byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean loadFirstSecret
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean loadFirstSecret2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean loadFirstSecret
params=byte[],int
/**
* Load First Secret
*
* @return boolean saying if first secret was loaded
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean loadFirstSecret(ByteArray data, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).loadFirstSecret(data.array, offset);
}
======================================
public boolean refreshPage(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean refreshPage
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean refreshPage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean refreshPage
params=int,int
/**
* Refreshes a particular 8-byte set of data on a given page.
* This will correct any weakly-programmed EEPROM bits. This
* feature is only available on the DS1961S, but is safely
* ignored on the DS2432. The refresh consists of a Refresh Scratchpad
* command followed by a Load First Secret to the same offset.
*
* @param page the page number that contains the 8-bytes to refresh.
* @param offset the offset into the page for the 8-bytes to refresh.
*
* @return <code>true</code> if refresh is successful.
*/
public boolean refreshPage(int page, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).refreshPage(page, offset);
}
======================================
public boolean refreshPage(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean refreshPage
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean refreshPage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean refreshPage
params=int
/**
* Refreshes a particular 8-byte set of data on a given page.
* This will correct any weakly-programmed EEPROM bits. This
* feature is only available on the DS1961S, but is safely
* ignored on the DS2432. The refresh consists of a Refresh Scratchpad
* command followed by a Load First Secret to the same offset.
*
* @param page the page number that contains the 8-bytes to refresh.
* @param offset the offset into the page for the 8-bytes to refresh.
*
* @return <code>true</code> if refresh is successful.
*/
public boolean refreshPage(int page)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).refreshPage(page);
}
======================================
public static boolean isMACValid(int, byte[], byte[], byte[], byte[], byte[])
sMethodName=public static boolean isMACValid
sParams=int, byte[], byte[], byte[], byte[], byte[]
sThrows=
tempMethodName=public static boolean isMACValid6
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public static boolean isMACValid
params=int,byte[],byte[],byte[],byte[],byte[]
/**
* Authenticates page data given a MAC.
*
* @param addr address of the data to be read
* @param memory the memory read from the page
* @param mac the MAC calculated for this function given back as the extra info
* @param challenge the 3 bytes written to the scratch pad used in calculating the mac
*
*/
public boolean isMACValid(int addr, ByteArray SerNum, ByteArray memory, ByteArray mac, ByteArray challenge, ByteArray secret)
{
return com.dalsemi.onewire.container.OneWireContainer33.isMACValid(addr, SerNum.array, memory.array, mac.array, challenge.array, secret.array);
}
======================================
public boolean installMasterSecret(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean installMasterSecret
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean installMasterSecret2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean installMasterSecret
params=int,byte[]
/**
* <p>Installs a secret on a DS1961S/DS2432. The secret is written in partial phrases
* of 47 bytes (32 bytes to a memory page, 8 bytes to the scratchpad, 7 bytes are
* discarded (but included for compatibility with DS193S)) and
* is cumulative until the entire secret is processed.</p>
*
* <p>On TINI, this method will be slightly faster if the secret's length is divisible by 47.
* However, since secret key generation is a part of initialization, it is probably
* not necessary.</p>
*
* @param page the page number used to write the partial secrets to
* @param secret the entire secret, in partial phrases, to be installed
*
* @return <code>true</code> if successful
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #bindSecretToiButton(int,byte[])
*/
public boolean installMasterSecret(int page, ByteArray newSecret)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).installMasterSecret(page, newSecret.array);
}
======================================
public boolean bindSecretToiButton(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean bindSecretToiButton
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean bindSecretToiButton2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean bindSecretToiButton
params=int,byte[]
/**
* <p>Binds an installed secret to a DS1961S/DS2432 by using
* well-known binding data and the DS1961S/DS2432's unique
* address. This makes the secret unique
* for this iButton.</p>
*
* @param page the page number that has the master secret already installed
* @param bind_data 32 bytes of binding data used to bind the iButton to the system
*
* @return <code>true</code> if successful
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #installMasterSecret(int,byte[])
*/
public boolean bindSecretToiButton(int pageNum, ByteArray bindData)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).bindSecretToiButton(pageNum, bindData.array);
}
======================================
public boolean writeDataPage(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean writeDataPage
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean writeDataPage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean writeDataPage
params=int,byte[]
/**
* <p>Writes a data page to the DS1961S/DS2432.</p>
*
* @param page_number page number to write
* @param page_data page data to write (must be at least 32 bytes long)
*
* @return <code>true</code> if successful, <code>false</code> if the operation
* failed
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean writeDataPage(int targetPage, ByteArray pageData)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).writeDataPage(targetPage, pageData.array);
}
======================================
public boolean writeDataPage(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean writeDataPage
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean writeDataPage3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean writeDataPage
params=int,byte[],int
/**
* <p>Writes a data page to the DS1961S/DS2432.</p>
*
* @param page_number page number to write
* @param page_data page data to write (must be at least 32 bytes long)
* @param offset the offset to start copying the 32-bytes of page data.
*
* @return <code>true</code> if successful, <code>false</code> if the operation
* failed
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean writeDataPage(int targetPage, ByteArray pageData, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).writeDataPage(targetPage, pageData.array, offset);
}
======================================
public boolean writeScratchpad(int, int, byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean writeScratchpad
sParams=int, int, byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean writeScratchpad5
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean writeScratchpad
params=int,int,byte[],int,int
/**
* <p>Writes data to the scratchpad. In order to write to a data page using this method,
* next call <code>readScratchPad()</code>, and then <code>copyScratchPad()</code>.
* Note that the addresses passed to this method will be the addresses the data is
* copied to if the <code>copyScratchPad()</code> method is called afterward.</p>
*
* <p>Also note that if too many bytes are written, this method will truncate the
* data so that only a valid number of bytes will be sent.</p>
*
* @param targetPage the page number this data will eventually be copied to
* @param targetPageOffset the offset on the page to copy this data to
* @param inputbuffer the data that will be copied into the scratchpad
* @param start offset into the input buffer for the data to write
* @param length number of bytes to write
*
* @return <code>true</code> if successful, <code>false</code> on a CRC error
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean writeScratchpad(int targetPage, int targetPageOffset, ByteArray inputbuffer, int start, int length)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).writeScratchpad(targetPage, targetPageOffset, inputbuffer.array, start, length);
}
======================================
public void readScratchpad(byte[], int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void readScratchpad
sParams=byte[], int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void readScratchpad3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public void readScratchpad
params=byte[],int,byte[]
/**
* Read from the Scratch Pad, which is a max of 8 bytes.
*
* @param scratchpad byte array to place read data into
* length of array is always pageLength.
* @param offset offset into readBuf to pug data
* @param extraInfo byte array to put extra info read into
* (TA1, TA2, e/s byte)
* Can be 'null' if extra info is not needed.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public void readScratchpad(ByteArray scratchpad, int offset, ByteArray extraInfo)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).readScratchpad(scratchpad.array, offset, extraInfo.array);
}
======================================
public boolean copyScratchpad(int, int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean copyScratchpad
sParams=int, int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean copyScratchpad4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean copyScratchpad
params=int,int,byte[],int
/**
* Copy all 8 bytes of the Sratch Pad to a certain page and offset in memory.
*
* @param targetPage the page to copy the data to
* @param targetPageOffset the offset into the page to copy to
* @param copy_auth byte[] containing write authorization
* @param authStart the offset into the copy_auth array where the authorization begins.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean copyScratchpad(int targetPage, int targetPageOffset, ByteArray copy_auth, int authStart)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).copyScratchpad(targetPage, targetPageOffset, copy_auth.array, authStart);
}
======================================
public boolean copyScratchpad(int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean copyScratchpad
sParams=int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean copyScratchpad2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean copyScratchpad
params=int,int
/**
* Copy all 8 bytes of the Sratch Pad to a certain page and offset in memory.
*
* @param targetPage the page to copy the data to
* @param targetPageOffset the offset into the page to copy to
* @param copy_auth byte[] containing write authorization
* @param authStart the offset into the copy_auth array where the authorization begins.
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean copyScratchpad(int targetPage, int targetPageOffset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).copyScratchpad(targetPage, targetPageOffset);
}
======================================
public boolean readMemoryPage(int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean readMemoryPage
sParams=int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean readMemoryPage3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean readMemoryPage
params=int,byte[],int
/**
* Reads a page of memory..
*
* @param page page number to read packet from
* @param pageData byte array to place read data into
* @param offset offset into readBuf to place data
*
* @throws OneWireIOException
* @throws OneWireException
*/
public boolean readMemoryPage(int page, ByteArray pageData, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).readMemoryPage(page, pageData.array, offset);
}
======================================
public boolean readAuthenticatedPage(int, byte[], int, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean readAuthenticatedPage
sParams=int, byte[], int, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean readAuthenticatedPage5
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer33
methodName=public boolean readAuthenticatedPage
params=int,byte[],int,byte[],int
/**
* <p>Reads and authenticates a page. See <code>readMemoryPage()</code> for a description
* of page numbers and their contents. This method will also generate a signature for the
* selected page, used in the authentication of roving (User) iButtons.</p>
*
* @param pageNum page number to read and authenticate
* @param pagedata array for the page data.
* @param offset offset to copy into the array
* @param computed_mac array for the MAC returned by the device.
* @param macStart offset to copy into the mac array
*
* @return <code>true</code> if successful, <code>false</code> if the operation
* failed while waiting for the DS1963S's output to alternate
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public boolean readAuthenticatedPage(int page, ByteArray pagedata, int offset, ByteArray computed_mac, int macStart)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer33)objectInstance).readAuthenticatedPage(page, pagedata.array, offset, computed_mac.array, macStart);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer37.java
superClassName=java.lang.Object
-->OneWireContainer37 implements com.dalsemi.onewire.container.PasswordContainer
OneWireContainer37 implements com.dalsemi.onewire.container.PasswordContainer
======================================
public static final byte WRITE_SCRATCHPAD_COMMAND
======================================
public static final byte READ_SCRATCHPAD_COMMAND
======================================
public static final byte COPY_SCRATCHPAD_PW_COMMAND
======================================
public static final byte READ_MEMORY_PW_COMMAND
======================================
public static final byte VERIFY_PSW_COMMAND
======================================
public static final byte READ_VERSION
======================================
public static final int PASSWORD_CONTROL_REGISTER
======================================
public static final int READ_ACCESS_PASSWORD
======================================
public static final int READ_WRITE_ACCESS_PASSWORD
======================================
public static final int READ_WRITE_PWD
======================================
public static final int READ_ONLY_PWD
======================================
public synchronized void setSpeedCheck(boolean)
sMethodName=public synchronized void setSpeedCheck
sParams=boolean
sThrows=
tempMethodName=public synchronized void setSpeedCheck1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public synchronized void setSpeedCheck
params=boolean
/**
* Directs the container to avoid the calls to doSpeed() in methods that communicate
* with the Thermocron. To ensure that all parts can talk to the 1-Wire bus
* at their desired speed, each method contains a call
* to <code>doSpeed()</code>. However, this is an expensive operation.
* If a user manages the bus speed in an
* application, call this method with <code>doSpeedCheck</code>
* as <code>false</code>. The default behavior is
* to call <code>doSpeed()</code>.
*
* @param doSpeedCheck <code>true</code> for <code>doSpeed()</code> to be called before every
* 1-Wire bus access, <code>false</code> to skip this expensive call
*
* @see OneWireContainer#doSpeed()
*/
public synchronized void setSpeedCheck(boolean doSpeedCheck)
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setSpeedCheck(doSpeedCheck);
}
======================================
public int getReadOnlyPasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadOnlyPasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadOnlyPasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public int getReadOnlyPasswordLength
params=
/**
* Retrieves the password length for the read-only password.
*
* @return the read-only password length
*
* @throws OneWireException
*/
public int getReadOnlyPasswordLength()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getReadOnlyPasswordLength();
}
======================================
public int getReadWritePasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadWritePasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadWritePasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public int getReadWritePasswordLength
params=
/**
* Retrieves the password length for the read/write password.
*
* @return the read/write password length
*
* @throws OneWireException
*/
public int getReadWritePasswordLength()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getReadWritePasswordLength();
}
======================================
public int getWriteOnlyPasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getWriteOnlyPasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getWriteOnlyPasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public int getWriteOnlyPasswordLength
params=
/**
* Retrieves the password length for the write-only password.
*
* @return the write-only password length
*
* @throws OneWireException
*/
public int getWriteOnlyPasswordLength()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getWriteOnlyPasswordLength();
}
======================================
public int getReadOnlyPasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadOnlyPasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadOnlyPasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public int getReadOnlyPasswordAddress
params=
/**
* Retrieves the address the read only password starts
*
* @return the address of the read only password
*/
public int getReadOnlyPasswordAddress()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getReadOnlyPasswordAddress();
}
======================================
public int getReadWritePasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadWritePasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadWritePasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public int getReadWritePasswordAddress
params=
/**
* Retrieves the address the read/write password starts
*
* @return the address of the read/write password
*/
public int getReadWritePasswordAddress()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getReadWritePasswordAddress();
}
======================================
public int getWriteOnlyPasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getWriteOnlyPasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getWriteOnlyPasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public int getWriteOnlyPasswordAddress
params=
/**
* Retrieves the address the write only password starts
*
* @return the address of the write only password
*/
public int getWriteOnlyPasswordAddress()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getWriteOnlyPasswordAddress();
}
======================================
public boolean hasReadOnlyPassword()
sMethodName=public boolean hasReadOnlyPassword
sParams=
sThrows=
tempMethodName=public boolean hasReadOnlyPassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean hasReadOnlyPassword
params=
/**
* Tells whether the device has a read only password.
*
* @return if the device has a read only password
*/
public boolean hasReadOnlyPassword()
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).hasReadOnlyPassword();
}
======================================
public boolean hasReadWritePassword()
sMethodName=public boolean hasReadWritePassword
sParams=
sThrows=
tempMethodName=public boolean hasReadWritePassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean hasReadWritePassword
params=
/**
* Tells whether the device has a read/write password.
*
* @return if the device has a read/write password
*/
public boolean hasReadWritePassword()
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).hasReadWritePassword();
}
======================================
public boolean hasWriteOnlyPassword()
sMethodName=public boolean hasWriteOnlyPassword
sParams=
sThrows=
tempMethodName=public boolean hasWriteOnlyPassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean hasWriteOnlyPassword
params=
/**
* Tells whether the device has a write only password.
*
* @return if the device has a write only password
*/
public boolean hasWriteOnlyPassword()
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).hasWriteOnlyPassword();
}
======================================
public boolean getDeviceReadOnlyPasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceReadOnlyPasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceReadOnlyPasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean getDeviceReadOnlyPasswordEnable
params=
/**
* Tells whether the read only password has been enabled.
*
* @return the enabled status of the read only password
*
* @throws OneWireException
*/
public boolean getDeviceReadOnlyPasswordEnable()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getDeviceReadOnlyPasswordEnable();
}
======================================
public boolean getDeviceReadWritePasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceReadWritePasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceReadWritePasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean getDeviceReadWritePasswordEnable
params=
/**
* Tells whether the read/write password has been enabled.
*
* @return the enabled status of the read/write password
*
* @throws OneWireException
*/
public boolean getDeviceReadWritePasswordEnable()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getDeviceReadWritePasswordEnable();
}
======================================
public boolean getDeviceWriteOnlyPasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceWriteOnlyPasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceWriteOnlyPasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean getDeviceWriteOnlyPasswordEnable
params=
/**
* Tells whether the write only password has been enabled.
*
* @return the enabled status of the write only password
*
* @throws OneWireException
*/
public boolean getDeviceWriteOnlyPasswordEnable()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getDeviceWriteOnlyPasswordEnable();
}
======================================
public boolean hasSinglePasswordEnable()
sMethodName=public boolean hasSinglePasswordEnable
sParams=
sThrows=
tempMethodName=public boolean hasSinglePasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean hasSinglePasswordEnable
params=
/**
* Returns true if this device has the capability to enable one type of password
* while leaving another type disabled. i.e. if the device has Read-Only password
* protection and Write-Only password protection, this method indicates whether or
* not you can enable Read-Only protection while leaving the Write-Only protection
* disabled.
*
* @return <code>true</code> if the device has the capability to enable one type
* of password while leaving another type disabled.
*/
public boolean hasSinglePasswordEnable()
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).hasSinglePasswordEnable();
}
======================================
public void setDevicePasswordEnableAll(boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDevicePasswordEnableAll
sParams=boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDevicePasswordEnableAll1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setDevicePasswordEnableAll
params=boolean
/**
* <p>Enables/Disables passwords for this device. If the part has more than one
* type of password (Read-Only, Write-Only, or Read/Write), all passwords
* will be enabled. This function is equivalent to the following:
* <code> owc37.setDevicePasswordEnable(
* owc37.hasReadOnlyPassword(),
* owc37.hasReadWritePassword(),
* owc37.hasWriteOnlyPassword() ); </code></p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</P>
*
* <P><B>
* WARNING: Enabling passwords requires that both the read password and the
* read/write password be re-written to the part. Before calling this method,
* you should set the container read password and read/write password values.
* This will ensure that the correct value is written into the part.
* </B></P>
*
* @param enableAll if <code>true</code>, all passwords are enabled. Otherwise,
* all passwords are disabled.
*/
public void setDevicePasswordEnableAll(boolean enableAll)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setDevicePasswordEnableAll(enableAll);
}
======================================
public void setDeviceReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setDeviceReadOnlyPassword
params=byte[],int
/**
* Attempts to change the value of the read password in the device's
* register. For this to be successful, either passwords must be disabled,
* or the read/write password for this container must be set and must match
* the value of the read/write password in the device's register.
*
* <P><B>
* WARNING: Setting the read password requires that both the read password
* and the read/write password be written to the part. Before calling this
* method, you should set the container read/write password value.
* This will ensure that the correct value is written into the part.
* </B></P>
*
* @param password the new value of 8-byte device read password, to be copied
* into the devices register.
* @param offset the offset to start copying the 8 bytes from the array
*/
public void setDeviceReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setDeviceReadOnlyPassword(password.array, offset);
}
======================================
public void setDeviceReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setDeviceReadWritePassword
params=byte[],int
/**
* Attempts to change the value of the read/write password in the device's
* register. For this to be successful, either passwords must be disabled,
* or the read/write password for this container must be set and must match
* the current value of the read/write password in the device's register.
*
* @param password the new value of 8-byte device read/write password, to be
* copied into the devices register.
* @param offset the offset to start copying the 8 bytes from the array
*/
public void setDeviceReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setDeviceReadWritePassword(password.array, offset);
}
======================================
public void setDeviceWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setDeviceWriteOnlyPassword
params=byte[],int
/**
* Attempts to change the value of the write only password in the device's
* register. For this to be successful, either passwords must be disabled,
* or the read/write password for this container must be set and must match
* the current value of the read/write password in the device's register.
*
* @param password the new value of 8-byte device read/write password, to be
* copied into the devices register.
* @param offset the offset to start copying the 8 bytes from the array
*/
public void setDeviceWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setDeviceWriteOnlyPassword(password.array, offset);
}
======================================
public void setDevicePasswordEnable(boolean, boolean, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDevicePasswordEnable
sParams=boolean, boolean, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDevicePasswordEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setDevicePasswordEnable
params=boolean,boolean,boolean
/**
* <P>Enables/disables passwords by writing to the devices password control
* register. For this to be successful, either passwords must be disabled,
* or the read/write password for this container must be set and must match
* the current value of the read/write password in the device's register.</P>
*
* <P><B>
* WARNING: Enabling passwords requires that both the read password and the
* read/write password be re-written to the part. Before calling this method,
* you should set the container read password and read/write password values.
* This will ensure that the correct value is written into the part.
* </B></P>
*
* @param enable if <code>true</code>, device passwords will be enabled.
* All subsequent read and write operations will require that the
* passwords for the container are set.
*/
public void setDevicePasswordEnable(boolean enableReadOnly, boolean enableReadWrite, boolean enableWriteOnly)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setDevicePasswordEnable(enableReadOnly, enableReadWrite, enableWriteOnly);
}
======================================
public void setContainerReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setContainerReadOnlyPassword
params=byte[],int
/**
* Sets the value of the read password for the container. This is the value
* used by this container to read the memory of the device. If this password
* does not match the value of the read password in the device's password
* register, all subsequent read operations will fail.
*
* @param password New 8-byte value of container's read password.
* @param offset Index to start copying the password from the array.
*/
public void setContainerReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setContainerReadOnlyPassword(password.array, offset);
}
======================================
public void getContainerReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void getContainerReadOnlyPassword
params=byte[],int
/**
* Returns the read password used by this container to read the memory
* of the device.
*
* @param password Holds the 8-byte value of container's read password.
* @param offset Index to start copying the password into the array.
*/
public void getContainerReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getContainerReadOnlyPassword(password.array, offset);
}
======================================
public boolean isContainerReadOnlyPasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerReadOnlyPasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerReadOnlyPasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean isContainerReadOnlyPasswordSet
params=
/**
* Returns true if the container's read password has been set. The return
* value is not affected by whether or not the read password of the container
* actually matches the value in the device's password register.
*
* @return <code>true</code> if the container's read password has been set
*/
public boolean isContainerReadOnlyPasswordSet()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).isContainerReadOnlyPasswordSet();
}
======================================
public void setContainerReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setContainerReadWritePassword
params=byte[],int
/**
* Sets the value of the read/write password for the container. This is the
* value used by this container to read and write to the memory of the
* device. If this password does not match the value of the read/write
* password in the device's password register, all subsequent read and write
* operations will fail.
*
* @param password New 8-byte value of container's read/write password.
* @param offset Index to start copying the password from the array.
*/
public void setContainerReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setContainerReadWritePassword(password.array, offset);
}
======================================
public void getContainerReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void getContainerReadWritePassword
params=byte[],int
/**
* Returns the read/write password used by this container to read from and
* write to the memory of the device.
*
* @param password Holds the 8-byte value of container's read/write password.
* @param offset Index to start copying the password into the array.
*/
public void getContainerReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getContainerReadWritePassword(password.array, offset);
}
======================================
public boolean isContainerReadWritePasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerReadWritePasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerReadWritePasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean isContainerReadWritePasswordSet
params=
/**
* Returns true if the container's read/write password has been set. The
* return value is not affected by whether or not the read/write password of
* the container actually matches the value in the device's password
* register.
*
* @return <code>true</code> if the container's read/write password has been
* set.
*/
public boolean isContainerReadWritePasswordSet()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).isContainerReadWritePasswordSet();
}
======================================
public void setContainerWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void setContainerWriteOnlyPassword
params=byte[],int
/**
* Sets the value of the read/write password for the container. This is the
* value used by this container to read and write to the memory of the
* device. If this password does not match the value of the read/write
* password in the device's password register, all subsequent read and write
* operations will fail.
*
* @param password New 8-byte value of container's read/write password.
* @param offset Index to start copying the password from the array.
*/
public void setContainerWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).setContainerWriteOnlyPassword(password.array, offset);
}
======================================
public void getContainerWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public void getContainerWriteOnlyPassword
params=byte[],int
/**
* Returns the read/write password used by this container to read from and
* write to the memory of the device.
*
* @param password Holds the 8-byte value of container's read/write password.
* @param offset Index to start copying the password into the array.
*/
public void getContainerWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).getContainerWriteOnlyPassword(password.array, offset);
}
======================================
public boolean isContainerWriteOnlyPasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerWriteOnlyPasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerWriteOnlyPasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean isContainerWriteOnlyPasswordSet
params=
/**
* Returns true if the container's read/write password has been set. The
* return value is not affected by whether or not the read/write password of
* the container actually matches the value in the device's password
* register.
*
* @return <code>true</code> if the container's read/write password has been
* set.
*/
public boolean isContainerWriteOnlyPasswordSet()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).isContainerWriteOnlyPasswordSet();
}
======================================
public boolean verifyPassword(byte[], int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean verifyPassword
sParams=byte[], int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean verifyPassword3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean verifyPassword
params=byte[],int,int
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer37
methodName=public boolean verifyPassword
params=byte[],int,int
methodMatcher=/boolean verifyPassword *\((.*byte.*\[\].*int.*int.*)\)/
/**
* No documentation available for method
*/
public boolean verifyPassword(ByteArray password, int offset, int type)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer37)objectInstance).verifyPassword(password.array, offset, type);
}
-------------------------------------------------------------------
creating: owapi\OneWireContainer41.java
superClassName=java.lang.Object
-->OneWireContainer41 implements com.dalsemi.onewire.container.PasswordContainer,com.dalsemi.onewire.container.MissionContainer,com.dalsemi.onewire.container.ClockContainer,com.dalsemi.onewire.container.TemperatureContainer,com.dalsemi.onewire.container.ADContainer,com.dalsemi.onewire.container.HumidityContainer
OneWireContainer41 implements com.dalsemi.onewire.container.PasswordContainer
OneWireContainer41 implements com.dalsemi.onewire.container.MissionContainer
OneWireContainer41 implements com.dalsemi.onewire.container.ClockContainer
OneWireContainer41 implements com.dalsemi.onewire.container.TemperatureContainer
OneWireContainer41 implements com.dalsemi.onewire.container.ADContainer
OneWireContainer41 implements com.dalsemi.onewire.container.HumidityContainer
======================================
public static final int TEMPERATURE_CHANNEL
======================================
public static final int DATA_CHANNEL
======================================
public static final byte WRITE_SCRATCHPAD_COMMAND
======================================
public static final byte READ_SCRATCHPAD_COMMAND
======================================
public static final byte COPY_SCRATCHPAD_PW_COMMAND
======================================
public static final byte READ_MEMORY_CRC_PW_COMMAND
======================================
public static final byte CLEAR_MEMORY_PW_COMMAND
======================================
public static final byte START_MISSION_PW_COMMAND
======================================
public static final byte STOP_MISSION_PW_COMMAND
======================================
public static final byte FORCED_CONVERSION
======================================
public static final int RTC_TIME
======================================
public static final int RTC_DATE
======================================
public static final int SAMPLE_RATE
======================================
public static final int TEMPERATURE_LOW_ALARM_THRESHOLD
======================================
public static final int TEMPERATURE_HIGH_ALARM_THRESHOLD
======================================
public static final int DATA_LOW_ALARM_THRESHOLD
======================================
public static final int DATA_HIGH_ALARM_THRESHOLD
======================================
public static final int LAST_TEMPERATURE_CONVERSION_LSB
======================================
public static final int LAST_TEMPERATURE_CONVERSION_MSB
======================================
public static final int LAST_DATA_CONVERSION_LSB
======================================
public static final int LAST_DATA_CONVERSION_MSB
======================================
public static final int TEMPERATURE_CONTROL_REGISTER
======================================
public static final byte TCR_BIT_ENABLE_TEMPERATURE_LOW_ALARM
======================================
public static final byte TCR_BIT_ENABLE_TEMPERATURE_HIGH_ALARM
======================================
public static final int DATA_CONTROL_REGISTER
======================================
public static final byte DCR_BIT_ENABLE_DATA_LOW_ALARM
======================================
public static final byte DCR_BIT_ENABLE_DATA_HIGH_ALARM
======================================
public static final int RTC_CONTROL_REGISTER
======================================
public static final byte RCR_BIT_ENABLE_OSCILLATOR
======================================
public static final byte RCR_BIT_ENABLE_HIGH_SPEED_SAMPLE
======================================
public static final int MISSION_CONTROL_REGISTER
======================================
public static final byte MCR_BIT_ENABLE_TEMPERATURE_LOGGING
======================================
public static final byte MCR_BIT_ENABLE_DATA_LOGGING
======================================
public static final byte MCR_BIT_TEMPERATURE_RESOLUTION
======================================
public static final byte MCR_BIT_DATA_RESOLUTION
======================================
public static final byte MCR_BIT_ENABLE_ROLLOVER
======================================
public static final byte MCR_BIT_START_MISSION_ON_TEMPERATURE_ALARM
======================================
public static final int ALARM_STATUS_REGISTER
======================================
public static final byte ASR_BIT_TEMPERATURE_LOW_ALARM
======================================
public static final byte ASR_BIT_TEMPERATURE_HIGH_ALARM
======================================
public static final byte ASR_BIT_DATA_LOW_ALARM
======================================
public static final byte ASR_BIT_DATA_HIGH_ALARM
======================================
public static final byte ASR_BIT_BATTERY_ON_RESET
======================================
public static final int GENERAL_STATUS_REGISTER
======================================
public static final byte GSR_BIT_SAMPLE_IN_PROGRESS
======================================
public static final byte GSR_BIT_MISSION_IN_PROGRESS
======================================
public static final byte GSR_BIT_CONVERSION_IN_PROGRESS
======================================
public static final byte GSR_BIT_MEMORY_CLEARED
======================================
public static final byte GSR_BIT_WAITING_FOR_TEMPERATURE_ALARM
======================================
public static final byte GSR_BIT_FORCED_CONVERSION_IN_PROGRESS
======================================
public static final int MISSION_START_DELAY
======================================
public static final int MISSION_TIMESTAMP_TIME
======================================
public static final int MISSION_TIMESTAMP_DATE
======================================
public static final int DEVICE_CONFIGURATION_BYTE
======================================
public static final byte DCB_DS2422
======================================
public static final byte DCB_DS1923
======================================
public static final byte DCB_DS1922L
======================================
public static final byte DCB_DS1922T
======================================
public static final int PASSWORD_CONTROL_REGISTER
======================================
public static final int READ_ACCESS_PASSWORD
======================================
public static final int READ_WRITE_ACCESS_PASSWORD
======================================
public static final int MISSION_SAMPLE_COUNT
======================================
public static final int DEVICE_SAMPLE_COUNT
======================================
public static final int MISSION_LOG_SIZE
======================================
public static final int ODD_MISSION_LOG_SIZE
======================================
public byte readDevice()[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readDevice
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public ByteArray readDevice0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public byte[] readDevice
params=
/**
* Retrieves the 1-Wire device sensor state. This state is
* returned as a byte array. Pass this byte array to the 'get'
* and 'set' methods. If the device state needs to be changed then call
* the 'writeDevice' to finalize the changes.
*
* @return 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public ByteArray readDevice()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new ByteArray().setupObject(((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).readDevice());
}
======================================
public void writeDevice(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writeDevice
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writeDevice1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void writeDevice
params=byte[]
/**
* Writes the 1-Wire device sensor state that
* have been changed by 'set' methods. Only the state registers that
* changed are updated. This is done by referencing a field information
* appended to the state data.
*
* @param state 1-Wire device sensor state
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void writeDevice(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).writeDevice(state.array);
}
======================================
public byte readByte(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte readByte
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public byte readByte1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public byte readByte
params=int
/**
* Reads a single byte from the DS1922. Note that the preferred manner
* of reading from the DS1922 Thermocron is through the <code>readDevice()</code>
* method or through the <code>MemoryBank</code> objects returned in the
* <code>getMemoryBanks()</code> method.
*
* @param memAddr the address to read from (in the range of 0x200-0x21F)
*
* @return the data byte read
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #readDevice()
* @see #getMemoryBanks()
*/
public byte readByte(int memAddr)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).readByte(memAddr);
}
======================================
public boolean getFlag(int, byte) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean getFlag
sParams=int, byte
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getFlag2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getFlag
params=int,byte
/**
* <p>Gets the status of the specified flag from the specified register.
* This method actually communicates with the DS1922. To improve
* performance if you intend to make multiple calls to this method,
* first call <code>readDevice()</code> and use the
* <code>getFlag(int, byte, byte[])</code> method instead.</p>
*
* <p>The DS1922 has several sets of flags.</p>
* <ul>
* <LI>Register: <CODE> TEMPERATURE_CONTROL_REGISTER </CODE><BR>
* Flags:
* <UL>
* <li><code> TCR_BIT_ENABLE_TEMPERATURE_LOW_ALARM </code></li>
* <li><code> TCR_BIT_ENABLE_TEMPERATURE_HIGH_ALARM </code></li>
* </UL>
* </LI>
* <LI>Register: <CODE> DATA_CONTROL_REGISTER </CODE><BR>
* Flags:
* <UL>
* <li><code> DCR_BIT_ENABLE_DATA_LOW_ALARM </code></li>
* <li><code> DCR_BIT_ENABLE_DATA_HIGH_ALARM </code></li>
* </UL>
* </LI>
* <LI>Register: <CODE> RTC_CONTROL_REGISTER </CODE><BR>
* Flags:
* <UL>
* <li><code> RCR_BIT_ENABLE_OSCILLATOR </code></li>
* <li><code> RCR_BIT_ENABLE_HIGH_SPEED_SAMPLE </code></li>
* </UL>
* </LI>
* <LI>Register: <CODE> MISSION_CONTROL_REGISTER </CODE><BR>
* Flags:
* <UL>
* <li><code> MCR_BIT_ENABLE_TEMPERATURE_LOGGING </code></li>
* <li><code> MCR_BIT_ENABLE_DATA_LOGGING </code></li>
* <li><code> MCR_BIT_TEMPERATURE_RESOLUTION </code></li>
* <li><code> MCR_BIT_DATA_RESOLUTION </code></li>
* <li><code> MCR_BIT_ENABLE_ROLLOVER </code></li>
* <li><code> MCR_BIT_START_MISSION_UPON_TEMPERATURE_ALARM </code></li>
* </UL>
* </LI>
* <LI>Register: <CODE> ALARM_STATUS_REGISTER </CODE><BR>
* Flags:
* <UL>
* <li><code> ASR_BIT_TEMPERATURE_LOW_ALARM </code></li>
* <li><code> ASR_BIT_TEMPERATURE_HIGH_ALARM </code></li>
* <li><code> ASR_BIT_DATA_LOW_ALARM </code></li>
* <li><code> ASR_BIT_DATA_HIGH_ALARM </code></li>
* <li><code> ASR_BIT_BATTERY_ON_RESET </code></li>
* </UL>
* </LI>
* <LI>Register: <CODE> GENERAL_STATUS_REGISTER </CODE><BR>
* Flags:
* <UL>
* <li><code> GSR_BIT_SAMPLE_IN_PROGRESS </code></li>
* <li><code> GSR_BIT_MISSION_IN_PROGRESS </code></li>
* <li><code> GSR_BIT_MEMORY_CLEARED </code></li>
* <li><code> GSR_BIT_WAITING_FOR_TEMPERATURE_ALARM </code></li>
* </UL>
* </LI>
* </ul>
*
* @param register address of register containing the flag (see above for available options)
* @param bitMask the flag to read (see above for available options)
*
* @return the status of the flag, where <code>true</code>
* signifies a "1" and <code>false</code> signifies a "0"
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getFlag(int,byte,byte[])
* @see #readDevice()
* @see #setFlag(int,byte,boolean)
*/
public boolean getFlag(int register, byte bitMask)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getFlag(register, bitMask);
}
======================================
public boolean getFlag(int, byte, byte[])
sMethodName=public boolean getFlag
sParams=int, byte, byte[]
sThrows=
tempMethodName=public boolean getFlag3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getFlag
params=int,byte,byte[]
/**
* <p>Gets the status of the specified flag from the specified register.
* This method is the preferred manner of reading the control and
* status flags.</p>
*
* <p>For more information on valid values for the <code>bitMask</code>
* parameter, see the {@link #getFlag(int,byte) getFlag(int,byte)} method.</p>
*
* @param register address of register containing the flag (see
* {@link #getFlag(int,byte) getFlag(int,byte)} for available options)
* @param bitMask the flag to read (see {@link #getFlag(int,byte) getFlag(int,byte)}
* for available options)
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the status of the flag, where <code>true</code>
* signifies a "1" and <code>false</code> signifies a "0"
*
* @see #getFlag(int,byte)
* @see #readDevice()
* @see #setFlag(int,byte,boolean,byte[])
*/
public boolean getFlag(int register, byte bitMask, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getFlag(register, bitMask, state.array);
}
======================================
public void setFlag(int, byte, boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void setFlag
sParams=int, byte, boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void setFlag3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setFlag
params=int,byte,boolean
/**
* <p>Sets the status of the specified flag in the specified register.
* If a mission is in progress a <code>OneWireIOException</code> will be thrown
* (one cannot write to the registers while a mission is commencing). This method
* actually communicates with the DS1922. To improve
* performance if you intend to make multiple calls to this method,
* first call <code>readDevice()</code> and use the
* <code>setFlag(int,byte,boolean,byte[])</code> method instead.</p>
*
* <p>For more information on valid values for the <code>bitMask</code>
* parameter, see the {@link #getFlag(int,byte) getFlag(int,byte)} method.</p>
*
* @param register address of register containing the flag (see
* {@link #getFlag(int,byte) getFlag(int,byte)} for available options)
* @param bitMask the flag to read (see {@link #getFlag(int,byte) getFlag(int,byte)}
* for available options)
* @param flagValue new value for the flag (<code>true</code> is logic "1")
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* In the case of the DS1922, this could also be due to a
* currently running mission.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getFlag(int,byte)
* @see #getFlag(int,byte,byte[])
* @see #setFlag(int,byte,boolean,byte[])
* @see #readDevice()
*/
public void setFlag(int register, byte bitMask, boolean flagValue)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setFlag(register, bitMask, flagValue);
}
======================================
public void setFlag(int, byte, boolean, byte[])
sMethodName=public void setFlag
sParams=int, byte, boolean, byte[]
sThrows=
tempMethodName=public void setFlag4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setFlag
params=int,byte,boolean,byte[]
/**
* <p>Sets the status of the specified flag in the specified register.
* If a mission is in progress a <code>OneWireIOException</code> will be thrown
* (one cannot write to the registers while a mission is commencing). This method
* is the preferred manner of setting the DS1922 status and control flags.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.</p>
*
* <p>For more information on valid values for the <code>bitMask</code>
* parameter, see the {@link #getFlag(int,byte) getFlag(int,byte)} method.</p>
*
* @param register address of register containing the flag (see
* {@link #getFlag(int,byte) getFlag(int,byte)} for available options)
* @param bitMask the flag to read (see {@link #getFlag(int,byte) getFlag(int,byte)}
* for available options)
* @param flagValue new value for the flag (<code>true</code> is logic "1")
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #getFlag(int,byte)
* @see #getFlag(int,byte,byte[])
* @see #setFlag(int,byte,boolean)
* @see #readDevice()
* @see #writeDevice(byte[])
*/
public void setFlag(int register, byte bitMask, boolean flagValue, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setFlag(register, bitMask, flagValue, state.array);
}
======================================
public com.dalsemi.onewire.container.MemoryBankScratchCRCPW getScratchpadMemoryBank()
sMethodName=public com.dalsemi.onewire.container.MemoryBankScratchCRCPW getScratchpadMemoryBank
sParams=
sThrows=
tempMethodName=public MemoryBankScratchCRCPW getScratchpadMemoryBank0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public com.dalsemi.onewire.container.MemoryBankScratchCRCPW getScratchpadMemoryBank
params=
/**
* Returns instance of the memory bank representing this device's
* scratchpad.
*
* @return scratchpad memory bank
*/
public MemoryBankScratchCRCPW getScratchpadMemoryBank()
{
return new MemoryBankScratchCRCPW(((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getScratchpadMemoryBank());
}
======================================
public com.dalsemi.onewire.container.MemoryBankNVCRCPW getUserDataMemoryBank()
sMethodName=public com.dalsemi.onewire.container.MemoryBankNVCRCPW getUserDataMemoryBank
sParams=
sThrows=
tempMethodName=public MemoryBankNVCRCPW getUserDataMemoryBank0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public com.dalsemi.onewire.container.MemoryBankNVCRCPW getUserDataMemoryBank
params=
/**
* Returns instance of the memory bank representing this device's
* general-purpose user data memory.
*
* @return user data memory bank
*/
public MemoryBankNVCRCPW getUserDataMemoryBank()
{
return new MemoryBankNVCRCPW(((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getUserDataMemoryBank());
}
======================================
public com.dalsemi.onewire.container.MemoryBankNVCRCPW getDataLogMemoryBank()
sMethodName=public com.dalsemi.onewire.container.MemoryBankNVCRCPW getDataLogMemoryBank
sParams=
sThrows=
tempMethodName=public MemoryBankNVCRCPW getDataLogMemoryBank0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public com.dalsemi.onewire.container.MemoryBankNVCRCPW getDataLogMemoryBank
params=
/**
* Returns instance of the memory bank representing this device's
* data log.
*
* @return data log memory bank
*/
public MemoryBankNVCRCPW getDataLogMemoryBank()
{
return new MemoryBankNVCRCPW(((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getDataLogMemoryBank());
}
======================================
public com.dalsemi.onewire.container.MemoryBankNVCRCPW getRegisterMemoryBank()
sMethodName=public com.dalsemi.onewire.container.MemoryBankNVCRCPW getRegisterMemoryBank
sParams=
sThrows=
tempMethodName=public MemoryBankNVCRCPW getRegisterMemoryBank0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public com.dalsemi.onewire.container.MemoryBankNVCRCPW getRegisterMemoryBank
params=
/**
* Returns instance of the memory bank representing this device's
* special function registers.
*
* @return register memory bank
*/
public MemoryBankNVCRCPW getRegisterMemoryBank()
{
return new MemoryBankNVCRCPW(((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getRegisterMemoryBank());
}
======================================
public byte getDeviceConfigByte() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public byte getDeviceConfigByte
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public byte getDeviceConfigByte0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public byte getDeviceConfigByte
params=
/**
* Returns the Device Configuration Byte, which specifies whether or
* not this device is a DS1922, DS1923, or DS2422.
*
* @return the Device Configuration Byte
* @throws OneWireIOException
* @throws OneWireException
*/
public byte getDeviceConfigByte()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getDeviceConfigByte();
}
======================================
public synchronized void setSpeedCheck(boolean)
sMethodName=public synchronized void setSpeedCheck
sParams=boolean
sThrows=
tempMethodName=public synchronized void setSpeedCheck1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public synchronized void setSpeedCheck
params=boolean
/**
* Directs the container to avoid the calls to doSpeed() in methods that communicate
* with the DS1922/DS2422. To ensure that all parts can talk to the 1-Wire bus
* at their desired speed, each method contains a call
* to <code>doSpeed()</code>. However, this is an expensive operation.
* If a user manages the bus speed in an
* application, call this method with <code>doSpeedCheck</code>
* as <code>false</code>. The default behavior is
* to call <code>doSpeed()</code>.
*
* @param doSpeedCheck <code>true</code> for <code>doSpeed()</code> to be called before every
* 1-Wire bus access, <code>false</code> to skip this expensive call
*
* @see OneWireContainer#doSpeed()
*/
public synchronized void setSpeedCheck(boolean doSpeedCheck)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setSpeedCheck(doSpeedCheck);
}
======================================
public void stopMission() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void stopMission
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void stopMission0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void stopMission
params=
/**
* Stops the currently running mission.
*
*/
public void stopMission()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).stopMission();
}
======================================
public void startMission() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void startMission
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void startMission0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void startMission
params=
/**
* Starts a new mission. Assumes all parameters have been set by either
* writing directly to the device registers, or by calling other setup
* methods.
*/
public void startMission()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).startMission();
}
======================================
public void clearMemory() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void clearMemory
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void clearMemory0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void clearMemory
params=
/**
* Erases the log memory from this missioning device.
*/
public void clearMemory()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).clearMemory();
}
======================================
public int getReadOnlyPasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadOnlyPasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadOnlyPasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getReadOnlyPasswordLength
params=
/**
* Returns the length in bytes of the Read-Only password.
*
* @return the length in bytes of the Read-Only password.
*/
public int getReadOnlyPasswordLength()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getReadOnlyPasswordLength();
}
======================================
public int getReadWritePasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadWritePasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadWritePasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getReadWritePasswordLength
params=
/**
* Returns the length in bytes of the Read/Write password.
*
* @return the length in bytes of the Read/Write password.
*/
public int getReadWritePasswordLength()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getReadWritePasswordLength();
}
======================================
public int getWriteOnlyPasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getWriteOnlyPasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getWriteOnlyPasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getWriteOnlyPasswordLength
params=
/**
* Returns the length in bytes of the Write-Only password.
*
* @return the length in bytes of the Write-Only password.
*/
public int getWriteOnlyPasswordLength()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getWriteOnlyPasswordLength();
}
======================================
public int getReadOnlyPasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadOnlyPasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadOnlyPasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getReadOnlyPasswordAddress
params=
/**
* Returns the absolute address of the memory location where
* the Read-Only password is written.
*
* @return the absolute address of the memory location where
* the Read-Only password is written.
*/
public int getReadOnlyPasswordAddress()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getReadOnlyPasswordAddress();
}
======================================
public int getReadWritePasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadWritePasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadWritePasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getReadWritePasswordAddress
params=
/**
* Returns the absolute address of the memory location where
* the Read/Write password is written.
*
* @return the absolute address of the memory location where
* the Read/Write password is written.
*/
public int getReadWritePasswordAddress()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getReadWritePasswordAddress();
}
======================================
public int getWriteOnlyPasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getWriteOnlyPasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getWriteOnlyPasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getWriteOnlyPasswordAddress
params=
/**
* Returns the absolute address of the memory location where
* the Write-Only password is written.
*
* @return the absolute address of the memory location where
* the Write-Only password is written.
*/
public int getWriteOnlyPasswordAddress()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getWriteOnlyPasswordAddress();
}
======================================
public boolean hasReadOnlyPassword()
sMethodName=public boolean hasReadOnlyPassword
sParams=
sThrows=
tempMethodName=public boolean hasReadOnlyPassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasReadOnlyPassword
params=
/**
* Returns true if this device has a Read-Only password.
* If false, all other functions dealing with the Read-Only
* password will throw an exception if called.
*
* @return <code>true</code> always, since DS1922 has Read-Only password.
*/
public boolean hasReadOnlyPassword()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasReadOnlyPassword();
}
======================================
public boolean hasReadWritePassword()
sMethodName=public boolean hasReadWritePassword
sParams=
sThrows=
tempMethodName=public boolean hasReadWritePassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasReadWritePassword
params=
/**
* Returns true if this device has a Read/Write password.
* If false, all other functions dealing with the Read/Write
* password will throw an exception if called.
*
* @return <code>true</code> always, since DS1922 has Read/Write password.
*/
public boolean hasReadWritePassword()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasReadWritePassword();
}
======================================
public boolean hasWriteOnlyPassword()
sMethodName=public boolean hasWriteOnlyPassword
sParams=
sThrows=
tempMethodName=public boolean hasWriteOnlyPassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasWriteOnlyPassword
params=
/**
* Returns true if this device has a Write-Only password.
* If false, all other functions dealing with the Write-Only
* password will throw an exception if called.
*
* @return <code>false</code> always, since DS1922 has no Write-Only password.
*/
public boolean hasWriteOnlyPassword()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasWriteOnlyPassword();
}
======================================
public boolean getDeviceReadOnlyPasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceReadOnlyPasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceReadOnlyPasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getDeviceReadOnlyPasswordEnable
params=
/**
* Returns true if the device's Read-Only password has been enabled.
*
* @return <code>true</code> if the device's Read-Only password has been enabled.
*/
public boolean getDeviceReadOnlyPasswordEnable()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getDeviceReadOnlyPasswordEnable();
}
======================================
public boolean getDeviceReadWritePasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceReadWritePasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceReadWritePasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getDeviceReadWritePasswordEnable
params=
/**
* Returns true if the device's Read/Write password has been enabled.
*
* @return <code>true</code> if the device's Read/Write password has been enabled.
*/
public boolean getDeviceReadWritePasswordEnable()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getDeviceReadWritePasswordEnable();
}
======================================
public boolean getDeviceWriteOnlyPasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceWriteOnlyPasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceWriteOnlyPasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getDeviceWriteOnlyPasswordEnable
params=
/**
* Returns true if the device's Write-Only password has been enabled.
*
* @return <code>true</code> if the device's Write-Only password has been enabled.
*/
public boolean getDeviceWriteOnlyPasswordEnable()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getDeviceWriteOnlyPasswordEnable();
}
======================================
public boolean hasSinglePasswordEnable()
sMethodName=public boolean hasSinglePasswordEnable
sParams=
sThrows=
tempMethodName=public boolean hasSinglePasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasSinglePasswordEnable
params=
/**
* Returns true if this device has the capability to enable one type of password
* while leaving another type disabled. i.e. if the device has Read-Only password
* protection and Write-Only password protection, this method indicates whether or
* not you can enable Read-Only protection while leaving the Write-Only protection
* disabled.
*
* @return <code>true</code> if the device has the capability to enable one type
* of password while leaving another type disabled.
*/
public boolean hasSinglePasswordEnable()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasSinglePasswordEnable();
}
======================================
public void setDevicePasswordEnable(boolean, boolean, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDevicePasswordEnable
sParams=boolean, boolean, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDevicePasswordEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setDevicePasswordEnable
params=boolean,boolean,boolean
/**
* <p>Enables/Disables passwords for this Device. This method allows you to
* individually enable the different types of passwords for a particular
* device. If <code>hasSinglePasswordEnable()</code> returns true,
* you can selectively enable particular types of passwords. Otherwise,
* this method will throw an exception if all supported types are not
* enabled.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* <P><B>
* WARNING: Enabling passwords requires that both the read password and the
* read/write password be re-written to the part. Before calling this method,
* you should set the container read password and read/write password values.
* This will ensure that the correct value is written into the part.
* </B></P>
*
* @param enableReadOnly if <code>true</code> Read-Only passwords will be enabled.
* @param enableReadWrite if <code>true</code> Read/Write passwords will be enabled.
* @param enableWriteOnly if <code>true</code> Write-Only passwords will be enabled.
*/
public void setDevicePasswordEnable(boolean enableReadOnly, boolean enableReadWrite, boolean enableWriteOnly)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setDevicePasswordEnable(enableReadOnly, enableReadWrite, enableWriteOnly);
}
======================================
public void setDevicePasswordEnableAll(boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDevicePasswordEnableAll
sParams=boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDevicePasswordEnableAll1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setDevicePasswordEnableAll
params=boolean
/**
* <p>Enables/Disables passwords for this device. If the part has more than one
* type of password (Read-Only, Write-Only, or Read/Write), all passwords
* will be enabled. This function is equivalent to the following:
* <code> owc41.setDevicePasswordEnable(
* owc41.hasReadOnlyPassword(),
* owc41.hasReadWritePassword(),
* owc41.hasWriteOnlyPassword() ); </code></p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</P>
*
* <P><B>
* WARNING: Enabling passwords requires that both the read password and the
* read/write password be re-written to the part. Before calling this method,
* you should set the container read password and read/write password values.
* This will ensure that the correct value is written into the part.
* </B></P>
*
* @param enableAll if <code>true</code>, all passwords are enabled. Otherwise,
* all passwords are disabled.
*/
public void setDevicePasswordEnableAll(boolean enableAll)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setDevicePasswordEnableAll(enableAll);
}
======================================
public void setDeviceReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setDeviceReadOnlyPassword
params=byte[],int
/**
* <p>Writes the given password to the device's Read-Only password register. Note
* that this function does not enable the password, just writes the value to
* the appropriate memory location.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* <P><B>
* WARNING: Setting the read password requires that both the read password
* and the read/write password be written to the part. Before calling this
* method, you should set the container read/write password value.
* This will ensure that the correct value is written into the part.
* </B></P>
*
* @param password the new password to be written to the device's Read-Only
* password register. Length must be
* <code>(offset + getReadOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setDeviceReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setDeviceReadOnlyPassword(password.array, offset);
}
======================================
public void setDeviceReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setDeviceReadWritePassword
params=byte[],int
/**
* <p>Writes the given password to the device's Read/Write password register. Note
* that this function does not enable the password, just writes the value to
* the appropriate memory location.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* @param password the new password to be written to the device's Read-Write
* password register. Length must be
* <code>(offset + getReadWritePasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setDeviceReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setDeviceReadWritePassword(password.array, offset);
}
======================================
public void setDeviceWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setDeviceWriteOnlyPassword
params=byte[],int
/**
* <p>Writes the given password to the device's Write-Only password register. Note
* that this function does not enable the password, just writes the value to
* the appropriate memory location.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* @param password the new password to be written to the device's Write-Only
* password register. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setDeviceWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setDeviceWriteOnlyPassword(password.array, offset);
}
======================================
public void setContainerReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setContainerReadOnlyPassword
params=byte[],int
/**
* Sets the Read-Only password used by the API when reading from the
* device's memory. This password is not written to the device's
* Read-Only password register. It is the password used by the
* software for interacting with the device only.
*
* @param password the new password to be used by the API when
* reading from the device's memory. Length must be
* <code>(offset + getReadOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setContainerReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setContainerReadOnlyPassword(password.array, offset);
}
======================================
public void setContainerReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setContainerReadWritePassword
params=byte[],int
/**
* Sets the Read/Write password used by the API when reading from or
* writing to the device's memory. This password is not written to
* the device's Read/Write password register. It is the password used
* by the software for interacting with the device only.
*
* @param password the new password to be used by the API when
* reading from or writing to the device's memory. Length must be
* <code>(offset + getReadWritePasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setContainerReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setContainerReadWritePassword(password.array, offset);
}
======================================
public void setContainerWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setContainerWriteOnlyPassword
params=byte[],int
/**
* Sets the Write-Only password used by the API when writing to the
* device's memory. This password is not written to the device's
* Write-Only password register. It is the password used by the
* software for interacting with the device only.
*
* @param password the new password to be used by the API when
* writing to the device's memory. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setContainerWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setContainerWriteOnlyPassword(password.array, offset);
}
======================================
public boolean isContainerReadOnlyPasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerReadOnlyPasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerReadOnlyPasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isContainerReadOnlyPasswordSet
params=
/**
* Returns true if the password used by the API for reading from the
* device's memory has been set. The return value is not affected by
* whether or not the read password of the container actually matches
* the value in the device's password register
*
* @return <code>true</code> if the password used by the API for
* reading from the device's memory has been set.
*/
public boolean isContainerReadOnlyPasswordSet()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isContainerReadOnlyPasswordSet();
}
======================================
public boolean isContainerReadWritePasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerReadWritePasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerReadWritePasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isContainerReadWritePasswordSet
params=
/**
* Returns true if the password used by the API for reading from or
* writing to the device's memory has been set. The return value is
* not affected by whether or not the read/write password of the
* container actually matches the value in the device's password
* register.
*
* @return <code>true</code> if the password used by the API for
* reading from or writing to the device's memory has been set.
*/
public boolean isContainerReadWritePasswordSet()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isContainerReadWritePasswordSet();
}
======================================
public boolean isContainerWriteOnlyPasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerWriteOnlyPasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerWriteOnlyPasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isContainerWriteOnlyPasswordSet
params=
/**
* Returns true if the password used by the API for writing to the
* device's memory has been set. The return value is not affected by
* whether or not the write password of the container actually matches
* the value in the device's password register.
*
* @return <code>true</code> if the password used by the API for
* writing to the device's memory has been set.
*/
public boolean isContainerWriteOnlyPasswordSet()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isContainerWriteOnlyPasswordSet();
}
======================================
public void getContainerReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void getContainerReadOnlyPassword
params=byte[],int
/**
* Gets the Read-Only password used by the API when reading from the
* device's memory. This password is not read from the device's
* Read-Only password register. It is the password used by the
* software for interacting with the device only and must have been
* set using the <code>setContainerReadOnlyPassword</code> method.
*
* @param password array for holding the password that is used by the
* API when reading from the device's memory. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying into the given password array
*/
public void getContainerReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getContainerReadOnlyPassword(password.array, offset);
}
======================================
public void getContainerReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void getContainerReadWritePassword
params=byte[],int
/**
* Gets the Read/Write password used by the API when reading from or
* writing to the device's memory. This password is not read from
* the device's Read/Write password register. It is the password used
* by the software for interacting with the device only and must have
* been set using the <code>setContainerReadWritePassword</code> method.
*
* @param password array for holding the password that is used by the
* API when reading from or writing to the device's memory. Length must be
* <code>(offset + getReadWritePasswordLength)</code>
* @param offset the starting point for copying into the given password array
*/
public void getContainerReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getContainerReadWritePassword(password.array, offset);
}
======================================
public void getContainerWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void getContainerWriteOnlyPassword
params=byte[],int
/**
* Gets the Write-Only password used by the API when writing to the
* device's memory. This password is not read from the device's
* Write-Only password register. It is the password used by the
* software for interacting with the device only and must have been
* set using the <code>setContainerWriteOnlyPassword</code> method.
*
* @param password array for holding the password that is used by the
* API when writing to the device's memory. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying into the given password array
*/
public void getContainerWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getContainerWriteOnlyPassword(password.array, offset);
}
======================================
public java.lang.String getMissionLabel(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public java.lang.String getMissionLabel
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public java.lang.String getMissionLabel1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public java.lang.String getMissionLabel
params=int
/**
* Returns a default friendly label for each channel supported by this
* Missioning device.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return friendly label for the specified channel
*/
public java.lang.String getMissionLabel(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionLabel(channel);
}
======================================
public void setStartUponTemperatureAlarmEnable(boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setStartUponTemperatureAlarmEnable
sParams=boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setStartUponTemperatureAlarmEnable1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setStartUponTemperatureAlarmEnable
params=boolean
/**
* Sets the SUTA (Start Upon Temperature Alarm) bit in the Mission Control
* register. This method will communicate with the device directly.
*
* @param enable sets/clears the SUTA bit in the Mission Control register.
*/
public void setStartUponTemperatureAlarmEnable(boolean enable)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setStartUponTemperatureAlarmEnable(enable);
}
======================================
public void setStartUponTemperatureAlarmEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setStartUponTemperatureAlarmEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setStartUponTemperatureAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setStartUponTemperatureAlarmEnable
params=boolean,byte[]
/**
* Sets the SUTA (Start Upon Temperature Alarm) bit in the Mission Control
* register. This method will set the bit in the provided 'state' array,
* which should be acquired through a call to <code>readDevice()</code>.
* After updating the 'state', the method <code>writeDevice(byte[])</code>
* should be called to commit your changes.
*
* @param enable sets/clears the SUTA bit in the Mission Control register.
* @param state current state of the device returned from <code>readDevice()</code>
*/
public void setStartUponTemperatureAlarmEnable(boolean enable, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setStartUponTemperatureAlarmEnable(enable, state.array);
}
======================================
public boolean isStartUponTemperatureAlarmEnabled() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isStartUponTemperatureAlarmEnabled
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isStartUponTemperatureAlarmEnabled0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isStartUponTemperatureAlarmEnabled
params=
/**
* Returns true if the SUTA (Start Upon Temperature Alarm) bit in the
* Mission Control register is set. This method will communicate with
* the device to read the status of the SUTA bit.
*
* @return <code>true</code> if the SUTA bit in the Mission Control register is set.
*/
public boolean isStartUponTemperatureAlarmEnabled()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isStartUponTemperatureAlarmEnabled();
}
======================================
public boolean isStartUponTemperatureAlarmEnabled(byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isStartUponTemperatureAlarmEnabled
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isStartUponTemperatureAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isStartUponTemperatureAlarmEnabled
params=byte[]
/**
* Returns true if the SUTA (Start Upon Temperature Alarm) bit in the
* Mission Control register is set. This method will check for the bit
* in the provided 'state' array, which should be acquired through a call
* to <code>readDevice()</code>.
*
* @param state current state of the device returned from <code>readDevice()</code>
* @return <code>true</code> if the SUTA bit in the Mission Control register is set.
*/
public boolean isStartUponTemperatureAlarmEnabled(ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isStartUponTemperatureAlarmEnabled(state.array);
}
======================================
public boolean isMissionSUTA() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isMissionSUTA
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isMissionSUTA0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isMissionSUTA
params=
/**
* Returns true if the currently loaded mission results indicate
* that this mission has the SUTA bit enabled.
*
* @return <code>true</code> if the currently loaded mission
* results indicate that this mission has the SUTA bit
* enabled.
*/
public boolean isMissionSUTA()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isMissionSUTA();
}
======================================
public boolean isMissionWFTA() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isMissionWFTA
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isMissionWFTA0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isMissionWFTA
params=
/**
* Returns true if the currently loaded mission results indicate
* that this mission has the SUTA bit enabled and is still
* Waiting For Temperature Alarm (WFTA).
*
* @return <code>true</code> if the currently loaded mission
* results indicate that this mission has the SUTA bit
* enabled and is still Waiting For Temperature Alarm (WFTA).
*/
public boolean isMissionWFTA()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isMissionWFTA();
}
======================================
public void startNewMission(int, int, boolean, boolean, boolean[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void startNewMission
sParams=int, int, boolean, boolean, boolean[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void startNewMission5
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void startNewMission
params=int,int,boolean,boolean,boolean[]
/**
* Begins a new mission on this missioning device.
*
* @param sampleRate indicates the sampling rate, in seconds, that
* this missioning device should log samples.
* @param missionStartDelay indicates the amount of time, in seconds,
* that should pass before the mission begins.
* @param rolloverEnabled if <code>false</code>, this device will stop
* recording new samples after the data log is full. Otherwise,
* it will replace samples starting at the beginning.
* @param syncClock if <code>true</code>, the real-time clock of this
* missioning device will be synchronized with the current time
* according to this <code>java.util.Date</code>.
*/
public void startNewMission(int sampleRate, int missionStartDelay, boolean rolloverEnabled, boolean syncClock, boolean[] channelEnabled)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).startNewMission(sampleRate, missionStartDelay, rolloverEnabled, syncClock, channelEnabled);
}
======================================
public synchronized void loadMissionResults() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public synchronized void loadMissionResults
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public synchronized void loadMissionResults0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public synchronized void loadMissionResults
params=
/**
* Loads the results of the currently running mission. Must be called
* before all mission result/status methods.
*/
public synchronized void loadMissionResults()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).loadMissionResults();
}
======================================
public boolean isMissionLoaded()
sMethodName=public boolean isMissionLoaded
sParams=
sThrows=
tempMethodName=public boolean isMissionLoaded0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isMissionLoaded
params=
/**
* Returns true if the mission results have been loaded from the device.
*
* @return <code>true</code> if the mission results have been loaded.
*/
public boolean isMissionLoaded()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isMissionLoaded();
}
======================================
public int getNumberMissionChannels()
sMethodName=public int getNumberMissionChannels
sParams=
sThrows=
tempMethodName=public int getNumberMissionChannels0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getNumberMissionChannels
params=
/**
* Gets the number of channels supported by this Missioning device.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberOfMissionChannels()</code> - 1)].
*
* @return the number of channels
*/
public int getNumberMissionChannels()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getNumberMissionChannels();
}
======================================
public void setMissionChannelEnable(int, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionChannelEnable
sParams=int, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionChannelEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setMissionChannelEnable
params=int,boolean
/**
* Enables/disables the specified mission channel, indicating whether or
* not the channel's readings will be recorded in the mission log.
*
* @param channel the channel to enable/disable
* @param enable if true, the channel is enabled
*/
public void setMissionChannelEnable(int channel, boolean enable)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setMissionChannelEnable(channel, enable);
}
======================================
public void setMissionChannelEnable(int, boolean, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionChannelEnable
sParams=int, boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionChannelEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setMissionChannelEnable
params=int,boolean,byte[]
/**
* Enables/disables the specified mission channel, indicating whether or
* not the channel's readings will be recorded in the mission log.
*
* @param channel the channel to enable/disable
* @param enable if true, the channel is enabled
* @param state the state as returned from readDevice, for cached writes
*/
public void setMissionChannelEnable(int channel, boolean enable, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setMissionChannelEnable(channel, enable, state.array);
}
======================================
public boolean getMissionChannelEnable(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean getMissionChannelEnable
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean getMissionChannelEnable1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getMissionChannelEnable
params=int
/**
* Returns true if the specified mission channel is enabled, indicating
* that the channel's readings will be recorded in the mission log.
*
* @param channel the channel to enable/disable
* @param enable if true, the channel is enabled
*/
public boolean getMissionChannelEnable(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionChannelEnable(channel);
}
======================================
public boolean getMissionChannelEnable(int, byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean getMissionChannelEnable
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean getMissionChannelEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getMissionChannelEnable
params=int,byte[]
/**
* Returns true if the specified mission channel is enabled, indicating
* that the channel's readings will be recorded in the mission log.
*
* @param channel the channel to enable/disable
* @param enable if true, the channel is enabled
*/
public boolean getMissionChannelEnable(int channel, ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionChannelEnable(channel, state.array);
}
======================================
public int getMissionSampleRate(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleRate
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleRate1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getMissionSampleRate
params=int
/**
* Returns the amount of time, in seconds, between samples taken
* by this missioning device.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return time, in seconds, between sampling
*/
public int getMissionSampleRate(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionSampleRate(channel);
}
======================================
public int getMissionSampleCount(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleCount
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleCount1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getMissionSampleCount
params=int
/**
* Returns the number of samples available for the specified channel
* during the current mission.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return number of samples available for the specified channel
*/
public int getMissionSampleCount(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionSampleCount(channel);
}
======================================
public int getDeviceSampleCount() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getDeviceSampleCount
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getDeviceSampleCount0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getDeviceSampleCount
params=
/**
* Reads the device and returns the total number of samples logged
* since the first power-on of this device.
*
* @return the total number of samples logged since the first power-on
* of this device.
*/
public int getDeviceSampleCount()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getDeviceSampleCount();
}
======================================
public int getDeviceSampleCount(byte[]) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getDeviceSampleCount
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getDeviceSampleCount1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getDeviceSampleCount
params=byte[]
/**
* Returns the total number of samples logged since the first power-on
* of this device.
*
* @param state The current state of the device as return from <code>readDevice()</code>
* @return the total number of samples logged since the first power-on
* of this device.
*/
public int getDeviceSampleCount(ByteArray state)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getDeviceSampleCount(state.array);
}
======================================
public int getMissionSampleCountTotal(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleCountTotal
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleCountTotal1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getMissionSampleCountTotal
params=int
/**
* Returns the total number of samples taken for the specified channel
* during the current mission. This number can be more than the actual
* sample count if rollover is enabled and the log has been filled.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return number of samples taken for the specified channel
*/
public int getMissionSampleCountTotal(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionSampleCountTotal(channel);
}
======================================
public double getMissionSample(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionSample
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getMissionSample2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getMissionSample
params=int,int
/**
* Returns the sample as degrees celsius if temperature channel is specified
* or as percent relative humidity if data channel is specified. If the
* device is a DS2422 configuration (or A-D results are forced on the DS1923),
* the data channel will return samples as the voltage measured.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param sampleNum the sample number to return, between <code>0</code> and
* <code>(getMissionSampleCount(channel)-1)</code>
* @return the sample's value in degrees Celsius or percent RH.
*/
public double getMissionSample(int channel, int sampleNum)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionSample(channel, sampleNum);
}
======================================
public int getMissionSampleAsInteger(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public int getMissionSampleAsInteger
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public int getMissionSampleAsInteger2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getMissionSampleAsInteger
params=int,int
/**
* Returns the sample as an integer value. This value is not converted to
* degrees Celsius for temperature or to percent RH for Humidity. It is
* simply the 8 or 16 bits of digital data written in the mission log for
* this sample entry. It is up to the user to mask off the unused bits
* and convert this value to it's proper units. This method is primarily
* for users of the DS2422 who are using an input device which is not an
* A-D or have an A-D wholly dissimilar to the one specified in the
* datasheet.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param sampleNum the sample number to return, between <code>0</code> and
* <code>(getMissionSampleCount(channel)-1)</code>
* @return the sample as a whole integer
*/
public int getMissionSampleAsInteger(int channel, int sampleNum)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionSampleAsInteger(channel, sampleNum);
}
======================================
public long getMissionSampleTimeStamp(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public long getMissionSampleTimeStamp
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public String getMissionSampleTimeStamp2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public long getMissionSampleTimeStamp
params=int,int
/**
* Returns the time, in milliseconds, that each sample was taken by the
* current mission.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param sampleNum the sample number to return, between <code>0</code> and
* <code>(getMissionSampleCount(channel)-1)</code>
* @return the sample's timestamp, in milliseconds
*/
public String getMissionSampleTimeStamp(int channel, int sampleNum)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionSampleTimeStamp(channel, sampleNum);
}
======================================
public boolean isMissionRunning() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isMissionRunning
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isMissionRunning0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isMissionRunning
params=
/**
* Returns <code>true</code> if a mission is currently running.
* @return <code>true</code> if a mission is currently running.
*/
public boolean isMissionRunning()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isMissionRunning();
}
======================================
public boolean isMissionRolloverEnabled() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean isMissionRolloverEnabled
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean isMissionRolloverEnabled0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isMissionRolloverEnabled
params=
/**
* Returns <code>true</code> if a rollover is enabled.
* @return <code>true</code> if a rollover is enabled.
*/
public boolean isMissionRolloverEnabled()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isMissionRolloverEnabled();
}
======================================
public boolean hasMissionRolloverOccurred() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean hasMissionRolloverOccurred
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean hasMissionRolloverOccurred0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasMissionRolloverOccurred
params=
/**
* Returns <code>true</code> if a mission has rolled over.
* @return <code>true</code> if a mission has rolled over.
*/
public boolean hasMissionRolloverOccurred()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasMissionRolloverOccurred();
}
======================================
public void clearMissionResults() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void clearMissionResults
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void clearMissionResults0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void clearMissionResults
params=
/**
* Clears the mission results and erases the log memory from this
* missioning device.
*/
public void clearMissionResults()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).clearMissionResults();
}
======================================
public long getMissionTimeStamp(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public long getMissionTimeStamp
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public String getMissionTimeStamp1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public long getMissionTimeStamp
params=int
/**
* Returns the time, in milliseconds, that the mission began.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return time, in milliseconds, that the mission began
*/
public String getMissionTimeStamp(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionTimeStamp(channel);
}
======================================
public long getFirstSampleOffset(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public long getFirstSampleOffset
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public String getFirstSampleOffset1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public long getFirstSampleOffset
params=int
/**
* Returns the amount of time, in milliseconds, before the first sample
* occurred. If rollover disabled, or datalog didn't fill up, this
* will be 0.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return time, in milliseconds, before first sample occurred
*/
public String getFirstSampleOffset(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getFirstSampleOffset(channel);
}
======================================
public double getMissionResolutions(int)[] throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionResolutions
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double[] getMissionResolutions1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double[] getMissionResolutions
params=int
/**
* Returns all available resolutions for the specified mission channel.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return all available resolutions for the specified mission channel.
*/
public double[] getMissionResolutions(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionResolutions(channel);
}
======================================
public double getMissionResolution(int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionResolution
sParams=int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getMissionResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getMissionResolution
params=int
/**
* Returns the currently selected resolution for the specified
* channel.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return the currently selected resolution for the specified channel.
*/
public double getMissionResolution(int channel)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionResolution(channel);
}
======================================
public void setMissionResolution(int, double) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionResolution
sParams=int, double
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setMissionResolution
params=int,double
/**
* Sets the selected resolution for the specified channel.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param resolution the new resolution for the specified channel.
*/
public void setMissionResolution(int channel, double resolution)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setMissionResolution(channel, resolution);
}
======================================
public void setTemperatureCalibrationRegisterUsage(boolean)
sMethodName=public void setTemperatureCalibrationRegisterUsage
sParams=boolean
sThrows=
tempMethodName=public void setTemperatureCalibrationRegisterUsage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setTemperatureCalibrationRegisterUsage
params=boolean
/**
* Enables/Disables the usage of calibration registers. Only
* applies to the DS1923 configuration. The calibration depends
* on an average error at 3 known reference points. This average
* error is written to 3 registers on the DS1922. The container
* use these values to calibrate the recorded humidity values
* and improve the accuracy of the device. This method allows you
* to turn off calibration so that you may download the actual
* data recorded to the device's memory and perform a manual
* calibration.
*
* @param use if <code>true</code>, all humidity values read from
* device will be calibrated.
*
*/
public void setTemperatureCalibrationRegisterUsage(boolean use)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setTemperatureCalibrationRegisterUsage(use);
}
======================================
public void setHumidityCalibrationRegisterUsage(boolean)
sMethodName=public void setHumidityCalibrationRegisterUsage
sParams=boolean
sThrows=
tempMethodName=public void setHumidityCalibrationRegisterUsage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setHumidityCalibrationRegisterUsage
params=boolean
/**
* Enables/Disables the usage of the humidity calibration registers.
* Only applies to the DS1923 configuration. The calibration depends
* on an average error at 3 known reference points. This average
* error is written to 3 registers on the DS1922. The container
* use these values to calibrate the recorded humidity values
* and improve the accuracy of the device. This method allows you
* to turn off calibration so that you may download the actual
* data recorded to the device's memory and perform a manual
* calibration.
*
* @param use if <code>true</code>, all humidity values read from
* device will be calibrated.
*/
public void setHumidityCalibrationRegisterUsage(boolean use)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setHumidityCalibrationRegisterUsage(use);
}
======================================
public void setTemperatureCompensationUsage(boolean)
sMethodName=public void setTemperatureCompensationUsage
sParams=boolean
sThrows=
tempMethodName=public void setTemperatureCompensationUsage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setTemperatureCompensationUsage
params=boolean
/**
* Enables/Disables the usage of temperature compensation. Only
* applies to the DS1923 configuration. The temperature
* compensation adjusts the humidity values based on the known
* effects of temperature on the humidity sensor. If this is
* a joint humidity and temperature mission, the temperature
* values used could (should?) come from the temperature log
* itself. If, however, there is no temperature log the
* default temperature value can be set for the mission using
* the <code>setDefaultTemperatureCompensationValue</code> method.
*
* @param use if <code>true</code>, all humidity values read from
* device will be compensated for temperature.
*
* @see #setDefaultTemperatureCompensationValue
*/
public void setTemperatureCompensationUsage(boolean use)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setTemperatureCompensationUsage(use);
}
======================================
public void setDefaultTemperatureCompensationValue(double, boolean)
sMethodName=public void setDefaultTemperatureCompensationValue
sParams=double, boolean
sThrows=
tempMethodName=public void setDefaultTemperatureCompensationValue2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setDefaultTemperatureCompensationValue
params=double,boolean
/**
* Sets the default temperature value for temperature compensation. This
* value will be used if there is no temperature log data or if the
* <code>override</code> parameter is true.
*
* @param temperatureValue the default temperature value for temperature
* compensation.
* @param override if <code>true</code>, the default temperature value
* will always be used (instead of the temperature log data).
*
* @see #setDefaultTemperatureCompensationValue
*/
public void setDefaultTemperatureCompensationValue(double temperatureValue, boolean override)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setDefaultTemperatureCompensationValue(temperatureValue, override);
}
======================================
public boolean hasMissionAlarms(int)
sMethodName=public boolean hasMissionAlarms
sParams=int
sThrows=
tempMethodName=public boolean hasMissionAlarms1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasMissionAlarms
params=int
/**
* Indicates whether or not the specified channel of this missioning device
* has mission alarm capabilities.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @return true if the device has mission alarms for the specified channel.
*/
public boolean hasMissionAlarms(int channel)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasMissionAlarms(channel);
}
======================================
public boolean hasMissionAlarmed(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean hasMissionAlarmed
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean hasMissionAlarmed2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasMissionAlarmed
params=int,int
/**
* Returns true if the specified channel's alarm value of the specified
* type has been triggered during the mission.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @return true if the alarm was triggered.
*/
public boolean hasMissionAlarmed(int channel, int alarmType)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasMissionAlarmed(channel, alarmType);
}
======================================
public boolean getMissionAlarmEnable(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public boolean getMissionAlarmEnable
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public boolean getMissionAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getMissionAlarmEnable
params=int,int
/**
* Returns true if the alarm of the specified type has been enabled for
* the specified channel.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @return true if the alarm of the specified type has been enabled for
* the specified channel.
*/
public boolean getMissionAlarmEnable(int channel, int alarmType)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionAlarmEnable(channel, alarmType);
}
======================================
public void setMissionAlarmEnable(int, int, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionAlarmEnable
sParams=int, int, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionAlarmEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setMissionAlarmEnable
params=int,int,boolean
/**
* Enables/disables the alarm of the specified type for the specified channel
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param enable if true, alarm is enabled.
*/
public void setMissionAlarmEnable(int channel, int alarmType, boolean enable)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setMissionAlarmEnable(channel, alarmType, enable);
}
======================================
public double getMissionAlarm(int, int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getMissionAlarm
sParams=int, int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getMissionAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getMissionAlarm
params=int,int
/**
* Returns the threshold value which will trigger the alarm of the
* specified type on the specified channel.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @return the threshold value which will trigger the alarm
*/
public double getMissionAlarm(int channel, int alarmType)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMissionAlarm(channel, alarmType);
}
======================================
public void setMissionAlarm(int, int, double) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setMissionAlarm
sParams=int, int, double
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setMissionAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setMissionAlarm
params=int,int,double
/**
* Sets the threshold value which will trigger the alarm of the
* specified type on the specified channel.
*
* @param channel the mission channel, between <code>0</code> and
* <code>(getNumberOfMissionChannels()-1)</code>
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param threshold the threshold value which will trigger the alarm
*/
public void setMissionAlarm(int channel, int alarmType, double threshold)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setMissionAlarm(channel, alarmType, threshold);
}
======================================
public boolean hasTemperatureAlarms()
sMethodName=public boolean hasTemperatureAlarms
sParams=
sThrows=
tempMethodName=public boolean hasTemperatureAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasTemperatureAlarms
params=
/**
* Checks to see if this temperature measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>TemperatureContainer</code>
* has high/low trip alarms
*
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*/
public boolean hasTemperatureAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasTemperatureAlarms();
}
======================================
public boolean hasSelectableTemperatureResolution()
sMethodName=public boolean hasSelectableTemperatureResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasSelectableTemperatureResolution
params=
/**
* Checks to see if this device has selectable temperature resolution.
*
* @return <code>true</code> if this <code>TemperatureContainer</code>
* has selectable temperature resolution
*
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public boolean hasSelectableTemperatureResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasSelectableTemperatureResolution();
}
======================================
public double getTemperatureResolutions()[]
sMethodName=public double getTemperatureResolutions
sParams=
sThrows=
tempMethodName=public double[] getTemperatureResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double[] getTemperatureResolutions
params=
/**
* Get an array of available temperature resolutions in Celsius.
*
* @return byte array of available temperature resolutions in Celsius with
* minimum resolution as the first element and maximum resolution
* as the last element
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #setTemperatureResolution
*/
public double[] getTemperatureResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getTemperatureResolutions();
}
======================================
public double getTemperatureAlarmResolution()
sMethodName=public double getTemperatureAlarmResolution
sParams=
sThrows=
tempMethodName=public double getTemperatureAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getTemperatureAlarmResolution
params=
/**
* Gets the temperature alarm resolution in Celsius.
*
* @return temperature alarm resolution in Celsius for this 1-wire device
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*
*/
public double getTemperatureAlarmResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getTemperatureAlarmResolution();
}
======================================
public double getMaxTemperature()
sMethodName=public double getMaxTemperature
sParams=
sThrows=
tempMethodName=public double getMaxTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getMaxTemperature
params=
/**
* Gets the maximum temperature in Celsius.
*
* @return maximum temperature in Celsius for this 1-wire device
*
* @see #getMinTemperature()
*/
public double getMaxTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMaxTemperature();
}
======================================
public double getMinTemperature()
sMethodName=public double getMinTemperature
sParams=
sThrows=
tempMethodName=public double getMinTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getMinTemperature
params=
/**
* Gets the minimum temperature in Celsius.
*
* @return minimum temperature in Celsius for this 1-wire device
*
* @see #getMaxTemperature()
*/
public double getMinTemperature()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getMinTemperature();
}
======================================
public void doTemperatureConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doTemperatureConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doTemperatureConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void doTemperatureConvert
params=byte[]
/**
* Performs a temperature conversion. Use the <code>state</code>
* information to calculate the conversion time.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* In the case of the DS1922 Thermocron, this could also be due to a
* currently running mission.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void doTemperatureConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).doTemperatureConvert(state.array);
}
======================================
public double getTemperature(byte[])
sMethodName=public double getTemperature
sParams=byte[]
sThrows=
tempMethodName=public double getTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getTemperature
params=byte[]
/**
* Gets the temperature value in Celsius from the <code>state</code>
* data retrieved from the <code>readDevice()</code> method.
*
* @param state byte array with device state information
*
* @return temperature in Celsius from the last
* <code>doTemperatureConvert()</code>
*/
public double getTemperature(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getTemperature(state.array);
}
======================================
public double getTemperatureAlarm(int, byte[])
sMethodName=public double getTemperatureAlarm
sParams=int, byte[]
sThrows=
tempMethodName=public double getTemperatureAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getTemperatureAlarm
params=int,byte[]
/**
* Gets the specified temperature alarm value in Celsius from the
* <code>state</code> data retrieved from the
* <code>readDevice()</code> method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return temperature alarm trip values in Celsius for this 1-wire device
*
* @see #hasTemperatureAlarms
* @see #setTemperatureAlarm
*/
public double getTemperatureAlarm(int alarmType, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getTemperatureAlarm(alarmType, state.array);
}
======================================
public double getTemperatureResolution(byte[])
sMethodName=public double getTemperatureResolution
sParams=byte[]
sThrows=
tempMethodName=public double getTemperatureResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getTemperatureResolution
params=byte[]
/**
* Gets the current temperature resolution in Celsius from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return temperature resolution in Celsius for this 1-wire device
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public double getTemperatureResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getTemperatureResolution(state.array);
}
======================================
public void setTemperatureAlarm(int, double, byte[])
sMethodName=public void setTemperatureAlarm
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setTemperatureAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setTemperatureAlarm
params=int,double,byte[]
/**
* Sets the temperature alarm value in Celsius in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in Celsius
* @param state byte array with device state information
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
*/
public void setTemperatureAlarm(int alarmType, double alarmValue, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setTemperatureAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setTemperatureResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setTemperatureResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setTemperatureResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setTemperatureResolution
params=double,byte[]
/**
* Sets the current temperature resolution in Celsius in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution temperature resolution in Celsius
* @param state byte array with device state information
*
* @throws OneWireException if the device does not support
* selectable temperature resolution
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
*/
public void setTemperatureResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setTemperatureResolution(resolution, state.array);
}
======================================
public boolean isRelative()
sMethodName=public boolean isRelative
sParams=
sThrows=
tempMethodName=public boolean isRelative0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isRelative
params=
/**
* Checks to see if humidity value given is a 'relative' humidity value.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* provides a relative humidity reading
*
* @see #getHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public boolean isRelative()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isRelative();
}
======================================
public boolean hasHumidityAlarms()
sMethodName=public boolean hasHumidityAlarms
sParams=
sThrows=
tempMethodName=public boolean hasHumidityAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasHumidityAlarms
params=
/**
* Checks to see if this Humidity measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* has high/low trip alarms
*
* @see #getHumidityAlarm
* @see #setHumidityAlarm
*/
public boolean hasHumidityAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasHumidityAlarms();
}
======================================
public boolean hasSelectableHumidityResolution()
sMethodName=public boolean hasSelectableHumidityResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableHumidityResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasSelectableHumidityResolution
params=
/**
* Checks to see if this device has selectable Humidity resolution.
*
* @return <code>true</code> if this <code>HumidityContainer</code>
* has selectable Humidity resolution
*
* @see #getHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public boolean hasSelectableHumidityResolution()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasSelectableHumidityResolution();
}
======================================
public double getHumidityResolutions()[]
sMethodName=public double getHumidityResolutions
sParams=
sThrows=
tempMethodName=public double[] getHumidityResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double[] getHumidityResolutions
params=
/**
* Get an array of available Humidity resolutions in percent humidity (0 to 100).
*
* @return byte array of available Humidity resolutions in percent with
* minimum resolution as the first element and maximum resolution
* as the last element.
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #setHumidityResolution
*/
public double[] getHumidityResolutions()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getHumidityResolutions();
}
======================================
public double getHumidityAlarmResolution() throws com.dalsemi.onewire.OneWireException
sMethodName=public double getHumidityAlarmResolution
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getHumidityAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getHumidityAlarmResolution
params=
/**
* Gets the Humidity alarm resolution in percent.
*
* @return Humidity alarm resolution in percent for this 1-wire device
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #getHumidityAlarm
* @see #setHumidityAlarm
*
*/
public double getHumidityAlarmResolution()
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getHumidityAlarmResolution();
}
======================================
public void doHumidityConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doHumidityConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doHumidityConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void doHumidityConvert
params=byte[]
/**
* Performs a Humidity conversion.
*
* @param state byte array with device state information
*
* @throws OneWireIOException on a 1-Wire communication error such as
* reading an incorrect CRC from a 1-Wire device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void doHumidityConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).doHumidityConvert(state.array);
}
======================================
public double getHumidity(byte[])
sMethodName=public double getHumidity
sParams=byte[]
sThrows=
tempMethodName=public double getHumidity1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getHumidity
params=byte[]
/**
* Gets the humidity expressed as a percent value (0.0 to 100.0) of humidity.
*
* @param state byte array with device state information
* @return humidity expressed as a percent
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #setHumidityResolution
*/
public double getHumidity(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getHumidity(state.array);
}
======================================
public double getHumidityResolution(byte[])
sMethodName=public double getHumidityResolution
sParams=byte[]
sThrows=
tempMethodName=public double getHumidityResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getHumidityResolution
params=byte[]
/**
* Gets the current Humidity resolution in percent from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return Humidity resolution in percent for this 1-wire device
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolutions
* @see #setHumidityResolution
*/
public double getHumidityResolution(ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getHumidityResolution(state.array);
}
======================================
public double getHumidityAlarm(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getHumidityAlarm
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getHumidityAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getHumidityAlarm
params=int,byte[]
/**
* Gets the specified Humidity alarm value in percent from the
* <code>state</code> data retrieved from the
* <code>readDevice()</code> method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return Humidity alarm trip values in percent for this 1-wire device
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #setHumidityAlarm
*/
public double getHumidityAlarm(int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getHumidityAlarm(alarmType, state.array);
}
======================================
public void setHumidityAlarm(int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setHumidityAlarm
sParams=int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setHumidityAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setHumidityAlarm
params=int,double,byte[]
/**
* Sets the Humidity alarm value in percent in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in percent
* @param state byte array with device state information
*
* @throws OneWireException Device does not support Humidity
* alarms
*
* @see #hasHumidityAlarms
* @see #getHumidityAlarm
*/
public void setHumidityAlarm(int alarmType, double alarmValue, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setHumidityAlarm(alarmType, alarmValue, state.array);
}
======================================
public void setHumidityResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setHumidityResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setHumidityResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setHumidityResolution
params=double,byte[]
/**
* Sets the current Humidity resolution in percent in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution Humidity resolution in percent
* @param state byte array with device state information
*
* @throws OneWireException Device does not support selectable
* Humidity resolution
*
* @see #hasSelectableHumidityResolution
* @see #getHumidityResolution
* @see #getHumidityResolutions
*/
public void setHumidityResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setHumidityResolution(resolution, state.array);
}
======================================
public int getNumberADChannels()
sMethodName=public int getNumberADChannels
sParams=
sThrows=
tempMethodName=public int getNumberADChannels0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getNumberADChannels
params=
/**
* Gets the number of channels supported by this A/D.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberADChannels()</code> - 1)].
*
* @return the number of channels
*/
public int getNumberADChannels()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getNumberADChannels();
}
======================================
public boolean hasADAlarms()
sMethodName=public boolean hasADAlarms
sParams=
sThrows=
tempMethodName=public boolean hasADAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasADAlarms
params=
/**
* Checks to see if this A/D measuring device has high/low
* alarms.
*
* @return true if this device has high/low trip alarms
*/
public boolean hasADAlarms()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasADAlarms();
}
======================================
public double getADRanges(int)[]
sMethodName=public double getADRanges
sParams=int
sThrows=
tempMethodName=public double[] getADRanges1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double[] getADRanges
params=int
/**
* Gets an array of available ranges for the specified
* A/D channel.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
*
* @return array indicating the available ranges starting
* from the largest range to the smallest range
*
* @see #getNumberADChannels()
*/
public double[] getADRanges(int channel)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADRanges(channel);
}
======================================
public double getADResolutions(int, double)[]
sMethodName=public double getADResolutions
sParams=int, double
sThrows=
tempMethodName=public double[] getADResolutions2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double[] getADResolutions
params=int,double
/**
* Gets an array of available resolutions based
* on the specified range on the specified A/D channel.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param range A/D range setting from the <code>getADRanges(int)</code> method
*
* @return array indicating the available resolutions on this
* <code>channel</code> for this <code>range</code>
*
* @see #getNumberADChannels()
* @see #getADRanges(int)
*/
public double[] getADResolutions(int channel, double range)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADResolutions(channel, range);
}
======================================
public boolean canADMultiChannelRead()
sMethodName=public boolean canADMultiChannelRead
sParams=
sThrows=
tempMethodName=public boolean canADMultiChannelRead0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean canADMultiChannelRead
params=
/**
* Checks to see if this A/D supports doing multiple voltage
* conversions at the same time.
*
* @return true if the device can do multi-channel voltage reads
*
* @see #doADConvert(boolean[],byte[])
*/
public boolean canADMultiChannelRead()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).canADMultiChannelRead();
}
======================================
public void doADConvert(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvert2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void doADConvert
params=int,byte[]
/**
* Performs a voltage conversion on one specified channel.
* Use the method <code>getADVoltage(int,byte[])</code> to read
* the result of this conversion, using the same <code>channel</code>
* argument as this method uses.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see OneWireSensor#readDevice()
* @see #getADVoltage(int,byte[])
*/
public void doADConvert(int a0, ByteArray a1)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).doADConvert(a0, a1.array);
}
======================================
public void doADConvert(boolean[], byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doADConvert
sParams=boolean[], byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doADConvertMulti2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void doADConvert
params=boolean[],byte[]
/**
* Performs voltage conversion on one or more specified
* channels. The method <code>getADVoltage(byte[])</code> can be used to read the result
* of the conversion(s). This A/D must support multi-channel read,
* reported by <code>canADMultiChannelRead()</code>, if more then 1 channel is specified.
*
* @param doConvert array of size <code>getNumberADChannels()</code> representing
* which channels should perform conversions
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see OneWireSensor#readDevice()
* @see #getADVoltage(byte[])
* @see #canADMultiChannelRead()
*/
public void doADConvertMulti(boolean[] a0, ByteArray a1)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).doADConvert(a0, a1.array);
}
======================================
public double getADVoltage(byte[])[] throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double[] getADVoltage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double[] getADVoltage
params=byte[]
/**
* Reads the value of the voltages after a <code>doADConvert(boolean[],byte[])</code>
* method call. This A/D device must support multi-channel reading, reported by
* <code>canADMultiChannelRead()</code>, if more than 1 channel conversion was attempted
* by <code>doADConvert()</code>.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return array with the voltage values for all channels
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see #doADConvert(boolean[],byte[])
*/
public double[] getADVoltage(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADVoltage(state.array);
}
======================================
public double getADVoltage(int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public double getADVoltage
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public double getADVoltage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getADVoltage
params=int,byte[]
/**
* Reads the value of the voltages after a <code>doADConvert(int,byte[])</code>
* method call. If more than one channel has been read it is more
* efficient to use the <code>getADVoltage(byte[])</code> method that
* returns all channel voltage values.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the voltage value for the specified channel
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* This is usually a recoverable error.
* @throws OneWireException on a communication or setup error with the
* 1-Wire adapter. This is usually a non-recoverable error.
*
* @see #doADConvert(int,byte[])
* @see #getADVoltage(byte[])
*/
public double getADVoltage(int channel, ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADVoltage(channel, state.array);
}
======================================
public double getADAlarm(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getADAlarm
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getADAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getADAlarm
params=int,int,byte[]
/**
* Reads the value of the specified A/D alarm on the specified channel.
* Not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the alarm value in volts
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#readDevice()
* @see #hasADAlarms()
*/
public double getADAlarm(int a0, int a1, ByteArray a2)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADAlarm(a0, a1, a2.array);
}
======================================
public boolean getADAlarmEnable(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getADAlarmEnable
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getADAlarmEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getADAlarmEnable
params=int,int,byte[]
/**
* Checks to see if the specified alarm on the specified channel is enabled.
* Not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if specified alarm is enabled
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#readDevice()
* @see #hasADAlarms()
*/
public boolean getADAlarmEnable(int a0, int a1, ByteArray a2)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADAlarmEnable(a0, a1, a2.array);
}
======================================
public boolean hasADAlarmed(int, int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean hasADAlarmed
sParams=int, int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean hasADAlarmed3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasADAlarmed
params=int,int,byte[]
/**
* Checks the state of the specified alarm on the specified channel.
* Not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if specified alarm occurred
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#readDevice()
* @see #hasADAlarms()
* @see #getADAlarmEnable(int,int,byte[])
* @see #setADAlarmEnable(int,int,boolean,byte[])
*/
public boolean hasADAlarmed(int a0, int a1, ByteArray a2)
throws com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasADAlarmed(a0, a1, a2.array);
}
======================================
public double getADResolution(int, byte[])
sMethodName=public double getADResolution
sParams=int, byte[]
sThrows=
tempMethodName=public double getADResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getADResolution
params=int,byte[]
/**
* Returns the currently selected resolution for the specified
* channel. This device may not have selectable resolutions,
* though this method will return a valid value.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the current resolution of <code>channel</code> in volts
*
* @see #getADResolutions(int,double)
* @see #setADResolution(int,double,byte[])
*/
public double getADResolution(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADResolution(channel, state.array);
}
======================================
public double getADRange(int, byte[])
sMethodName=public double getADRange
sParams=int, byte[]
sThrows=
tempMethodName=public double getADRange2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getADRange
params=int,byte[]
/**
* Returns the currently selected range for the specified
* channel. This device may not have selectable ranges,
* though this method will return a valid value.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the input voltage range
*
* @see #getADRanges(int)
* @see #setADRange(int,double,byte[])
*/
public double getADRange(int channel, ByteArray state)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADRange(channel, state.array);
}
======================================
public void setADAlarm(int, int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarm
sParams=int, int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarm4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADAlarm
params=int,int,double,byte[]
/**
* Sets the voltage value of the specified alarm on the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param alarm new alarm value
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasADAlarms()
* @see #getADAlarm(int,int,byte[])
* @see #getADAlarmEnable(int,int,byte[])
* @see #setADAlarmEnable(int,int,boolean,byte[])
* @see #hasADAlarmed(int,int,byte[])
*/
public void setADAlarm(int a0, int a1, double a2, ByteArray a3)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setADAlarm(a0, a1, a2, a3.array);
}
======================================
public void setADAlarmEnable(int, int, boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setADAlarmEnable
sParams=int, int, boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setADAlarmEnable4
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADAlarmEnable
params=int,int,boolean,byte[]
/**
* Enables or disables the specified alarm on the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param alarmType the desired alarm, <code>ALARM_HIGH</code> or <code>ALARM_LOW</code>
* @param alarmEnable true to enable the alarm, false to disable
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have A/D alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasADAlarms()
* @see #getADAlarm(int,int,byte[])
* @see #setADAlarm(int,int,double,byte[])
* @see #getADAlarmEnable(int,int,byte[])
* @see #hasADAlarmed(int,int,byte[])
*/
public void setADAlarmEnable(int a0, int a1, boolean a2, ByteArray a3)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setADAlarmEnable(a0, a1, a2, a3.array);
}
======================================
public void setADResolution(int, double, byte[])
sMethodName=public void setADResolution
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADResolution3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADResolution
params=int,double,byte[]
/**
* Sets the conversion resolution value for the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param resolution one of the resolutions returned by <code>getADResolutions(int,double)</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #getADResolutions(int,double)
* @see #getADResolution(int,byte[])
*
*/
public void setADResolution(int channel, double resolution, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setADResolution(channel, resolution, state.array);
}
======================================
public void setADRange(int, double, byte[])
sMethodName=public void setADRange
sParams=int, double, byte[]
sThrows=
tempMethodName=public void setADRange3
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADRange
params=int,double,byte[]
/**
* Sets the input range for the specified channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all A/D devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasADAlarms()</code> method.
*
* @param channel channel number in the range [0 to (<code>getNumberADChannels()</code> - 1)]
* @param range one of the ranges returned by <code>getADRanges(int)</code>
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #getADRanges(int)
* @see #getADRange(int,byte[])
*/
public void setADRange(int channel, double range, ByteArray state)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setADRange(channel, range, state.array);
}
======================================
public void setADReferenceVoltage(double)
sMethodName=public void setADReferenceVoltage
sParams=double
sThrows=
tempMethodName=public void setADReferenceVoltage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADReferenceVoltage
params=double
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADReferenceVoltage
params=double
methodMatcher=/void setADReferenceVoltage *\((.*double.*)\)/
/**
* No documentation available for method
*/
public void setADReferenceVoltage(double referenceVoltage)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setADReferenceVoltage(referenceVoltage);
}
======================================
public double getADReferenceVoltage()
sMethodName=public double getADReferenceVoltage
sParams=
sThrows=
tempMethodName=public double getADReferenceVoltage0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getADReferenceVoltage
params=
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public double getADReferenceVoltage
params=
methodMatcher=/double getADReferenceVoltage *\((.*.*)\)/
/**
* No documentation available for method
*/
public double getADReferenceVoltage()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADReferenceVoltage();
}
======================================
public void setADDeviceBitCount(int)
sMethodName=public void setADDeviceBitCount
sParams=int
sThrows=
tempMethodName=public void setADDeviceBitCount1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADDeviceBitCount
params=int
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setADDeviceBitCount
params=int
methodMatcher=/void setADDeviceBitCount *\((.*int.*)\)/
/**
* No documentation available for method
*/
public void setADDeviceBitCount(int bits)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setADDeviceBitCount(bits);
}
======================================
public int getADDeviceBitCount()
sMethodName=public int getADDeviceBitCount
sParams=
sThrows=
tempMethodName=public int getADDeviceBitCount0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getADDeviceBitCount
params=
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public int getADDeviceBitCount
params=
methodMatcher=/int getADDeviceBitCount *\((.*.*)\)/
/**
* No documentation available for method
*/
public int getADDeviceBitCount()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getADDeviceBitCount();
}
======================================
public void setForceADResults(boolean)
sMethodName=public void setForceADResults
sParams=boolean
sThrows=
tempMethodName=public void setForceADResults1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setForceADResults
params=boolean
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setForceADResults
params=boolean
methodMatcher=/void setForceADResults *\((.*boolean.*)\)/
/**
* No documentation available for method
*/
public void setForceADResults(boolean force)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setForceADResults(force);
}
======================================
public boolean getForceADResults()
sMethodName=public boolean getForceADResults
sParams=
sThrows=
tempMethodName=public boolean getForceADResults0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getForceADResults
params=
No documentation available for method
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean getForceADResults
params=
methodMatcher=/boolean getForceADResults *\((.*.*)\)/
/**
* No documentation available for method
*/
public boolean getForceADResults()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getForceADResults();
}
======================================
public boolean hasClockAlarm()
sMethodName=public boolean hasClockAlarm
sParams=
sThrows=
tempMethodName=public boolean hasClockAlarm0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean hasClockAlarm
params=
/**
* Checks to see if the clock has an alarm feature.
*
* @return false, since this device does not have clock alarms
*
* @see #getClockAlarm(byte[])
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean hasClockAlarm()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).hasClockAlarm();
}
======================================
public boolean canDisableClock()
sMethodName=public boolean canDisableClock
sParams=
sThrows=
tempMethodName=public boolean canDisableClock0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean canDisableClock
params=
/**
* Checks to see if the clock can be disabled.
*
* @return true if the clock can be enabled and disabled
*
* @see #isClockRunning(byte[])
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean canDisableClock()
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).canDisableClock();
}
======================================
public long getClockResolution()
sMethodName=public long getClockResolution
sParams=
sThrows=
tempMethodName=public String getClockResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public long getClockResolution
params=
/**
* Gets the clock resolution in milliseconds
*
* @return the clock resolution in milliseconds
*/
public String getClockResolution()
{
return ""+((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getClockResolution();
}
======================================
public long getClock(byte[])
sMethodName=public long getClock
sParams=byte[]
sThrows=
tempMethodName=public String getClock1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public long getClock
params=byte[]
/**
* Extracts the Real-Time clock value in milliseconds.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the time represented in this clock in milliseconds since 1970
*
* @see OneWireSensor#readDevice()
* @see #setClock(long,byte[])
*/
public String getClock(ByteArray a0)
{
return ""+((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getClock(a0.array);
}
======================================
public long getClockAlarm(byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public long getClockAlarm
sParams=byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public String getClockAlarm1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public long getClockAlarm
params=byte[]
/**
* Extracts the clock alarm value for the Real-Time clock.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return milliseconds since 1970 that the clock alarm is set to
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public String getClockAlarm(ByteArray a0)
throws com.dalsemi.onewire.OneWireException
{
return ""+((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).getClockAlarm(a0.array);
}
======================================
public boolean isClockAlarming(byte[])
sMethodName=public boolean isClockAlarming
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarming1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isClockAlarming
params=byte[]
/**
* Checks if the clock alarm flag has been set.
* This will occur when the value of the Real-Time
* clock equals the value of the clock alarm.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the Real-Time clock is alarming
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarming(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isClockAlarming(a0.array);
}
======================================
public boolean isClockAlarmEnabled(byte[])
sMethodName=public boolean isClockAlarmEnabled
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockAlarmEnabled1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isClockAlarmEnabled
params=byte[]
/**
* Checks if the clock alarm is enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if clock alarm is enabled
*
* @see OneWireSensor#readDevice()
* @see #hasClockAlarm()
* @see #isClockAlarming(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public boolean isClockAlarmEnabled(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isClockAlarmEnabled(a0.array);
}
======================================
public boolean isClockRunning(byte[])
sMethodName=public boolean isClockRunning
sParams=byte[]
sThrows=
tempMethodName=public boolean isClockRunning1
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public boolean isClockRunning
params=byte[]
/**
* Checks if the device's oscillator is enabled. The clock
* will not increment if the clock oscillator is not enabled.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return true if the clock is running
*
* @see OneWireSensor#readDevice()
* @see #canDisableClock()
* @see #setClockRunEnable(boolean,byte[])
*/
public boolean isClockRunning(ByteArray a0)
{
return ((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).isClockRunning(a0.array);
}
======================================
public void setClock(long, byte[])
sMethodName=public void setClock
sParams=long, byte[]
sThrows=
tempMethodName=public void setClock2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setClock
params=long,byte[]
/**
* Sets the Real-Time clock.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param time new value for the Real-Time clock, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #getClock(byte[])
*/
public void setClock(String a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setClock(Long.parseLong(a0), a1.array);
}
======================================
public void setClockAlarm(long, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarm
sParams=long, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setClockAlarm
params=long,byte[]
/**
* Sets the clock alarm.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param time - new value for the Real-Time clock alarm, in milliseconds
* since January 1, 1970
* @param state current state of the device returned from <code>readDevice()</code>
*
* @throws OneWireException if this device does not have clock alarms
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #isClockAlarming(byte[])
* @see #setClockAlarmEnable(boolean,byte[])
*/
public void setClockAlarm(String a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setClockAlarm(Long.parseLong(a0), a1.array);
}
======================================
public void setClockRunEnable(boolean, byte[])
sMethodName=public void setClockRunEnable
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setClockRunEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setClockRunEnable
params=boolean,byte[]
/**
* Enables or disables the oscillator, turning the clock 'on' and 'off'.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices can disable their oscillators. Check to see if this device can
* disable its oscillator first by calling the <code>canDisableClock()</code> method.
*
* @param runEnable true to enable the clock oscillator
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #canDisableClock()
* @see #isClockRunning(byte[])
*/
public void setClockRunEnable(boolean a0, ByteArray a1)
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setClockRunEnable(a0, a1.array);
}
======================================
public void setClockAlarmEnable(boolean, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setClockAlarmEnable
sParams=boolean, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setClockAlarmEnable2
getMethodDocumentation
className=com.dalsemi.onewire.container.OneWireContainer41
methodName=public void setClockAlarmEnable
params=boolean,byte[]
/**
* Enables or disables the clock alarm.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>. Also note that
* not all clock devices have alarms. Check to see if this device has
* alarms first by calling the <code>hasClockAlarm()</code> method.
*
* @param alarmEnable true to enable the clock alarm
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see OneWireSensor#writeDevice(byte[])
* @see #hasClockAlarm()
* @see #isClockAlarmEnabled(byte[])
* @see #getClockAlarm(byte[])
* @see #setClockAlarm(long,byte[])
* @see #isClockAlarming(byte[])
*/
public void setClockAlarmEnable(boolean a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OneWireContainer41)objectInstance).setClockAlarmEnable(a0, a1.array);
}
-------------------------------------------------------------------
creating: owapi\OTPMemoryBank.java
superClassName=com.dalsemi.onewire.container.MemoryBank
======================================
public boolean canRedirectPage()
sMethodName=public boolean canRedirectPage
sParams=
sThrows=
tempMethodName=public boolean canRedirectPage0
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public boolean canRedirectPage
params=
/**
* Checks to see if this memory bank has pages that can be redirected
* to a new page. This is used in Write-Once memory
* to provide a means to update.
*
* @return <CODE> true </CODE> if this memory bank pages can be redirected
* to a new page
*
* @see #redirectPage(int,int) redirectPage
* @see #getRedirectedPage(int) getRedirectedPage
*/
public boolean canRedirectPage()
{
return ((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).canRedirectPage();
}
======================================
public boolean canLockPage()
sMethodName=public boolean canLockPage
sParams=
sThrows=
tempMethodName=public boolean canLockPage0
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public boolean canLockPage
params=
/**
* Checks to see if this memory bank has pages that can be locked. A
* locked page would prevent any changes to it's contents.
*
* @return <CODE> true </CODE> if this memory bank has pages that can be
* locked
*
* @see #lockPage(int) lockPage
* @see #isPageLocked(int) isPageLocked
*/
public boolean canLockPage()
{
return ((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).canLockPage();
}
======================================
public boolean canLockRedirectPage()
sMethodName=public boolean canLockRedirectPage
sParams=
sThrows=
tempMethodName=public boolean canLockRedirectPage0
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public boolean canLockRedirectPage
params=
/**
* Checks to see if this memory bank has pages that can be locked from
* being redirected. This would prevent a Write-Once memory from
* being updated.
*
* @return <CODE> true </CODE> if this memory bank has pages that can
* be locked from being redirected to a new page
* @see #lockRedirectPage(int) lockRedirectPage
* @see #isRedirectPageLocked(int) isRedirectPageLocked
*/
public boolean canLockRedirectPage()
{
return ((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).canLockRedirectPage();
}
======================================
public void lockPage(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void lockPage
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void lockPage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public void lockPage
params=int
/**
* Locks the specifed page in this memory bank. Not supported
* by all devices.
*
* @param page number of page to lock
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a read back verification fails. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter. It will also be thrown if the device needs 'program' voltage
* and the adapter used by this device does not support it.
*
* @see #isPageLocked(int) isPageLocked
* @see #canLockPage() canLockPage
* @see canProgram()
*/
public void lockPage(int a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).lockPage(a0);
}
======================================
public boolean isPageLocked(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isPageLocked
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isPageLocked1
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public boolean isPageLocked
params=int
/**
* Checks to see if the specified page is locked.
*
* @param page page to check
*
* @return <CODE> true </CODE> if page is locked
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter.
*
* @see #lockPage(int) lockPage
* @see #canLockPage() canLockPage
*/
public boolean isPageLocked(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).isPageLocked(page);
}
======================================
public void redirectPage(int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void redirectPage
sParams=int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void redirectPage2
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public void redirectPage
params=int,int
/**
* Redirects the specifed page to a new page.
* Not supported by all devices.
*
* @param page number of page to redirect
* @param newPage new page number to redirect to
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter. It will also be thrown if the device needs 'program' voltage
* and the adapter used by this device does not support it.
*
* @see #canRedirectPage() canRedirectPage
* @see #getRedirectedPage(int) getRedirectedPage
* @see canProgram()
*/
public void redirectPage(int a0, int a1)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).redirectPage(a0, a1);
}
======================================
public int isPageRedirected(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int isPageRedirected
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int isPageRedirected1
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public int isPageRedirected
params=int
/**
* Checks to see if the specified page is redirected.
* Not supported by all devices.
*
* @param page page to check for redirection
*
* @return the new page number or 0 if not redirected
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter.
*
* @see #canRedirectPage() canRedirectPage
* @see #redirectPage(int,int) redirectPage
*
* @deprecated As of 1-Wire API 0.01, replaced by {@link #getRedirectedPage(int)}
*/
public int isPageRedirected(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).isPageRedirected(page);
}
======================================
public int getRedirectedPage(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int getRedirectedPage
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int getRedirectedPage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public int getRedirectedPage
params=int
/**
* Gets the page redirection of the specified page.
* Not supported by all devices.
*
* @param page page to check for redirection
*
* @return the new page number or 0 if not redirected
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter.
*
* @see #canRedirectPage() canRedirectPage
* @see #redirectPage(int,int) redirectPage
* @since 1-Wire API 0.01
*/
public int getRedirectedPage(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).getRedirectedPage(page);
}
======================================
public void lockRedirectPage(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void lockRedirectPage
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void lockRedirectPage1
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public void lockRedirectPage
params=int
/**
* Locks the redirection of the specifed page.
* Not supported by all devices.
*
* @param page page to redirect
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter. It will also be thrown if the device needs 'program' voltage
* and the adapter used by this device does not support it.
*
* @see #canLockRedirectPage() canLockRedirectPage
* @see #isRedirectPageLocked(int) isRedirectPageLocked
* @see canProgram()
*/
public void lockRedirectPage(int a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).lockRedirectPage(a0);
}
======================================
public boolean isRedirectPageLocked(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean isRedirectPageLocked
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isRedirectPageLocked1
getMethodDocumentation
className=com.dalsemi.onewire.container.OTPMemoryBank
methodName=public boolean isRedirectPageLocked
params=int
/**
* Checks to see if the specified page has redirection locked.
* Not supported by all devices.
*
* @param page page to check for locked redirection
*
* @return <CODE> true </CODE> if redirection is locked for this page
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter.
*
* @see #canLockRedirectPage() canLockRedirectPage
* @see #lockRedirectPage(int) lockRedirectPage
*/
public boolean isRedirectPageLocked(int page)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.OTPMemoryBank)objectInstance).isRedirectPageLocked(page);
}
-------------------------------------------------------------------
creating: owapi\PagedMemoryBank.java
======================================
public int getNumberPages()
sMethodName=public int getNumberPages
sParams=
sThrows=
tempMethodName=public int getNumberPages0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public int getNumberPages
params=
/**
* Gets the number of pages in this memory bank.
* The page numbers are then always 0 to (getNumberPages() - 1).
*
* @return number of pages in this memory bank
*/
public int getNumberPages()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).getNumberPages();
}
======================================
public int getPageLength()
sMethodName=public int getPageLength
sParams=
sThrows=
tempMethodName=public int getPageLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public int getPageLength
params=
/**
* Gets raw page length in bytes in this memory bank.
*
* @return page length in bytes in this memory bank
*/
public int getPageLength()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).getPageLength();
}
======================================
public int getMaxPacketDataLength()
sMethodName=public int getMaxPacketDataLength
sParams=
sThrows=
tempMethodName=public int getMaxPacketDataLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public int getMaxPacketDataLength
params=
/**
* Gets Maximum data page length in bytes for a packet
* read or written in this memory bank. See the
* {@link #readPagePacket(int,boolean,byte[],int) readPagePacket}
* and
* {@link #writePagePacket(int,byte[],int,int) writePagePacket}
* methods. This method is only usefull
* if this memory bank is general purpose memory.
*
* @return max packet page length in bytes in this memory bank
*
* @see #readPagePacket(int,boolean,byte[],int) readPagePacket
* @see #readPagePacket(int,boolean,byte[],int,byte[]) readPagePacket(extra)
* @see #writePagePacket(int,byte[],int,int) writePagePacket
*/
public int getMaxPacketDataLength()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).getMaxPacketDataLength();
}
======================================
public boolean hasPageAutoCRC()
sMethodName=public boolean hasPageAutoCRC
sParams=
sThrows=
tempMethodName=public boolean hasPageAutoCRC0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public boolean hasPageAutoCRC
params=
/**
* Checks to see if this memory bank's pages can be read with
* the contents being verified by a device generated CRC.
* This is used to see if the
* {@link #readPageCRC(int,boolean,byte[],int) readPageCRC}
* method can be used.
*
* @return <CODE> true </CODE> if this memory bank can be
* read with self generated CRC
*
* @see #readPageCRC(int,boolean,byte[],int) readPageCRC
* @see #readPageCRC(int,boolean,byte[],int,byte[]) readPageCRC(extra)
*/
public boolean hasPageAutoCRC()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).hasPageAutoCRC();
}
======================================
public boolean haveExtraInfo()
sMethodName=public boolean haveExtraInfo
sParams=
sThrows=
tempMethodName=public boolean haveExtraInfo0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public boolean haveExtraInfo
params=
/**
* Checks to see if this memory bank's pages deliver extra
* information outside of the normal data space, when read. Examples
* of this may be a redirection byte, counter, tamper protection
* bytes, or SHA-1 result. If this method returns true then the
* methods with an 'extraInfo' parameter can be used:
* {@link #readPage(int,boolean,byte[],int,byte[]) readPage},
* {@link #readPageCRC(int,boolean,byte[],int,byte[]) readPageCRC}, and
* {@link #readPagePacket(int,boolean,byte[],int,byte[]) readPagePacket}.
*
* @return <CODE> true </CODE> if reading the this memory bank's
* pages provides extra information
*
* @see #readPage(int,boolean,byte[],int,byte[]) readPage(extra)
* @see #readPageCRC(int,boolean,byte[],int,byte[]) readPageCRC(extra)
* @see #readPagePacket(int,boolean,byte[],int,byte[]) readPagePacket(extra)
*
* @deprecated As of 1-Wire API 0.01, replaced by {@link #hasExtraInfo()}
*/
public boolean haveExtraInfo()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).haveExtraInfo();
}
======================================
public boolean hasExtraInfo()
sMethodName=public boolean hasExtraInfo
sParams=
sThrows=
tempMethodName=public boolean hasExtraInfo0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public boolean hasExtraInfo
params=
/**
* Checks to see if this memory bank's pages deliver extra
* information outside of the normal data space, when read. Examples
* of this may be a redirection byte, counter, tamper protection
* bytes, or SHA-1 result. If this method returns true then the
* methods with an 'extraInfo' parameter can be used:
* {@link #readPage(int,boolean,byte[],int,byte[]) readPage},
* {@link #readPageCRC(int,boolean,byte[],int,byte[]) readPageCRC}, and
* {@link #readPagePacket(int,boolean,byte[],int,byte[]) readPagePacket}.
*
* @return <CODE> true </CODE> if reading the this memory bank's
* pages provides extra information
*
* @see #readPage(int,boolean,byte[],int,byte[]) readPage(extra)
* @see #readPageCRC(int,boolean,byte[],int,byte[]) readPageCRC(extra)
* @see #readPagePacket(int,boolean,byte[],int,byte[]) readPagePacket(extra)
* @since 1-Wire API 0.01
*/
public boolean hasExtraInfo()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).hasExtraInfo();
}
======================================
public int getExtraInfoLength()
sMethodName=public int getExtraInfoLength
sParams=
sThrows=
tempMethodName=public int getExtraInfoLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public int getExtraInfoLength
params=
/**
* Gets the length in bytes of extra information that
* is read when reading a page in this memory bank.
*
* @return number of bytes in Extra Information read when reading
* pages from this memory bank
*
* @see #hasExtraInfo() hasExtraInfo
*/
public int getExtraInfoLength()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).getExtraInfoLength();
}
======================================
public java.lang.String getExtraInfoDescription()
sMethodName=public java.lang.String getExtraInfoDescription
sParams=
sThrows=
tempMethodName=public java.lang.String getExtraInfoDescription0
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public java.lang.String getExtraInfoDescription
params=
/**
* Gets a string description of what is contained in
* the Extra Information returned when reading pages in this
* memory bank.
*
* @return extra information description.
*
* @see #hasExtraInfo() hasExtraInfo
*/
public java.lang.String getExtraInfoDescription()
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).getExtraInfoDescription();
}
======================================
public void readPage(int, boolean, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void readPage
sParams=int, boolean, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void readPage4
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public void readPage
params=int,boolean,byte[],int
/**
* Reads a page in this memory bank with no
* CRC checking (device or data). The resulting data from this API
* may or may not be what is on the 1-Wire device. It is recommends
* that the data contain some kind of checking (CRC) like in the
* {@link #readPagePacket(int,boolean,byte[],int) readPagePacket}
* method or have the 1-Wire device provide the
* CRC as in
* {@link #readPageCRC(int,boolean,byte[],int) readPageCRC}.
* However device CRC generation is not
* supported on all memory types, see
* {@link #hasPageAutoCRC() hasPageAutoCRC}.
* If neither is an option then this method could be called more
* then once to at least verify that the same data is read consistently.
*
* The readContinue parameter is used to eliminate the overhead in re-accessing
* a part already being read from. For example, if pages 0 - 4 are to
* be read, readContinue would be set to false for page 0 and would be set
* to true for the next four calls.
* <P> Note: Using readContinue = true can only be used if the new
* read continues where the last one left off
* and it is inside a 'beginExclusive/endExclusive'
* block.
*
* @param page page number to read packet from
* @param readContinue <CODE> true </CODE> then device read
* is continued without re-selecting
* @param readBuf location for data read
* @param offset offset into readBuf to place data
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*/
public void readPage(int page, boolean readContinue, ByteArray readBuf, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).readPage(page, readContinue, readBuf.array, offset);
}
======================================
public void readPage(int, boolean, byte[], int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void readPage
sParams=int, boolean, byte[], int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void readPage5
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public void readPage
params=int,boolean,byte[],int,byte[]
/**
* Reads a page in this memory bank with extra information with no
* CRC checking (device or data). The resulting data from this API
* may or may not be what is on the 1-Wire device. It is recommends
* that the data contain some kind of checking (CRC) like in the
* {@link #readPagePacket(int,boolean,byte[],int,byte[]) readPagePacket}
* method or have the 1-Wire device provide the
* CRC as in
* {@link #readPageCRC(int,boolean,byte[],int,byte[]) readPageCRC}.
* However device CRC generation is not
* supported on all memory types, see
* {@link #hasPageAutoCRC() hasPageAutoCRC}.
* If neither is an option then this method could be called more
* then once to at least verify that the same data is read consistently.The
* readContinue parameter is used to eliminate the overhead in re-accessing
* a part already being read from. For example, if pages 0 - 4 are to
* be read, readContinue would be set to false for page 0 and would be set
* to true for the next four calls.
*
* <P> Note: Using readContinue = true can only be used if the new
* read continues where the last one left off
* and it is inside a 'beginExclusive/endExclusive'
* block.
*
* @param page page number to read packet from
* @param readContinue <CODE> true </CODE> then device read
* is continued without re-selecting
* @param readBuf location for data read
* @param offset offset into readBuf to place data
* @param extraInfo location for extra info read
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no 1-Wire device present. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #hasExtraInfo() hasExtraInfo
* @see #getExtraInfoLength() getExtraInfoLength
*/
public void readPage(int page, boolean readContinue, ByteArray readBuf, int offset, ByteArray extraInfo)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).readPage(page, readContinue, readBuf.array, offset, extraInfo.array);
}
======================================
public int readPagePacket(int, boolean, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int readPagePacket
sParams=int, boolean, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int readPagePacket4
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public int readPagePacket
params=int,boolean,byte[],int
/**
* Reads a Universal Data Packet.
*
* The Universal Data Packet always starts on page boundaries but
* can end anywhere in the page. The structure specifies the length of
* data bytes not including the length byte and the CRC16 bytes.
* There is one length byte. The CRC16 is first initialized to
* the page number. This provides a check to verify the page that
* was intended is being read. The CRC16 is then calculated over
* the length and data bytes. The CRC16 is then inverted and stored
* low byte first followed by the high byte. The structure is
* used by this method to verify the data but only
* the data payload is returned. The
* readContinue parameter is used to eliminate the overhead in re-accessing
* a part already being read from. For example, if pages 0 - 4 are to
* be read, readContinue would be set to false for page 0 and would be set
* to true for the next four calls.
*
* <P> See Dallas Semiconductor Application Note 114
* for details: <A HREF="http://dbserv.maxim-ic.com/appnotes.cfm?appnote_number=114">
* http://dbserv.maxim-ic.com/appnotes.cfm?appnote_number=114</A>
*
* <P> Note: Using readContinue = true can only be used if the new
* read continues where the last one left off
* and it is inside a 'beginExclusive/endExclusive'
* block.
*
* @param page page number to read packet from
* @param readContinue <CODE> true </CODE> true then device read
* is continued without re-selecting
* @param readBuf location for data read
* @param offset offset into readBuf to place data
*
* @return number of data bytes read from the device and saved to
* readBuf at the provided offset
*
* @throws OneWireIOException on a 1-Wire communication error such as
* an invalid CRC16 or length found in the packet. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* It could also be caused due to the device page not containing a
* valid packet.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getMaxPacketDataLength() getMaxPacketDataLength
*/
public int readPagePacket(int page, boolean readContinue, ByteArray readBuf, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).readPagePacket(page, readContinue, readBuf.array, offset);
}
======================================
public int readPagePacket(int, boolean, byte[], int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int readPagePacket
sParams=int, boolean, byte[], int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int readPagePacket5
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public int readPagePacket
params=int,boolean,byte[],int,byte[]
/**
* Reads a Universal Data Packet and extra information. See the
* method
* {@link #readPagePacket(int,boolean,byte[],int) readPagePacket}
* for a description of the packet structure. The
* readContinue parameter is used to eliminate the overhead in re-accessing
* a part already being read from. For example, if pages 0 - 4 are to
* be read, readContinue would be set to false for page 0 and would be set
* to true for the next four calls.
*
* <P> Note: Using readContinue = true can only be used if the new
* read continues where the last one left off
* and it is inside a 'beginExclusive/endExclusive'
* block.
*
* @param page page number to read packet from
* @param readContinue <CODE> true </CODE> then device read
* is continued without re-selecting
* @param readBuf location for data read
* @param offset offset into readBuf to place data
* @param extraInfo location for extra info read
*
* @return number of data bytes read from the device and written to
* readBuf at the offset.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* an invalid CRC16 or length found in the packet. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* It could also be caused due to the device page not containing a
* valid packet.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #hasExtraInfo() hasExtraInfo
* @see #getExtraInfoLength() getExtraInfoLength
* @see #getMaxPacketDataLength() getMaxPacketDataLength
*/
public int readPagePacket(int page, boolean readContinue, ByteArray readBuf, int offset, ByteArray extraInfo)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return ((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).readPagePacket(page, readContinue, readBuf.array, offset, extraInfo.array);
}
======================================
public void writePagePacket(int, byte[], int, int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void writePagePacket
sParams=int, byte[], int, int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void writePagePacket4
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public void writePagePacket
params=int,byte[],int,int
/**
* Writes a Universal Data Packet. See the method
* {@link #readPagePacket(int,boolean,byte[],int) readPagePacket}
* for a description of the packet structure.
*
* @param page page number to write packet to
* @param writeBuf data to write
* @param offset offset into writeBuf where data to write is
* @param len number of bytes to write with a max of
* {@link #getMaxPacketDataLength() getMaxPacketDataLength}
* elements
*
* @throws OneWireIOException on a 1-Wire communication error such as
* read verification error on write. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* It could also be caused due to the device page being write protected.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #getMaxPacketDataLength() getMaxPacketDataLength
*/
public void writePagePacket(int page, ByteArray writeBuf, int offset, int len)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).writePagePacket(page, writeBuf.array, offset, len);
}
======================================
public void readPageCRC(int, boolean, byte[], int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void readPageCRC
sParams=int, boolean, byte[], int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void readPageCRC4
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public void readPageCRC
params=int,boolean,byte[],int
/**
* Reads a complete memory page with CRC verification provided by the
* device. Not supported by all devices. The
* readContinue parameter is used to eliminate the overhead in re-accessing
* a part already being read from. For example, if pages 0 - 4 are to
* be read, readContinue would be set to false for page 0 and would be set
* to true for the next four calls.
*
* <P> Note: Using readContinue = true can only be used if the new
* read continues where the last one left off
* and it is inside a 'beginExclusive/endExclusive'
* block.
*
* @param page page number to read
* @param readContinue <CODE> true </CODE> true then device read
* is continued without re-selecting
* @param readBuf location for data read
* @param offset offset into readBuf to place data
*
* @throws OneWireIOException on a 1-Wire communication error such as
* an invalid CRC read from device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #hasPageAutoCRC() hasPageAutoCRC
* @see #getPageLength() getPageLength
*/
public void readPageCRC(int page, boolean readContinue, ByteArray readBuf, int offset)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).readPageCRC(page, readContinue, readBuf.array, offset);
}
======================================
public void readPageCRC(int, boolean, byte[], int, byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void readPageCRC
sParams=int, boolean, byte[], int, byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void readPageCRC5
getMethodDocumentation
className=com.dalsemi.onewire.container.PagedMemoryBank
methodName=public void readPageCRC
params=int,boolean,byte[],int,byte[]
/**
* Reads a complete memory page with CRC verification provided by the
* device with extra information. Not supported by all devices. The
* readContinue parameter is used to eliminate the overhead in re-accessing
* a part already being read from. For example, if pages 0 - 4 are to
* be read, readContinue would be set to false for page 0 and would be set
* to true for the next four calls.
*
*
* <P> Note: Using readContinue = true can only be used if the new
* read continues where the last one left off
* and it is inside a 'beginExclusive/endExclusive'
* block.
*
* @param page page number to read
* @param readContinue <CODE> true </CODE> true then device read
* is issued without continued without re-selecting
* @param readBuf location for data read
* @param offset offset into readBuf to place data
* @param extraInfo location for extra info read
*
* @throws OneWireIOException on a 1-Wire communication error such as
* an invalid CRC read from device. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter
*
* @see #hasExtraInfo() hasExtraInfo
* @see #getExtraInfoLength() getExtraInfoLength
* @see #hasPageAutoCRC() hasPageAutoCRC
* @see #getPageLength() getPageLength
*/
public void readPageCRC(int page, boolean readContinue, ByteArray readBuf, int offset, ByteArray extraInfo)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
((com.dalsemi.onewire.container.PagedMemoryBank)objectInstance).readPageCRC(page, readContinue, readBuf.array, offset, extraInfo.array);
}
-------------------------------------------------------------------
creating: owapi\PasswordContainer.java
No COM CLSID for PasswordContainer
======================================
public int getReadOnlyPasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadOnlyPasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadOnlyPasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public int getReadOnlyPasswordLength
params=
/**
* Returns the length in bytes of the Read-Only password.
*
* @return the length in bytes of the Read-Only password.
*/
public int getReadOnlyPasswordLength()
throws com.dalsemi.onewire.OneWireException;
======================================
public int getReadWritePasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadWritePasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadWritePasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public int getReadWritePasswordLength
params=
/**
* Returns the length in bytes of the Read/Write password.
*
* @return the length in bytes of the Read/Write password.
*/
public int getReadWritePasswordLength()
throws com.dalsemi.onewire.OneWireException;
======================================
public int getWriteOnlyPasswordLength() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getWriteOnlyPasswordLength
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getWriteOnlyPasswordLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public int getWriteOnlyPasswordLength
params=
/**
* Returns the length in bytes of the Write-Only password.
*
* @return the length in bytes of the Write-Only password.
*/
public int getWriteOnlyPasswordLength()
throws com.dalsemi.onewire.OneWireException;
======================================
public int getReadOnlyPasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadOnlyPasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadOnlyPasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public int getReadOnlyPasswordAddress
params=
/**
* Returns the absolute address of the memory location where
* the Read-Only password is written.
*
* @return the absolute address of the memory location where
* the Read-Only password is written.
*/
public int getReadOnlyPasswordAddress()
throws com.dalsemi.onewire.OneWireException;
======================================
public int getReadWritePasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getReadWritePasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getReadWritePasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public int getReadWritePasswordAddress
params=
/**
* Returns the absolute address of the memory location where
* the Read/Write password is written.
*
* @return the absolute address of the memory location where
* the Read/Write password is written.
*/
public int getReadWritePasswordAddress()
throws com.dalsemi.onewire.OneWireException;
======================================
public int getWriteOnlyPasswordAddress() throws com.dalsemi.onewire.OneWireException
sMethodName=public int getWriteOnlyPasswordAddress
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public int getWriteOnlyPasswordAddress0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public int getWriteOnlyPasswordAddress
params=
/**
* Returns the absolute address of the memory location where
* the Write-Only password is written.
*
* @return the absolute address of the memory location where
* the Write-Only password is written.
*/
public int getWriteOnlyPasswordAddress()
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean hasReadOnlyPassword()
sMethodName=public boolean hasReadOnlyPassword
sParams=
sThrows=
tempMethodName=public boolean hasReadOnlyPassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean hasReadOnlyPassword
params=
/**
* Returns true if this device has a Read-Only password.
* If false, all other functions dealing with the Read-Only
* password will throw an exception if called.
*
* @return <code>true</code> if this device has a Read-Only password.
*/
public boolean hasReadOnlyPassword();
======================================
public boolean hasReadWritePassword()
sMethodName=public boolean hasReadWritePassword
sParams=
sThrows=
tempMethodName=public boolean hasReadWritePassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean hasReadWritePassword
params=
/**
* Returns true if this device has a Read/Write password.
* If false, all other functions dealing with the Read/Write
* password will throw an exception if called.
*
* @return <code>true</code> if this device has a Read/Write password.
*/
public boolean hasReadWritePassword();
======================================
public boolean hasWriteOnlyPassword()
sMethodName=public boolean hasWriteOnlyPassword
sParams=
sThrows=
tempMethodName=public boolean hasWriteOnlyPassword0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean hasWriteOnlyPassword
params=
/**
* Returns true if this device has a Write-Only password.
* If false, all other functions dealing with the Write-Only
* password will throw an exception if called.
*
* @return <code>true</code> if this device has a Write-Only password.
*/
public boolean hasWriteOnlyPassword();
======================================
public boolean getDeviceReadOnlyPasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceReadOnlyPasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceReadOnlyPasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean getDeviceReadOnlyPasswordEnable
params=
/**
* Returns true if the device's Read-Only password has been enabled.
*
* @return <code>true</code> if the device's Read-Only password has been enabled.
*/
public boolean getDeviceReadOnlyPasswordEnable()
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean getDeviceReadWritePasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceReadWritePasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceReadWritePasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean getDeviceReadWritePasswordEnable
params=
/**
* Returns true if the device's Read/Write password has been enabled.
*
* @return <code>true</code> if the device's Read/Write password has been enabled.
*/
public boolean getDeviceReadWritePasswordEnable()
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean getDeviceWriteOnlyPasswordEnable() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getDeviceWriteOnlyPasswordEnable
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getDeviceWriteOnlyPasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean getDeviceWriteOnlyPasswordEnable
params=
/**
* Returns true if the device's Write-Only password has been enabled.
*
* @return <code>true</code> if the device's Write-Only password has been enabled.
*/
public boolean getDeviceWriteOnlyPasswordEnable()
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean hasSinglePasswordEnable()
sMethodName=public boolean hasSinglePasswordEnable
sParams=
sThrows=
tempMethodName=public boolean hasSinglePasswordEnable0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean hasSinglePasswordEnable
params=
/**
* Returns true if this device has the capability to enable one type of password
* while leaving another type disabled. i.e. if the device has Read-Only password
* protection and Write-Only password protection, this method indicates whether or
* not you can enable Read-Only protection while leaving the Write-Only protection
* disabled.
*
* @return <code>true</code> if the device has the capability to enable one type
* of password while leaving another type disabled.
*/
public boolean hasSinglePasswordEnable();
======================================
public void setDevicePasswordEnable(boolean, boolean, boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDevicePasswordEnable
sParams=boolean, boolean, boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDevicePasswordEnable3
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setDevicePasswordEnable
params=boolean,boolean,boolean
/**
* <p>Enables/Disables passwords for this Device. This method allows you to
* individually enable the different types of passwords for a particular
* device. If <code>hasSinglePasswordEnable()</code> returns true,
* you can selectively enable particular types of passwords. Otherwise,
* this method will throw an exception if all supported types are not
* enabled.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* @param enableReadOnly if <code>true</code> Read-Only passwords will be enabled.
* @param enableReadWrite if <code>true</code> Read/Write passwords will be enabled.
* @param enableWriteOnly if <code>true</code> Write-Only passwords will be enabled.
*/
public void setDevicePasswordEnable(boolean enableReadOnly, boolean enableReadWrite, boolean enableWriteOnly)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setDevicePasswordEnableAll(boolean) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDevicePasswordEnableAll
sParams=boolean
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDevicePasswordEnableAll1
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setDevicePasswordEnableAll
params=boolean
/**
* <p>Enables/Disables passwords for this device. If the part has more than one
* type of password (Read-Only, Write-Only, or Read/Write), all passwords
* will be enabled. This function is equivalent to the following:
* <code> owc41.setDevicePasswordEnable(
* owc41.hasReadOnlyPassword(),
* owc41.hasReadWritePassword(),
* owc41.hasWriteOnlyPassword() ); </code></p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* @param enableAll if <code>true</code>, all passwords are enabled. Otherwise,
* all passwords are disabled.
*/
public void setDevicePasswordEnableAll(boolean enableAll)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setDeviceReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setDeviceReadOnlyPassword
params=byte[],int
/**
* <p>Writes the given password to the device's Read-Only password register. Note
* that this function does not enable the password, just writes the value to
* the appropriate memory location.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* @param password the new password to be written to the device's Read-Only
* password register. Length must be
* <code>(offset + getReadOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setDeviceReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setDeviceReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setDeviceReadWritePassword
params=byte[],int
/**
* <p>Writes the given password to the device's Read/Write password register. Note
* that this function does not enable the password, just writes the value to
* the appropriate memory location.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* @param password the new password to be written to the device's Read-Write
* password register. Length must be
* <code>(offset + getReadWritePasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setDeviceReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setDeviceWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void setDeviceWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void setDeviceWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setDeviceWriteOnlyPassword
params=byte[],int
/**
* <p>Writes the given password to the device's Write-Only password register. Note
* that this function does not enable the password, just writes the value to
* the appropriate memory location.</p>
*
* <p>For this to be successful, either write-protect passwords must be disabled,
* or the write-protect password(s) for this container must be set and must match
* the value of the write-protect password(s) in the device's register.</p>
*
* @param password the new password to be written to the device's Write-Only
* password register. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setDeviceWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public void setContainerReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setContainerReadOnlyPassword
params=byte[],int
/**
* Sets the Read-Only password used by the API when reading from the
* device's memory. This password is not written to the device's
* Read-Only password register. It is the password used by the
* software for interacting with the device only.
*
* @param password the new password to be used by the API when
* reading from the device's memory. Length must be
* <code>(offset + getReadOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setContainerReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setContainerReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setContainerReadWritePassword
params=byte[],int
/**
* Sets the Read/Write password used by the API when reading from or
* writing to the device's memory. This password is not written to
* the device's Read/Write password register. It is the password used
* by the software for interacting with the device only.
*
* @param password the new password to be used by the API when
* reading from or writing to the device's memory. Length must be
* <code>(offset + getReadWritePasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setContainerReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setContainerWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setContainerWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setContainerWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void setContainerWriteOnlyPassword
params=byte[],int
/**
* Sets the Write-Only password used by the API when writing to the
* device's memory. This password is not written to the device's
* Write-Only password register. It is the password used by the
* software for interacting with the device only.
*
* @param password the new password to be used by the API when
* writing to the device's memory. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying from the given password array
*/
public void setContainerWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean isContainerReadOnlyPasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerReadOnlyPasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerReadOnlyPasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean isContainerReadOnlyPasswordSet
params=
/**
* Returns true if the password used by the API for reading from the
* device's memory has been set. The return value is not affected by
* whether or not the read password of the container actually matches
* the value in the device's password register.
*
* @return <code>true</code> if the password used by the API for
* reading from the device's memory has been set.
*/
public boolean isContainerReadOnlyPasswordSet()
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean isContainerReadWritePasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerReadWritePasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerReadWritePasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean isContainerReadWritePasswordSet
params=
/**
* Returns true if the password used by the API for reading from or
* writing to the device's memory has been set. The return value is
* not affected by whether or not the read/write password of the
* container actually matches the value in the device's password
* register.
*
* @return <code>true</code> if the password used by the API for
* reading from or writing to the device's memory has been set.
*/
public boolean isContainerReadWritePasswordSet()
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean isContainerWriteOnlyPasswordSet() throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean isContainerWriteOnlyPasswordSet
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean isContainerWriteOnlyPasswordSet0
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public boolean isContainerWriteOnlyPasswordSet
params=
/**
* Returns true if the password used by the API for writing to the
* device's memory has been set. The return value is not affected by
* whether or not the write password of the container actually matches
* the value in the device's password register.
*
* @return <code>true</code> if the password used by the API for
* writing to the device's memory has been set.
*/
public boolean isContainerWriteOnlyPasswordSet()
throws com.dalsemi.onewire.OneWireException;
======================================
public void getContainerReadOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerReadOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerReadOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void getContainerReadOnlyPassword
params=byte[],int
/**
* Gets the Read-Only password used by the API when reading from the
* device's memory. This password is not read from the device's
* Read-Only password register. It is the password used by the
* software for interacting with the device only and must have been
* set using the <code>setContainerReadOnlyPassword</code> method.
*
* @param password array for holding the password that is used by the
* API when reading from the device's memory. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying into the given password array
*/
public void getContainerReadOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException;
======================================
public void getContainerReadWritePassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerReadWritePassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerReadWritePassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void getContainerReadWritePassword
params=byte[],int
/**
* Gets the Read/Write password used by the API when reading from or
* writing to the device's memory. This password is not read from
* the device's Read/Write password register. It is the password used
* by the software for interacting with the device only and must have
* been set using the <code>setContainerReadWritePassword</code> method.
*
* @param password array for holding the password that is used by the
* API when reading from or writing to the device's memory. Length must be
* <code>(offset + getReadWritePasswordLength)</code>
* @param offset the starting point for copying into the given password array
*/
public void getContainerReadWritePassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException;
======================================
public void getContainerWriteOnlyPassword(byte[], int) throws com.dalsemi.onewire.OneWireException
sMethodName=public void getContainerWriteOnlyPassword
sParams=byte[], int
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void getContainerWriteOnlyPassword2
getMethodDocumentation
className=com.dalsemi.onewire.container.PasswordContainer
methodName=public void getContainerWriteOnlyPassword
params=byte[],int
/**
* Gets the Write-Only password used by the API when writing to the
* device's memory. This password is not read from the device's
* Write-Only password register. It is the password used by the
* software for interacting with the device only and must have been
* set using the <code>setContainerWriteOnlyPassword</code> method.
*
* @param password array for holding the password that is used by the
* API when writing to the device's memory. Length must be
* <code>(offset + getWriteOnlyPasswordLength)</code>
* @param offset the starting point for copying into the given password array
*/
public void getContainerWriteOnlyPassword(ByteArray password, int offset)
throws com.dalsemi.onewire.OneWireException;
-------------------------------------------------------------------
creating: owapi\PotentiometerContainer.java
No COM CLSID for PotentiometerContainer
======================================
public boolean isLinear(byte[])
sMethodName=public boolean isLinear
sParams=byte[]
sThrows=
tempMethodName=public boolean isLinear1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public boolean isLinear
params=byte[]
/**
* Querys to see if this Potentiometer 1-Wire Device
* has linear potentiometer element(s) or logarithmic
* potentiometer element(s).
*
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if this device has linear potentiometer element(s),
* <CODE>false</CODE> if this device has logarithmic potentiometer element(s)
*/
public boolean isLinear(ByteArray state);
======================================
public boolean wiperSettingsAreVolatile(byte[])
sMethodName=public boolean wiperSettingsAreVolatile
sParams=byte[]
sThrows=
tempMethodName=public boolean wiperSettingsAreVolatile1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public boolean wiperSettingsAreVolatile
params=byte[]
/**
* Querys to see if this Potentiometer 1-Wire Device's
* wiper settings are volatile or non-volatile.
*
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if the wiper settings are volatile,
* <CODE>false</CODE> if the wiper settings are non-volatile.
*/
public boolean wiperSettingsAreVolatile(ByteArray state);
======================================
public int numberOfPotentiometers(byte[])
sMethodName=public int numberOfPotentiometers
sParams=byte[]
sThrows=
tempMethodName=public int numberOfPotentiometers1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int numberOfPotentiometers
params=byte[]
/**
* Querys to see how many potentiometers this
* Potentiometer 1-Wire Device has.
*
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return number of potentiometers on this device
*/
public int numberOfPotentiometers(ByteArray state);
======================================
public int numberOfWiperSettings(byte[])
sMethodName=public int numberOfWiperSettings
sParams=byte[]
sThrows=
tempMethodName=public int numberOfWiperSettings1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int numberOfWiperSettings
params=byte[]
/**
* Querys to find the number of wiper settings
* that any wiper on this Potentiometer 1-Wire
* Device can have.
*
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return number of wiper positions available
*/
public int numberOfWiperSettings(ByteArray state);
======================================
public int potentiometerResistance(byte[])
sMethodName=public int potentiometerResistance
sParams=byte[]
sThrows=
tempMethodName=public int potentiometerResistance1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int potentiometerResistance
params=byte[]
/**
* Querys to find the resistance value of the potentiometer.
*
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return resistance value in k-Ohms
*/
public int potentiometerResistance(ByteArray state);
======================================
public int getCurrentWiperNumber(byte[])
sMethodName=public int getCurrentWiperNumber
sParams=byte[]
sThrows=
tempMethodName=public int getCurrentWiperNumber1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int getCurrentWiperNumber
params=byte[]
/**
* Gets the currently selected wiper number. All wiper actions
* affect this wiper. The number of wipers is the same as
* <CODE>numberOfPotentiometers()</CODE>.
*
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return current wiper number
*/
public int getCurrentWiperNumber(ByteArray state);
======================================
public void setCurrentWiperNumber(int, byte[])
sMethodName=public void setCurrentWiperNumber
sParams=int, byte[]
sThrows=
tempMethodName=public void setCurrentWiperNumber2
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public void setCurrentWiperNumber
params=int,byte[]
/**
* Sets the currently selected wiper number. All wiper actions will
* then affect this wiper. The number of wipers is the same as
* <CODE>numberOfPotentiometers()</CODE>.
*
* @param wiper_number wiper number to select for communication
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
*/
public void setCurrentWiperNumber(int wiper_number, ByteArray state);
======================================
public boolean isChargePumpOn(byte[])
sMethodName=public boolean isChargePumpOn
sParams=byte[]
sThrows=
tempMethodName=public boolean isChargePumpOn1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public boolean isChargePumpOn
params=byte[]
/**
* Determines if the Potentiometer's charge pump is enabled.
*
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if enabled, <CODE>false</CODE> if not
*
*/
public boolean isChargePumpOn(ByteArray state);
======================================
public void setChargePump(boolean, byte[])
sMethodName=public void setChargePump
sParams=boolean, byte[]
sThrows=
tempMethodName=public void setChargePump2
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public void setChargePump
params=boolean,byte[]
/**
* Sets the state of the Potentiometer'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.
*
* @param charge_pump_on <CODE>true</CODE> to enable the charge pump, <CODE>false</CODE> to disable charge pump
* @param state state buffer of the Potentiometer 1-Wire Device (returned by <CODE>readDevice()</CODE>)
* @return <CODE>true</CODE> if the operation was successful, <CODE>false</CODE> if there was an error
*/
public void setChargePump(boolean charge_pump_on, ByteArray state);
======================================
public int getWiperPosition() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int getWiperPosition
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int getWiperPosition0
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int getWiperPosition
params=
/**
* Gets the current wiper position of the Potentiometer. The wiper position
* is between 0 and <CODE>numberOfWiperPositions()</CODE>, and describes the voltage output.
*
* @return wiper position between 0 and <CODE>numberOfWiperPositions()</CODE>
*
* @exception OneWireIOException Data was not read correctly
* @exception com.dalsemi.onewire.OneWireException Could not find device
*/
public int getWiperPosition()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public boolean setWiperPosition(int) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public boolean setWiperPosition
sParams=int
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public boolean setWiperPosition1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public boolean setWiperPosition
params=int
/**
* Sets the wiper position of the potentiometer.
*
* @param position position to set the wiper to
* @return <CODE>true</CODE> if the operation was successful, <CODE>false</CODE> otherwise
*
* @exception OneWireIOException Data was not written correctly
* @exception com.dalsemi.onewire.OneWireException Could not find device
*/
public boolean setWiperPosition(int a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public int increment(boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int increment
sParams=boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int increment1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int increment
params=boolean
/**
* Increments the wiper position by one.
*
* @param reselect <CODE>increment()</CODE> can be called without resetting
* the part if the last call was an <CODE>increment()</CODE> or <CODE>decrement()</CODE>.
* <CODE>true</CODE> if device is to be selected (must be called with <CODE>true</CODE>
* after any other 1-wire method)
*
* @return new position of wiper (0 to <CODE>numberOfWiperPositions()</CODE>)
*
* @exception OneWireIOException Data was not written correctly
* @exception com.dalsemi.onewire.OneWireException Could not find device
*/
public int increment(boolean a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public int decrement(boolean) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int decrement
sParams=boolean
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int decrement1
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int decrement
params=boolean
/**
* Decrements the wiper position.
*
* @param reselect <CODE>decrement()</CODE> can be called without resetting
* the part if the last call was an <CODE>increment()</CODE> or <CODE>decrement()</CODE>.
* <CODE>true</CODE> if device is to be selected (must be called with <CODE>true</CODE>
* after any other 1-wire method)
*
* @return new position of wiper (0 to <CODE>numberOfWiperPositions()</CODE>).
*
* @exception OneWireIOException Data was not written correctly
* @exception com.dalsemi.onewire.OneWireException Could not find device
*/
public int decrement(boolean a0)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public int increment() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int increment
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int increment0
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int increment
params=
/**
* Increments the wiper position by one.
*
* @param reselect <CODE>increment()</CODE> can be called without resetting
* the part if the last call was an <CODE>increment()</CODE> or <CODE>decrement()</CODE>.
* <CODE>true</CODE> if device is to be selected (must be called with <CODE>true</CODE>
* after any other 1-wire method)
*
* @return new position of wiper (0 to <CODE>numberOfWiperPositions()</CODE>)
*
* @exception OneWireIOException Data was not written correctly
* @exception com.dalsemi.onewire.OneWireException Could not find device
*/
public int increment()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public int decrement() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public int decrement
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public int decrement0
getMethodDocumentation
className=com.dalsemi.onewire.container.PotentiometerContainer
methodName=public int decrement
params=
/**
* Decrements the wiper position.
*
* @param reselect <CODE>decrement()</CODE> can be called without resetting
* the part if the last call was an <CODE>increment()</CODE> or <CODE>decrement()</CODE>.
* <CODE>true</CODE> if device is to be selected (must be called with <CODE>true</CODE>
* after any other 1-wire method)
*
* @return new position of wiper (0 to <CODE>numberOfWiperPositions()</CODE>).
*
* @exception OneWireIOException Data was not written correctly
* @exception com.dalsemi.onewire.OneWireException Could not find device
*/
public int decrement()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
-------------------------------------------------------------------
creating: owapi\ResponseAPDU.java
======================================
public com.dalsemi.onewire.container.ResponseAPDU(byte[])
sMethodName=public com.dalsemi.onewire.container.ResponseAPDU
sParams=byte[]
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public void createNewInstance
params=byte[]
/**
* Constructs a new <code>ResponseAPDU</code> with the given buffer
* byte array. The internal <code>apduLength</code> is set to the
* length of the buffer passed.
*
* @param buffer the byte array with data for the internal
* <code>apduBuffer</code>
*
* @throws RuntimeException thrown when <code>buffer</code> length
* < <code>2</code>.
*
* @see CommandAPDU
*/
public void createNewInstance(ByteArray buffer)
{
objectInstance = new com.dalsemi.onewire.container.ResponseAPDU(buffer.array);
}
======================================
public byte getData()[]
sMethodName=public byte getData
sParams=
sThrows=
tempMethodName=public ByteArray getData0
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public byte[] getData
params=
/**
* Gets the data field of this <code>ResponseAPDU</code>.
*
* @return a byte array containing this <code>ResponseAPDU</code> data field
*/
public ByteArray getData()
{
return new ByteArray().setupObject(objectInstance.getData());
}
======================================
public final int getSW()
sMethodName=public final int getSW
sParams=
sThrows=
tempMethodName=public final int getSW0
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public final int getSW
params=
/**
* Gets the value of SW1 and SW2 as an integer.
* It is computed as:<BR><BR>
* <code>(((SW1 << 8) & 0xFF00) | (SW2 & 0xFF))</code><BR>
*
* @return <code>(((SW1 << 8) & 0xFF00) | (SW2 & 0xFF))</code> as an integer
*/
public final int getSW()
{
return objectInstance.getSW();
}
======================================
public final byte getSW1()
sMethodName=public final byte getSW1
sParams=
sThrows=
tempMethodName=public final byte getSW10
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public final byte getSW1
params=
/**
* Gets the value of SW1.
*
* @return value of SW1 as a byte
*/
public final byte getSW1()
{
return objectInstance.getSW1();
}
======================================
public final byte getSW2()
sMethodName=public final byte getSW2
sParams=
sThrows=
tempMethodName=public final byte getSW20
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public final byte getSW2
params=
/**
* Gets the value of SW2.
*
* @return value of SW2 as a byte
*/
public final byte getSW2()
{
return objectInstance.getSW2();
}
======================================
public final byte getByte(int)
sMethodName=public final byte getByte
sParams=int
sThrows=
tempMethodName=public final byte getByte1
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public final byte getByte
params=int
/**
* Gets the byte value at the specified offset in <code>apduBuffer</code>.
*
* @param index the offset in the <code>apduBuffer</code>
* @return the value at the given offset,
* or <code>-1</code> if the offset is invalid
*
* @see #getBytes
* @see #getLength
*/
public final byte getByte(int index)
{
return objectInstance.getByte(index);
}
======================================
public final byte getBytes()[]
sMethodName=public final byte getBytes
sParams=
sThrows=
tempMethodName=public final ByteArray getBytes0
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public final byte[] getBytes
params=
/**
* Gets a byte array holding this <code>ResponseAPDU</code>
* <code>apduBuffer</code>.
*
* @return <code>apduBuffer</code> copied into a new array
*
* @see #getByte
* @see #getLength
*/
public final ByteArray getBytes()
{
return new ByteArray().setupObject(objectInstance.getBytes());
}
======================================
public final int getLength()
sMethodName=public final int getLength
sParams=
sThrows=
tempMethodName=public final int getLength0
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public final int getLength
params=
/**
* Gets the length of <code>apduBuffer</code>.
*
* @return <code>apduLength</code> the length of the
* <code>apduBuffer</code> currently stored
*/
public final int getLength()
{
return objectInstance.getLength();
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.container.ResponseAPDU
methodName=public java.lang.String toString
params=
/**
* Gets a string representation of this <code>ResponseAPDU</code>.
*
* @return a string describing this <code>ResponseAPDU</code>
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
-------------------------------------------------------------------
creating: owapi\SwitchContainer.java
No COM CLSID for SwitchContainer
======================================
public boolean isHighSideSwitch()
sMethodName=public boolean isHighSideSwitch
sParams=
sThrows=
tempMethodName=public boolean isHighSideSwitch0
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean isHighSideSwitch
params=
/**
* Checks to see if the channels of this switch are 'high side'
* switches. This indicates that when 'on' or <code>true</code>, the switch output is
* connect to the 1-Wire data. If this method returns <code>false</code>
* then when the switch is 'on' or <code>true</code>, the switch is connected
* to ground.
*
* @return <code>true</code> if the switch is a 'high side' switch,
* <code>false</code> if the switch is a 'low side' switch
*
* @see #getLatchState(int,byte[])
*/
public boolean isHighSideSwitch();
======================================
public boolean hasActivitySensing()
sMethodName=public boolean hasActivitySensing
sParams=
sThrows=
tempMethodName=public boolean hasActivitySensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean hasActivitySensing
params=
/**
* Checks to see if the channels of this switch support
* activity sensing. If this method returns <code>true</code> then the
* method <code>getSensedActivity(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support activity sensing
*
* @see #getSensedActivity(int,byte[])
* @see #clearActivity()
*/
public boolean hasActivitySensing();
======================================
public boolean hasLevelSensing()
sMethodName=public boolean hasLevelSensing
sParams=
sThrows=
tempMethodName=public boolean hasLevelSensing0
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean hasLevelSensing
params=
/**
* Checks to see if the channels of this switch support
* level sensing. If this method returns <code>true</code> then the
* method <code>getLevel(int,byte[])</code> can be used.
*
* @return <code>true</code> if channels support level sensing
*
* @see #getLevel(int,byte[])
*/
public boolean hasLevelSensing();
======================================
public boolean hasSmartOn()
sMethodName=public boolean hasSmartOn
sParams=
sThrows=
tempMethodName=public boolean hasSmartOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean hasSmartOn
params=
/**
* Checks to see if the channels of this switch support
* 'smart on'. Smart on is the ability to turn on a channel
* such that only 1-Wire device on this channel are awake
* and ready to do an operation. This greatly reduces
* the time to discover the device down a branch.
* If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* can be used with the <code>doSmart</code> parameter <code>true</code>.
*
* @return <code>true</code> if channels support 'smart on'
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean hasSmartOn();
======================================
public boolean onlySingleChannelOn()
sMethodName=public boolean onlySingleChannelOn
sParams=
sThrows=
tempMethodName=public boolean onlySingleChannelOn0
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean onlySingleChannelOn
params=
/**
* Checks to see if the channels of this switch require that only one
* channel is on at any one time. If this method returns <code>true</code> then the
* method <code>setLatchState(int,boolean,boolean,byte[])</code>
* will not only affect the state of the given
* channel but may affect the state of the other channels as well
* to insure that only one channel is on at a time.
*
* @return <code>true</code> if only one channel can be on at a time.
*
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean onlySingleChannelOn();
======================================
public int getNumberChannels(byte[])
sMethodName=public int getNumberChannels
sParams=byte[]
sThrows=
tempMethodName=public int getNumberChannels1
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public int getNumberChannels
params=byte[]
/**
* Gets the number of channels supported by this switch.
* Channel specific methods will use a channel number specified
* by an integer from [0 to (<code>getNumberChannels(byte[])</code> - 1)]. Note that
* all devices of the same family will not necessarily have the
* same number of channels. The DS2406 comes in two packages--one that
* has a single channel, and one that has two channels.
*
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return the number of channels for this device
*/
public int getNumberChannels(ByteArray state);
======================================
public boolean getLevel(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getLevel
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getLevel2
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean getLevel
params=int,byte[]
/**
* Checks the sensed level on the indicated channel.
* To avoid an exception, verify that this switch
* has level sensing with the <code>hasLevelSensing()</code>.
* Level sensing means that the device can sense the logic
* level on its PIO pin.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if level sensed is 'high' and <code>false</code> if level sensed is 'low'
*
* @see OneWireSensor#readDevice()
* @see #hasLevelSensing()
*/
public boolean getLevel(int a0, ByteArray a1)
throws com.dalsemi.onewire.OneWireException;
======================================
public boolean getLatchState(int, byte[])
sMethodName=public boolean getLatchState
sParams=int, byte[]
sThrows=
tempMethodName=public boolean getLatchState2
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean getLatchState
params=int,byte[]
/**
* Checks the latch state of the indicated channel.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if channel latch is 'on'
* or conducting and <code>false</code> if channel latch is 'off' and not
* conducting. Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
*
* @see OneWireSensor#readDevice()
* @see #isHighSideSwitch()
* @see #setLatchState(int,boolean,boolean,byte[])
*/
public boolean getLatchState(int a0, ByteArray a1);
======================================
public boolean getSensedActivity(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public boolean getSensedActivity
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public boolean getSensedActivity2
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public boolean getSensedActivity
params=int,byte[]
/**
* Checks if the indicated channel has experienced activity.
* This occurs when the level on the PIO pins changes. To clear
* the activity that is reported, call <code>clearActivity()</code>.
* To avoid an exception, verify that this device supports activity
* sensing by calling the method <code>hasActivitySensing()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param state current state of the device returned from <code>readDevice()</code>
*
* @return <code>true</code> if activity was detected and <code>false</code> if no activity was detected
*
* @throws OneWireException if this device does not have activity sensing
*
* @see #hasActivitySensing()
* @see #clearActivity()
*/
public boolean getSensedActivity(int channel, ByteArray state)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setLatchState(int, boolean, boolean, byte[])
sMethodName=public void setLatchState
sParams=int, boolean, boolean, byte[]
sThrows=
tempMethodName=public void setLatchState4
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public void setLatchState
params=int,boolean,boolean,byte[]
/**
* Sets the latch state of the indicated channel.
* The method <code>writeDevice()</code> must be called to finalize
* changes to the device. Note that multiple 'set' methods can
* be called before one call to <code>writeDevice()</code>.
*
* @param channel channel to execute this operation, in the range [0 to (<code>getNumberChannels(byte[])</code> - 1)]
* @param latchState <code>true</code> to set the channel latch 'on'
* (conducting) and <code>false</code> to set the channel latch 'off' (not
* conducting). Note that the actual output when the latch is 'on'
* is returned from the <code>isHighSideSwitch()</code> method.
* @param doSmart If latchState is 'on'/<code>true</code> then doSmart indicates
* if a 'smart on' is to be done. To avoid an exception
* check the capabilities of this device using the
* <code>hasSmartOn()</code> method.
* @param state current state of the device returned from <code>readDevice()</code>
*
* @see #hasSmartOn()
* @see #getLatchState(int,byte[])
* @see OneWireSensor#writeDevice(byte[])
*/
public void setLatchState(int a0, boolean a1, boolean a2, ByteArray a3);
======================================
public void clearActivity() throws com.dalsemi.onewire.OneWireException
sMethodName=public void clearActivity
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void clearActivity0
getMethodDocumentation
className=com.dalsemi.onewire.container.SwitchContainer
methodName=public void clearActivity
params=
/**
* <p>Clears the activity latches the next time possible. For
* example, on a DS2406/07, this happens the next time the
* status is read with <code>readDevice()</code>.</p>
*
* <p>The activity latches will only be cleared once. With the
* DS2406/07, this means that only the first call to <code>readDevice()</code>
* will clear the activity latches. Subsequent calls to <code>readDevice()</code>
* will leave the activity latch states intact, unless this method has been invoked
* since the last call to <code>readDevice()</code>.</p>
*
* @throws OneWireException if this device does not support activity sensing
*
* @see OneWireSensor#readDevice()
* @see #getSensedActivity(int,byte[])
*/
public void clearActivity()
throws com.dalsemi.onewire.OneWireException;
-------------------------------------------------------------------
creating: owapi\TemperatureContainer.java
No COM CLSID for TemperatureContainer
======================================
public static final int ALARM_HIGH
======================================
public static final int ALARM_LOW
======================================
public boolean hasTemperatureAlarms()
sMethodName=public boolean hasTemperatureAlarms
sParams=
sThrows=
tempMethodName=public boolean hasTemperatureAlarms0
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public boolean hasTemperatureAlarms
params=
/**
* Checks to see if this temperature measuring device has high/low
* trip alarms.
*
* @return <code>true</code> if this <code>TemperatureContainer</code>
* has high/low trip alarms
*
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*/
public boolean hasTemperatureAlarms();
======================================
public boolean hasSelectableTemperatureResolution()
sMethodName=public boolean hasSelectableTemperatureResolution
sParams=
sThrows=
tempMethodName=public boolean hasSelectableTemperatureResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public boolean hasSelectableTemperatureResolution
params=
/**
* Checks to see if this device has selectable temperature resolution.
*
* @return <code>true</code> if this <code>TemperatureContainer</code>
* has selectable temperature resolution
*
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public boolean hasSelectableTemperatureResolution();
======================================
public double getTemperatureResolutions()[]
sMethodName=public double getTemperatureResolutions
sParams=
sThrows=
tempMethodName=public double[] getTemperatureResolutions0
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public double[] getTemperatureResolutions
params=
/**
* Get an array of available temperature resolutions in Celsius.
*
* @return byte array of available temperature resolutions in Celsius with
* minimum resolution as the first element and maximum resolution
* as the last element.
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #setTemperatureResolution
*/
public double[] getTemperatureResolutions();
======================================
public double getTemperatureAlarmResolution() throws com.dalsemi.onewire.OneWireException
sMethodName=public double getTemperatureAlarmResolution
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getTemperatureAlarmResolution0
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public double getTemperatureAlarmResolution
params=
/**
* Gets the temperature alarm resolution in Celsius.
*
* @return temperature alarm resolution in Celsius for this 1-wire device
*
* @throws OneWireException Device does not support temperature
* alarms
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
* @see #setTemperatureAlarm
*
*/
public double getTemperatureAlarmResolution()
throws com.dalsemi.onewire.OneWireException;
======================================
public double getMaxTemperature()
sMethodName=public double getMaxTemperature
sParams=
sThrows=
tempMethodName=public double getMaxTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public double getMaxTemperature
params=
/**
* Gets the maximum temperature in Celsius.
*
* @return maximum temperature in Celsius for this 1-wire device
*/
public double getMaxTemperature();
======================================
public double getMinTemperature()
sMethodName=public double getMinTemperature
sParams=
sThrows=
tempMethodName=public double getMinTemperature0
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public double getMinTemperature
params=
/**
* Gets the minimum temperature in Celsius.
*
* @return minimum temperature in Celsius for this 1-wire device
*/
public double getMinTemperature();
======================================
public void doTemperatureConvert(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public void doTemperatureConvert
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public void doTemperatureConvert1
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public void doTemperatureConvert
params=byte[]
/**
* Performs a temperature conversion.
*
* @param state byte array with device state information
*
* @throws OneWireException Part could not be found [ fatal ]
* @throws OneWireIOException Data wasn't transferred properly [ recoverable ]
*/
public void doTemperatureConvert(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException;
======================================
public double getTemperature(byte[]) throws com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public double getTemperature
sParams=byte[]
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public double getTemperature1
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public double getTemperature
params=byte[]
/**
* Gets the temperature value in Celsius from the <code>state</code>
* data retrieved from the <code>readDevice()</code> method.
*
* @param state byte array with device state information
*
* @return temperature in Celsius from the last
* <code>doTemperatureConvert()</code>
*
* @throws OneWireIOException In the case of invalid temperature data
*/
public double getTemperature(ByteArray state)
throws com.dalsemi.onewire.adapter.OneWireIOException;
======================================
public double getTemperatureAlarm(int, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public double getTemperatureAlarm
sParams=int, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public double getTemperatureAlarm2
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public double getTemperatureAlarm
params=int,byte[]
/**
* Gets the specified temperature alarm value in Celsius from the
* <code>state</code> data retrieved from the
* <code>readDevice()</code> method.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param state byte array with device state information
*
* @return temperature alarm trip values in Celsius for this 1-wire device
*
* @throws OneWireException Device does not support temperature
* alarms
*
* @see #hasTemperatureAlarms
* @see #setTemperatureAlarm
*/
public double getTemperatureAlarm(int alarmType, ByteArray state)
throws com.dalsemi.onewire.OneWireException;
======================================
public double getTemperatureResolution(byte[])
sMethodName=public double getTemperatureResolution
sParams=byte[]
sThrows=
tempMethodName=public double getTemperatureResolution1
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public double getTemperatureResolution
params=byte[]
/**
* Gets the current temperature resolution in Celsius from the
* <code>state</code> data retrieved from the <code>readDevice()</code>
* method.
*
* @param state byte array with device state information
*
* @return temperature resolution in Celsius for this 1-wire device
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolutions
* @see #setTemperatureResolution
*/
public double getTemperatureResolution(ByteArray state);
======================================
public void setTemperatureAlarm(int, double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setTemperatureAlarm
sParams=int, double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setTemperatureAlarm3
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public void setTemperatureAlarm
params=int,double,byte[]
/**
* Sets the temperature alarm value in Celsius in the provided
* <code>state</code> data.
* Use the method <code>writeDevice()</code> with
* this data to finalize the change to the device.
*
* @param alarmType valid value: <code>ALARM_HIGH</code> or
* <code>ALARM_LOW</code>
* @param alarmValue alarm trip value in Celsius
* @param state byte array with device state information
*
* @throws OneWireException Device does not support temperature
* alarms
*
* @see #hasTemperatureAlarms
* @see #getTemperatureAlarm
*/
public void setTemperatureAlarm(int alarmType, double alarmValue, ByteArray state)
throws com.dalsemi.onewire.OneWireException;
======================================
public void setTemperatureResolution(double, byte[]) throws com.dalsemi.onewire.OneWireException
sMethodName=public void setTemperatureResolution
sParams=double, byte[]
sThrows=throws com.dalsemi.onewire.OneWireException
tempMethodName=public void setTemperatureResolution2
getMethodDocumentation
className=com.dalsemi.onewire.container.TemperatureContainer
methodName=public void setTemperatureResolution
params=double,byte[]
/**
* Sets the current temperature resolution in Celsius in the provided
* <code>state</code> data. Use the method <code>writeDevice()</code>
* with this data to finalize the change to the device.
*
* @param resolution temperature resolution in Celsius
* @param state byte array with device state information
*
* @throws OneWireException Device does not support selectable
* temperature resolution
*
* @see #hasSelectableTemperatureResolution
* @see #getTemperatureResolution
* @see #getTemperatureResolutions
*/
public void setTemperatureResolution(double resolution, ByteArray state)
throws com.dalsemi.onewire.OneWireException;
-------------------------------------------------------------------
creating: owapi\Debug.java
======================================
public static final void setDebugMode(boolean)
sMethodName=public static final void setDebugMode
sParams=boolean
sThrows=
tempMethodName=public static final void setDebugMode1
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final void setDebugMode
params=boolean
/**
* Sets the debug printing mode for this application.
*
* @param <code>true</code> to see debug messages, <code>false</code>
* to suppress them
*/
public final void setDebugMode(boolean onoff)
{
com.dalsemi.onewire.debug.Debug.setDebugMode(onoff);
}
======================================
public static final boolean getDebugMode()
sMethodName=public static final boolean getDebugMode
sParams=
sThrows=
tempMethodName=public static final boolean getDebugMode0
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final boolean getDebugMode
params=
/**
* Gets the debug printing mode for this application.
*
* @return <code>true</code> indicates debug messages are on,
* <code>false</code> supresses them.
*/
public final boolean getDebugMode()
{
return com.dalsemi.onewire.debug.Debug.getDebugMode();
}
======================================
public static final void setPrintStream(java.io.PrintStream)
sMethodName=public static final void setPrintStream
sParams=java.io.PrintStream
sThrows=
tempMethodName=public static final void setPrintStream1
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final void setPrintStream
params=java.io.PrintStream
/**
* Sets the output stream for printing the debug info.
*
* @param out the output stream for printing the debug info.
*/
public final void setPrintStream(java.io.PrintStream outStream)
{
com.dalsemi.onewire.debug.Debug.setPrintStream(outStream);
}
======================================
public static final void debug(java.lang.String)
sMethodName=public static final void debug
sParams=java.lang.String
sThrows=
tempMethodName=public static final void debug1
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final void debug
params=java.lang.String
/**
* Prints the specified <code>java.lang.String</code> object
* if debug mode is enabled. This method calls <code>PrintStream.println(String)</code>,
* and pre-pends the <code>String</code> ">> " to the message, so
* taht if a program were to call (when debug mode was enabled):
* <code><pre>
* ");
* </pre></code>
* the resulting output would look like:
* <code><pre>
* >> Some notification...
* </pre></code>
*
* @param x the message to print out if in debug mode
*/
public final void debug(java.lang.String a0)
{
com.dalsemi.onewire.debug.Debug.debug(a0);
}
======================================
public static final void debug(java.lang.String, byte[])
sMethodName=public static final void debug
sParams=java.lang.String, byte[]
sThrows=
tempMethodName=public static final void debug2
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final void debug
params=java.lang.String,byte[]
/**
* Prints the specified array of bytes with a given label
* if debug mode is enabled. This method calls
* <code>PrintStream.println(String)</code>,
* and pre-pends the <code>String</code> ">> " to the message, so
* taht if a program were to call (when debug mode was enabled):
* <code><pre>
* ", myBytes);
* </pre></code>
* the resulting output would look like:
* <code><pre>
* >> my label
* >> FF F1 F2 F3 F4 F5 F6 FF
* </pre></code>
*
* @param lbl the message to print out above the array
* @param bytes the byte array to print out
*/
public final void debug(java.lang.String a0, ByteArray a1)
{
com.dalsemi.onewire.debug.Debug.debug(a0, a1.array);
}
======================================
public static final void debug(java.lang.String, byte[], int, int)
sMethodName=public static final void debug
sParams=java.lang.String, byte[], int, int
sThrows=
tempMethodName=public static final void debug4
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final void debug
params=java.lang.String,byte[],int,int
/**
* Prints the specified array of bytes with a given label
* if debug mode is enabled. This method calls
* <code>PrintStream.println(String)</code>,
* and pre-pends the <code>String</code> ">> " to the message, so
* taht if a program were to call (when debug mode was enabled):
* <code><pre>
* ", myBytes, 0, 8);
* </pre></code>
* the resulting output would look like:
* <code><pre>
* >> my label
* >> FF F1 F2 F3 F4 F5 F6 FF
* </pre></code>
*
* @param lbl the message to print out above the array
* @param bytes the byte array to print out
* @param offset the offset to start printing from the array
* @param length the number of bytes to print from the array
*/
public final void debug(java.lang.String a0, ByteArray a1, int a2, int a3)
{
com.dalsemi.onewire.debug.Debug.debug(a0, a1.array, a2, a3);
}
======================================
public static final void debug(java.lang.String, java.lang.Throwable)
sMethodName=public static final void debug
sParams=java.lang.String, java.lang.Throwable
sThrows=
tempMethodName=public static final void debugWithException2
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final void debug
params=java.lang.String,java.lang.Throwable
/**
* Prints the specified exception with a given label
* if debug mode is enabled. This method calls
* <code>PrintStream.println(String)</code>,
* and pre-pends the <code>String</code> ">> " to the message, so
* taht if a program were to call (when debug mode was enabled):
* <code><pre>
* ", exception);
* </pre></code>
* the resulting output would look like:
* <code><pre>
* >> my label
* >> OneWireIOException: Device Not Present
* </pre></code>
*
* @param lbl the message to print out above the array
* @param bytes the byte array to print out
* @param offset the offset to start printing from the array
* @param length the number of bytes to print from the array
*/
public final void debugWithException(java.lang.String a0, java.lang.Throwable a1)
{
com.dalsemi.onewire.debug.Debug.debug(a0, a1);
}
======================================
public static final void stackTrace()
sMethodName=public static final void stackTrace
sParams=
sThrows=
tempMethodName=public static final void stackTrace0
getMethodDocumentation
className=com.dalsemi.onewire.debug.Debug
methodName=public static final void stackTrace
params=
/**
* Prints out an exception stack trace for debugging purposes.
* This is useful to figure out which functions are calling
* a particular function at runtime.
*
*/
public final void stackTrace()
{
com.dalsemi.onewire.debug.Debug.stackTrace();
}
-------------------------------------------------------------------
creating: owapi\OneWireAccessProvider.java
======================================
public static java.util.Enumeration enumerateAllAdapters()
sMethodName=public static java.util.Enumeration enumerateAllAdapters
sParams=
sThrows=
tempMethodName=public static java.util.Enumeration enumerateAllAdapters0
getMethodDocumentation
className=com.dalsemi.onewire.OneWireAccessProvider
methodName=public static java.util.Enumeration enumerateAllAdapters
params=
/**
* Gets an <code>Enumeration</code> 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.
*
* @return <code>Enumeration</code> of <code>DSPortAdapters</code> in the system
*/
public java.util.Enumeration enumerateAllAdapters()
{
java.util.Enumeration retEnum = com.dalsemi.onewire.OneWireAccessProvider.enumerateAllAdapters();
java.util.Vector reRetEnum = new java.util.Vector();
while(retEnum.hasMoreElements())
{
/*Double Check This*/
Object o = retEnum.nextElement();
o = new DSPortAdapter(o);
reRetEnum.addElement(o);
}
return reRetEnum.elements();
}
======================================
public static com.dalsemi.onewire.adapter.DSPortAdapter getAdapter(java.lang.String, java.lang.String) throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public static com.dalsemi.onewire.adapter.DSPortAdapter getAdapter
sParams=java.lang.String, java.lang.String
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public static DSPortAdapter getAdapter2
getMethodDocumentation
className=com.dalsemi.onewire.OneWireAccessProvider
methodName=public static com.dalsemi.onewire.adapter.DSPortAdapter getAdapter
params=java.lang.String,java.lang.String
/**
* Finds, opens, and verifies the specified adapter on the
* indicated port.
*
* @param adapterName string name of the adapter (match to result
* of call to getAdapterName() method in DSPortAdapter)
* @param portName string name of the port used in the method
* selectPort() in DSPortAdapter
*
* @return <code>DSPortAdapter</code> if adapter present
*
* @throws OneWireIOException when communcation with the adapter fails
* @throws OneWireException when the port or adapter not present
*/
public DSPortAdapter getAdapter(java.lang.String adapterName, java.lang.String portName)
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new DSPortAdapter(com.dalsemi.onewire.OneWireAccessProvider.getAdapter(adapterName, portName));
}
======================================
public static com.dalsemi.onewire.adapter.DSPortAdapter getDefaultAdapter() throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
sMethodName=public static com.dalsemi.onewire.adapter.DSPortAdapter getDefaultAdapter
sParams=
sThrows=throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
tempMethodName=public static DSPortAdapter getDefaultAdapter0
getMethodDocumentation
className=com.dalsemi.onewire.OneWireAccessProvider
methodName=public static com.dalsemi.onewire.adapter.DSPortAdapter getDefaultAdapter
params=
/**
* Finds, opens, and verifies the default adapter and
* port. Looks for the default adapter/port in the following locations:
* <p>
* <ul>
* <li> Use adapter/port in System.properties for onewire.adapter.default,
* and onewire.port.default properties tags.</li>
* <li> Use adapter/port from onewire.properties file in current directory
* or < java.home >/lib/ (Desktop) or /etc/ (TINI)</li>
* <li> Use smart default
* <ul>
* <li> Desktop
* <ul>
* <li> First, TMEX default (Win32 only)
* <li> Second, if TMEX not present, then DS9097U/(first serial port)
* </ul>
* <li> TINI, TINIExternalAdapter on port serial1
* </ul>
* </ul>
*
* @return <code>DSPortAdapter</code> if default adapter present
*
* @throws OneWireIOException when communcation with the adapter fails
* @throws OneWireException when the port or adapter not present
*/
public DSPortAdapter getDefaultAdapter()
throws com.dalsemi.onewire.adapter.OneWireIOException, com.dalsemi.onewire.OneWireException
{
return new DSPortAdapter(com.dalsemi.onewire.OneWireAccessProvider.getDefaultAdapter());
}
======================================
public static java.lang.String getProperty(java.lang.String)
sMethodName=public static java.lang.String getProperty
sParams=java.lang.String
sThrows=
tempMethodName=public static java.lang.String getProperty1
getMethodDocumentation
className=com.dalsemi.onewire.OneWireAccessProvider
methodName=public static java.lang.String getProperty
params=java.lang.String
/**
* Gets the specfied onewire property.
* Looks for the property in the following locations:
* <p>
* <ul>
* <li> In System.properties
* <li> In onewire.properties file in current directory
* or < java.home >/lib/ (Desktop) or /etc/ (TINI)
* <li> 'smart' default if property is 'onewire.adapter.default'
* or 'onewire.port.default'
* </ul>
*
* @param propName string name of the property to read
*
* @return <code>String</code> representing the property value or <code>null</code> if
* it could not be found (<code>onewire.adapter.default</code> and
* <code>onewire.port.default</code> may
* return a 'smart' default even if property not present)
*/
public java.lang.String getProperty(java.lang.String propName)
{
return com.dalsemi.onewire.OneWireAccessProvider.getProperty(propName);
}
======================================
public static void setUseOverridingAdapter(com.dalsemi.onewire.adapter.DSPortAdapter)
sMethodName=public static void setUseOverridingAdapter
sParams=com.dalsemi.onewire.adapter.DSPortAdapter
sThrows=
tempMethodName=public static void setUseOverridingAdapter1
getMethodDocumentation
className=com.dalsemi.onewire.OneWireAccessProvider
methodName=public static void setUseOverridingAdapter
params=com.dalsemi.onewire.adapter.DSPortAdapter
/**
* Sets an overriding adapter. This adapter will be returned from
* getAdapter and getDefaultAdapter despite what was requested.
*
* @param adapter adapter to be the override
*
* @see #getAdapter
* @see #getDefaultAdapter
* @see #clearUseOverridingAdapter
*/
public void setUseOverridingAdapter(DSPortAdapter adapter)
{
com.dalsemi.onewire.OneWireAccessProvider.setUseOverridingAdapter(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance));
}
======================================
public static void clearUseOverridingAdapter()
sMethodName=public static void clearUseOverridingAdapter
sParams=
sThrows=
tempMethodName=public static void clearUseOverridingAdapter0
getMethodDocumentation
className=com.dalsemi.onewire.OneWireAccessProvider
methodName=public static void clearUseOverridingAdapter
params=
/**
* Clears the overriding adapter. The operation of
* getAdapter and getDefaultAdapter will be returned to normal.
*
* @see #getAdapter
* @see #getDefaultAdapter
* @see #setUseOverridingAdapter
*/
public void clearUseOverridingAdapter()
{
com.dalsemi.onewire.OneWireAccessProvider.clearUseOverridingAdapter();
}
-------------------------------------------------------------------
creating: owapi\Address.java
======================================
public static boolean isValid(byte[])
sMethodName=public static boolean isValid
sParams=byte[]
sThrows=
tempMethodName=public static boolean isValidFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static boolean isValid
params=byte[]
/**
* Checks the CRC8 calculation of this 1-Wire Network address.
* <p>
* The address is valid if the CRC8 of the first seven bytes of the address gives
* a result equal to the eighth byte.
*
* @param address iButton or 1-Wire Network address to verify
*
* @return <code>true</code> if the family code is non-zero and the
* CRC8 calculation is correct.
* @see CRC8
*/
public boolean isValidFromBytes(ByteArray a0)
{
return com.dalsemi.onewire.utils.Address.isValid(a0.array);
}
======================================
public static boolean isValid(java.lang.String)
sMethodName=public static boolean isValid
sParams=java.lang.String
sThrows=
tempMethodName=public static boolean isValid1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static boolean isValid
params=java.lang.String
/**
* Checks the CRC8 calculation of this 1-Wire Network address.
* <p>
* The address is valid if the CRC8 of the first seven bytes of the address gives
* a result equal to the eighth byte.
*
* @param address iButton or 1-Wire Network address to verify
*
* @return <code>true</code> if the family code is non-zero and the
* CRC8 calculation is correct.
* @see CRC8
*/
public boolean isValid(java.lang.String a0)
{
return com.dalsemi.onewire.utils.Address.isValid(a0);
}
======================================
public static boolean isValid(long)
sMethodName=public static boolean isValid
sParams=long
sThrows=
tempMethodName=public static boolean isValidFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static boolean isValid
params=long
/**
* Checks the CRC8 calculation of this 1-Wire Network address.
* <p>
* The address is valid if the CRC8 of the first seven bytes of the address gives
* a result equal to the eighth byte.
*
* @param address iButton or 1-Wire Network address to verify
*
* @return <code>true</code> if the family code is non-zero and the
* CRC8 calculation is correct.
* @see CRC8
*/
public boolean isValidFromLong(String a0)
{
return com.dalsemi.onewire.utils.Address.isValid(Long.parseLong(a0));
}
======================================
public static java.lang.String toString(byte[])
sMethodName=public static java.lang.String toString
sParams=byte[]
sThrows=
tempMethodName=public static java.lang.String toStringFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static java.lang.String toString
params=byte[]
/**
* Converts a 1-Wire Network address byte array (little endian)
* to a hex string representation (big endian).
*
* @param address, family code first.
*
* @return address represented in a String, family code last.
*/
public java.lang.String toStringFromBytes(ByteArray address)
{
return com.dalsemi.onewire.utils.Address.toString(address.array);
}
======================================
public static java.lang.String toString(long)
sMethodName=public static java.lang.String toString
sParams=long
sThrows=
tempMethodName=public static java.lang.String toStringFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static java.lang.String toString
params=long
/**
* Converts a 1-Wire Network address long (little endian)
* to a hex string representation (big endian).
*
* @param address, family code first.
*
* @return address represented in a long, little endian.
*/
public java.lang.String toStringFromLong(String address)
{
return com.dalsemi.onewire.utils.Address.toString(Long.parseLong(address));
}
======================================
public static byte toByteArray(java.lang.String)[]
sMethodName=public static byte toByteArray
sParams=java.lang.String
sThrows=
tempMethodName=public static ByteArray toByteArray1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static byte[] toByteArray
params=java.lang.String
/**
* Converts a 1-Wire Network Address string (big endian)
* to a byte array (little endian).
*
* @param address, family code last.
*
* @return address represented in a byte array, family
* code (LS byte) first.
*/
public ByteArray toByteArray(java.lang.String address)
{
return new ByteArray().setupObject(com.dalsemi.onewire.utils.Address.toByteArray(address));
}
======================================
public static byte toByteArray(long)[]
sMethodName=public static byte toByteArray
sParams=long
sThrows=
tempMethodName=public static ByteArray toByteArrayFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static byte[] toByteArray
params=long
/**
* Convert an iButton or 1-Wire device address as a long
* (little endian) into an array of bytes.
*/
public ByteArray toByteArrayFromLong(String address)
{
return new ByteArray().setupObject(com.dalsemi.onewire.utils.Address.toByteArray(Long.parseLong(address)));
}
======================================
public static long toLong(byte[])
sMethodName=public static long toLong
sParams=byte[]
sThrows=
tempMethodName=public static String toLongFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static long toLong
params=byte[]
/**
* Converts a 1-Wire Network Address to a long (little endian).
*
* @returns address represented as a long.
*/
public String toLongFromBytes(ByteArray address)
{
return ""+com.dalsemi.onewire.utils.Address.toLong(address.array);
}
======================================
public static long toLong(java.lang.String)
sMethodName=public static long toLong
sParams=java.lang.String
sThrows=
tempMethodName=public static String toLong1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Address
methodName=public static long toLong
params=java.lang.String
/**
* Converts a 1-Wire Network Address to a long (little endian).
*
* @returns address represented as a String.
*/
public String toLong(java.lang.String address)
{
return ""+com.dalsemi.onewire.utils.Address.toLong(address);
}
-------------------------------------------------------------------
creating: owapi\Bit.java
======================================
public static void arrayWriteBit(int, int, int, byte[])
sMethodName=public static void arrayWriteBit
sParams=int, int, int, byte[]
sThrows=
tempMethodName=public static void arrayWriteBit4
getMethodDocumentation
className=com.dalsemi.onewire.utils.Bit
methodName=public static void arrayWriteBit
params=int,int,int,byte[]
/**
* Write the bit state in a byte array.
*
* @param state new state of the bit 1, 0
* @param index bit index into byte array
* @param offset byte offset into byte array to start
* @param buf byte array to manipulate
*/
public void arrayWriteBit(int state, int index, int offset, ByteArray buf)
{
com.dalsemi.onewire.utils.Bit.arrayWriteBit(state, index, offset, buf.array);
}
======================================
public static int arrayReadBit(int, int, byte[])
sMethodName=public static int arrayReadBit
sParams=int, int, byte[]
sThrows=
tempMethodName=public static int arrayReadBit3
getMethodDocumentation
className=com.dalsemi.onewire.utils.Bit
methodName=public static int arrayReadBit
params=int,int,byte[]
/**
* Read a bit state in a byte array.
*
* @param index bit index into byte array
* @param offset byte offset into byte array to start
* @param buf byte array to read from
*
* @return bit state 1 or 0
*/
public int arrayReadBit(int index, int offset, ByteArray buf)
{
return com.dalsemi.onewire.utils.Bit.arrayReadBit(index, offset, buf.array);
}
-------------------------------------------------------------------
creating: owapi\Convert.java
======================================
public static final double toFahrenheit(double)
sMethodName=public static final double toFahrenheit
sParams=double
sThrows=
Testing: public static final double toFahrenheit {double}
Testing: new: public static final double toFahrenheitFromDouble
tempMethodName=public static final double toFahrenheitFromDouble1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final double toFahrenheit
params=double
/**
* Converts a temperature reading from Celsius to Fahrenheit.
*
* @param celsiusTemperature temperature value in Celsius
*
* @return the Fahrenheit conversion of the supplied temperature
*/
public final double toFahrenheitFromDouble(double celsiusTemperature)
{
return com.dalsemi.onewire.utils.Convert.toFahrenheit(celsiusTemperature);
}
======================================
public static final double toCelsius(double)
sMethodName=public static final double toCelsius
sParams=double
sThrows=
Testing: public static final double toCelsius {double}
Testing: new: public static final double toCelsiusFromDouble
tempMethodName=public static final double toCelsiusFromDouble1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final double toCelsius
params=double
/**
* Converts a temperature reading from Fahrenheit to Celsius.
*
* @param fahrenheitTemperature temperature value in Fahrenheit
*
* @return the Celsius conversion of the supplied temperature
*/
public final double toCelsiusFromDouble(double fahrenheitTemperature)
{
return com.dalsemi.onewire.utils.Convert.toCelsius(fahrenheitTemperature);
}
======================================
public static final long toLong(byte[], int, int)
sMethodName=public static final long toLong
sParams=byte[], int, int
sThrows=
Testing: public static final long toLong {byte[], int, int}
Testing: new: public static final String toLongFromBytes
tempMethodName=public static final String toLongFromBytes3
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final long toLong
params=byte[],int,int
/**
* This method constructs a long from a LSByte byte array of specified length.
*
* @param byteArray byte array to convert to a long (LSByte first)
* @param offset byte offset into the array where to start to convert
* @param len number of bytes to use to convert to a long
*
* @returns value constructed from bytes
*/
public final String toLongFromBytes(ByteArray byteArray, int offset, int len)
{
return ""+com.dalsemi.onewire.utils.Convert.toLong(byteArray.array, offset, len);
}
======================================
public static final long toLong(byte[])
sMethodName=public static final long toLong
sParams=byte[]
sThrows=
Testing: public static final long toLong {byte[]}
Testing: new: public static final String toLongFromBytes
tempMethodName=public static final String toLongFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final long toLong
params=byte[]
/**
* This method constructs a long from a LSByte byte array of specified length.
*
* @param byteArray byte array to convert to a long (LSByte first)
* @param offset byte offset into the array where to start to convert
* @param len number of bytes to use to convert to a long
*
* @returns value constructed from bytes
*/
public final String toLongFromBytes(ByteArray byteArray)
{
return ""+com.dalsemi.onewire.utils.Convert.toLong(byteArray.array);
}
======================================
public static final void toByteArray(long, byte[], int, int)
sMethodName=public static final void toByteArray
sParams=long, byte[], int, int
sThrows=
Testing: public static final void toByteArray {long, byte[], int, int}
Testing: new: public static final void toByteArrayFromLong
tempMethodName=public static final void toByteArrayFromLong4
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final void toByteArray
params=long,byte[],int,int
/**
* This method constructs a LSByte byte array with specified length from a long.
*
* @param longVal the long value to convert to a byte array.
* @param byteArray LSByte first byte array, holds bytes from long
* @param offset byte offset into the array
* @param len number of bytes to get
*
* @returns value constructed from bytes
*/
public final void toByteArrayFromLong(String longVal, ByteArray byteArray, int offset, int len)
{
com.dalsemi.onewire.utils.Convert.toByteArray(Long.parseLong(longVal), byteArray.array, offset, len);
}
======================================
public static final void toByteArray(long, byte[])
sMethodName=public static final void toByteArray
sParams=long, byte[]
sThrows=
Testing: public static final void toByteArray {long, byte[]}
Testing: new: public static final void toByteArrayFromLong
tempMethodName=public static final void toByteArrayFromLong2
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final void toByteArray
params=long,byte[]
/**
* This method constructs a LSByte byte array with specified length from a long.
*
* @param longVal the long value to convert to a byte array.
* @param byteArray LSByte first byte array, holds bytes from long
* @param offset byte offset into the array
* @param len number of bytes to get
*
* @returns value constructed from bytes
*/
public final void toByteArrayFromLong(String longVal, ByteArray byteArray)
{
com.dalsemi.onewire.utils.Convert.toByteArray(Long.parseLong(longVal), byteArray.array);
}
======================================
public static final byte toByteArray(long)[]
sMethodName=public static final byte toByteArray
sParams=long
sThrows=
Testing: public static final byte[] toByteArray {long}
Testing: new: public static final ByteArray toByteArrayFromLong
tempMethodName=public static final ByteArray toByteArrayFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final byte[] toByteArray
params=long
/**
* This method constructs a LSByte byte array with 8 bytes from a long.
*
* @param longVal the long value to convert to a byte array.
*
* @returns value constructed from bytes
*/
public final ByteArray toByteArrayFromLong(String longVal)
{
return new ByteArray().setupObject(com.dalsemi.onewire.utils.Convert.toByteArray(Long.parseLong(longVal)));
}
======================================
public static final int toInt(byte[], int, int)
sMethodName=public static final int toInt
sParams=byte[], int, int
sThrows=
Testing: public static final int toInt {byte[], int, int}
Testing: new: public static final int toIntFromBytes
tempMethodName=public static final int toIntFromBytes3
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final int toInt
params=byte[],int,int
/**
* This method constructs an int from a LSByte byte array of specified length.
*
* @param byteArray byte array to convert to an int (LSByte first)
* @param offset byte offset into the array where to start to convert
* @param len number of bytes to use to convert to an int
*
* @returns value constructed from bytes
*/
public final int toIntFromBytes(ByteArray byteArray, int offset, int len)
{
return com.dalsemi.onewire.utils.Convert.toInt(byteArray.array, offset, len);
}
======================================
public static final int toInt(byte[])
sMethodName=public static final int toInt
sParams=byte[]
sThrows=
Testing: public static final int toInt {byte[]}
Testing: new: public static final int toIntFromBytes
tempMethodName=public static final int toIntFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final int toInt
params=byte[]
/**
* This method constructs an int from a LSByte byte array of specified length.
*
* @param byteArray byte array to convert to an int (LSByte first)
* @param offset byte offset into the array where to start to convert
* @param len number of bytes to use to convert to an int
*
* @returns value constructed from bytes
*/
public final int toIntFromBytes(ByteArray byteArray)
{
return com.dalsemi.onewire.utils.Convert.toInt(byteArray.array);
}
======================================
public static final void toByteArray(int, byte[], int, int)
sMethodName=public static final void toByteArray
sParams=int, byte[], int, int
sThrows=
Testing: public static final void toByteArray {int, byte[], int, int}
Testing: new: public static final void toByteArrayFromInt
tempMethodName=public static final void toByteArrayFromInt4
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final void toByteArray
params=int,byte[],int,int
/**
* This method constructs a LSByte byte array with specified length from an int.
*
* @param intVal the int value to convert to a byte array.
* @param byteArray LSByte first byte array, holds bytes from int
* @param offset byte offset into the array
* @param len number of bytes to get
*/
public final void toByteArrayFromInt(int intVal, ByteArray byteArray, int offset, int len)
{
com.dalsemi.onewire.utils.Convert.toByteArray(intVal, byteArray.array, offset, len);
}
======================================
public static final void toByteArray(int, byte[])
sMethodName=public static final void toByteArray
sParams=int, byte[]
sThrows=
Testing: public static final void toByteArray {int, byte[]}
Testing: new: public static final void toByteArrayFromInt
tempMethodName=public static final void toByteArrayFromInt2
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final void toByteArray
params=int,byte[]
/**
* This method constructs a LSByte byte array with specified length from an int.
*
* @param intVal the int value to convert to a byte array.
* @param byteArray LSByte first byte array, holds bytes from int
* @param offset byte offset into the array
* @param len number of bytes to get
*/
public final void toByteArrayFromInt(int intVal, ByteArray byteArray)
{
com.dalsemi.onewire.utils.Convert.toByteArray(intVal, byteArray.array);
}
======================================
public static final byte toByteArray(int)[]
sMethodName=public static final byte toByteArray
sParams=int
sThrows=
Testing: public static final byte[] toByteArray {int}
Testing: new: public static final ByteArray toByteArrayFromInt
tempMethodName=public static final ByteArray toByteArrayFromInt1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final byte[] toByteArray
params=int
/**
* This method constructs a LSByte byte array with 4 bytes from an int.
*
* @param longVal the long value to convert to a byte array.
*
* @returns value constructed from bytes
*/
public final ByteArray toByteArrayFromInt(int intVal)
{
return new ByteArray().setupObject(com.dalsemi.onewire.utils.Convert.toByteArray(intVal));
}
======================================
public static final byte toByteArray(java.lang.String)[] throws com.dalsemi.onewire.utils.Convert. ConvertException
sMethodName=public static final byte toByteArray
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.utils.Convert. ConvertException
Testing: public static final byte[] toByteArray {java.lang.String}
Testing: new: public static final ByteArray toByteArrayFromHexString
tempMethodName=public static final ByteArray toByteArrayFromHexString1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final byte[] toByteArray
params=java.lang.String
/**
* <P>Converts a hex-encoded string into an array of bytes.</P>
* <P>To illustrate the rules for parsing, the following String:<br>
* "FF 0 1234 567"<br>
* becomes:<br>
* byte[]{0xFF,0x00,0x12,0x34,0x56,0x07}
* </P>
*
* @param strData hex-encoded numerical string
* @return byte[] the decoded bytes
*/
public final ByteArray toByteArrayFromHexString(java.lang.String strData)
throws com.dalsemi.onewire.utils.Convert. ConvertException
{
return new ByteArray().setupObject(com.dalsemi.onewire.utils.Convert.toByteArray(strData));
}
======================================
public static final int toByteArray(java.lang.String, byte[]) throws com.dalsemi.onewire.utils.Convert. ConvertException
sMethodName=public static final int toByteArray
sParams=java.lang.String, byte[]
sThrows=throws com.dalsemi.onewire.utils.Convert. ConvertException
Testing: public static final int toByteArray {java.lang.String, byte[]}
Testing: new: public static final int toByteArrayFromHexString
tempMethodName=public static final int toByteArrayFromHexString2
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final int toByteArray
params=java.lang.String,byte[]
/**
* <P>Converts a hex-encoded string into an array of bytes.</P>
* <P>To illustrate the rules for parsing, the following String:<br>
* "FF 0 1234 567"<br>
* becomes:<br>
* byte[]{0xFF,0x00,0x12,0x34,0x56,0x07}
* </P>
*
* @param strData hex-encoded numerical string
* @param bData byte[] which will hold the decoded bytes
* @return The number of bytes converted
*/
public final int toByteArrayFromHexString(java.lang.String strData, ByteArray bData)
throws com.dalsemi.onewire.utils.Convert. ConvertException
{
return com.dalsemi.onewire.utils.Convert.toByteArray(strData, bData.array);
}
======================================
public static final int toByteArray(java.lang.String, byte[], int, int) throws com.dalsemi.onewire.utils.Convert. ConvertException
sMethodName=public static final int toByteArray
sParams=java.lang.String, byte[], int, int
sThrows=throws com.dalsemi.onewire.utils.Convert. ConvertException
Testing: public static final int toByteArray {java.lang.String, byte[], int, int}
Testing: new: public static final int toByteArrayFromHexString
tempMethodName=public static final int toByteArrayFromHexString4
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final int toByteArray
params=java.lang.String,byte[],int,int
/**
* <P>Converts a hex-encoded string into an array of bytes.</P>
* <P>To illustrate the rules for parsing, the following String:<br>
* "FF 0 1234 567"<br>
* becomes:<br>
* byte[]{0xFF,0x00,0x12,0x34,0x56,0x07}
* </P>
*
* @param strData hex-encoded numerical string
* @param bData byte[] which will hold the decoded bytes
* @param offset the offset into bData to start placing bytes
* @param length the maximum number of bytes to convert
* @return The number of bytes converted
*/
public final int toByteArrayFromHexString(java.lang.String strData, ByteArray bData, int offset, int length)
throws com.dalsemi.onewire.utils.Convert. ConvertException
{
return com.dalsemi.onewire.utils.Convert.toByteArray(strData, bData.array, offset, length);
}
======================================
public static final java.lang.String toHexString(byte[])
sMethodName=public static final java.lang.String toHexString
sParams=byte[]
sThrows=
Testing: public static final java.lang.String toHexString {byte[]}
Testing: new: public static final java.lang.String toHexStringFromBytes
tempMethodName=public static final java.lang.String toHexStringFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=byte[]
/**
* Converts a byte array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The byte[] to convert to a hex-encoded string
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromBytes(ByteArray data)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data.array);
}
======================================
public static final java.lang.String toHexString(byte[], int, int)
sMethodName=public static final java.lang.String toHexString
sParams=byte[], int, int
sThrows=
Testing: public static final java.lang.String toHexString {byte[], int, int}
Testing: new: public static final java.lang.String toHexStringFromBytes
tempMethodName=public static final java.lang.String toHexStringFromBytes3
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=byte[],int,int
/**
* Converts a byte array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The byte[] to convert to a hex-encoded string
* @param offset the offset to start converting bytes
* @param length the number of bytes to convert
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromBytes(ByteArray data, int offset, int length)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data.array, offset, length);
}
======================================
public static final java.lang.String toHexString(byte[], java.lang.String)
sMethodName=public static final java.lang.String toHexString
sParams=byte[], java.lang.String
sThrows=
Testing: public static final java.lang.String toHexString {byte[], java.lang.String}
Testing: new: public static final java.lang.String toHexStringFromBytes
tempMethodName=public static final java.lang.String toHexStringFromBytes2
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=byte[],java.lang.String
/**
* Converts a byte array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The byte[] to convert to a hex-encoded string
* @param delimeter the delimeter to place between each byte of data
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromBytes(ByteArray data, java.lang.String delimeter)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data.array, delimeter);
}
======================================
public static final java.lang.String toHexString(byte[], int, int, java.lang.String)
sMethodName=public static final java.lang.String toHexString
sParams=byte[], int, int, java.lang.String
sThrows=
Testing: public static final java.lang.String toHexString {byte[], int, int, java.lang.String}
Testing: new: public static final java.lang.String toHexStringFromBytes
tempMethodName=public static final java.lang.String toHexStringFromBytes4
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=byte[],int,int,java.lang.String
/**
* Converts a byte array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The byte[] to convert to a hex-encoded string
* @param offset the offset to start converting bytes
* @param length the number of bytes to convert
* @param delimeter the delimeter to place between each byte of data
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromBytes(ByteArray data, int offset, int length, java.lang.String delimeter)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data.array, offset, length, delimeter);
}
======================================
public static final java.lang.String toHexString(byte)
sMethodName=public static final java.lang.String toHexString
sParams=byte
sThrows=
Testing: public static final java.lang.String toHexString {byte}
Testing: new: public static final java.lang.String toHexStringFromByte
tempMethodName=public static final java.lang.String toHexStringFromByte1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=byte
/**
* Converts a byte array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The byte[] to convert to a hex-encoded string
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromByte(byte data)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data);
}
======================================
public static final java.lang.String toHexString(char[])
sMethodName=public static final java.lang.String toHexString
sParams=char[]
sThrows=
Testing: public static final java.lang.String toHexString {char[]}
Testing: new: public static final java.lang.String toHexStringFromChars
tempMethodName=public static final java.lang.String toHexStringFromChars1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=char[]
/**
* Converts a char array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The char[] to convert to a hex-encoded string
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromChars(char[] data)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data);
}
======================================
public static final java.lang.String toHexString(char[], int, int)
sMethodName=public static final java.lang.String toHexString
sParams=char[], int, int
sThrows=
Testing: public static final java.lang.String toHexString {char[], int, int}
Testing: new: public static final java.lang.String toHexStringFromChars
tempMethodName=public static final java.lang.String toHexStringFromChars3
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=char[],int,int
/**
* Converts a byte array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The char[] to convert to a hex-encoded string
* @param offset the offset to start converting bytes
* @param length the number of bytes to convert
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromChars(char[] data, int offset, int length)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data, offset, length);
}
======================================
public static final java.lang.String toHexString(char[], java.lang.String)
sMethodName=public static final java.lang.String toHexString
sParams=char[], java.lang.String
sThrows=
Testing: public static final java.lang.String toHexString {char[], java.lang.String}
Testing: new: public static final java.lang.String toHexStringFromChars
tempMethodName=public static final java.lang.String toHexStringFromChars2
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=char[],java.lang.String
/**
* Converts a char array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The char[] to convert to a hex-encoded string
* @param delimeter the delimeter to place between each byte of data
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromChars(char[] data, java.lang.String delimeter)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data, delimeter);
}
======================================
public static final java.lang.String toHexString(char[], int, int, java.lang.String)
sMethodName=public static final java.lang.String toHexString
sParams=char[], int, int, java.lang.String
sThrows=
Testing: public static final java.lang.String toHexString {char[], int, int, java.lang.String}
Testing: new: public static final java.lang.String toHexStringFromChars
tempMethodName=public static final java.lang.String toHexStringFromChars4
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=char[],int,int,java.lang.String
/**
* Converts a char array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The char[] to convert to a hex-encoded string
* @param offset the offset to start converting bytes
* @param length the number of bytes to convert
* @param delimeter the delimeter to place between each byte of data
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromChars(char[] data, int offset, int length, java.lang.String delimeter)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data, offset, length, delimeter);
}
======================================
public static final java.lang.String toHexString(char)
sMethodName=public static final java.lang.String toHexString
sParams=char
sThrows=
Testing: public static final java.lang.String toHexString {char}
Testing: new: public static final java.lang.String toHexStringFromChar
tempMethodName=public static final java.lang.String toHexStringFromChar1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=char
/**
* Converts a char array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The char[] to convert to a hex-encoded string
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromChar(char data)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data);
}
======================================
public static final long toLong(java.lang.String) throws com.dalsemi.onewire.utils.Convert. ConvertException
sMethodName=public static final long toLong
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.utils.Convert. ConvertException
Testing: public static final long toLong {java.lang.String}
Testing: new: public static final String toLongFromHexString
tempMethodName=public static final String toLongFromHexString1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final long toLong
params=java.lang.String
/**
* <P>Converts a hex-encoded string (LSByte) into a long.</P>
* <P>To illustrate the rules for parsing, the following String:<br>
* "FF 0 1234 567 12 03"<br>
* becomes:<br>
* long 0x03120756341200ff
* </P>
*
* @param strData hex-encoded numerical string
* @return the decoded long
*/
public final String toLongFromHexString(java.lang.String strData)
throws com.dalsemi.onewire.utils.Convert. ConvertException
{
return ""+com.dalsemi.onewire.utils.Convert.toLong(strData);
}
======================================
public static final java.lang.String toHexString(long)
sMethodName=public static final java.lang.String toHexString
sParams=long
sThrows=
Testing: public static final java.lang.String toHexString {long}
Testing: new: public static final java.lang.String toHexStringFromLong
tempMethodName=public static final java.lang.String toHexStringFromLong1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=long
/**
* <P>Converts a long into a hex-encoded string (LSByte).</P>
*
* @param lValue the long integer to encode
* @return String Hex-encoded String
*/
public final java.lang.String toHexStringFromLong(String lValue)
{
return com.dalsemi.onewire.utils.Convert.toHexString(Long.parseLong(lValue));
}
======================================
public static final int toInt(java.lang.String) throws com.dalsemi.onewire.utils.Convert. ConvertException
sMethodName=public static final int toInt
sParams=java.lang.String
sThrows=throws com.dalsemi.onewire.utils.Convert. ConvertException
Testing: public static final int toInt {java.lang.String}
Testing: new: public static final int toIntFromHexString
tempMethodName=public static final int toIntFromHexString1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final int toInt
params=java.lang.String
/**
* <P>Converts a hex-encoded string (LSByte) into an int.</P>
* <P>To illustrate the rules for parsing, the following String:<br>
* "FF 0 1234 567 12 03"<br>
* becomes:<br>
* long 0x03120756341200ff
* </P>
*
* @param strData hex-encoded numerical string
* @return the decoded int
*/
public final int toIntFromHexString(java.lang.String strData)
throws com.dalsemi.onewire.utils.Convert. ConvertException
{
return com.dalsemi.onewire.utils.Convert.toInt(strData);
}
======================================
public static final java.lang.String toHexString(int)
sMethodName=public static final java.lang.String toHexString
sParams=int
sThrows=
Testing: public static final java.lang.String toHexString {int}
Testing: new: public static final java.lang.String toHexStringFromInt
tempMethodName=public static final java.lang.String toHexStringFromInt1
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toHexString
params=int
/**
* Converts a byte array into a hex-encoded String, using the provided
* delimeter.
*
* @param data The byte[] to convert to a hex-encoded string
* @param offset the offset to start converting bytes
* @param length the number of bytes to convert
* @return Hex-encoded String
*/
public final java.lang.String toHexStringFromInt(int data)
{
return com.dalsemi.onewire.utils.Convert.toHexString(data);
}
======================================
public static final java.lang.String toString(double, int)
sMethodName=public static final java.lang.String toString
sParams=double, int
sThrows=
Testing: public static final java.lang.String toString {double, int}
Testing: new: public static final java.lang.String toStringFromDouble
tempMethodName=public static final java.lang.String toStringFromDouble2
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toString
params=double,int
/**
* <P>Converts a double value into a string with the specified number of
* digits after the decimal place.</P>
*
* @param dubbel the double value to convert to a string
* @param nFrac the number of digits to display after the decimal point
*
* @return String representation of the double value with the specified
* number of digits after the decimal place.
*/
public final java.lang.String toStringFromDouble(double dubbel, int nFrac)
{
return com.dalsemi.onewire.utils.Convert.toString(dubbel, nFrac);
}
======================================
public static final java.lang.String toString(float, int)
sMethodName=public static final java.lang.String toString
sParams=float, int
sThrows=
Testing: public static final java.lang.String toString {float, int}
Testing: new: public static final java.lang.String toStringFromFloat
tempMethodName=public static final java.lang.String toStringFromFloat2
getMethodDocumentation
className=com.dalsemi.onewire.utils.Convert
methodName=public static final java.lang.String toString
params=float,int
/**
* <P>Converts a float value into a string with the specified number of
* digits after the decimal place.</P>
* <P>Note: this function does not properly handle special case float
* values such as Infinity and NaN.</P>
*
* @param flote the float value to convert to a string
* @param nFrac the number of digits to display after the decimal point
*
* @return String representation of the float value with the specified
* number of digits after the decimal place.
*/
public final java.lang.String toStringFromFloat(float flote, int nFrac)
{
return com.dalsemi.onewire.utils.Convert.toString(flote, nFrac);
}
-------------------------------------------------------------------
creating: owapi\CRC16.java
======================================
public static int compute(int)
sMethodName=public static int compute
sParams=int
sThrows=
tempMethodName=public static int compute1
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC16
methodName=public static int compute
params=int
/**
* Perform the CRC16 on the data element based on a zero seed.
* <p>
* CRC16 is based on the polynomial = X^16 + X^15 + X^2 + 1.
*
* @param dataToCrc data element on which to perform the CRC16
* @return CRC16 value
*/
public int compute(int dataToCrc)
{
return com.dalsemi.onewire.utils.CRC16.compute(dataToCrc);
}
======================================
public static int compute(int, int)
sMethodName=public static int compute
sParams=int, int
sThrows=
tempMethodName=public static int compute2
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC16
methodName=public static int compute
params=int,int
/**
* Perform the CRC16 on the data element based on the provided seed.
* <p>
* CRC16 is based on the polynomial = X^16 + X^15 + X^2 + 1.
*
* @param dataToCrc data element on which to perform the CRC16
* @return CRC16 value
*/
public int compute(int dataToCrc, int seed)
{
return com.dalsemi.onewire.utils.CRC16.compute(dataToCrc, seed);
}
======================================
public static int compute(byte[])
sMethodName=public static int compute
sParams=byte[]
sThrows=
tempMethodName=public static int computeFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC16
methodName=public static int compute
params=byte[]
/**
* Perform the CRC16 on an array of data elements based on a
* zero seed.
* <p>
* CRC16 is based on the polynomial = X^16 + X^15 + X^2 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC16
*
* @return CRC16 value
*/
public int computeFromBytes(ByteArray dataToCrc )
{
return com.dalsemi.onewire.utils.CRC16.compute(dataToCrc .array);
}
======================================
public static int compute(byte[], int, int)
sMethodName=public static int compute
sParams=byte[], int, int
sThrows=
tempMethodName=public static int computeFromBytes3
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC16
methodName=public static int compute
params=byte[],int,int
/**
* Perform the CRC16 on an array of data elements based on a
* zero seed.
* <p>
* CRC16 is based on the polynomial = X^16 + X^15 + X^2 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC16
* @param off offset into the data array
* @param len length of data to CRC16
*
* @return CRC16 value
*/
public int computeFromBytes(ByteArray dataToCrc , int off, int len)
{
return com.dalsemi.onewire.utils.CRC16.compute(dataToCrc .array, off, len);
}
======================================
public static int compute(byte[], int, int, int)
sMethodName=public static int compute
sParams=byte[], int, int, int
sThrows=
tempMethodName=public static int computeFromBytes4
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC16
methodName=public static int compute
params=byte[],int,int,int
/**
* Perform the CRC16 on an array of data elements based on the
* provided seed.
* <p>
* CRC16 is based on the polynomial = X^16 + X^15 + X^2 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC16
* @param off offset into the data array
* @param len length of data to CRC16
* @param seed seed to use for CRC16
*
* @return CRC16 value
*/
public int computeFromBytes(ByteArray dataToCrc , int off, int len, int seed)
{
return com.dalsemi.onewire.utils.CRC16.compute(dataToCrc .array, off, len, seed);
}
======================================
public static int compute(byte[], int)
sMethodName=public static int compute
sParams=byte[], int
sThrows=
tempMethodName=public static int computeFromBytes2
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC16
methodName=public static int compute
params=byte[],int
/**
* Perform the CRC16 on an array of data elements based on a
* zero seed.
* <p>
* CRC16 is based on the polynomial = X^16 + X^15 + X^2 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC16
* @param off offset into the data array
* @param len length of data to CRC16
*
* @return CRC16 value
*/
public int computeFromBytes(ByteArray dataToCrc , int off)
{
return com.dalsemi.onewire.utils.CRC16.compute(dataToCrc .array, off);
}
-------------------------------------------------------------------
creating: owapi\CRC8.java
======================================
public static int compute(int, int)
sMethodName=public static int compute
sParams=int, int
sThrows=
tempMethodName=public static int compute2
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC8
methodName=public static int compute
params=int,int
/**
* Perform the CRC8 on the data element based on the provided seed.
* <p>
* CRC8 is based on the polynomial = X^8 + X^5 + X^4 + 1.
*
* @param dataToCrc data element on which to perform the CRC8
* @param seed seed the CRC8 with this value
* @return CRC8 value
*/
public int compute(int dataToCRC, int seed)
{
return com.dalsemi.onewire.utils.CRC8.compute(dataToCRC, seed);
}
======================================
public static int compute(int)
sMethodName=public static int compute
sParams=int
sThrows=
tempMethodName=public static int compute1
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC8
methodName=public static int compute
params=int
/**
* Perform the CRC8 on the data element based on the provided seed.
* <p>
* CRC8 is based on the polynomial = X^8 + X^5 + X^4 + 1.
*
* @param dataToCrc data element on which to perform the CRC8
* @param seed seed the CRC8 with this value
* @return CRC8 value
*/
public int compute(int dataToCRC)
{
return com.dalsemi.onewire.utils.CRC8.compute(dataToCRC);
}
======================================
public static int compute(byte[])
sMethodName=public static int compute
sParams=byte[]
sThrows=
tempMethodName=public static int computeFromBytes1
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC8
methodName=public static int compute
params=byte[]
/**
* Perform the CRC8 on an array of data elements based on a
* zero seed.
* <p>
* CRC8 is based on the polynomial = X^8 + X^5 + X^4 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC8
* @return CRC8 value
*/
public int computeFromBytes(ByteArray dataToCrc )
{
return com.dalsemi.onewire.utils.CRC8.compute(dataToCrc .array);
}
======================================
public static int compute(byte[], int, int)
sMethodName=public static int compute
sParams=byte[], int, int
sThrows=
tempMethodName=public static int computeFromBytes3
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC8
methodName=public static int compute
params=byte[],int,int
/**
* Perform the CRC8 on an array of data elements based on a
* zero seed.
* <p>
* CRC8 is based on the polynomial = X^8 + X^5 + X^4 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC8
* @param off offset into array
* @param len length of data to crc
* @return CRC8 value
*/
public int computeFromBytes(ByteArray dataToCrc , int off, int len)
{
return com.dalsemi.onewire.utils.CRC8.compute(dataToCrc .array, off, len);
}
======================================
public static int compute(byte[], int, int, int)
sMethodName=public static int compute
sParams=byte[], int, int, int
sThrows=
tempMethodName=public static int computeFromBytes4
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC8
methodName=public static int compute
params=byte[],int,int,int
/**
* Perform the CRC8 on an array of data elements based on the
* provided seed.
* <p>
* CRC8 is based on the polynomial = X^8 + X^5 + X^4 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC8
* @param off offset into array
* @param len length of data to crc
* @param seed seed to use for CRC8
* @return CRC8 value
*/
public int computeFromBytes(ByteArray dataToCrc , int off, int len, int seed)
{
return com.dalsemi.onewire.utils.CRC8.compute(dataToCrc .array, off, len, seed);
}
======================================
public static int compute(byte[], int)
sMethodName=public static int compute
sParams=byte[], int
sThrows=
tempMethodName=public static int computeFromBytes2
getMethodDocumentation
className=com.dalsemi.onewire.utils.CRC8
methodName=public static int compute
params=byte[],int
/**
* Perform the CRC8 on an array of data elements based on a
* zero seed.
* <p>
* CRC8 is based on the polynomial = X^8 + X^5 + X^4 + 1.
*
* @param dataToCrc array of data elements on which to perform the CRC8
* @param off offset into array
* @param len length of data to crc
* @return CRC8 value
*/
public int computeFromBytes(ByteArray dataToCrc , int off)
{
return com.dalsemi.onewire.utils.CRC8.compute(dataToCrc .array, off);
}
-------------------------------------------------------------------
creating: owapi\OWPath.java
======================================
public com.dalsemi.onewire.utils.OWPath(com.dalsemi.onewire.adapter.DSPortAdapter)
sMethodName=public com.dalsemi.onewire.utils.OWPath
sParams=com.dalsemi.onewire.adapter.DSPortAdapter
sThrows=
tempMethodName=public void createNewInstance1
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter
/**
* Create a new 1-Wire path with no elemements. Elements
* can be added by using <CODE> copy </CODE> and/or
* <CODE> add </CODE>.
*
* @param adapter where the path is based
*
* @see #copy(OWPath) copy
* @see #add(OneWireContainer, int) add
*/
public void createNewInstance(DSPortAdapter adapter)
{
objectInstance = new com.dalsemi.onewire.utils.OWPath(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance));
}
======================================
public com.dalsemi.onewire.utils.OWPath(com.dalsemi.onewire.adapter.DSPortAdapter,com.dalsemi.onewire.utils.OWPath)
sMethodName=public com.dalsemi.onewire.utils.OWPath
sParams=com.dalsemi.onewire.adapter.DSPortAdapter,com.dalsemi.onewire.utils.OWPath
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public void createNewInstance
params=com.dalsemi.onewire.adapter.DSPortAdapter,com.dalsemi.onewire.utils.OWPath
/**
* Create a new path with a starting path. New elements
* can be added with <CODE>add</CODE>.
*
* @param adapter where the 1-Wire path is based
* @param currentPath starting value of this 1-Wire path
*
* @see #add(OneWireContainer, int) add
*/
public void createNewInstance(DSPortAdapter adapter, OWPath currentOWPath)
{
objectInstance = new com.dalsemi.onewire.utils.OWPath(((com.dalsemi.onewire.adapter.DSPortAdapter)adapter.objectInstance), ((com.dalsemi.onewire.utils.OWPath)currentOWPath.objectInstance));
}
======================================
public void copy(com.dalsemi.onewire.utils.OWPath)
sMethodName=public void copy
sParams=com.dalsemi.onewire.utils.OWPath
sThrows=
tempMethodName=public void copy1
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public void copy
params=com.dalsemi.onewire.utils.OWPath
/**
* Copy the elements from the provided 1-Wire path into this 1-Wire path.
*
* @param currentOWPath path to copy from
*/
public void copy(OWPath currentOWPath)
{
objectInstance.copy(((com.dalsemi.onewire.utils.OWPath)currentOWPath.objectInstance));
}
======================================
public void add(com.dalsemi.onewire.container.OneWireContainer, int)
sMethodName=public void add
sParams=com.dalsemi.onewire.container.OneWireContainer, int
sThrows=
tempMethodName=public void add2
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public void add
params=com.dalsemi.onewire.container.OneWireContainer,int
/**
* Add a 1-Wire path element to this 1-Wire path.
*
* @param owc 1-Wire device switch
* @param channel of device that represents this 1-Wire path element
*
* @see #copy(OWPath) copy
*/
public void add(OneWireContainer owc, int channel)
{
objectInstance.add(((com.dalsemi.onewire.container.OneWireContainer)owc.objectInstance), channel);
}
======================================
public boolean equals(com.dalsemi.onewire.utils.OWPath)
sMethodName=public boolean equals
sParams=com.dalsemi.onewire.utils.OWPath
sThrows=
tempMethodName=public boolean equals1
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public boolean equals
params=com.dalsemi.onewire.utils.OWPath
/**
* Compare this 1-Wire path with another.
*
* @param compareOWPath 1-Wire path to compare to
*
* @return <CODE> true </CODE> if the 1-Wire paths are the same
*/
public boolean equals(OWPath compareOWPath)
{
return objectInstance.equals(((com.dalsemi.onewire.utils.OWPath)compareOWPath.objectInstance));
}
======================================
public java.util.Enumeration getAllOWPathElements()
sMethodName=public java.util.Enumeration getAllOWPathElements
sParams=
sThrows=
tempMethodName=public java.util.Enumeration getAllOWPathElements0
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public java.util.Enumeration getAllOWPathElements
params=
/**
* Get an enumeration of all of the 1-Wire path elements in
* this 1-Wire path.
*
* @return enumeration of all of the 1-Wire path elements
*
* @see OWPathElement
*/
public java.util.Enumeration getAllOWPathElements()
{
java.util.Enumeration retEnum = objectInstance.getAllOWPathElements();
java.util.Vector reRetEnum = new java.util.Vector();
while(retEnum.hasMoreElements())
{
/*Double Check This*/
Object o = retEnum.nextElement();
o = new OWPath(o);
reRetEnum.addElement(o);
}
return reRetEnum.elements();
}
======================================
public java.lang.String toString()
sMethodName=public java.lang.String toString
sParams=
sThrows=
tempMethodName=public java.lang.String toString0
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public java.lang.String toString
params=
/**
* Get a string representation of this 1-Wire path.
*
* @return string 1-Wire path as string
*/
public java.lang.String toString()
{
return objectInstance.toString();
}
======================================
public void open() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void open
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void open0
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public void open
params=
/**
* Open this 1-Wire path so that a remote device can be accessed.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter.
*/
public void open()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.open();
}
======================================
public void close() throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
sMethodName=public void close
sParams=
sThrows=throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
tempMethodName=public void close0
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPath
methodName=public void close
params=
/**
* Close each element in this 1-Wire path in reverse order.
*
* @throws OneWireIOException on a 1-Wire communication error such as
* no device present or a CRC read from the device is incorrect. This could be
* caused by a physical interruption in the 1-Wire Network due to
* shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
* @throws OneWireException on a communication or setup error with the 1-Wire
* adapter.
*/
public void close()
throws com.dalsemi.onewire.OneWireException, com.dalsemi.onewire.adapter.OneWireIOException
{
objectInstance.close();
}
-------------------------------------------------------------------
creating: owapi\OWPathElement.java
======================================
public com.dalsemi.onewire.utils.OWPathElement(com.dalsemi.onewire.container.OneWireContainer,int)
sMethodName=public com.dalsemi.onewire.utils.OWPathElement
sParams=com.dalsemi.onewire.container.OneWireContainer,int
sThrows=
tempMethodName=public void createNewInstance2
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPathElement
methodName=public void createNewInstance
params=com.dalsemi.onewire.container.OneWireContainer,int
/**
* Create a new 1-Wire path element.
*
* @param owcInstance device that is the path element. Must implement
* SwitchContainer.
* @param channelNumber channel number of the 1-Wire path
*/
public void createNewInstance(OneWireContainer owcInstance, int channelNumber)
{
objectInstance = new com.dalsemi.onewire.utils.OWPathElement(((com.dalsemi.onewire.container.OneWireContainer)owcInstance.objectInstance), channelNumber);
}
======================================
public com.dalsemi.onewire.container.OneWireContainer getContainer()
sMethodName=public com.dalsemi.onewire.container.OneWireContainer getContainer
sParams=
sThrows=
tempMethodName=public OneWireContainer getContainer0
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPathElement
methodName=public com.dalsemi.onewire.container.OneWireContainer getContainer
params=
/**
* Get the 1-Wire container for this 1-Wire path element.
*
* @return OneWireContainer of this 1-Wire path element
*
* @see OneWireContainer
*/
public OneWireContainer getContainer()
{
return new OneWireContainer(objectInstance.getContainer());
}
======================================
public int getChannel()
sMethodName=public int getChannel
sParams=
sThrows=
tempMethodName=public int getChannel0
getMethodDocumentation
className=com.dalsemi.onewire.utils.OWPathElement
methodName=public int getChannel
params=
/**
* Get the channel number of this 1-Wire path element.
*
* @return channel number of this element
*/
public int getChannel()
{
return objectInstance.getChannel();
}
-------------------------------------------------------------------
creating: owapi\SHA.java
======================================
public static final synchronized byte ComputeSHA(byte[], byte[], int)[]
sMethodName=public static final synchronized byte ComputeSHA
sParams=byte[], byte[], int
sThrows=
tempMethodName=public static final synchronized ByteArray ComputeSHA3
getMethodDocumentation
className=com.dalsemi.onewire.utils.SHA
methodName=public static final synchronized byte[] ComputeSHA
params=byte[],byte[],int
/**
* Does Dallas SHA, as specified in DS1963S datasheet.
* result is in intel Endian format, starting with the
* LSB of E to the MSB of E followed by the LSB of D.
* result array should be at least 20 bytes long, after
* the offset.
*
* @param MT The message block (padded if necessary).
* @param result The byte[] into which the result will be copied.
* @param offset The starting location in 'result' to start copying.
*/
public final synchronized ByteArray ComputeSHA(ByteArray MT, ByteArray result, int offset)
{
return new ByteArray().setupObject(com.dalsemi.onewire.utils.SHA.ComputeSHA(MT.array, result.array, offset));
}
======================================
public static final synchronized void ComputeSHA(byte[], int[])
sMethodName=public static final synchronized void ComputeSHA
sParams=byte[], int[]
sThrows=
tempMethodName=public static final synchronized void ComputeSHA2
getMethodDocumentation
className=com.dalsemi.onewire.utils.SHA
methodName=public static final synchronized void ComputeSHA
params=byte[],int[]
/**
* Does Dallas SHA, as specified in DS1963S datasheet.
* result is in intel Endian format, starting with the
* LSB of E to the MSB of E followed by the LSB of D.
*
* @param MT The message block (padded if necessary).
* @param ABCDE The result will be copied into this 5-int array.
*/
public final synchronized void ComputeSHA(ByteArray MT, int[] ABCDE)
{
com.dalsemi.onewire.utils.SHA.ComputeSHA(MT.array, ABCDE);
}
done
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.