@particle/device-control-util
Utility classes and functions used by other packages in this repository.
Installation
npm install @particle/device-control-util --save
API
Boolean
areEqualArrays(arr1, arr2) ⇒ 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. |
Number
readUint32Be(buf, [offs]) ⇒ 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. |
Number
readUint32Le(buf, [offs]) ⇒ 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. |
Number
readUint16Be(buf, [offs]) ⇒ 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. |
Number
readUint16Le(buf, [offs]) ⇒ 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. |
Number
readUint8(buf, [offs]) ⇒ 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. |
Uint8Array
toUint8Array(val) ⇒ Convert a value to a Uint8Array
.
Kind: global function
Param | Type | Description |
---|---|---|
val | * |
Value to convert. |
Uint8Array
concatUint8Arrays(...arrs) ⇒ 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