libraryDocs / bytepack

bytepack

librarysharedsource

Library that packs & unpacks types as bytes.

Classes & types

Functions

`bytepack.readDate`	Reads date in DOS format from single Short number ( UInt16 ).
`bytepack.readDoubleBE`	Reads signed 8-byte (64 bit) float (double) from big endian bytes.
`bytepack.readDoubleLE`	Reads signed 8-byte (64 bit) float (double) from little endian bytes.
`bytepack.readFixedPoint`	Reads fixed-point number (UQm.n) from specified integer with n bits.
`bytepack.readFloatBE`	Reads signed 4-byte (32 bit) float from big endian bytes.
`bytepack.readFloatLE`	Reads signed 4-byte (32 bit) float from little endian bytes.
`bytepack.readHex16BE`	Reads unsigned 2-byte (16 bit) integer from big endian hex bytes.
`bytepack.readHex24BE`	Reads unsigned 3-byte (24 bit) integer from big endian hex bytes.
`bytepack.readHex32BE`	Reads unsigned 4-byte (32 bit) integer from big endian hex bytes.
`bytepack.readHex8`	Reads unsigned 1-byte (8 bit) integer from big endian hex bytes.
`bytepack.readInt16BE`	Reads signed 2-byte (16 bit) integer as big endian bytes.
`bytepack.readInt16LE`	Reads signed 2-byte (16 bit) integer as little endian bytes.
`bytepack.readInt24BE`	Reads signed 3-byte (24 bit) integer as big endian bytes.
`bytepack.readInt24LE`	Reads signed 3-byte (24 bit) integer as little endian bytes.
`bytepack.readInt32BE`	Reads signed 4-byte (32 bit) integer from big endian bytes.
`bytepack.readInt32LE`	Reads signed 4-byte (32 bit) integer from little endian bytes.
`bytepack.readInt40BE`	Reads signed 5-byte (40 bit) integer from big endian bytes.
`bytepack.readInt40LE`	Reads signed 5-byte (40 bit) integer from little endian bytes.
`bytepack.readInt48BE`	Reads signed 6-byte (48 bit) integer from big endian bytes.
`bytepack.readInt48LE`	Reads signed 6-byte (48 bit) integer from little endian bytes.
`bytepack.readInt56BE`	Reads signed 7-byte (56 bit) integer from big endian bytes.
`bytepack.readInt56LE`	Reads signed 7-byte (56 bit) integer from little endian bytes.
`bytepack.readInt64BE`	Reads signed 8-byte (64 bit) integer from big endian bytes.
`bytepack.readInt64LE`	Reads signed 8-byte (64 bit) integer from little endian bytes.
`bytepack.readInt8`	Reads signed 1-byte (8 bit) integer as little endian bytes.
`bytepack.readTime`	Reads hours, minutes and seconds from single Short number ( UInt16 ).
`bytepack.readUInt16BE`	Reads unsigned 2-byte (16 bit) integer from big endian bytes.
`bytepack.readUInt16LE`	Reads unsigned 2-byte (16 bit) integer from little endian bytes.
`bytepack.readUInt24BE`	Reads unsigned 3-byte (24 bit) integer from big endian bytes.
`bytepack.readUInt24LE`	Reads unsigned 3-byte (24 bit) integer from little endian bytes.
`bytepack.readUInt32BE`	Reads unsigned 4-byte (32 bit) integer from big endian bytes.
`bytepack.readUInt32LE`	Reads unsigned 4-byte (32 bit) integer from little endian bytes.
`bytepack.readUInt40BE`	Reads unsigned 5-byte (40 bit) integer from big endian bytes.
`bytepack.readUInt40LE`	Reads unsigned 5-byte (40 bit) integer from little endian bytes.
`bytepack.readUInt48BE`	Reads unsigned 6-byte (48 bit) integer from big endian bytes.
`bytepack.readUInt48LE`	Reads unsigned 6-byte (48 bit) integer from little endian bytes.
`bytepack.readUInt56BE`	Reads unsigned 7-byte (56 bit) integer from big endian bytes.
`bytepack.readUInt56LE`	Reads unsigned 7-byte (56 bit) integer from little endian bytes.
`bytepack.readUInt64BE`	Reads unsigned 8-byte (64 bit) integer from big endian bytes.
`bytepack.readUInt64LE`	Reads unsigned 8-byte (64 bit) integer from little endian bytes.
`bytepack.readUInt8`	Reads unsigned 1-byte (8 bit) integer from bytes.
`bytepack.writeDate`	Writes date in DOS format as single Short number ( UInt16 ).
`bytepack.writeDoubleBE`	Writes signed 8-byte (64 bit) float (double) as big endian bytes.
`bytepack.writeDoubleLE`	Writes signed 8-byte (64 bit) float (double) as little endian bytes.
`bytepack.writeFixedPoint`	Writes fixed-point number (UQm.n or Qm.n) as integer with n fractional bits.
`bytepack.writeFloatBE`	Writes signed 4-byte (32 bit) float as big endian bytes.
`bytepack.writeFloatLE`	Writes signed 4-byte (32 bit) float as little endian bytes.
`bytepack.writeHex16BE`	Encodes unsigned 2-byte (16 bit) integer to big endian hex bytes.
`bytepack.writeHex16LE`	Encodes unsigned 2-byte (16 bit) integer to little endian hex bytes.
`bytepack.writeHex24BE`	Encodes unsigned 3-byte (24 bit) integer to big endian hex bytes.
`bytepack.writeHex24LE`	Encodes unsigned 3-byte (24 bit) integer to little endian hex bytes.
`bytepack.writeHex32BE`	Encodes unsigned 4-byte (32 bit) integer to big endian hex bytes.
`bytepack.writeHex32LE`	Encodes unsigned 4-byte (32 bit) integer to little endian hex bytes.
`bytepack.writeHex8`	Encodes unsigned 1-byte (8 bit) integer to big endian hex bytes.
`bytepack.writeInt16BE`	Writes signed 2-byte (16 bit) integer as big endian bytes.
`bytepack.writeInt16LE`	Writes signed 2-byte (16 bit) integer as little endian bytes.
`bytepack.writeInt24BE`	Writes signed 3-byte (24 bit) integer as big endian bytes.
`bytepack.writeInt24LE`	Writes signed 3-byte (24 bit) integer as little endian bytes.
`bytepack.writeInt32BE`	Writes signed 4-byte (32 bit) integer as big endian bytes.
`bytepack.writeInt32LE`	Writes signed 4-byte (32 bit) integer as little endian bytes.
`bytepack.writeInt40BE`	Writes signed 5-byte (40 bit) integer as big endian bytes.
`bytepack.writeInt40LE`	Writes signed 5-byte (40 bit) integer as little endian bytes.
`bytepack.writeInt48BE`	Writes signed 6-byte (48 bit) integer as big endian bytes.
`bytepack.writeInt48LE`	Writes signed 6-byte (48 bit) integer as little endian bytes.
`bytepack.writeInt56BE`	Writes signed 7-byte (56 bit) integer as big endian bytes.
`bytepack.writeInt56LE`	Writes signed 7-byte (56 bit) integer as little endian bytes.
`bytepack.writeInt64BE`	Writes signed 8-byte (64 bit) integer as big endian bytes.
`bytepack.writeInt64LE`	Writes signed 8-byte (64 bit) integer as little endian bytes.
`bytepack.writeInt8`	Writes signed 1-byte (8 bit) integer as little endian bytes.
`bytepack.writeTime`	Writes time in DOS format as single Short number ( UInt16 ).
`bytepack.writeUInt16BE`	Writes unsigned 2-byte (16 bit) integer as big endian bytes.
`bytepack.writeUInt16LE`	Writes unsigned 2-byte (16 bit) integer as little endian bytes.
`bytepack.writeUInt24BE`	Writes unsigned 3-byte (24 bit) integer as big endian bytes.
`bytepack.writeUInt24LE`	Writes unsigned 3-byte (24 bit) integer as little endian bytes.
`bytepack.writeUInt32BE`	Writes unsigned 4-byte (32 bit) integer as big endian bytes.
`bytepack.writeUInt32LE`	Writes unsigned 4-byte (32 bit) integer as little endian bytes.
`bytepack.writeUInt40BE`	Writes unsigned 5-byte (40 bit) integer as big endian bytes.
`bytepack.writeUInt40LE`	Writes unsigned 5-byte (40 bit) integer as little endian bytes.
`bytepack.writeUInt48BE`	Writes unsigned 6-byte (48 bit) integer as big endian bytes.
`bytepack.writeUInt48LE`	Writes unsigned 6-byte (48 bit) integer as little endian bytes.
`bytepack.writeUInt56BE`	Writes unsigned 7-byte (56 bit) integer as big endian bytes.
`bytepack.writeUInt56LE`	Writes unsigned 7-byte (56 bit) integer as little endian bytes.
`bytepack.writeUInt64BE`	Writes unsigned 8-byte (64 bit) integer as big endian bytes.
`bytepack.writeUInt64LE`	Writes unsigned 8-byte (64 bit) integer as little endian bytes.
`bytepack.writeUInt8`	Writes unsigned 1-byte (8 bit) integer as bytes.

#bytepack.readDate

sharednodiscardsource

function bytepack.readDate(uint16: integer): integer, integer, integer

Reads date in DOS format from single Short number ( UInt16 ).

Parameters

Name	Type	Description
`uint16`	`integer`	The uint16 to read from.

Returns

Type	Name	Description
`integer`	`day`	The day.
`integer`	`month`	The month.
`integer`	`year`	The year.

#bytepack.readDoubleBE

sharednodiscardsource

function bytepack.readDoubleBE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer, uint8_8: integer): number

Reads signed 8-byte (64 bit) float (double) from big endian bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.
`uint8_8`	`integer`	The eighth byte.

Returns

Type	Name	Description
`number`	`value`	The signed 8-byte float.

#bytepack.readDoubleLE

sharednodiscardsource

function bytepack.readDoubleLE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer, uint8_8: integer): number

Reads signed 8-byte (64 bit) float (double) from little endian bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.
`uint8_8`	`integer`	The eighth byte.

Returns

Type	Name	Description
`number`	`value`	The signed 8-byte float.

#bytepack.readFixedPoint

sharednodiscardsource

function bytepack.readFixedPoint(n: integer, integer: integer): number

Reads fixed-point number (UQm.n) from specified integer with n bits.

Commonly Used UQm.n Formats (unsigned)

Format	Range	Precision (Step)
UQ8.8	`0 to 255.996`	0.00390625 (1/256)
UQ10.6	`0 to 1023.984375`	0.015625 (1/64)
UQ12.4	`0 to 4095.9375`	0.0625 (1/16)
UQ16.16	`0 to 65,535.99998`	0.0000152588 (1/65536)
UQ24.8	`0 to 16,777,215.996`	0.00390625 (1/256)
UQ32.16	`0 to 4,294,967,295.99998`	0.0000152588 (1/65536)

Commonly Used Qm.n Formats (signed)

Format	Range	Precision (Step)
Q8.8	`-128.0 to 127.996`	0.00390625 (1/256)
Q10.6	`-512.0 to 511.984375`	0.015625 (1/64)
Q12.4	`-2048.0 to 2047.9375`	0.0625 (1/16)
Q16.16	`-32,768.0 to 32,767.99998`	0.0000152588 (1/65536)
Q24.8	`-8,388,608.0 to 8,388,607.996`	0.00390625 (1/256)
Q32.16	`-2,147,483,648.0 to 2,147,483,647.99998`	0.0000152588 (1/65536)

Parameters

Name	Type	Description
`n`	`integer`	Number of fractional bits.
`integer`	`integer`	The integer number to read from.

Returns

Type	Name	Description
`number`	`value`	The unsigned fixed-point number.

#bytepack.readFloatBE

sharednodiscardsource

function bytepack.readFloatBE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer): number

Reads signed 4-byte (32 bit) float from big endian bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.

Returns

Type	Name	Description
`number`	`value`	The signed 4-byte float.

#bytepack.readFloatLE

sharednodiscardsource

function bytepack.readFloatLE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer): number

Reads signed 4-byte (32 bit) float from little endian bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.

Returns

Type	Name	Description
`number`	`value`	The signed 4-byte float.

#bytepack.readHex16BE

sharednodiscardsource

function bytepack.readHex16BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer): integer | nil

Reads unsigned 2-byte (16 bit) integer from big endian hex bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.

Returns

Type	Name	Description
`integer \| nil`	`value`	The unsigned 2-byte integer or `nil` if bytes do not match the allowed ones.

#bytepack.readHex24BE

sharednodiscardsource

function bytepack.readHex24BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer): integer | nil

Reads unsigned 3-byte (24 bit) integer from big endian hex bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.

Returns

Type	Name	Description
`integer \| nil`	`value`	The unsigned 3-byte integer or `nil` if bytes do not match the allowed ones.

#bytepack.readHex32BE

sharednodiscardsource

function bytepack.readHex32BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer, uint8_8: integer): integer | nil

Reads unsigned 4-byte (32 bit) integer from big endian hex bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.
`uint8_8`	`integer`	The eighth byte.

Returns

Type	Name	Description
`integer \| nil`	`value`	The unsigned 4-byte integer or `nil` if bytes do not match the allowed ones.

#bytepack.readHex8

sharednodiscardsource

function bytepack.readHex8(uint8_1: integer, uint8_2: integer): integer | nil

Reads unsigned 1-byte (8 bit) integer from big endian hex bytes.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.

Returns

Type	Name	Description
`integer \| nil`	`value`	The unsigned 1-byte integer or `nil` if bytes do not match the allowed ones.

#bytepack.readInt16BE

sharednodiscardsource

function bytepack.readInt16BE(uint8_1: integer, uint8_2: integer): integer

Reads signed 2-byte (16 bit) integer as big endian bytes.

Valid values without loss of precision: -32768 - 32767

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 2-byte integer.

#bytepack.readInt16LE

sharednodiscardsource

function bytepack.readInt16LE(uint8_1: integer, uint8_2: integer): integer

Reads signed 2-byte (16 bit) integer as little endian bytes.

Valid values without loss of precision: -32768 - 32767

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 2-byte integer.

#bytepack.readInt24BE

sharednodiscardsource

function bytepack.readInt24BE(uint8_1: integer, uint8_2: integer, uint8_3: integer): integer

Reads signed 3-byte (24 bit) integer as big endian bytes.

Valid values without loss of precision: -8388608 - 8388607

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 3-byte integer.

#bytepack.readInt24LE

sharednodiscardsource

function bytepack.readInt24LE(uint8_1: integer, uint8_2: integer, uint8_3: integer): integer

Reads signed 3-byte (24 bit) integer as little endian bytes.

Valid values without loss of precision: -8388608 - 8388607

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 3-byte integer.

#bytepack.readInt32BE

sharednodiscardsource

function bytepack.readInt32BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer): integer

Reads signed 4-byte (32 bit) integer from big endian bytes.

Valid values without loss of precision: -2147483648 - 2147483647

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 4-byte integer.

#bytepack.readInt32LE

sharednodiscardsource

function bytepack.readInt32LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer): integer

Reads signed 4-byte (32 bit) integer from little endian bytes.

Valid values without loss of precision: -2147483648 - 2147483647

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 4-byte integer.

#bytepack.readInt40BE

sharednodiscardsource

function bytepack.readInt40BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer): integer

Reads signed 5-byte (40 bit) integer from big endian bytes.

Valid values without loss of precision: -549755813888 - 549755813887

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 5-byte integer.

#bytepack.readInt40LE

sharednodiscardsource

function bytepack.readInt40LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer): integer

Reads signed 5-byte (40 bit) integer from little endian bytes.

Valid values without loss of precision: -549755813888 - 549755813887

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 5-byte integer.

#bytepack.readInt48BE

sharednodiscardsource

function bytepack.readInt48BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer): integer

Reads signed 6-byte (48 bit) integer from big endian bytes.

Valid values without loss of precision: -140737488355328 - 140737488355327

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 6-byte integer.

#bytepack.readInt48LE

sharednodiscardsource

function bytepack.readInt48LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer): integer

Reads signed 6-byte (48 bit) integer from little endian bytes.

Valid values without loss of precision: -140737488355328 - 140737488355327

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 6-byte integer.

#bytepack.readInt56BE

sharednodiscardsource

function bytepack.readInt56BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer): integer

Reads signed 7-byte (56 bit) integer from big endian bytes.

Valid values without loss of precision: -36028797018963968 - 36028797018963967

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 7-byte integer.

#bytepack.readInt56LE

sharednodiscardsource

function bytepack.readInt56LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer): integer

Reads signed 7-byte (56 bit) integer from little endian bytes.

Valid values without loss of precision: -36028797018963968 - 36028797018963967

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 7-byte integer.

#bytepack.readInt64BE

sharednodiscardsource

function bytepack.readInt64BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer, uint8_8: integer): integer

Reads signed 8-byte (64 bit) integer from big endian bytes.

Valid values without loss of precision: -9007199254740991 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.
`uint8_8`	`integer`	The eighth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 8-byte integer.

#bytepack.readInt64LE

sharednodiscardsource

function bytepack.readInt64LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer, uint8_8: integer): integer

Reads signed 8-byte (64 bit) integer from little endian bytes.

Valid values without loss of precision: -9007199254740991 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.
`uint8_8`	`integer`	The eighth byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 8-byte integer.

#bytepack.readInt8

sharednodiscardsource

function bytepack.readInt8(uint8_1: integer): integer

Reads signed 1-byte (8 bit) integer as little endian bytes.

Valid values without loss of precision: -128 - 127

Parameters

Name	Type	Description
`uint8_1`	`integer`	The byte.

Returns

Type	Name	Description
`integer`	`value`	The signed 1-byte integer.

#bytepack.readTime

sharednodiscardsource

function bytepack.readTime(uint16: integer): integer, integer, integer

Reads hours, minutes and seconds from single Short number ( UInt16 ).

Parameters

Name	Type	Description
`uint16`	`integer`	The uint16 to read from.

Returns

Type	Name	Description
`integer`	`hours`	The number of hours.
`integer`	`minutes`	The number of minutes.
`integer`	`seconds`	The number of seconds, will be rounded.

#bytepack.readUInt16BE

sharednodiscardsource

function bytepack.readUInt16BE(uint8_1: integer, uint8_2: integer): integer

Reads unsigned 2-byte (16 bit) integer from big endian bytes.

Valid values without loss of precision: 0 - 65535

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 2-byte integer.

#bytepack.readUInt16LE

sharednodiscardsource

function bytepack.readUInt16LE(uint8_1: integer, uint8_2: integer): integer

Reads unsigned 2-byte (16 bit) integer from little endian bytes.

Valid values without loss of precision: 0 - 65535

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 2-byte integer.

#bytepack.readUInt24BE

sharednodiscardsource

function bytepack.readUInt24BE(uint8_1: integer, uint8_2: integer, uint8_3: integer): integer

Reads unsigned 3-byte (24 bit) integer from big endian bytes.

Valid values without loss of precision: 0 - 16777215

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 3-byte integer.

#bytepack.readUInt24LE

sharednodiscardsource

function bytepack.readUInt24LE(uint8_1: integer, uint8_2: integer, uint8_3: integer): integer

Reads unsigned 3-byte (24 bit) integer from little endian bytes.

Valid values without loss of precision: 0 - 16777215

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 3-byte integer.

#bytepack.readUInt32BE

sharednodiscardsource

function bytepack.readUInt32BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer): integer

Reads unsigned 4-byte (32 bit) integer from big endian bytes.

Valid values without loss of precision: 0 - 4294967295

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 4-byte integer.

#bytepack.readUInt32LE

sharednodiscardsource

function bytepack.readUInt32LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer): integer

Reads unsigned 4-byte (32 bit) integer from little endian bytes.

Valid values without loss of precision: 0 - 4294967295

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 4-byte integer.

#bytepack.readUInt40BE

sharednodiscardsource

function bytepack.readUInt40BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer): integer

Reads unsigned 5-byte (40 bit) integer from big endian bytes.

Valid values without loss of precision: 0 - 1099511627775

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 5-byte integer.

#bytepack.readUInt40LE

sharednodiscardsource

function bytepack.readUInt40LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer): integer

Reads unsigned 5-byte (40 bit) integer from little endian bytes.

Valid values without loss of precision: 0 - 1099511627775

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 5-byte integer.

#bytepack.readUInt48BE

sharednodiscardsource

function bytepack.readUInt48BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer): integer

Reads unsigned 6-byte (48 bit) integer from big endian bytes.

Valid values without loss of precision: 0 - 281474976710655

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 6-byte integer.

#bytepack.readUInt48LE

sharednodiscardsource

function bytepack.readUInt48LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer): integer

Reads unsigned 6-byte (48 bit) integer from little endian bytes.

Valid values without loss of precision: 0 - 281474976710655

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 6-byte integer.

#bytepack.readUInt56BE

sharednodiscardsource

function bytepack.readUInt56BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer): integer

Reads unsigned 7-byte (56 bit) integer from big endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 7-byte integer.

#bytepack.readUInt56LE

sharednodiscardsource

function bytepack.readUInt56LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer): integer

Reads unsigned 7-byte (56 bit) integer from little endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 7-byte integer.

#bytepack.readUInt64BE

sharednodiscardsource

function bytepack.readUInt64BE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer, uint8_8: integer): integer

Reads unsigned 8-byte (64 bit) integer from big endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.
`uint8_8`	`integer`	The eighth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 8-byte integer.

#bytepack.readUInt64LE

sharednodiscardsource

function bytepack.readUInt64LE(uint8_1: integer, uint8_2: integer, uint8_3: integer, uint8_4: integer, uint8_5: integer, uint8_6: integer, uint8_7: integer, uint8_8: integer): integer

Reads unsigned 8-byte (64 bit) integer from little endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`uint8_1`	`integer`	The first byte.
`uint8_2`	`integer`	The second byte.
`uint8_3`	`integer`	The third byte.
`uint8_4`	`integer`	The fourth byte.
`uint8_5`	`integer`	The fifth byte.
`uint8_6`	`integer`	The sixth byte.
`uint8_7`	`integer`	The seventh byte.
`uint8_8`	`integer`	The eighth byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 8-byte integer.

#bytepack.readUInt8

sharednodiscardsource

function bytepack.readUInt8(uint8_1: integer): integer

Reads unsigned 1-byte (8 bit) integer from bytes.

Valid values without loss of precision: 0 - 255

Parameters

Name	Type	Description
`uint8_1`	`integer`	The byte.

Returns

Type	Name	Description
`integer`	`value`	The unsigned 1-byte integer.

#bytepack.writeDate

sharednodiscardsource

function bytepack.writeDate(day?: integer, month?: integer, year?: integer): integer

Writes date in DOS format as single Short number ( UInt16 ).

Parameters

Name	Type	Description
`day`optional	`integer`	The day.
`month`optional	`integer`	The month.
`year`optional	`integer`	The year.

Returns

Type	Name	Description
`integer`	`uint16`	The uint16 to read from.

#bytepack.writeDoubleBE

sharednodiscardsource

function bytepack.writeDoubleBE(value: number): integer, integer, integer, integer, integer, integer, integer, integer

Writes signed 8-byte (64 bit) float (double) as big endian bytes.

Parameters

Name	Type	Description
`value`	`number`	The signed 8-byte float.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeDoubleLE

sharednodiscardsource

function bytepack.writeDoubleLE(value: number): integer, integer, integer, integer, integer, integer, integer, integer

Writes signed 8-byte (64 bit) float (double) as little endian bytes.

Parameters

Name	Type	Description
`value`	`number`	The signed 8-byte float.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeFixedPoint

sharednodiscardsource

function bytepack.writeFixedPoint(value: number, m: integer, n: integer): integer

Writes fixed-point number (UQm.n or Qm.n) as integer with n fractional bits.

The value is rounded to the nearest representable step.

Commonly Used UQm.n Formats

Format	Range	Precision (Step)
UQ8.8	`0 to 255.996`	0.00390625 (1/256)
UQ10.6	`0 to 1023.984375`	0.015625 (1/64)
UQ12.4	`0 to 4095.9375`	0.0625 (1/16)
UQ16.16	`0 to 65,535.99998`	0.0000152588 (1/65536)
UQ24.8	`0 to 16,777,215.996`	0.00390625 (1/256)
UQ32.16	`0 to 4,294,967,295.99998`	0.0000152588 (1/65536)

Commonly Used Qm.n Formats (signed)

Format	Range	Precision (Step)
Q8.8	`-128.0 to 127.996`	0.00390625 (1/256)
Q10.6	`-512.0 to 511.984375`	0.015625 (1/64)
Q12.4	`-2048.0 to 2047.9375`	0.0625 (1/16)
Q16.16	`-32,768.0 to 32,767.99998`	0.0000152588 (1/65536)
Q24.8	`-8,388,608.0 to 8,388,607.996`	0.00390625 (1/256)
Q32.16	`-2,147,483,648.0 to 2,147,483,647.99998`	0.0000152588 (1/65536)

Parameters

Name	Type	Description
`value`	`number`	The fixed-point number.
`m`	`integer`	Number of integer bits (including sign bit).
`n`	`integer`	Number of fractional bits.

Returns

Type	Name	Description
`integer`	`integer`	The integer number to read from.

#bytepack.writeFloatBE

sharednodiscardsource

function bytepack.writeFloatBE(value: number): integer, integer, integer, integer

Writes signed 4-byte (32 bit) float as big endian bytes.

Parameters

Name	Type	Description
`value`	`number`	The signed 4-byte float.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeFloatLE

sharednodiscardsource

function bytepack.writeFloatLE(value: number): integer, integer, integer, integer

Writes signed 4-byte (32 bit) float as little endian bytes.

Parameters

Name	Type	Description
`value`	`number`	The signed 4-byte float.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeHex16BE

sharednodiscardsource

function bytepack.writeHex16BE(uint16: integer): integer, integer, integer, integer

Encodes unsigned 2-byte (16 bit) integer to big endian hex bytes.

Valid values without loss of precision: 0 - 65535

Parameters

Name	Type	Description
`uint16`	`integer`	The unsigned 2-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeHex16LE

sharednodiscardsource

function bytepack.writeHex16LE(uint16: integer): integer, integer, integer, integer

Encodes unsigned 2-byte (16 bit) integer to little endian hex bytes.

Valid values without loss of precision: 0 - 65535

Parameters

Name	Type	Description
`uint16`	`integer`	The unsigned 2-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeHex24BE

sharednodiscardsource

function bytepack.writeHex24BE(uint24: integer): integer, integer, integer, integer, integer, integer

Encodes unsigned 3-byte (24 bit) integer to big endian hex bytes.

Valid values without loss of precision: 0 - 16777215

Parameters

Name	Type	Description
`uint24`	`integer`	The unsigned 3-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.

#bytepack.writeHex24LE

sharednodiscardsource

function bytepack.writeHex24LE(uint24: integer): integer, integer, integer, integer, integer, integer

Encodes unsigned 3-byte (24 bit) integer to little endian hex bytes.

Valid values without loss of precision: 0 - 16777215

Parameters

Name	Type	Description
`uint24`	`integer`	The unsigned 3-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.

#bytepack.writeHex32BE

sharednodiscardsource

function bytepack.writeHex32BE(uint32: integer): integer, integer, integer, integer, integer, integer, integer, integer

Encodes unsigned 4-byte (32 bit) integer to big endian hex bytes.

Valid values without loss of precision: 0 - 4294967295

Parameters

Name	Type	Description
`uint32`	`integer`	The unsigned 4-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeHex32LE

sharednodiscardsource

function bytepack.writeHex32LE(uint32: integer): integer, integer, integer, integer, integer, integer, integer, integer

Encodes unsigned 4-byte (32 bit) integer to little endian hex bytes.

Valid values without loss of precision: 0 - 4294967295

Parameters

Name	Type	Description
`uint32`	`integer`	The unsigned 4-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeHex8

sharednodiscardsource

function bytepack.writeHex8(uint8: integer): integer, integer

Encodes unsigned 1-byte (8 bit) integer to big endian hex bytes.

Valid values without loss of precision: 0 - 255

Parameters

Name	Type	Description
`uint8`	`integer`	The unsigned 1-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.

#bytepack.writeInt16BE

sharednodiscardsource

function bytepack.writeInt16BE(value: integer): integer, integer

Writes signed 2-byte (16 bit) integer as big endian bytes.

Valid values without loss of precision: -32768 - 32767

Parameters

Name	Type	Description
`value`	`integer`	The signed 2-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.

#bytepack.writeInt16LE

sharednodiscardsource

function bytepack.writeInt16LE(value: integer): integer, integer

Writes signed 2-byte (16 bit) integer as little endian bytes.

Valid values without loss of precision: -32768 - 32767

Parameters

Name	Type	Description
`value`	`integer`	The signed 2-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.

#bytepack.writeInt24BE

sharednodiscardsource

function bytepack.writeInt24BE(value: integer): integer, integer, integer

Writes signed 3-byte (24 bit) integer as big endian bytes.

Valid values without loss of precision: -8388608 - 8388607

Parameters

Name	Type	Description
`value`	`integer`	The signed 3-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.

#bytepack.writeInt24LE

sharednodiscardsource

function bytepack.writeInt24LE(value: integer): integer, integer, integer

Writes signed 3-byte (24 bit) integer as little endian bytes.

Valid values without loss of precision: -8388608 - 8388607

Parameters

Name	Type	Description
`value`	`integer`	The signed 3-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.

#bytepack.writeInt32BE

sharednodiscardsource

function bytepack.writeInt32BE(value: integer): integer, integer, integer, integer

Writes signed 4-byte (32 bit) integer as big endian bytes.

Valid values without loss of precision: -2147483648 - 2147483647

Parameters

Name	Type	Description
`value`	`integer`	The signed 4-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeInt32LE

sharednodiscardsource

function bytepack.writeInt32LE(value: integer): integer, integer, integer, integer

Writes signed 4-byte (32 bit) integer as little endian bytes.

Valid values without loss of precision: -2147483648 - 2147483647

Parameters

Name	Type	Description
`value`	`integer`	The signed 4-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeInt40BE

sharednodiscardsource

function bytepack.writeInt40BE(value: integer): integer, integer, integer, integer, integer

Writes signed 5-byte (40 bit) integer as big endian bytes.

Valid values without loss of precision: -549755813888 - 549755813887

Parameters

Name	Type	Description
`value`	`integer`	The signed 5-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.

#bytepack.writeInt40LE

sharednodiscardsource

function bytepack.writeInt40LE(value: integer): integer, integer, integer, integer, integer

Writes signed 5-byte (40 bit) integer as little endian bytes.

Valid values without loss of precision: -549755813888 - 549755813887

Parameters

Name	Type	Description
`value`	`integer`	The signed 5-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.

#bytepack.writeInt48BE

sharednodiscardsource

function bytepack.writeInt48BE(value: integer): integer, integer, integer, integer, integer, integer

Writes signed 6-byte (48 bit) integer as big endian bytes.

Valid values without loss of precision: -140737488355328 - 140737488355327

Parameters

Name	Type	Description
`value`	`integer`	The signed 6-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.

#bytepack.writeInt48LE

sharednodiscardsource

function bytepack.writeInt48LE(value: integer): integer, integer, integer, integer, integer, integer

Writes signed 6-byte (48 bit) integer as little endian bytes.

Valid values without loss of precision: -140737488355328 - 140737488355327

Parameters

Name	Type	Description
`value`	`integer`	The signed 6-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.

#bytepack.writeInt56BE

sharednodiscardsource

function bytepack.writeInt56BE(value: integer): integer, integer, integer, integer, integer, integer, integer

Writes signed 7-byte (56 bit) integer as big endian bytes.

Valid values without loss of precision: -36028797018963968 - 36028797018963967

Parameters

Name	Type	Description
`value`	`integer`	The signed 7-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.

#bytepack.writeInt56LE

sharednodiscardsource

function bytepack.writeInt56LE(value: integer): integer, integer, integer, integer, integer, integer, integer

Writes signed 7-byte (56 bit) integer as little endian bytes.

Valid values without loss of precision: -36028797018963968 - 36028797018963967

Parameters

Name	Type	Description
`value`	`integer`	The signed 7-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.

#bytepack.writeInt64BE

sharednodiscardsource

function bytepack.writeInt64BE(value: integer): integer, integer, integer, integer, integer, integer, integer, integer

Writes signed 8-byte (64 bit) integer as big endian bytes.

Valid values without loss of precision: -9007199254740991 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`value`	`integer`	The signed 8-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeInt64LE

sharednodiscardsource

function bytepack.writeInt64LE(value: integer): integer, integer, integer, integer, integer, integer, integer, integer

Writes signed 8-byte (64 bit) integer as little endian bytes.

Valid values without loss of precision: -9007199254740991 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`value`	`integer`	The signed 8-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeInt8

sharednodiscardsource

function bytepack.writeInt8(value: integer): integer

Writes signed 1-byte (8 bit) integer as little endian bytes.

Valid values without loss of precision: -128 - 127

Parameters

Name	Type	Description
`value`	`integer`	The signed 1-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The byte.

#bytepack.writeTime

sharednodiscardsource

function bytepack.writeTime(hours?: integer, minutes?: integer, seconds?: integer): integer

Writes time in DOS format as single Short number ( UInt16 ).

Values are clamped to the valid DOS ranges: hours 0 - 23, minutes 0 - 59, seconds 0 - 59.

Parameters

Name	Type	Description
`hours`optional	`integer`	The number of hours.
`minutes`optional	`integer`	The number of minutes.
`seconds`optional	`integer`	The number of seconds, will be rounded.

Returns

Type	Name	Description
`integer`	`uint16`	The uint16 to read from.

#bytepack.writeUInt16BE

sharednodiscardsource

function bytepack.writeUInt16BE(value: integer): integer, integer

Writes unsigned 2-byte (16 bit) integer as big endian bytes.

Valid values without loss of precision: 0 - 65535

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 2-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.

#bytepack.writeUInt16LE

sharednodiscardsource

function bytepack.writeUInt16LE(value: integer): integer, integer

Writes unsigned 2-byte (16 bit) integer as little endian bytes.

Valid values without loss of precision: 0 - 65535

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 2-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.

#bytepack.writeUInt24BE

sharednodiscardsource

function bytepack.writeUInt24BE(value: integer): integer, integer, integer

Writes unsigned 3-byte (24 bit) integer as big endian bytes.

Valid values without loss of precision: 0 - 16777215

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 3-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.

#bytepack.writeUInt24LE

sharednodiscardsource

function bytepack.writeUInt24LE(value: integer): integer, integer, integer

Writes unsigned 3-byte (24 bit) integer as little endian bytes.

Valid values without loss of precision: 0 - 16777215

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 3-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.

#bytepack.writeUInt32BE

sharednodiscardsource

function bytepack.writeUInt32BE(value: integer): integer, integer, integer, integer

Writes unsigned 4-byte (32 bit) integer as big endian bytes.

Valid values without loss of precision: 0 - 4294967295

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 4-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeUInt32LE

sharednodiscardsource

function bytepack.writeUInt32LE(value: integer): integer, integer, integer, integer

Writes unsigned 4-byte (32 bit) integer as little endian bytes.

Valid values without loss of precision: 0 - 4294967295

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 4-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.

#bytepack.writeUInt40BE

sharednodiscardsource

function bytepack.writeUInt40BE(value: integer): integer, integer, integer, integer, integer

Writes unsigned 5-byte (40 bit) integer as big endian bytes.

Valid values without loss of precision: 0 - 1099511627775.

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 5-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.

#bytepack.writeUInt40LE

sharednodiscardsource

function bytepack.writeUInt40LE(value: integer): integer, integer, integer, integer, integer

Writes unsigned 5-byte (40 bit) integer as little endian bytes.

Valid values without loss of precision: 0 - 1099511627775.

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 5-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.

#bytepack.writeUInt48BE

sharednodiscardsource

function bytepack.writeUInt48BE(value: integer): integer, integer, integer, integer, integer, integer

Writes unsigned 6-byte (48 bit) integer as big endian bytes.

Valid values without loss of precision: 0 - 281474976710655

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 6-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.

#bytepack.writeUInt48LE

sharednodiscardsource

function bytepack.writeUInt48LE(value: integer): integer, integer, integer, integer, integer, integer

Writes unsigned 6-byte (48 bit) integer as little endian bytes.

Valid values without loss of precision: 0 - 281474976710655

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 6-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.

#bytepack.writeUInt56BE

sharednodiscardsource

function bytepack.writeUInt56BE(value: integer): integer, integer, integer, integer, integer, integer, integer

Writes unsigned 7-byte (56 bit) integer as big endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 7-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.

#bytepack.writeUInt56LE

sharednodiscardsource

function bytepack.writeUInt56LE(value: integer): integer, integer, integer, integer, integer, integer, integer

Writes unsigned 7-byte (56 bit) integer as little endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 7-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.

#bytepack.writeUInt64BE

sharednodiscardsource

function bytepack.writeUInt64BE(value: integer): integer, integer, integer, integer, integer, integer, integer, integer

Writes unsigned 8-byte (64 bit) integer as big endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 8-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeUInt64LE

sharednodiscardsource

function bytepack.writeUInt64LE(value: integer): integer, integer, integer, integer, integer, integer, integer, integer

Writes unsigned 8-byte (64 bit) integer as little endian bytes.

Valid values without loss of precision: 0 - 9007199254740991

All values above will have problems when working with them.

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 8-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The first byte.
`integer`	`uint8_2`	The second byte.
`integer`	`uint8_3`	The third byte.
`integer`	`uint8_4`	The fourth byte.
`integer`	`uint8_5`	The fifth byte.
`integer`	`uint8_6`	The sixth byte.
`integer`	`uint8_7`	The seventh byte.
`integer`	`uint8_8`	The eighth byte.

#bytepack.writeUInt8

sharednodiscardsource

function bytepack.writeUInt8(value: integer): integer

Writes unsigned 1-byte (8 bit) integer as bytes.

Valid values without loss of precision: 0 - 255

Parameters

Name	Type	Description
`value`	`integer`	The unsigned 1-byte integer.

Returns

Type	Name	Description
`integer`	`uint8_1`	The byte.