# LowpanBeaconInfo Summary:[Constants](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#constants)\|[Methods](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#) # LowpanBeaconInfo ` public class LowpanBeaconInfo ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` ` |---|---------------------------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | com.google.android.things.lowpan.LowpanBeaconInfo |
*** ** * ** *** Describes a LoWPAN Beacon. LowpanBeaconInfo objects are emitted by the[LowpanScanner](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanScanner)class when performing a network scan. They contain a[LowpanIdentity](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanIdentity)object along with the originating hardware address, RSSI, and (if available) LQI of the received network beacon. **See also:** - [onNetScanBeacon(LowpanBeaconInfo)](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanScanner.Callback#onNetScanBeacon(com.google.android.things.lowpan.LowpanBeaconInfo)) ## Summary | ### Constants || |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [FLAG_CAN_ASSIST](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#FLAG_CAN_ASSIST) Indicates if the device which sent this beacon can assist with commissioning a device onto the LoWPAN. | | ### Public methods || |---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` boolean` | ` `[equals](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` rhs) ` Indicates whether some other object is "equal to" this one. | | ` byte[]` | ` `[getBeaconAddress](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#getBeaconAddress())`() ` Returns a copy of the beacon address associated with this beacon. | | ` `[Collection](https://developer.android.com/reference/java/util/Collection)`<`[Integer](https://developer.android.com/reference/java/lang/Integer)`>` | ` `[getFlags](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#getFlags())`() ` Returns a collection of integers representing any flags associated with this beacon. | | ` `[LowpanIdentity](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanIdentity) | ` `[getLowpanIdentity](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#getLowpanIdentity())`() ` Returns the LowpanIdentity object associated with this beacon. | | ` int` | ` `[getLqi](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#getLqi())`() ` Returns the Link Quality Index (LQI) of the beacon. | | ` int` | ` `[getRssi](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#getRssi())`() ` Returns the RSSI of the beacon, measured in dBm. | | ` int` | ` `[hashCode](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#hashCode())`() ` Returns a hash code value for the object. | | ` boolean` | ` `[isFlagSet](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#isFlagSet(int))`(int flag) ` Test for determining if a specific flag is set on this beacon. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#toString())`() ` Returns a string representation of the object. | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo#)From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long, int))`(long millis, int nanos) ` Causes the current thread to wait until another thread invokes the[notify()](https://developer.android.com/reference/java/lang/Object.html#notify())method or the[notifyAll()](https://developer.android.com/reference/java/lang/Object.html#notifyAll())method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long millis) ` Causes the current thread to wait until either another thread invokes the[notify()](https://developer.android.com/reference/java/lang/Object.html#notify())method or the[notifyAll()](https://developer.android.com/reference/java/lang/Object.html#notifyAll())method for this object, or a specified amount of time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until another thread invokes the[notify()](https://developer.android.com/reference/java/lang/Object.html#notify())method or the[notifyAll()](https://developer.android.com/reference/java/lang/Object.html#notifyAll())method for this object. | || ## Constants ### FLAG_CAN_ASSIST ``` int FLAG_CAN_ASSIST ``` Indicates if the device which sent this beacon can assist with commissioning a device onto the LoWPAN.
Constant Value: 1 (0x00000001) ## Public methods ### equals ``` boolean equals (Object rhs) ``` Indicates whether some other object is "equal to" this one. The`equals`method implements an equivalence relation on non-null object references: - It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`. - It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`. - It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`. - It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified. - For any non-null reference value`x`,`x.equals(null)`should return`false`. The`equals`method for class`Object`implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values`x`and`y`, this method returns`true`if and only if`x`and`y`refer to the same object (`x == y`has the value`true`). Note that it is generally necessary to override the`hashCode`method whenever this method is overridden, so as to maintain the general contract for the`hashCode`method, which states that equal objects must have equal hash codes.
| Parameters || |-------|--------------------------------------------------------------| | `rhs` | `Object`: the reference object with which to compare.
| | Returns || |-----------|-------------------------------------------------------------------------------| | `boolean` | `true`if this object is the same as the obj argument;`false`otherwise.
| ### getBeaconAddress ``` byte[] getBeaconAddress () ``` Returns a copy of the beacon address associated with this beacon.
| Returns || |----------|--------| | `byte[]` |
| ### getFlags ``` Collection getFlags () ``` Returns a collection of integers representing any flags associated with this beacon.
| Returns || |------------------------------------------------------------------------------------------------------------------------------------------------------|--------| | [Collection](https://developer.android.com/reference/java/util/Collection)`<`[Integer](https://developer.android.com/reference/java/lang/Integer)`>` |
| ### getLowpanIdentity ``` LowpanIdentity getLowpanIdentity () ``` Returns the LowpanIdentity object associated with this beacon.
| Returns || |-----------------------------------------------------------------------------------------------------------|--------| | [LowpanIdentity](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanIdentity) |
| ### getLqi ``` int getLqi () ``` Returns the Link Quality Index (LQI) of the beacon. The returned value ranges between 0 and 255: - A value of 0 indicates that the LQI was not set. - A value of 1 indicates the worst possible quality where the decoded beacon is still valid. - A value of 255 indicates the best possible quality that can be recognized by the radio hardware. - Values 2-254 are intended to represent relative quality levels evenly distributed between the worst and best, with lower values always indicating a worse quality than higher values.

| Returns || |-------|--------| | `int` |
| ### getRssi ``` int getRssi () ``` Returns the RSSI of the beacon, measured in dBm.
| Returns || |-------|--------| | `int` |
| ### hashCode ``` int hashCode () ``` Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[HashMap](https://developer.android.com/reference/java/util/HashMap.html). The general contract of`hashCode`is: - Whenever it is invoked on the same object more than once during an execution of a Java application, the`hashCode`method must consistently return the same integer, provided no information used in`equals`comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the`equals(Object)`method, then calling the`hashCode`method on each of the two objects must produce the same integer result. - It is*not* required that if two objects are unequal according to the[equals(java.lang.Object)](https://developer.android.com/reference/java/lang/Object.html#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. As much as is reasonably practical, the hashCode method defined by class`Object`does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
| Returns || |-------|-------------------------------------------| | `int` | a hash code value for this object.
| ### isFlagSet ``` boolean isFlagSet (int flag) ``` Test for determining if a specific flag is set on this beacon.
| Parameters || |--------|--------------| | `flag` | `int`
| | Returns || |-----------|--------| | `boolean` |
| ### toString ``` String toString () ``` Returns a string representation of the object. In general, the`toString`method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The`toString`method for class`Object`returns a string consisting of the name of the class of which the object is an instance, the at-sign character \``@`', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: > > ``` > getClass().getName() + '@' + Integer.toHexString(hashCode()) > > ```

| Returns || |--------------------------------------------------------------------|-----------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object.
| - ## Classes - [LowpanBeaconInfo](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanBeaconInfo) - [LowpanCredential](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanCredential) - [LowpanEnergyScanResult](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanEnergyScanResult) - [LowpanIdentity](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanIdentity) - [LowpanIdentity.Builder](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanIdentity.Builder) - [LowpanInterface](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanInterface) - [LowpanInterface.Callback](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanInterface.Callback) - [LowpanManager](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanManager) - [LowpanManager.Callback](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanManager.Callback) - [LowpanProvisioningParams](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanProvisioningParams) - [LowpanProvisioningParams.Builder](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanProvisioningParams.Builder) - [LowpanScanner](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanScanner) - [LowpanScanner.Callback](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanScanner.Callback) - ## Exceptions - [InterfaceDisabledException](https://developer.android.com/reference/com/google/android/things/lowpan/InterfaceDisabledException) - [JoinFailedAtAuthException](https://developer.android.com/reference/com/google/android/things/lowpan/JoinFailedAtAuthException) - [JoinFailedAtScanException](https://developer.android.com/reference/com/google/android/things/lowpan/JoinFailedAtScanException) - [JoinFailedException](https://developer.android.com/reference/com/google/android/things/lowpan/JoinFailedException) - [LowpanException](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanException) - [LowpanRuntimeException](https://developer.android.com/reference/com/google/android/things/lowpan/LowpanRuntimeException) - [NetworkAlreadyExistsException](https://developer.android.com/reference/com/google/android/things/lowpan/NetworkAlreadyExistsException) - [OperationCanceledException](https://developer.android.com/reference/com/google/android/things/lowpan/OperationCanceledException) - [WrongStateException](https://developer.android.com/reference/com/google/android/things/lowpan/WrongStateException)