com.dalsemi.onewire.utils
Class Address

java.lang.Object
  |
  +--com.dalsemi.onewire.utils.Address

public class Address
extends Object

Utilities to translate and verify the 1-Wire Network address.

Q: What is a 1-Wire Network Address?

A: A 1-Wire address is 64 bits consisting of an eight bit family code, forty eight bits of serialized data and an eight bit CRC8 of the first 56 bits.

For example given the following address in hexadecimal:

10 28 E9 14 00 00 00 F3

The above is a family code 10 device with a serialized data of 28 E9 14 00 00 00, and a CRC8 of F3.

The address can be stored in several ways:

Version:
0.00, 21 August 2000

Method Summary
static boolean isValid(byte[] address)
          Checks the CRC8 calculation of this 1-Wire Network address.
static boolean isValid(long address)
          Checks the CRC8 calculation of this 1-Wire Network address.
static boolean isValid(String address)
          Checks the CRC8 calculation of this 1-Wire Network address.
static byte[] toByteArray(long address)
          Convert an iButton or 1-Wire device address as a long (little endian) into an array of bytes.
static byte[] toByteArray(String address)
          Converts a 1-Wire Network Address string (big endian) to a byte array (little endian).
static long toLong(byte[] address)
          Converts a 1-Wire Network Address to a long (little endian).
static long toLong(String address)
          Converts a 1-Wire Network Address to a long (little endian).
static String toString(byte[] address)
          Converts a 1-Wire Network address byte array (little endian) to a hex string representation (big endian).
static String toString(long address)
          Converts a 1-Wire Network address long (little endian) to a hex string representation (big endian).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isValid

public static boolean isValid(byte[] address)
Checks the CRC8 calculation of this 1-Wire Network address.

The address is valid if the CRC8 of the first seven bytes of the address gives a result equal to the eighth byte.

Parameters:
address - iButton or 1-Wire Network address to verify
Returns:
true if the family code is non-zero and the CRC8 calculation is correct.
See Also:
CRC8

isValid

public static boolean isValid(String address)
Checks the CRC8 calculation of this 1-Wire Network address.

The address is valid if the CRC8 of the first seven bytes of the address gives a result equal to the eighth byte.

Parameters:
address - iButton or 1-Wire Network address to verify
Returns:
true if the family code is non-zero and the CRC8 calculation is correct.
See Also:
CRC8

isValid

public static boolean isValid(long address)
Checks the CRC8 calculation of this 1-Wire Network address.

The address is valid if the CRC8 of the first seven bytes of the address gives a result equal to the eighth byte.

Parameters:
address - iButton or 1-Wire Network address to verify
Returns:
true if the family code is non-zero and the CRC8 calculation is correct.
See Also:
CRC8

toString

public static String toString(byte[] address)
Converts a 1-Wire Network address byte array (little endian) to a hex string representation (big endian).
Parameters:
address, - family code first.
Returns:
address represented in a String, family code last.

toString

public static String toString(long address)
Converts a 1-Wire Network address long (little endian) to a hex string representation (big endian).
Parameters:
address, - family code first.
Returns:
address represented in a long, little endian.

toByteArray

public static byte[] toByteArray(String address)
Converts a 1-Wire Network Address string (big endian) to a byte array (little endian).
Parameters:
address, - family code last.
Returns:
address represented in a byte array, family code (LS byte) first.

toByteArray

public static byte[] toByteArray(long address)
Convert an iButton or 1-Wire device address as a long (little endian) into an array of bytes.

toLong

public static long toLong(byte[] address)
Converts a 1-Wire Network Address to a long (little endian).

toLong

public static long toLong(String address)
Converts a 1-Wire Network Address to a long (little endian).