BufferReader
Defined in: src/protocol/buffer.ts:6
Cursor-based reader for MeshCore companion frames. Replaces hardcoded
absolute offsets (e.g. frame.readUInt32LE(132)) so variable-length frames
decode without off-by-one risk. Ported from meshcore.js’s BufferReader.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BufferReader(buf): BufferReader;Defined in: src/protocol/buffer.ts:8
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
buf | Buffer |
Returns
Section titled “Returns”BufferReader
Accessors
Section titled “Accessors”remaining
Section titled “remaining”Get Signature
Section titled “Get Signature”get remaining(): number;Defined in: src/protocol/buffer.ts:10
Returns
Section titled “Returns”number
Methods
Section titled “Methods”readByte()
Section titled “readByte()”readByte(): number;Defined in: src/protocol/buffer.ts:14
Returns
Section titled “Returns”number
readBytes()
Section titled “readBytes()”readBytes(n): Buffer;Defined in: src/protocol/buffer.ts:46
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
n | number |
Returns
Section titled “Returns”Buffer
readCString()
Section titled “readCString()”readCString(maxLen): string;Defined in: src/protocol/buffer.ts:62
Fixed-width null-padded string: consumes exactly maxLen bytes, returns
the text up to the first null.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
maxLen | number |
Returns
Section titled “Returns”string
readInt16LE()
Section titled “readInt16LE()”readInt16LE(): number;Defined in: src/protocol/buffer.ts:25
Returns
Section titled “Returns”number
readInt24BE()
Section titled “readInt24BE()”readInt24BE(): number;Defined in: src/protocol/buffer.ts:41
24-bit big-endian signed — used by CayenneLPP GPS fields.
Returns
Section titled “Returns”number
readInt32LE()
Section titled “readInt32LE()”readInt32LE(): number;Defined in: src/protocol/buffer.ts:35
Returns
Section titled “Returns”number
readInt8()
Section titled “readInt8()”readInt8(): number;Defined in: src/protocol/buffer.ts:17
Returns
Section titled “Returns”number
readRemaining()
Section titled “readRemaining()”readRemaining(): Buffer;Defined in: src/protocol/buffer.ts:54
Returns
Section titled “Returns”Buffer
readString()
Section titled “readString()”readString(): string;Defined in: src/protocol/buffer.ts:57
Returns
Section titled “Returns”string
readUInt16LE()
Section titled “readUInt16LE()”readUInt16LE(): number;Defined in: src/protocol/buffer.ts:20
Returns
Section titled “Returns”number
readUInt32LE()
Section titled “readUInt32LE()”readUInt32LE(): number;Defined in: src/protocol/buffer.ts:30
Returns
Section titled “Returns”number