: Class MicroLanState

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibutton.tmex.adapter
Class MicroLanState

java.lang.Object
  |
  +--com.ibutton.tmex.adapter.MicroLanState

public class MicroLanState
extends java.lang.Object

MicroLan State contains the current MicroLan state information

Field Summary
`static char`	`ALARM_SEARCH_CMD` Conditional Search, only 'alarming' devices participate
`static char`	`BIT` Block mode, bit
`static char`	`BYTE` Block mode, byte
`boolean`	`canProgram` True in programming voltage is available
`static int`	`CONDITION_AFTER_BIT` Condition for power bus state change, after next bit communication
`static int`	`CONDITION_AFTER_BYTE` Condition for power bus state change, after next byte communication
`static int`	`CONDITION_NOW` Condition for power bus state change, immediate
`static int`	`DELIVERY_CURRENT_DETECT` Duration used in delivering power to the bus, current detect
`static int`	`DELIVERY_EPROM` Duration used in delivering power to the bus, 480 us
`static int`	`DELIVERY_FOUR_SECONDS` Duration used in delivering power to the bus, 4 second
`static int`	`DELIVERY_HALF_SECOND` Duration used in delivering power to the bus, 1/2 second
`static int`	`DELIVERY_INFINITE` Duration used in delivering power to the bus, infinite
`static int`	`DELIVERY_ONE_SECOND` Duration used in delivering power to the bus, 1 second
`static int`	`DELIVERY_SMART_DONE` Duration used in delivering power to the bus, smart complete
`static int`	`DELIVERY_TWO_SECONDS` Duration used in delivering power to the bus, 2 seconds
`iButtonID`	`ID` ID number of the current iButton found
`static char`	`LEVEL_BREAK` MicroLan level, normal (strong pulldown to 0Volts, reset bus)
`static char`	`LEVEL_NORMAL` MicroLan level, normal (weak 5Volt pullup)
`static char`	`LEVEL_POWER_DELIVERY` MicroLan level, normal (strong 5Volt pullup, used for power delivery)
`static char`	`LEVEL_PROGRAM` MicroLan level, normal (strong 12Volt pullup, used to program eprom )
`boolean`	`levelChangeOnNextBit` True if a level change is primed to occure on the next bit of communication.
`boolean`	`levelChangeOnNextByte` True if a level change is primed to occure on the next byte of communication.
`int`	`levelTimeFactor` The amount of time that the 'level' value will be on for.
`static char`	`MATCH_CMD` 'Match' select command
`char`	`microLanLevel` This is the current logical MicroLan pullup level. The valid values are: LEVEL_NORMAL LEVEL_POWER_DELIVERY LEVEL_BREAK LEVEL_PROGRAM
`char`	`microLanSpeed` This is the current logical speed that the MicroLan is operating at.
`static char`	`NORMAL_SEARCH_CMD` Normal Search, all devices participate
`char`	`primedLevelValue` The new level value that is primed to change on the next bit or byte depending on the flags, levelChangeOnNextBit and levelChangeOnNextByte The valid values are: LEVEL_NORMAL LEVEL_STRONGPULLUP LEVEL_BREAK LEVEL_PROGRAM
`static char`	`RESET` Block mode, reset
`static int`	`RESET_ALARM` MicroLan reset result = alarm
`static int`	`RESET_NOPRESENCE` MicroLan reset result = no presence
`static int`	`RESET_PRESENCE` MicroLan reset result = presence
`static int`	`RESET_SHORT` MicroLan reset result = shorted
`static char`	`SEARCH` Block mode, search
`int[]`	`searchExcludeFamilies` Array of iButton families to exclude in any search
`int`	`searchFamilyLastDiscrepancy` Value of the last discrepancy in the family code during the last search for an iButton
`int[]`	`searchIncludeFamilies` Array of iButton families to include in any search
`boolean`	`searchLastDevice` Flag to indicate that the last device found is the last device in a search sequence on the MicroLAN.
`int`	`searchLastDiscrepancy` Value of the last discrepancy during the last search for an iButton
`boolean`	`searchOnlyAlarmingButtons` Flag to indicate the conditional search is to be performed so that only iButtons in an alarm state will be found.
`static int`	`SPEED_FLEX` Speed modes for MicroLan bus, flexible for long lines
`static int`	`SPEED_HYPERDRIVE` Speed modes for MicroLan bus, hyperdrive
`static int`	`SPEED_OVERDRIVE` Speed modes for MicroLan bus, overdrive
`static int`	`SPEED_REGULAR` Speed modes for MicroLan bus, regular

Constructor Summary
`MicroLanState()` Construct the initial state of the MicroLan

Methods inherited from class java.lang.Object

clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

Field Detail

SPEED_REGULAR

public static final int SPEED_REGULAR

Speed modes for MicroLan bus, regular

SPEED_FLEX

public static final int SPEED_FLEX

Speed modes for MicroLan bus, flexible for long lines

SPEED_OVERDRIVE

public static final int SPEED_OVERDRIVE

Speed modes for MicroLan bus, overdrive

SPEED_HYPERDRIVE

public static final int SPEED_HYPERDRIVE

Speed modes for MicroLan bus, hyperdrive

BIT

public static final char BIT

Block mode, bit

BYTE

public static final char BYTE

Block mode, byte

RESET

public static final char RESET

Block mode, reset

SEARCH

public static final char SEARCH

Block mode, search

LEVEL_NORMAL

public static final char LEVEL_NORMAL

MicroLan level, normal (weak 5Volt pullup)

LEVEL_POWER_DELIVERY

public static final char LEVEL_POWER_DELIVERY

MicroLan level, normal (strong 5Volt pullup, used for power delivery)

LEVEL_BREAK

public static final char LEVEL_BREAK

MicroLan level, normal (strong pulldown to 0Volts, reset bus)

LEVEL_PROGRAM

public static final char LEVEL_PROGRAM

MicroLan level, normal (strong 12Volt pullup, used to program eprom )

RESET_NOPRESENCE

public static final int RESET_NOPRESENCE

MicroLan reset result = no presence

RESET_PRESENCE

public static final int RESET_PRESENCE

MicroLan reset result = presence

RESET_ALARM

public static final int RESET_ALARM

MicroLan reset result = alarm

RESET_SHORT

public static final int RESET_SHORT

MicroLan reset result = shorted

CONDITION_NOW

public static final int CONDITION_NOW

Condition for power bus state change, immediate

CONDITION_AFTER_BIT

public static final int CONDITION_AFTER_BIT

Condition for power bus state change, after next bit communication

CONDITION_AFTER_BYTE

public static final int CONDITION_AFTER_BYTE

Condition for power bus state change, after next byte communication

DELIVERY_HALF_SECOND

public static final int DELIVERY_HALF_SECOND

Duration used in delivering power to the bus, 1/2 second

DELIVERY_ONE_SECOND

public static final int DELIVERY_ONE_SECOND

Duration used in delivering power to the bus, 1 second

DELIVERY_TWO_SECONDS

public static final int DELIVERY_TWO_SECONDS

Duration used in delivering power to the bus, 2 seconds

DELIVERY_FOUR_SECONDS

public static final int DELIVERY_FOUR_SECONDS

Duration used in delivering power to the bus, 4 second

DELIVERY_SMART_DONE

public static final int DELIVERY_SMART_DONE

Duration used in delivering power to the bus, smart complete

DELIVERY_INFINITE

public static final int DELIVERY_INFINITE

Duration used in delivering power to the bus, infinite

DELIVERY_CURRENT_DETECT

public static final int DELIVERY_CURRENT_DETECT

Duration used in delivering power to the bus, current detect

DELIVERY_EPROM

public static final int DELIVERY_EPROM

Duration used in delivering power to the bus, 480 us

NORMAL_SEARCH_CMD

public static final char NORMAL_SEARCH_CMD

Normal Search, all devices participate

ALARM_SEARCH_CMD

public static final char ALARM_SEARCH_CMD

Conditional Search, only 'alarming' devices participate

MATCH_CMD

public static final char MATCH_CMD

'Match' select command

microLanSpeed

public char microLanSpeed

This is the current logical speed that the MicroLan is operating at.

The valid values for this are:

SPEED_REGULAR
SPEED_FLEX
SPEED_OVERDRIVE
SPEED_HYPERDRIVE

microLanLevel

public char microLanLevel

This is the current logical MicroLan pullup level.

The valid values are:

LEVEL_NORMAL
LEVEL_POWER_DELIVERY
LEVEL_BREAK
LEVEL_PROGRAM

canProgram

public boolean canProgram

True in programming voltage is available

levelChangeOnNextBit

public boolean levelChangeOnNextBit

True if a level change is primed to occure on the next bit of communication.

levelChangeOnNextByte

public boolean levelChangeOnNextByte

True if a level change is primed to occure on the next byte of communication.

primedLevelValue

public char primedLevelValue

The new level value that is primed to change on the next bit or byte depending on the flags, levelChangeOnNextBit and levelChangeOnNextByte The valid values are:

LEVEL_NORMAL
LEVEL_STRONGPULLUP
LEVEL_BREAK
LEVEL_PROGRAM

levelTimeFactor

public int levelTimeFactor

The amount of time that the 'level' value will be on for. The valid values are:

0 (DELIVERY_HALF_SECOND) provide power for 1/2 second.
1 (DELIVERY_ONE_SECOND) provide power for 1 second.
2 (DELIVERY_TWO_SECONDS) provide power for 2 seconds.
3 (DELIVERY_FOUR_SECONDS) provide power for 4 seconds.
4 (DELIVERY_SMART_DONE) provide power until the the device is no longer drawing significant power.
5 (DELIVERY_INFINITE) provide power until the setBusNormal() method is called.

searchLastDiscrepancy

public int searchLastDiscrepancy

Value of the last discrepancy during the last search for an iButton

searchFamilyLastDiscrepancy

public int searchFamilyLastDiscrepancy

Value of the last discrepancy in the family code during the last search for an iButton

searchLastDevice

public boolean searchLastDevice

Flag to indicate that the last device found is the last device in a search sequence on the MicroLAN.

ID

public iButtonID ID

ID number of the current iButton found

searchIncludeFamilies

public int[] searchIncludeFamilies

Array of iButton families to include in any search

searchExcludeFamilies

public int[] searchExcludeFamilies

Array of iButton families to exclude in any search

searchOnlyAlarmingButtons

public boolean searchOnlyAlarmingButtons

Flag to indicate the conditional search is to be performed so that only iButtons in an alarm state will be found.

Constructor Detail

MicroLanState

public MicroLanState()

Construct the initial state of the MicroLan