# LowpanDriver

Summary:[Constants](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#constants)\|[Ctors](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#pubctors)\|[Methods](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#)  

# LowpanDriver

`
public


abstract
class
LowpanDriver
`  
`

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.userdriver.lowpan.LowpanDriver |

<br />

*** ** * ** ***

Driver to implement LoWPAN device.

User defined drivers should extend this class.

The frame format used for this class is draft-rquattle-spinel-unified-00, available here: https://tools.ietf.org/html/draft-rquattle-spinel-unified-00

## Summary

|                                                                             ### Constants                                                                             ||
|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [ERROR_GARBAGE](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#ERROR_GARBAGE) Garbage-received error code.   |
| `int` | [ERROR_IOFAIL](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#ERROR_IOFAIL) Input/Output-failure error code. |
| `int` | [ERROR_TOOBIG](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#ERROR_TOOBIG) Frame-too-big error code.        |

|                                                          ### Public constructors                                                           ||
|-----------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[LowpanDriver](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#LowpanDriver())`() ` |

|                                                                                                                                                                                             ### Public methods                                                                                                                                                                                              ||
|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` abstract void` | ` `[reset](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#reset())`() ` Physically resets the NCP.                                                                                                                                                                                                                                      |
| ` abstract void` | ` `[sendFrame](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#sendFrame(byte[]))`(byte[] frame) ` Sends Spinel frames to the NCP.                                                                                                                                                                                                       |
| ` abstract void` | ` `[start](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#start(com.google.android.things.userdriver.lowpan.LowpanDriverCallback))`(`[LowpanDriverCallback](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback)` callback) ` Starts the LoWPAN driver and makes it ready for use. |
| ` abstract void` | ` `[stop](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#stop())`() ` Stops the LoWPAN driver, optionally putting it in a low-power state.                                                                                                                                                                                              |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#)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

### ERROR_GARBAGE

```
int ERROR_GARBAGE
```

Garbage-received error code.

This error code is emitted via[onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))in response to the receipt of an invalid frame from the NCP which could not be recovered. For example, the frame may be invalid due to a bad CRC or because it was too long. This error is informative for the upper layers and not fatal.

<br />

**See also:**

- [onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))

Constant Value: 5 (0x00000005)  

### ERROR_IOFAIL

```
int ERROR_IOFAIL
```

Input/Output-failure error code.

This error code is emitted via[onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))in response to any sort of non-recoverable I/O failure, and may be emitted at any time. Once this error is emitted, the driver is considered stopped: a call to[start(LowpanDriverCallback)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#start(com.google.android.things.userdriver.lowpan.LowpanDriverCallback))is required to begin using the interface again.

<br />

**See also:**

- [onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))
- [start(LowpanDriverCallback)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#start(com.google.android.things.userdriver.lowpan.LowpanDriverCallback))

Constant Value: 4 (0x00000004)  

### ERROR_TOOBIG

```
int ERROR_TOOBIG
```

Frame-too-big error code.

This error code is emitted via[onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))in response to @{link #sendFrame(byte\[\])} being called with an argument which is too large.

<br />

**See also:**

- [onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))
- [sendFrame(byte[])](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#sendFrame(byte[]))

Constant Value: 3 (0x00000003)

## Public constructors

### LowpanDriver

```
LowpanDriver ()
```

<br />

<br />

## Public methods

### reset

```
void reset ()
```

Physically resets the NCP. Implemented by the driver.

<br />

### sendFrame

```
void sendFrame (byte[] frame)
```

Sends Spinel frames to the NCP. Implemented by the driver.

<br />

|                    Parameters                    ||
|---------|-----------------------------------------|
| `frame` | `byte`: Frame received from NCP. <br /> |

### start

```
void start (LowpanDriverCallback callback)
```

Starts the LoWPAN driver and makes it ready for use.

Implemented by the driver.[onStarted()](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onStarted())MUST be called at some point during or after this method is called.

The driver can signal a failure to start by calling[onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))on`callback`instead of[onStarted()](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onStarted()).

<br />

|                Parameters                 ||
|------------|-------------------------------|
| `callback` | `LowpanDriverCallback` <br /> |

**See also:**

- [onError(int)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onError(int))
- [onStarted()](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback#onStarted())
- [stop()](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#stop())  

### stop

```
void stop ()
```

Stops the LoWPAN driver, optionally putting it in a low-power state.

Implemented by the driver. May be restarted by calling[start(LowpanDriverCallback)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#start(com.google.android.things.userdriver.lowpan.LowpanDriverCallback)).

<br />

**See also:**

- [start(LowpanDriverCallback)](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver#start(com.google.android.things.userdriver.lowpan.LowpanDriverCallback))  
-

  ## Classes

  - [LowpanDriver](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriver)
  - [LowpanDriverCallback](https://developer.android.com/reference/com/google/android/things/userdriver/lowpan/LowpanDriverCallback)