@particle/device-control-util

Utility classes and functions used by other packages in this repository.

Installation

npm install @particle/device-control-util --save

API

areEqualArrays(arr1, arr2) ⇒ Boolean

Compare two array-like objects.

Kind: global function
Returns: Boolean - true if the arrays are equal or false otherwise.

| Param | Type | Description | | --- | --- | --- | | arr1 | Array.<*> | First array. | | arr2 | Array.<*> | Second array. |

writeUint32Be(buf, val, [offs])

Write a 32-bit unsigned integer to a buffer (big-endian).

Kind: global function

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Destination buffer. | | val | Number | | Value. | | [offs] | Number | 0 | Offset in the destination buffer. |

writeUint32Le(buf, val, [offs])

Write a 32-bit unsigned integer to a buffer (little-endian).

Kind: global function

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Destination buffer. | | val | Number | | Value. | | [offs] | Number | 0 | Offset in the destination buffer. |

writeUint16Be(buf, val, [offs])

Write a 16-bit unsigned integer to a buffer (big-endian).

Kind: global function

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Destination buffer. | | val | Number | | Value. | | [offs] | Number | 0 | Offset in the destination buffer. |

writeUint16Le(buf, val, [offs])

Write a 16-bit unsigned integer to a buffer (little-endian).

Kind: global function

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Destination buffer. | | val | Number | | Value. | | [offs] | Number | 0 | Offset in the destination buffer. |

writeUint8(buf, val, [offs])

Write an 8-bit unsigned integer to a buffer.

Kind: global function

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Destination buffer. | | val | Number | | Value. | | [offs] | Number | 0 | Offset in the destination buffer. |

readUint32Be(buf, [offs]) ⇒ Number

Read a 32-bit unsigned integer from a buffer (big-endian).

Kind: global function
Returns: Number - Value.

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Source buffer. | | [offs] | Number | 0 | Offset in the source buffer. |

readUint32Le(buf, [offs]) ⇒ Number

Read a 32-bit unsigned integer from a buffer (little-endian).

Kind: global function
Returns: Number - Value.

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Source buffer. | | [offs] | Number | 0 | Offset in the source buffer. |

readUint16Be(buf, [offs]) ⇒ Number

Read a 16-bit unsigned integer from a buffer (big-endian).

Kind: global function
Returns: Number - Value.

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Source buffer. | | [offs] | Number | 0 | Offset in the source buffer. |

readUint16Le(buf, [offs]) ⇒ Number

Read a 16-bit unsigned integer from a buffer (little-endian).

Kind: global function
Returns: Number - Value.

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Source buffer. | | [offs] | Number | 0 | Offset in the source buffer. |

readUint8(buf, [offs]) ⇒ Number

Read an 8-bit unsigned integer from a buffer.

Kind: global function
Returns: Number - Value.

| Param | Type | Default | Description | | --- | --- | --- | --- | | buf | Uint8Array | | Source buffer. | | [offs] | Number | 0 | Offset in the source buffer. |

toUint8Array(val) ⇒ Uint8Array

Convert a value to a Uint8Array.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | val | * | Value to convert. |

concatUint8Arrays(...arrs) ⇒ Uint8Array

Concatenate a number of Uint8Array objects.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | ...arrs | Uint8Array | Arrays to concatenate. |

NOTE: Unfortunately, docs have a nasty habit of falling out of date. When in doubt, check usage in tests